docs(core): renamed generated folder (#8491)
This commit is contained in:
Benjamin Cabanes
GitHub
parent
a4e848c709
commit
57995d8d14
1302
.yarn/releases/yarn-1.22.10.cjs
vendored
1302
.yarn/releases/yarn-1.22.10.cjs
vendored
File diff suppressed because it is too large
Load Diff
@ -13,138 +13,138 @@ It only uses language primitives and immutable objects
|
|||||||
|
|
||||||
### Project Graph Enumerations
|
### Project Graph Enumerations
|
||||||
|
|
||||||
- [DependencyType](../../default/nx-devkit/index#dependencytype)
|
- [DependencyType](../../generated/nx-devkit/index#dependencytype)
|
||||||
|
|
||||||
### Utils Enumerations
|
### Utils Enumerations
|
||||||
|
|
||||||
- [ChangeType](../../default/nx-devkit/index#changetype)
|
- [ChangeType](../../generated/nx-devkit/index#changetype)
|
||||||
|
|
||||||
### Project Graph Classes
|
### Project Graph Classes
|
||||||
|
|
||||||
- [ProjectGraphBuilder](../../default/nx-devkit/index#projectgraphbuilder)
|
- [ProjectGraphBuilder](../../generated/nx-devkit/index#projectgraphbuilder)
|
||||||
|
|
||||||
### Commands Interfaces
|
### Commands Interfaces
|
||||||
|
|
||||||
- [Target](../../default/nx-devkit/index#target)
|
- [Target](../../generated/nx-devkit/index#target)
|
||||||
|
|
||||||
### Other Interfaces
|
### Other Interfaces
|
||||||
|
|
||||||
- [NxPlugin](../../default/nx-devkit/index#nxplugin)
|
- [NxPlugin](../../generated/nx-devkit/index#nxplugin)
|
||||||
|
|
||||||
### Project Graph Interfaces
|
### Project Graph Interfaces
|
||||||
|
|
||||||
- [FileData](../../default/nx-devkit/index#filedata)
|
- [FileData](../../generated/nx-devkit/index#filedata)
|
||||||
- [ProjectFileMap](../../default/nx-devkit/index#projectfilemap)
|
- [ProjectFileMap](../../generated/nx-devkit/index#projectfilemap)
|
||||||
- [ProjectGraph](../../default/nx-devkit/index#projectgraph)
|
- [ProjectGraph](../../generated/nx-devkit/index#projectgraph)
|
||||||
- [ProjectGraphDependency](../../default/nx-devkit/index#projectgraphdependency)
|
- [ProjectGraphDependency](../../generated/nx-devkit/index#projectgraphdependency)
|
||||||
- [ProjectGraphExternalNode](../../default/nx-devkit/index#projectgraphexternalnode)
|
- [ProjectGraphExternalNode](../../generated/nx-devkit/index#projectgraphexternalnode)
|
||||||
- [ProjectGraphProcessorContext](../../default/nx-devkit/index#projectgraphprocessorcontext)
|
- [ProjectGraphProcessorContext](../../generated/nx-devkit/index#projectgraphprocessorcontext)
|
||||||
- [ProjectGraphProjectNode](../../default/nx-devkit/index#projectgraphprojectnode)
|
- [ProjectGraphProjectNode](../../generated/nx-devkit/index#projectgraphprojectnode)
|
||||||
|
|
||||||
### Tree Interfaces
|
### Tree Interfaces
|
||||||
|
|
||||||
- [FileChange](../../default/nx-devkit/index#filechange)
|
- [FileChange](../../generated/nx-devkit/index#filechange)
|
||||||
- [Tree](../../default/nx-devkit/index#tree)
|
- [Tree](../../generated/nx-devkit/index#tree)
|
||||||
|
|
||||||
### Utils Interfaces
|
### Utils Interfaces
|
||||||
|
|
||||||
- [JsonParseOptions](../../default/nx-devkit/index#jsonparseoptions)
|
- [JsonParseOptions](../../generated/nx-devkit/index#jsonparseoptions)
|
||||||
- [JsonSerializeOptions](../../default/nx-devkit/index#jsonserializeoptions)
|
- [JsonSerializeOptions](../../generated/nx-devkit/index#jsonserializeoptions)
|
||||||
- [StringDeletion](../../default/nx-devkit/index#stringdeletion)
|
- [StringDeletion](../../generated/nx-devkit/index#stringdeletion)
|
||||||
- [StringInsertion](../../default/nx-devkit/index#stringinsertion)
|
- [StringInsertion](../../generated/nx-devkit/index#stringinsertion)
|
||||||
|
|
||||||
### Workspace Interfaces
|
### Workspace Interfaces
|
||||||
|
|
||||||
- [ExecutorContext](../../default/nx-devkit/index#executorcontext)
|
- [ExecutorContext](../../generated/nx-devkit/index#executorcontext)
|
||||||
- [ImplicitJsonSubsetDependency](../../default/nx-devkit/index#implicitjsonsubsetdependency)
|
- [ImplicitJsonSubsetDependency](../../generated/nx-devkit/index#implicitjsonsubsetdependency)
|
||||||
- [NxAffectedConfig](../../default/nx-devkit/index#nxaffectedconfig)
|
- [NxAffectedConfig](../../generated/nx-devkit/index#nxaffectedconfig)
|
||||||
- [NxJsonConfiguration](../../default/nx-devkit/index#nxjsonconfiguration)
|
- [NxJsonConfiguration](../../generated/nx-devkit/index#nxjsonconfiguration)
|
||||||
- [NxJsonProjectConfiguration](../../default/nx-devkit/index#nxjsonprojectconfiguration)
|
- [NxJsonProjectConfiguration](../../generated/nx-devkit/index#nxjsonprojectconfiguration)
|
||||||
- [ProjectConfiguration](../../default/nx-devkit/index#projectconfiguration)
|
- [ProjectConfiguration](../../generated/nx-devkit/index#projectconfiguration)
|
||||||
- [TargetConfiguration](../../default/nx-devkit/index#targetconfiguration)
|
- [TargetConfiguration](../../generated/nx-devkit/index#targetconfiguration)
|
||||||
- [TargetDependencyConfig](../../default/nx-devkit/index#targetdependencyconfig)
|
- [TargetDependencyConfig](../../generated/nx-devkit/index#targetdependencyconfig)
|
||||||
- [Task](../../default/nx-devkit/index#task)
|
- [Task](../../generated/nx-devkit/index#task)
|
||||||
- [TaskGraph](../../default/nx-devkit/index#taskgraph)
|
- [TaskGraph](../../generated/nx-devkit/index#taskgraph)
|
||||||
- [Workspace](../../default/nx-devkit/index#workspace)
|
- [Workspace](../../generated/nx-devkit/index#workspace)
|
||||||
- [WorkspaceJsonConfiguration](../../default/nx-devkit/index#workspacejsonconfiguration)
|
- [WorkspaceJsonConfiguration](../../generated/nx-devkit/index#workspacejsonconfiguration)
|
||||||
|
|
||||||
### Generators Type aliases
|
### Generators Type aliases
|
||||||
|
|
||||||
- [WorkspaceConfiguration](../../default/nx-devkit/index#workspaceconfiguration)
|
- [WorkspaceConfiguration](../../generated/nx-devkit/index#workspaceconfiguration)
|
||||||
|
|
||||||
### Other Type aliases
|
### Other Type aliases
|
||||||
|
|
||||||
- [ProjectTargetConfigurator](../../default/nx-devkit/index#projecttargetconfigurator)
|
- [ProjectTargetConfigurator](../../generated/nx-devkit/index#projecttargetconfigurator)
|
||||||
|
|
||||||
### Package Manager Type aliases
|
### Package Manager Type aliases
|
||||||
|
|
||||||
- [PackageManager](../../default/nx-devkit/index#packagemanager)
|
- [PackageManager](../../generated/nx-devkit/index#packagemanager)
|
||||||
|
|
||||||
### Project Graph Type aliases
|
### Project Graph Type aliases
|
||||||
|
|
||||||
- [ProjectGraphNode](../../default/nx-devkit/index#projectgraphnode)
|
- [ProjectGraphNode](../../generated/nx-devkit/index#projectgraphnode)
|
||||||
|
|
||||||
### Utils Type aliases
|
### Utils Type aliases
|
||||||
|
|
||||||
- [StringChange](../../default/nx-devkit/index#stringchange)
|
- [StringChange](../../generated/nx-devkit/index#stringchange)
|
||||||
|
|
||||||
### Workspace Type aliases
|
### Workspace Type aliases
|
||||||
|
|
||||||
- [Executor](../../default/nx-devkit/index#executor)
|
- [Executor](../../generated/nx-devkit/index#executor)
|
||||||
- [Generator](../../default/nx-devkit/index#generator)
|
- [Generator](../../generated/nx-devkit/index#generator)
|
||||||
- [GeneratorCallback](../../default/nx-devkit/index#generatorcallback)
|
- [GeneratorCallback](../../generated/nx-devkit/index#generatorcallback)
|
||||||
- [ImplicitDependencyEntry](../../default/nx-devkit/index#implicitdependencyentry)
|
- [ImplicitDependencyEntry](../../generated/nx-devkit/index#implicitdependencyentry)
|
||||||
- [ProjectType](../../default/nx-devkit/index#projecttype)
|
- [ProjectType](../../generated/nx-devkit/index#projecttype)
|
||||||
- [TaskGraphExecutor](../../default/nx-devkit/index#taskgraphexecutor)
|
- [TaskGraphExecutor](../../generated/nx-devkit/index#taskgraphexecutor)
|
||||||
|
|
||||||
### Logger Variables
|
### Logger Variables
|
||||||
|
|
||||||
- [logger](../../default/nx-devkit/index#logger)
|
- [logger](../../generated/nx-devkit/index#logger)
|
||||||
|
|
||||||
### Functions
|
### Functions
|
||||||
|
|
||||||
- [addDependenciesToPackageJson](../../default/nx-devkit/index#adddependenciestopackagejson)
|
- [addDependenciesToPackageJson](../../generated/nx-devkit/index#adddependenciestopackagejson)
|
||||||
- [addProjectConfiguration](../../default/nx-devkit/index#addprojectconfiguration)
|
- [addProjectConfiguration](../../generated/nx-devkit/index#addprojectconfiguration)
|
||||||
- [applyChangesToString](../../default/nx-devkit/index#applychangestostring)
|
- [applyChangesToString](../../generated/nx-devkit/index#applychangestostring)
|
||||||
- [convertNxExecutor](../../default/nx-devkit/index#convertnxexecutor)
|
- [convertNxExecutor](../../generated/nx-devkit/index#convertnxexecutor)
|
||||||
- [convertNxGenerator](../../default/nx-devkit/index#convertnxgenerator)
|
- [convertNxGenerator](../../generated/nx-devkit/index#convertnxgenerator)
|
||||||
- [detectPackageManager](../../default/nx-devkit/index#detectpackagemanager)
|
- [detectPackageManager](../../generated/nx-devkit/index#detectpackagemanager)
|
||||||
- [formatFiles](../../default/nx-devkit/index#formatfiles)
|
- [formatFiles](../../generated/nx-devkit/index#formatfiles)
|
||||||
- [generateFiles](../../default/nx-devkit/index#generatefiles)
|
- [generateFiles](../../generated/nx-devkit/index#generatefiles)
|
||||||
- [getPackageManagerCommand](../../default/nx-devkit/index#getpackagemanagercommand)
|
- [getPackageManagerCommand](../../generated/nx-devkit/index#getpackagemanagercommand)
|
||||||
- [getPackageManagerVersion](../../default/nx-devkit/index#getpackagemanagerversion)
|
- [getPackageManagerVersion](../../generated/nx-devkit/index#getpackagemanagerversion)
|
||||||
- [getProjects](../../default/nx-devkit/index#getprojects)
|
- [getProjects](../../generated/nx-devkit/index#getprojects)
|
||||||
- [getWorkspaceLayout](../../default/nx-devkit/index#getworkspacelayout)
|
- [getWorkspaceLayout](../../generated/nx-devkit/index#getworkspacelayout)
|
||||||
- [getWorkspacePath](../../default/nx-devkit/index#getworkspacepath)
|
- [getWorkspacePath](../../generated/nx-devkit/index#getworkspacepath)
|
||||||
- [installPackagesTask](../../default/nx-devkit/index#installpackagestask)
|
- [installPackagesTask](../../generated/nx-devkit/index#installpackagestask)
|
||||||
- [isStandaloneProject](../../default/nx-devkit/index#isstandaloneproject)
|
- [isStandaloneProject](../../generated/nx-devkit/index#isstandaloneproject)
|
||||||
- [joinPathFragments](../../default/nx-devkit/index#joinpathfragments)
|
- [joinPathFragments](../../generated/nx-devkit/index#joinpathfragments)
|
||||||
- [moveFilesToNewDirectory](../../default/nx-devkit/index#movefilestonewdirectory)
|
- [moveFilesToNewDirectory](../../generated/nx-devkit/index#movefilestonewdirectory)
|
||||||
- [names](../../default/nx-devkit/index#names)
|
- [names](../../generated/nx-devkit/index#names)
|
||||||
- [normalizePath](../../default/nx-devkit/index#normalizepath)
|
- [normalizePath](../../generated/nx-devkit/index#normalizepath)
|
||||||
- [offsetFromRoot](../../default/nx-devkit/index#offsetfromroot)
|
- [offsetFromRoot](../../generated/nx-devkit/index#offsetfromroot)
|
||||||
- [parseJson](../../default/nx-devkit/index#parsejson)
|
- [parseJson](../../generated/nx-devkit/index#parsejson)
|
||||||
- [parseTargetString](../../default/nx-devkit/index#parsetargetstring)
|
- [parseTargetString](../../generated/nx-devkit/index#parsetargetstring)
|
||||||
- [readJson](../../default/nx-devkit/index#readjson)
|
- [readJson](../../generated/nx-devkit/index#readjson)
|
||||||
- [readJsonFile](../../default/nx-devkit/index#readjsonfile)
|
- [readJsonFile](../../generated/nx-devkit/index#readjsonfile)
|
||||||
- [readProjectConfiguration](../../default/nx-devkit/index#readprojectconfiguration)
|
- [readProjectConfiguration](../../generated/nx-devkit/index#readprojectconfiguration)
|
||||||
- [readTargetOptions](../../default/nx-devkit/index#readtargetoptions)
|
- [readTargetOptions](../../generated/nx-devkit/index#readtargetoptions)
|
||||||
- [readWorkspaceConfiguration](../../default/nx-devkit/index#readworkspaceconfiguration)
|
- [readWorkspaceConfiguration](../../generated/nx-devkit/index#readworkspaceconfiguration)
|
||||||
- [removeDependenciesFromPackageJson](../../default/nx-devkit/index#removedependenciesfrompackagejson)
|
- [removeDependenciesFromPackageJson](../../generated/nx-devkit/index#removedependenciesfrompackagejson)
|
||||||
- [removeProjectConfiguration](../../default/nx-devkit/index#removeprojectconfiguration)
|
- [removeProjectConfiguration](../../generated/nx-devkit/index#removeprojectconfiguration)
|
||||||
- [runExecutor](../../default/nx-devkit/index#runexecutor)
|
- [runExecutor](../../generated/nx-devkit/index#runexecutor)
|
||||||
- [serializeJson](../../default/nx-devkit/index#serializejson)
|
- [serializeJson](../../generated/nx-devkit/index#serializejson)
|
||||||
- [stripIndents](../../default/nx-devkit/index#stripindents)
|
- [stripIndents](../../generated/nx-devkit/index#stripindents)
|
||||||
- [stripJsonComments](../../default/nx-devkit/index#stripjsoncomments)
|
- [stripJsonComments](../../generated/nx-devkit/index#stripjsoncomments)
|
||||||
- [targetToTargetString](../../default/nx-devkit/index#targettotargetstring)
|
- [targetToTargetString](../../generated/nx-devkit/index#targettotargetstring)
|
||||||
- [toJS](../../default/nx-devkit/index#tojs)
|
- [toJS](../../generated/nx-devkit/index#tojs)
|
||||||
- [updateJson](../../default/nx-devkit/index#updatejson)
|
- [updateJson](../../generated/nx-devkit/index#updatejson)
|
||||||
- [updateProjectConfiguration](../../default/nx-devkit/index#updateprojectconfiguration)
|
- [updateProjectConfiguration](../../generated/nx-devkit/index#updateprojectconfiguration)
|
||||||
- [updateTsConfigsToJs](../../default/nx-devkit/index#updatetsconfigstojs)
|
- [updateTsConfigsToJs](../../generated/nx-devkit/index#updatetsconfigstojs)
|
||||||
- [updateWorkspaceConfiguration](../../default/nx-devkit/index#updateworkspaceconfiguration)
|
- [updateWorkspaceConfiguration](../../generated/nx-devkit/index#updateworkspaceconfiguration)
|
||||||
- [visitNotIgnoredFiles](../../default/nx-devkit/index#visitnotignoredfiles)
|
- [visitNotIgnoredFiles](../../generated/nx-devkit/index#visitnotignoredfiles)
|
||||||
- [writeJson](../../default/nx-devkit/index#writejson)
|
- [writeJson](../../generated/nx-devkit/index#writejson)
|
||||||
- [writeJsonFile](../../default/nx-devkit/index#writejsonfile)
|
- [writeJsonFile](../../generated/nx-devkit/index#writejsonfile)
|
||||||
|
|
||||||
## Project Graph Enumerations
|
## Project Graph Enumerations
|
||||||
|
|
||||||
@ -368,7 +368,7 @@ A plugin for Nx
|
|||||||
|
|
||||||
### WorkspaceConfiguration
|
### WorkspaceConfiguration
|
||||||
|
|
||||||
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../default/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../default/nx-devkit/index#nxjsonconfiguration)\>
|
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../generated/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../generated/nx-devkit/index#nxjsonconfiguration)\>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -376,11 +376,11 @@ A plugin for Nx
|
|||||||
|
|
||||||
### ProjectTargetConfigurator
|
### ProjectTargetConfigurator
|
||||||
|
|
||||||
Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`<`string`, [`TargetConfiguration`](../../default/nx-devkit/index#targetconfiguration)\>
|
Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`<`string`, [`TargetConfiguration`](../../generated/nx-devkit/index#targetconfiguration)\>
|
||||||
|
|
||||||
#### Type declaration
|
#### Type declaration
|
||||||
|
|
||||||
▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../default/nx-devkit/index#targetconfiguration)\>
|
▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../generated/nx-devkit/index#targetconfiguration)\>
|
||||||
|
|
||||||
##### Parameters
|
##### Parameters
|
||||||
|
|
||||||
@ -390,7 +390,7 @@ A plugin for Nx
|
|||||||
|
|
||||||
##### Returns
|
##### Returns
|
||||||
|
|
||||||
`Record`<`string`, [`TargetConfiguration`](../../default/nx-devkit/index#targetconfiguration)\>
|
`Record`<`string`, [`TargetConfiguration`](../../generated/nx-devkit/index#targetconfiguration)\>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -406,7 +406,7 @@ A plugin for Nx
|
|||||||
|
|
||||||
### ProjectGraphNode
|
### ProjectGraphNode
|
||||||
|
|
||||||
Ƭ **ProjectGraphNode**<`T`\>: [`ProjectGraphProjectNode`](../../default/nx-devkit/index#projectgraphprojectnode)<`T`\> \| [`ProjectGraphExternalNode`](../../default/nx-devkit/index#projectgraphexternalnode)
|
Ƭ **ProjectGraphNode**<`T`\>: [`ProjectGraphProjectNode`](../../generated/nx-devkit/index#projectgraphprojectnode)<`T`\> \| [`ProjectGraphExternalNode`](../../generated/nx-devkit/index#projectgraphexternalnode)
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
@ -420,7 +420,7 @@ A plugin for Nx
|
|||||||
|
|
||||||
### StringChange
|
### StringChange
|
||||||
|
|
||||||
Ƭ **StringChange**: [`StringInsertion`](../../default/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../default/nx-devkit/index#stringdeletion)
|
Ƭ **StringChange**: [`StringInsertion`](../../generated/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../generated/nx-devkit/index#stringdeletion)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -428,7 +428,7 @@ A plugin for Nx
|
|||||||
|
|
||||||
### Executor
|
### Executor
|
||||||
|
|
||||||
Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../default/nx-devkit/index#executorcontext)) => `Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\>
|
Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../generated/nx-devkit/index#executorcontext)) => `Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\>
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
@ -444,10 +444,10 @@ Implementation of a target of a project
|
|||||||
|
|
||||||
##### Parameters
|
##### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :-------- | :----------------------------------------------------------------- |
|
| :-------- | :------------------------------------------------------------------- |
|
||||||
| `options` | `T` |
|
| `options` | `T` |
|
||||||
| `context` | [`ExecutorContext`](../../default/nx-devkit/index#executorcontext) |
|
| `context` | [`ExecutorContext`](../../generated/nx-devkit/index#executorcontext) |
|
||||||
|
|
||||||
##### Returns
|
##### Returns
|
||||||
|
|
||||||
@ -457,7 +457,7 @@ Implementation of a target of a project
|
|||||||
|
|
||||||
### Generator
|
### Generator
|
||||||
|
|
||||||
Ƭ **Generator**<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback)\>
|
Ƭ **Generator**<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback)\>
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
@ -467,7 +467,7 @@ Implementation of a target of a project
|
|||||||
|
|
||||||
#### Type declaration
|
#### Type declaration
|
||||||
|
|
||||||
▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback)\>
|
▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback)\>
|
||||||
|
|
||||||
A function that schedules updates to the filesystem to be done atomically
|
A function that schedules updates to the filesystem to be done atomically
|
||||||
|
|
||||||
@ -480,7 +480,7 @@ A function that schedules updates to the filesystem to be done atomically
|
|||||||
|
|
||||||
##### Returns
|
##### Returns
|
||||||
|
|
||||||
`void` \| [`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback)\>
|
`void` \| [`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback)\>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -512,7 +512,7 @@ A callback function that is executed after changes are made to the file system
|
|||||||
|
|
||||||
#### Index signature
|
#### Index signature
|
||||||
|
|
||||||
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../default/nx-devkit/index#implicitjsonsubsetdependency)<`T`\>
|
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../generated/nx-devkit/index#implicitjsonsubsetdependency)<`T`\>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -524,7 +524,7 @@ A callback function that is executed after changes are made to the file system
|
|||||||
|
|
||||||
### TaskGraphExecutor
|
### TaskGraphExecutor
|
||||||
|
|
||||||
Ƭ **TaskGraphExecutor**<`T`\>: (`taskGraph`: [`TaskGraph`](../../default/nx-devkit/index#taskgraph), `options`: `Record`<`string`, `T`\>, `overrides`: `T`, `context`: [`ExecutorContext`](../../default/nx-devkit/index#executorcontext)) => `Promise`<`Record`<`string`, `Object`\>\>
|
Ƭ **TaskGraphExecutor**<`T`\>: (`taskGraph`: [`TaskGraph`](../../generated/nx-devkit/index#taskgraph), `options`: `Record`<`string`, `T`\>, `overrides`: `T`, `context`: [`ExecutorContext`](../../generated/nx-devkit/index#executorcontext)) => `Promise`<`Record`<`string`, `Object`\>\>
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
@ -540,12 +540,12 @@ Implementation of a target of a project that handles multiple projects to be bat
|
|||||||
|
|
||||||
##### Parameters
|
##### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :---------- | :----------------------------------------------------------------- |
|
| :---------- | :------------------------------------------------------------------- |
|
||||||
| `taskGraph` | [`TaskGraph`](../../default/nx-devkit/index#taskgraph) |
|
| `taskGraph` | [`TaskGraph`](../../generated/nx-devkit/index#taskgraph) |
|
||||||
| `options` | `Record`<`string`, `T`\> |
|
| `options` | `Record`<`string`, `T`\> |
|
||||||
| `overrides` | `T` |
|
| `overrides` | `T` |
|
||||||
| `context` | [`ExecutorContext`](../../default/nx-devkit/index#executorcontext) |
|
| `context` | [`ExecutorContext`](../../generated/nx-devkit/index#executorcontext) |
|
||||||
|
|
||||||
##### Returns
|
##### Returns
|
||||||
|
|
||||||
@ -572,7 +572,7 @@ Implementation of a target of a project that handles multiple projects to be bat
|
|||||||
|
|
||||||
### addDependenciesToPackageJson
|
### addDependenciesToPackageJson
|
||||||
|
|
||||||
▸ **addDependenciesToPackageJson**(`tree`, `dependencies`, `devDependencies`, `packageJsonPath?`): [`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback)
|
▸ **addDependenciesToPackageJson**(`tree`, `dependencies`, `devDependencies`, `packageJsonPath?`): [`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback)
|
||||||
|
|
||||||
Add Dependencies and Dev Dependencies to package.json
|
Add Dependencies and Dev Dependencies to package.json
|
||||||
|
|
||||||
@ -586,16 +586,16 @@ This will **add** `react` and `jest` to the dependencies and devDependencies sec
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
| :---------------- | :------------------------------------------- | :--------------- | :---------------------------------------------------------------------- |
|
| :---------------- | :--------------------------------------------- | :--------------- | :---------------------------------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | `undefined` | Tree representing file system to modify |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | `undefined` | Tree representing file system to modify |
|
||||||
| `dependencies` | `Record`<`string`, `string`\> | `undefined` | Dependencies to be added to the dependencies section of package.json |
|
| `dependencies` | `Record`<`string`, `string`\> | `undefined` | Dependencies to be added to the dependencies section of package.json |
|
||||||
| `devDependencies` | `Record`<`string`, `string`\> | `undefined` | Dependencies to be added to the devDependencies section of package.json |
|
| `devDependencies` | `Record`<`string`, `string`\> | `undefined` | Dependencies to be added to the devDependencies section of package.json |
|
||||||
| `packageJsonPath` | `string` | `'package.json'` | Path to package.json |
|
| `packageJsonPath` | `string` | `'package.json'` | Path to package.json |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
[`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback)
|
[`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback)
|
||||||
|
|
||||||
Callback to install dependencies only if necessary. undefined is returned if changes are not necessary.
|
Callback to install dependencies only if necessary. undefined is returned if changes are not necessary.
|
||||||
|
|
||||||
@ -612,12 +612,12 @@ The utility will update either files.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :--------------------- | :--------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- |
|
| :--------------------- | :----------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | the file system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | the file system tree |
|
||||||
| `projectName` | `string` | unique name. Often directories are part of the name (e.g., mydir-mylib) |
|
| `projectName` | `string` | unique name. Often directories are part of the name (e.g., mydir-mylib) |
|
||||||
| `projectConfiguration` | [`ProjectConfiguration`](../../default/nx-devkit/index#projectconfiguration) | project configuration |
|
| `projectConfiguration` | [`ProjectConfiguration`](../../generated/nx-devkit/index#projectconfiguration) | project configuration |
|
||||||
| `standalone?` | `boolean` | should the project use package.json? If false, the project config is inside workspace.json |
|
| `standalone?` | `boolean` | should the project use package.json? If false, the project config is inside workspace.json |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -661,10 +661,10 @@ bootstrap({
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :-------- | :------------------------------------------------------------- |
|
| :-------- | :--------------------------------------------------------------- |
|
||||||
| `text` | `string` |
|
| `text` | `string` |
|
||||||
| `changes` | [`StringChange`](../../default/nx-devkit/index#stringchange)[] |
|
| `changes` | [`StringChange`](../../generated/nx-devkit/index#stringchange)[] |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -682,9 +682,9 @@ Use this to expose a compatible Angular Builder
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :--------- | :----------------------------------------------------------- |
|
| :--------- | :------------------------------------------------------------- |
|
||||||
| `executor` | [`Executor`](../../default/nx-devkit/index#executor)<`any`\> |
|
| `executor` | [`Executor`](../../generated/nx-devkit/index#executor)<`any`\> |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -706,9 +706,9 @@ Convert an Nx Generator into an Angular Devkit Schematic
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :---------- | :----------------------------------------------------------- |
|
| :---------- | :------------------------------------------------------------- |
|
||||||
| `generator` | [`Generator`](../../default/nx-devkit/index#generator)<`T`\> |
|
| `generator` | [`Generator`](../../generated/nx-devkit/index#generator)<`T`\> |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -743,7 +743,7 @@ Convert an Nx Generator into an Angular Devkit Schematic
|
|||||||
|
|
||||||
### detectPackageManager
|
### detectPackageManager
|
||||||
|
|
||||||
▸ **detectPackageManager**(`dir?`): [`PackageManager`](../../default/nx-devkit/index#packagemanager)
|
▸ **detectPackageManager**(`dir?`): [`PackageManager`](../../generated/nx-devkit/index#packagemanager)
|
||||||
|
|
||||||
Detects which package manager is used in the workspace based on the lock file.
|
Detects which package manager is used in the workspace based on the lock file.
|
||||||
|
|
||||||
@ -755,7 +755,7 @@ Detects which package manager is used in the workspace based on the lock file.
|
|||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
[`PackageManager`](../../default/nx-devkit/index#packagemanager)
|
[`PackageManager`](../../generated/nx-devkit/index#packagemanager)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -767,9 +767,9 @@ Formats all the created or updated files using Prettier
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :----- | :------------------------------------------- | :------------------- |
|
| :----- | :--------------------------------------------- | :------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | the file system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | the file system tree |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -805,12 +805,12 @@ doesn't get confused about incorrect TypeScript files.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :-------------- | :------------------------------------------- | :-------------------------------------------- |
|
| :-------------- | :--------------------------------------------- | :-------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | the file system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | the file system tree |
|
||||||
| `srcFolder` | `string` | the source folder of files (absolute path) |
|
| `srcFolder` | `string` | the source folder of files (absolute path) |
|
||||||
| `target` | `string` | the target folder (relative to the tree root) |
|
| `target` | `string` | the target folder (relative to the tree root) |
|
||||||
| `substitutions` | `Object` | an object of key-value pairs |
|
| `substitutions` | `Object` | an object of key-value pairs |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -834,9 +834,9 @@ execSync(`${getPackageManagerCommand().addDev} my-dev-package`);
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :--------------- | :--------------------------------------------------------------- |
|
| :--------------- | :----------------------------------------------------------------- |
|
||||||
| `packageManager` | [`PackageManager`](../../default/nx-devkit/index#packagemanager) |
|
| `packageManager` | [`PackageManager`](../../generated/nx-devkit/index#packagemanager) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -854,9 +854,9 @@ but it can also be passed in explicitly.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :--------------- | :--------------------------------------------------------------- |
|
| :--------------- | :----------------------------------------------------------------- |
|
||||||
| `packageManager` | [`PackageManager`](../../default/nx-devkit/index#packagemanager) |
|
| `packageManager` | [`PackageManager`](../../generated/nx-devkit/index#packagemanager) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -866,21 +866,21 @@ but it can also be passed in explicitly.
|
|||||||
|
|
||||||
### getProjects
|
### getProjects
|
||||||
|
|
||||||
▸ **getProjects**(`tree`): `Map`<`string`, [`ProjectConfiguration`](../../default/nx-devkit/index#projectconfiguration)\>
|
▸ **getProjects**(`tree`): `Map`<`string`, [`ProjectConfiguration`](../../generated/nx-devkit/index#projectconfiguration)\>
|
||||||
|
|
||||||
Get a map of all projects in a workspace.
|
Get a map of all projects in a workspace.
|
||||||
|
|
||||||
Use [readProjectConfiguration](../../default/nx-devkit/index#readprojectconfiguration) if only one project is needed.
|
Use [readProjectConfiguration](../../generated/nx-devkit/index#readprojectconfiguration) if only one project is needed.
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :----- | :------------------------------------------- |
|
| :----- | :--------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
`Map`<`string`, [`ProjectConfiguration`](../../default/nx-devkit/index#projectconfiguration)\>
|
`Map`<`string`, [`ProjectConfiguration`](../../generated/nx-devkit/index#projectconfiguration)\>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -899,9 +899,9 @@ Example:
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :----- | :------------------------------------------- | :--------------- |
|
| :----- | :--------------------------------------------- | :--------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | file system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | file system tree |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -922,9 +922,9 @@ Example:
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :----- | :------------------------------------------- |
|
| :----- | :--------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -941,12 +941,12 @@ Runs `npm install` or `yarn install`. It will skip running the install if
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
| :--------------- | :--------------------------------------------------------------- | :------------ | :------------------------------------------------------------ |
|
| :--------------- | :----------------------------------------------------------------- | :------------ | :------------------------------------------------------------ |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | `undefined` | the file system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | `undefined` | the file system tree |
|
||||||
| `alwaysRun` | `boolean` | `false` | always run the command even if `package.json` hasn't changed. |
|
| `alwaysRun` | `boolean` | `false` | always run the command even if `package.json` hasn't changed. |
|
||||||
| `cwd` | `string` | `''` | - |
|
| `cwd` | `string` | `''` | - |
|
||||||
| `packageManager` | [`PackageManager`](../../default/nx-devkit/index#packagemanager) | `undefined` | - |
|
| `packageManager` | [`PackageManager`](../../generated/nx-devkit/index#packagemanager) | `undefined` | - |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -962,10 +962,10 @@ Returns if a project has a standalone configuration (project.json).
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :-------- | :------------------------------------------- | :------------------- |
|
| :-------- | :--------------------------------------------- | :------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | the file system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | the file system tree |
|
||||||
| `project` | `string` | the project name |
|
| `project` | `string` | the project name |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -997,11 +997,11 @@ Normalized path fragments and joins them
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :------- | :------------------------------------------- |
|
| :------- | :--------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) |
|
||||||
| `oldDir` | `string` |
|
| `oldDir` | `string` |
|
||||||
| `newDir` | `string` |
|
| `newDir` | `string` |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1100,10 +1100,10 @@ By default javascript-style comments are allowed.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :--------- | :------------------------------------------------------------------- | :--------------------- |
|
| :--------- | :--------------------------------------------------------------------- | :--------------------- |
|
||||||
| `input` | `string` | JSON content as string |
|
| `input` | `string` | JSON content as string |
|
||||||
| `options?` | [`JsonParseOptions`](../../default/nx-devkit/index#jsonparseoptions) | JSON parse options |
|
| `options?` | [`JsonParseOptions`](../../generated/nx-devkit/index#jsonparseoptions) | JSON parse options |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1115,7 +1115,7 @@ Object the JSON content represents
|
|||||||
|
|
||||||
### parseTargetString
|
### parseTargetString
|
||||||
|
|
||||||
▸ **parseTargetString**(`targetString`): [`Target`](../../default/nx-devkit/index#target)
|
▸ **parseTargetString**(`targetString`): [`Target`](../../generated/nx-devkit/index#target)
|
||||||
|
|
||||||
Parses a target string into {project, target, configuration}
|
Parses a target string into {project, target, configuration}
|
||||||
|
|
||||||
@ -1134,7 +1134,7 @@ parseTargetString('proj:test:production'); // returns { project: "proj", target:
|
|||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
[`Target`](../../default/nx-devkit/index#target)
|
[`Target`](../../generated/nx-devkit/index#target)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -1152,11 +1152,11 @@ Reads a json file, removes all comments and parses JSON.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :--------- | :------------------------------------------------------------------- | :-------------------------- |
|
| :--------- | :--------------------------------------------------------------------- | :-------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | file system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | file system tree |
|
||||||
| `path` | `string` | file path |
|
| `path` | `string` | file path |
|
||||||
| `options?` | [`JsonParseOptions`](../../default/nx-devkit/index#jsonparseoptions) | Optional JSON Parse Options |
|
| `options?` | [`JsonParseOptions`](../../generated/nx-devkit/index#jsonparseoptions) | Optional JSON Parse Options |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1193,7 +1193,7 @@ Object the JSON content of the file represents
|
|||||||
|
|
||||||
### readProjectConfiguration
|
### readProjectConfiguration
|
||||||
|
|
||||||
▸ **readProjectConfiguration**(`tree`, `projectName`): [`ProjectConfiguration`](../../default/nx-devkit/index#projectconfiguration)
|
▸ **readProjectConfiguration**(`tree`, `projectName`): [`ProjectConfiguration`](../../generated/nx-devkit/index#projectconfiguration)
|
||||||
|
|
||||||
Reads a project configuration.
|
Reads a project configuration.
|
||||||
|
|
||||||
@ -1204,14 +1204,14 @@ The utility will read from either file.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :------------ | :------------------------------------------- | :---------------------------------------------------------------------- |
|
| :------------ | :--------------------------------------------- | :---------------------------------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | the file system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | the file system tree |
|
||||||
| `projectName` | `string` | unique name. Often directories are part of the name (e.g., mydir-mylib) |
|
| `projectName` | `string` | unique name. Often directories are part of the name (e.g., mydir-mylib) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
[`ProjectConfiguration`](../../default/nx-devkit/index#projectconfiguration)
|
[`ProjectConfiguration`](../../generated/nx-devkit/index#projectconfiguration)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -1231,10 +1231,10 @@ Works as if you invoked the target yourself without passing any command lint ove
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :------------------ | :----------------------------------------------------------------- |
|
| :------------------ | :------------------------------------------------------------------- |
|
||||||
| `__namedParameters` | [`Target`](../../default/nx-devkit/index#target) |
|
| `__namedParameters` | [`Target`](../../generated/nx-devkit/index#target) |
|
||||||
| `context` | [`ExecutorContext`](../../default/nx-devkit/index#executorcontext) |
|
| `context` | [`ExecutorContext`](../../generated/nx-devkit/index#executorcontext) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1244,27 +1244,27 @@ Works as if you invoked the target yourself without passing any command lint ove
|
|||||||
|
|
||||||
### readWorkspaceConfiguration
|
### readWorkspaceConfiguration
|
||||||
|
|
||||||
▸ **readWorkspaceConfiguration**(`tree`): [`WorkspaceConfiguration`](../../default/nx-devkit/index#workspaceconfiguration)
|
▸ **readWorkspaceConfiguration**(`tree`): [`WorkspaceConfiguration`](../../generated/nx-devkit/index#workspaceconfiguration)
|
||||||
|
|
||||||
Read general workspace configuration such as the default project or cli settings
|
Read general workspace configuration such as the default project or cli settings
|
||||||
|
|
||||||
This does _not_ provide projects configuration, use [readProjectConfiguration](../../default/nx-devkit/index#readprojectconfiguration) instead.
|
This does _not_ provide projects configuration, use [readProjectConfiguration](../../generated/nx-devkit/index#readprojectconfiguration) instead.
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :----- | :------------------------------------------- |
|
| :----- | :--------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
[`WorkspaceConfiguration`](../../default/nx-devkit/index#workspaceconfiguration)
|
[`WorkspaceConfiguration`](../../generated/nx-devkit/index#workspaceconfiguration)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### removeDependenciesFromPackageJson
|
### removeDependenciesFromPackageJson
|
||||||
|
|
||||||
▸ **removeDependenciesFromPackageJson**(`tree`, `dependencies`, `devDependencies`, `packageJsonPath?`): [`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback)
|
▸ **removeDependenciesFromPackageJson**(`tree`, `dependencies`, `devDependencies`, `packageJsonPath?`): [`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback)
|
||||||
|
|
||||||
Remove Dependencies and Dev Dependencies from package.json
|
Remove Dependencies and Dev Dependencies from package.json
|
||||||
|
|
||||||
@ -1278,16 +1278,16 @@ This will **remove** `react` and `jest` from the dependencies and devDependencie
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
| :---------------- | :------------------------------------------- | :--------------- | :-------------------------------------------------------------------------- |
|
| :---------------- | :--------------------------------------------- | :--------------- | :-------------------------------------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | `undefined` | - |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | `undefined` | - |
|
||||||
| `dependencies` | `string`[] | `undefined` | Dependencies to be removed from the dependencies section of package.json |
|
| `dependencies` | `string`[] | `undefined` | Dependencies to be removed from the dependencies section of package.json |
|
||||||
| `devDependencies` | `string`[] | `undefined` | Dependencies to be removed from the devDependencies section of package.json |
|
| `devDependencies` | `string`[] | `undefined` | Dependencies to be removed from the devDependencies section of package.json |
|
||||||
| `packageJsonPath` | `string` | `'package.json'` | - |
|
| `packageJsonPath` | `string` | `'package.json'` | - |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
[`GeneratorCallback`](../../default/nx-devkit/index#generatorcallback)
|
[`GeneratorCallback`](../../generated/nx-devkit/index#generatorcallback)
|
||||||
|
|
||||||
Callback to uninstall dependencies only if necessary. undefined is returned if changes are not necessary.
|
Callback to uninstall dependencies only if necessary. undefined is returned if changes are not necessary.
|
||||||
|
|
||||||
@ -1304,10 +1304,10 @@ The utility will update either file.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :------------ | :------------------------------------------- |
|
| :------------ | :--------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) |
|
||||||
| `projectName` | `string` |
|
| `projectName` | `string` |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1355,14 +1355,14 @@ Note that the return value is a promise of an iterator, so you need to await bef
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :--------------------------------- | :----------------------------------------------------------------- |
|
| :--------------------------------- | :------------------------------------------------------------------- |
|
||||||
| `targetDescription` | `Object` |
|
| `targetDescription` | `Object` |
|
||||||
| `targetDescription.configuration?` | `string` |
|
| `targetDescription.configuration?` | `string` |
|
||||||
| `targetDescription.project` | `string` |
|
| `targetDescription.project` | `string` |
|
||||||
| `targetDescription.target` | `string` |
|
| `targetDescription.target` | `string` |
|
||||||
| `options` | `Object` |
|
| `options` | `Object` |
|
||||||
| `context` | [`ExecutorContext`](../../default/nx-devkit/index#executorcontext) |
|
| `context` | [`ExecutorContext`](../../generated/nx-devkit/index#executorcontext) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1385,10 +1385,10 @@ By default the JSON string is formatted with a 2 space intendation to be easy re
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :--------- | :--------------------------------------------------------------------------- | :---------------------------------------- |
|
| :--------- | :----------------------------------------------------------------------------- | :---------------------------------------- |
|
||||||
| `input` | `T` | Object which should be serialized to JSON |
|
| `input` | `T` | Object which should be serialized to JSON |
|
||||||
| `options?` | [`JsonSerializeOptions`](../../default/nx-devkit/index#jsonserializeoptions) | JSON serialize options |
|
| `options?` | [`JsonSerializeOptions`](../../generated/nx-devkit/index#jsonserializeoptions) | JSON serialize options |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1456,9 +1456,9 @@ Returns a string in the format "project:target[:configuration]" for the target
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :------- | :----------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| :------- | :------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `target` | [`Target`](../../default/nx-devkit/index#target) | target object Examples: `typescript targetToTargetString({ project: "proj", target: "test" }) // returns "proj:test" targetToTargetString({ project: "proj", target: "test", configuration: "production" }) // returns "proj:test:production" ` |
|
| `target` | [`Target`](../../generated/nx-devkit/index#target) | target object Examples: `typescript targetToTargetString({ project: "proj", target: "test" }) // returns "proj:test" targetToTargetString({ project: "proj", target: "test", configuration: "production" }) // returns "proj:test:production" ` |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1474,9 +1474,9 @@ Rename and transpile any new typescript files created to javascript files
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :----- | :------------------------------------------- |
|
| :----- | :--------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1499,12 +1499,12 @@ Updates a JSON value to the file system tree
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :--------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- |
|
| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | File system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | File system tree |
|
||||||
| `path` | `string` | Path of JSON file in the Tree |
|
| `path` | `string` | Path of JSON file in the Tree |
|
||||||
| `updater` | (`value`: `T`) => `U` | Function that maps the current value of a JSON document to a new value to be written to the document |
|
| `updater` | (`value`: `T`) => `U` | Function that maps the current value of a JSON document to a new value to be written to the document |
|
||||||
| `options?` | [`JsonParseOptions`](../../default/nx-devkit/index#jsonparseoptions) & [`JsonSerializeOptions`](../../default/nx-devkit/index#jsonserializeoptions) | Optional JSON Parse and Serialize Options |
|
| `options?` | [`JsonParseOptions`](../../generated/nx-devkit/index#jsonparseoptions) & [`JsonSerializeOptions`](../../generated/nx-devkit/index#jsonserializeoptions) | Optional JSON Parse and Serialize Options |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1523,11 +1523,11 @@ The utility will update either files.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :--------------------- | :--------------------------------------------------------------------------- | :---------------------------------------------------------------------- |
|
| :--------------------- | :----------------------------------------------------------------------------- | :---------------------------------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | the file system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | the file system tree |
|
||||||
| `projectName` | `string` | unique name. Often directories are part of the name (e.g., mydir-mylib) |
|
| `projectName` | `string` | unique name. Often directories are part of the name (e.g., mydir-mylib) |
|
||||||
| `projectConfiguration` | [`ProjectConfiguration`](../../default/nx-devkit/index#projectconfiguration) | project configuration |
|
| `projectConfiguration` | [`ProjectConfiguration`](../../generated/nx-devkit/index#projectconfiguration) | project configuration |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1541,11 +1541,11 @@ The utility will update either files.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :-------------------- | :------------------------------------------- |
|
| :-------------------- | :--------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) |
|
||||||
| `options` | `Object` |
|
| `options` | `Object` |
|
||||||
| `options.projectRoot` | `string` |
|
| `options.projectRoot` | `string` |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1559,14 +1559,14 @@ The utility will update either files.
|
|||||||
|
|
||||||
Update general workspace configuration such as the default project or cli settings.
|
Update general workspace configuration such as the default project or cli settings.
|
||||||
|
|
||||||
This does _not_ update projects configuration, use [updateProjectConfiguration](../../default/nx-devkit/index#updateprojectconfiguration) or [addProjectConfiguration](../../default/nx-devkit/index#addprojectconfiguration) instead.
|
This does _not_ update projects configuration, use [updateProjectConfiguration](../../generated/nx-devkit/index#updateprojectconfiguration) or [addProjectConfiguration](../../generated/nx-devkit/index#addprojectconfiguration) instead.
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :---------------- | :------------------------------------------------------------------------------- |
|
| :---------------- | :--------------------------------------------------------------------------------- |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) |
|
||||||
| `workspaceConfig` | [`WorkspaceConfiguration`](../../default/nx-devkit/index#workspaceconfiguration) |
|
| `workspaceConfig` | [`WorkspaceConfiguration`](../../generated/nx-devkit/index#workspaceconfiguration) |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1582,11 +1582,11 @@ Utility to act on all files in a tree that are not ignored by git.
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Default value |
|
| Name | Type | Default value |
|
||||||
| :-------- | :------------------------------------------- | :------------ |
|
| :-------- | :--------------------------------------------- | :------------ |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | `undefined` |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | `undefined` |
|
||||||
| `dirPath` | `string` | `tree.root` |
|
| `dirPath` | `string` | `tree.root` |
|
||||||
| `visitor` | (`path`: `string`) => `void` | `undefined` |
|
| `visitor` | (`path`: `string`) => `void` | `undefined` |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -1608,12 +1608,12 @@ Writes a JSON value to the file system tree
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| :--------- | :--------------------------------------------------------------------------- | :------------------------------ |
|
| :--------- | :----------------------------------------------------------------------------- | :------------------------------ |
|
||||||
| `tree` | [`Tree`](../../default/nx-devkit/index#tree) | File system tree |
|
| `tree` | [`Tree`](../../generated/nx-devkit/index#tree) | File system tree |
|
||||||
| `path` | `string` | Path of JSON file in the Tree |
|
| `path` | `string` | Path of JSON file in the Tree |
|
||||||
| `value` | `T` | Serializable value to write |
|
| `value` | `T` | Serializable value to write |
|
||||||
| `options?` | [`JsonSerializeOptions`](../../default/nx-devkit/index#jsonserializeoptions) | Optional JSON Serialize Options |
|
| `options?` | [`JsonSerializeOptions`](../../generated/nx-devkit/index#jsonserializeoptions) | Optional JSON Serialize Options |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@ -4,13 +4,13 @@
|
|||||||
|
|
||||||
### Ng CLI Adapter Classes
|
### Ng CLI Adapter Classes
|
||||||
|
|
||||||
- [NxScopedHost](../../default/nx-devkit/ngcli_adapter#nxscopedhost)
|
- [NxScopedHost](../../generated/nx-devkit/ngcli_adapter#nxscopedhost)
|
||||||
|
|
||||||
### Functions
|
### Functions
|
||||||
|
|
||||||
- [mockSchematicsForTesting](../../default/nx-devkit/ngcli_adapter#mockschematicsfortesting)
|
- [mockSchematicsForTesting](../../generated/nx-devkit/ngcli_adapter#mockschematicsfortesting)
|
||||||
- [overrideCollectionResolutionForTesting](../../default/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
- [overrideCollectionResolutionForTesting](../../generated/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
||||||
- [wrapAngularDevkitSchematic](../../default/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
- [wrapAngularDevkitSchematic](../../generated/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
||||||
|
|
||||||
## Ng CLI Adapter Classes
|
## Ng CLI Adapter Classes
|
||||||
|
|
||||||
@ -91,7 +91,7 @@ overrideCollectionResolutionForTesting({
|
|||||||
|
|
||||||
### wrapAngularDevkitSchematic
|
### wrapAngularDevkitSchematic
|
||||||
|
|
||||||
▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../default/nx-devkit/index#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\>
|
▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../generated/nx-devkit/index#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\>
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
@ -108,10 +108,10 @@ overrideCollectionResolutionForTesting({
|
|||||||
|
|
||||||
##### Parameters
|
##### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :----------------- | :------------------------------------------- |
|
| :----------------- | :--------------------------------------------- |
|
||||||
| `host` | [`Tree`](../../default/nx-devkit/index#tree) |
|
| `host` | [`Tree`](../../generated/nx-devkit/index#tree) |
|
||||||
| `generatorOptions` | `Object` |
|
| `generatorOptions` | `Object` |
|
||||||
|
|
||||||
##### Returns
|
##### Returns
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user