miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(nxdev): remove nx-devkit generated redirect rules & fix url (#10318)

Browse Source
This commit is contained in:
Benjamin Cabanes 2022-05-16 10:34:53 -04:00 committed by GitHub
parent 17c40229a7
commit c7ec631060
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 342 additions and 368 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

470
docs/generated/api-nx-devkit/index.md → docs/generated/devkit/index.md
View File

@ -13,168 +13,168 @@ It only uses language primitives and immutable objects
### Project Graph Enumerations ### Project Graph Enumerations
- [DependencyType](../../nx-devkit/index#dependencytype) - [DependencyType](../../devkit/index#dependencytype)
### Utils Enumerations ### Utils Enumerations
- [ChangeType](../../nx-devkit/index#changetype) - [ChangeType](../../devkit/index#changetype)
### Project Graph Classes ### Project Graph Classes
- [ProjectGraphBuilder](../../nx-devkit/index#projectgraphbuilder) - [ProjectGraphBuilder](../../devkit/index#projectgraphbuilder)
### Utils Classes ### Utils Classes
- [Hasher](../../nx-devkit/index#hasher) - [Hasher](../../devkit/index#hasher)
### Workspace Classes ### Workspace Classes
- [Workspaces](../../nx-devkit/index#workspaces) - [Workspaces](../../devkit/index#workspaces)
### Commands Interfaces ### Commands Interfaces
- [Target](../../nx-devkit/index#target) - [Target](../../devkit/index#target)
### Other Interfaces ### Other Interfaces
- [NxPlugin](../../nx-devkit/index#nxplugin) - [NxPlugin](../../devkit/index#nxplugin)
### Project Graph Interfaces ### Project Graph Interfaces
- [FileData](../../nx-devkit/index#filedata) - [FileData](../../devkit/index#filedata)
- [ProjectFileMap](../../nx-devkit/index#projectfilemap) - [ProjectFileMap](../../devkit/index#projectfilemap)
- [ProjectGraph](../../nx-devkit/index#projectgraph) - [ProjectGraph](../../devkit/index#projectgraph)
- [ProjectGraphDependency](../../nx-devkit/index#projectgraphdependency) - [ProjectGraphDependency](../../devkit/index#projectgraphdependency)
- [ProjectGraphExternalNode](../../nx-devkit/index#projectgraphexternalnode) - [ProjectGraphExternalNode](../../devkit/index#projectgraphexternalnode)
- [ProjectGraphProcessorContext](../../nx-devkit/index#projectgraphprocessorcontext) - [ProjectGraphProcessorContext](../../devkit/index#projectgraphprocessorcontext)
- [ProjectGraphProjectNode](../../nx-devkit/index#projectgraphprojectnode) - [ProjectGraphProjectNode](../../devkit/index#projectgraphprojectnode)
- [ProjectGraphV4](../../nx-devkit/index#projectgraphv4) - [ProjectGraphV4](../../devkit/index#projectgraphv4)
### Tree Interfaces ### Tree Interfaces
- [FileChange](../../nx-devkit/index#filechange) - [FileChange](../../devkit/index#filechange)
- [Tree](../../nx-devkit/index#tree) - [Tree](../../devkit/index#tree)
### Utils Interfaces ### Utils Interfaces
- [DefaultTasksRunnerOptions](../../nx-devkit/index#defaulttasksrunneroptions) - [DefaultTasksRunnerOptions](../../devkit/index#defaulttasksrunneroptions)
- [Hash](../../nx-devkit/index#hash) - [Hash](../../devkit/index#hash)
- [JsonParseOptions](../../nx-devkit/index#jsonparseoptions) - [JsonParseOptions](../../devkit/index#jsonparseoptions)
- [JsonSerializeOptions](../../nx-devkit/index#jsonserializeoptions) - [JsonSerializeOptions](../../devkit/index#jsonserializeoptions)
- [RemoteCache](../../nx-devkit/index#remotecache) - [RemoteCache](../../devkit/index#remotecache)
- [StringDeletion](../../nx-devkit/index#stringdeletion) - [StringDeletion](../../devkit/index#stringdeletion)
- [StringInsertion](../../nx-devkit/index#stringinsertion) - [StringInsertion](../../devkit/index#stringinsertion)
### Workspace Interfaces ### Workspace Interfaces
- [ExecutorContext](../../nx-devkit/index#executorcontext) - [ExecutorContext](../../devkit/index#executorcontext)
- [ExecutorsJson](../../nx-devkit/index#executorsjson) - [ExecutorsJson](../../devkit/index#executorsjson)
- [GeneratorsJson](../../nx-devkit/index#generatorsjson) - [GeneratorsJson](../../devkit/index#generatorsjson)
- [HasherContext](../../nx-devkit/index#hashercontext) - [HasherContext](../../devkit/index#hashercontext)
- [ImplicitJsonSubsetDependency](../../nx-devkit/index#implicitjsonsubsetdependency) - [ImplicitJsonSubsetDependency](../../devkit/index#implicitjsonsubsetdependency)
- [MigrationsJson](../../nx-devkit/index#migrationsjson) - [MigrationsJson](../../devkit/index#migrationsjson)
- [NxAffectedConfig](../../nx-devkit/index#nxaffectedconfig) - [NxAffectedConfig](../../devkit/index#nxaffectedconfig)
- [NxJsonConfiguration](../../nx-devkit/index#nxjsonconfiguration) - [NxJsonConfiguration](../../devkit/index#nxjsonconfiguration)
- [ProjectConfiguration](../../nx-devkit/index#projectconfiguration) - [ProjectConfiguration](../../devkit/index#projectconfiguration)
- [TargetConfiguration](../../nx-devkit/index#targetconfiguration) - [TargetConfiguration](../../devkit/index#targetconfiguration)
- [TargetDependencyConfig](../../nx-devkit/index#targetdependencyconfig) - [TargetDependencyConfig](../../devkit/index#targetdependencyconfig)
- [Task](../../nx-devkit/index#task) - [Task](../../devkit/index#task)
- [TaskGraph](../../nx-devkit/index#taskgraph) - [TaskGraph](../../devkit/index#taskgraph)
- [Workspace](../../nx-devkit/index#workspace) - [Workspace](../../devkit/index#workspace)
- [WorkspaceJsonConfiguration](../../nx-devkit/index#workspacejsonconfiguration) - [WorkspaceJsonConfiguration](../../devkit/index#workspacejsonconfiguration)
### Generators Type aliases ### Generators Type aliases
- [WorkspaceConfiguration](../../nx-devkit/index#workspaceconfiguration) - [WorkspaceConfiguration](../../devkit/index#workspaceconfiguration)
### Other Type aliases ### Other Type aliases
- [ProjectTargetConfigurator](../../nx-devkit/index#projecttargetconfigurator) - [ProjectTargetConfigurator](../../devkit/index#projecttargetconfigurator)
### Package Manager Type aliases ### Package Manager Type aliases
- [PackageManager](../../nx-devkit/index#packagemanager) - [PackageManager](../../devkit/index#packagemanager)
### Project Graph Type aliases ### Project Graph Type aliases
- [ProjectGraphNode](../../nx-devkit/index#projectgraphnode) - [ProjectGraphNode](../../devkit/index#projectgraphnode)
### Utils Type aliases ### Utils Type aliases
- [StringChange](../../nx-devkit/index#stringchange) - [StringChange](../../devkit/index#stringchange)
### Workspace Type aliases ### Workspace Type aliases
- [CustomHasher](../../nx-devkit/index#customhasher) - [CustomHasher](../../devkit/index#customhasher)
- [Executor](../../nx-devkit/index#executor) - [Executor](../../devkit/index#executor)
- [Generator](../../nx-devkit/index#generator) - [Generator](../../devkit/index#generator)
- [GeneratorCallback](../../nx-devkit/index#generatorcallback) - [GeneratorCallback](../../devkit/index#generatorcallback)
- [ImplicitDependencyEntry](../../nx-devkit/index#implicitdependencyentry) - [ImplicitDependencyEntry](../../devkit/index#implicitdependencyentry)
- [ProjectType](../../nx-devkit/index#projecttype) - [ProjectType](../../devkit/index#projecttype)
- [TaskGraphExecutor](../../nx-devkit/index#taskgraphexecutor) - [TaskGraphExecutor](../../devkit/index#taskgraphexecutor)
### Logger Variables ### Logger Variables
- [logger](../../nx-devkit/index#logger) - [logger](../../devkit/index#logger)
### Utils Variables ### Utils Variables
- [appRootPath](../../nx-devkit/index#approotpath) - [appRootPath](../../devkit/index#approotpath)
- [cacheDir](../../nx-devkit/index#cachedir) - [cacheDir](../../devkit/index#cachedir)
- [output](../../nx-devkit/index#output) - [output](../../devkit/index#output)
- [workspaceRoot](../../nx-devkit/index#workspaceroot) - [workspaceRoot](../../devkit/index#workspaceroot)
### Functions ### Functions
- [addDependenciesToPackageJson](../../nx-devkit/index#adddependenciestopackagejson) - [addDependenciesToPackageJson](../../devkit/index#adddependenciestopackagejson)
- [addProjectConfiguration](../../nx-devkit/index#addprojectconfiguration) - [addProjectConfiguration](../../devkit/index#addprojectconfiguration)
- [applyChangesToString](../../nx-devkit/index#applychangestostring) - [applyChangesToString](../../devkit/index#applychangestostring)
- [convertNxExecutor](../../nx-devkit/index#convertnxexecutor) - [convertNxExecutor](../../devkit/index#convertnxexecutor)
- [convertNxGenerator](../../nx-devkit/index#convertnxgenerator) - [convertNxGenerator](../../devkit/index#convertnxgenerator)
- [createProjectGraphAsync](../../nx-devkit/index#createprojectgraphasync) - [createProjectGraphAsync](../../devkit/index#createprojectgraphasync)
- [defaultTasksRunner](../../nx-devkit/index#defaulttasksrunner) - [defaultTasksRunner](../../devkit/index#defaulttasksrunner)
- [detectPackageManager](../../nx-devkit/index#detectpackagemanager) - [detectPackageManager](../../devkit/index#detectpackagemanager)
- [formatFiles](../../nx-devkit/index#formatfiles) - [formatFiles](../../devkit/index#formatfiles)
- [generateFiles](../../nx-devkit/index#generatefiles) - [generateFiles](../../devkit/index#generatefiles)
- [getOutputsForTargetAndConfiguration](../../nx-devkit/index#getoutputsfortargetandconfiguration) - [getOutputsForTargetAndConfiguration](../../devkit/index#getoutputsfortargetandconfiguration)
- [getPackageManagerCommand](../../nx-devkit/index#getpackagemanagercommand) - [getPackageManagerCommand](../../devkit/index#getpackagemanagercommand)
- [getPackageManagerVersion](../../nx-devkit/index#getpackagemanagerversion) - [getPackageManagerVersion](../../devkit/index#getpackagemanagerversion)
- [getProjects](../../nx-devkit/index#getprojects) - [getProjects](../../devkit/index#getprojects)
- [getWorkspaceLayout](../../nx-devkit/index#getworkspacelayout) - [getWorkspaceLayout](../../devkit/index#getworkspacelayout)
- [getWorkspacePath](../../nx-devkit/index#getworkspacepath) - [getWorkspacePath](../../devkit/index#getworkspacepath)
- [installPackagesTask](../../nx-devkit/index#installpackagestask) - [installPackagesTask](../../devkit/index#installpackagestask)
- [isStandaloneProject](../../nx-devkit/index#isstandaloneproject) - [isStandaloneProject](../../devkit/index#isstandaloneproject)
- [joinPathFragments](../../nx-devkit/index#joinpathfragments) - [joinPathFragments](../../devkit/index#joinpathfragments)
- [moveFilesToNewDirectory](../../nx-devkit/index#movefilestonewdirectory) - [moveFilesToNewDirectory](../../devkit/index#movefilestonewdirectory)
- [names](../../nx-devkit/index#names) - [names](../../devkit/index#names)
- [normalizePath](../../nx-devkit/index#normalizepath) - [normalizePath](../../devkit/index#normalizepath)
- [offsetFromRoot](../../nx-devkit/index#offsetfromroot) - [offsetFromRoot](../../devkit/index#offsetfromroot)
- [parseJson](../../nx-devkit/index#parsejson) - [parseJson](../../devkit/index#parsejson)
- [parseTargetString](../../nx-devkit/index#parsetargetstring) - [parseTargetString](../../devkit/index#parsetargetstring)
- [readCachedProjectGraph](../../nx-devkit/index#readcachedprojectgraph) - [readCachedProjectGraph](../../devkit/index#readcachedprojectgraph)
- [readJson](../../nx-devkit/index#readjson) - [readJson](../../devkit/index#readjson)
- [readJsonFile](../../nx-devkit/index#readjsonfile) - [readJsonFile](../../devkit/index#readjsonfile)
- [readNxJson](../../nx-devkit/index#readnxjson) - [readNxJson](../../devkit/index#readnxjson)
- [readProjectConfiguration](../../nx-devkit/index#readprojectconfiguration) - [readProjectConfiguration](../../devkit/index#readprojectconfiguration)
- [readTargetOptions](../../nx-devkit/index#readtargetoptions) - [readTargetOptions](../../devkit/index#readtargetoptions)
- [readWorkspaceConfiguration](../../nx-devkit/index#readworkspaceconfiguration) - [readWorkspaceConfiguration](../../devkit/index#readworkspaceconfiguration)
- [removeDependenciesFromPackageJson](../../nx-devkit/index#removedependenciesfrompackagejson) - [removeDependenciesFromPackageJson](../../devkit/index#removedependenciesfrompackagejson)
- [removeProjectConfiguration](../../nx-devkit/index#removeprojectconfiguration) - [removeProjectConfiguration](../../devkit/index#removeprojectconfiguration)
- [reverse](../../nx-devkit/index#reverse) - [reverse](../../devkit/index#reverse)
- [runExecutor](../../nx-devkit/index#runexecutor) - [runExecutor](../../devkit/index#runexecutor)
- [serializeJson](../../nx-devkit/index#serializejson) - [serializeJson](../../devkit/index#serializejson)
- [stripIndents](../../nx-devkit/index#stripindents) - [stripIndents](../../devkit/index#stripindents)
- [stripJsonComments](../../nx-devkit/index#stripjsoncomments) - [stripJsonComments](../../devkit/index#stripjsoncomments)
- [targetToTargetString](../../nx-devkit/index#targettotargetstring) - [targetToTargetString](../../devkit/index#targettotargetstring)
- [toJS](../../nx-devkit/index#tojs) - [toJS](../../devkit/index#tojs)
- [updateJson](../../nx-devkit/index#updatejson) - [updateJson](../../devkit/index#updatejson)
- [updateProjectConfiguration](../../nx-devkit/index#updateprojectconfiguration) - [updateProjectConfiguration](../../devkit/index#updateprojectconfiguration)
- [updateTsConfigsToJs](../../nx-devkit/index#updatetsconfigstojs) - [updateTsConfigsToJs](../../devkit/index#updatetsconfigstojs)
- [updateWorkspaceConfiguration](../../nx-devkit/index#updateworkspaceconfiguration) - [updateWorkspaceConfiguration](../../devkit/index#updateworkspaceconfiguration)
- [visitNotIgnoredFiles](../../nx-devkit/index#visitnotignoredfiles) - [visitNotIgnoredFiles](../../devkit/index#visitnotignoredfiles)
- [workspaceLayout](../../nx-devkit/index#workspacelayout) - [workspaceLayout](../../devkit/index#workspacelayout)
- [writeJson](../../nx-devkit/index#writejson) - [writeJson](../../devkit/index#writejson)
- [writeJsonFile](../../nx-devkit/index#writejsonfile) - [writeJsonFile](../../devkit/index#writejsonfile)
## Project Graph Enumerations ## Project Graph Enumerations
@ -462,7 +462,7 @@ A plugin for Nx
### WorkspaceConfiguration ### WorkspaceConfiguration
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../nx-devkit/index#nxjsonconfiguration)\> Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)\>
--- ---
@ -470,11 +470,11 @@ A plugin for Nx
### ProjectTargetConfigurator ### ProjectTargetConfigurator
Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`<`string`, [`TargetConfiguration`](../../nx-devkit/index#targetconfiguration)\> Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`<`string`, [`TargetConfiguration`](../../devkit/index#targetconfiguration)\>
#### Type declaration #### Type declaration
▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../nx-devkit/index#targetconfiguration)\> ▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../devkit/index#targetconfiguration)\>
##### Parameters ##### Parameters
@ -484,7 +484,7 @@ A plugin for Nx
##### Returns ##### Returns
`Record`<`string`, [`TargetConfiguration`](../../nx-devkit/index#targetconfiguration)\> `Record`<`string`, [`TargetConfiguration`](../../devkit/index#targetconfiguration)\>
--- ---
@ -500,7 +500,7 @@ A plugin for Nx
### ProjectGraphNode ### ProjectGraphNode
Ƭ **ProjectGraphNode**<`T`\>: [`ProjectGraphProjectNode`](../../nx-devkit/index#projectgraphprojectnode)<`T`\> \| [`ProjectGraphExternalNode`](../../nx-devkit/index#projectgraphexternalnode) Ƭ **ProjectGraphNode**<`T`\>: [`ProjectGraphProjectNode`](../../devkit/index#projectgraphprojectnode)<`T`\> \| [`ProjectGraphExternalNode`](../../devkit/index#projectgraphexternalnode)
#### Type parameters #### Type parameters
@ -514,7 +514,7 @@ A plugin for Nx
### StringChange ### StringChange
Ƭ **StringChange**: [`StringInsertion`](../../nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../nx-devkit/index#stringdeletion) Ƭ **StringChange**: [`StringInsertion`](../../devkit/index#stringinsertion) \| [`StringDeletion`](../../devkit/index#stringdeletion)
--- ---
@ -522,28 +522,28 @@ A plugin for Nx
### CustomHasher ### CustomHasher
Ƭ **CustomHasher**: (`task`: [`Task`](../../nx-devkit/index#task), `context`: [`HasherContext`](../../nx-devkit/index#hashercontext)) => `Promise`<[`Hash`](../../nx-devkit/index#hash)\> Ƭ **CustomHasher**: (`task`: [`Task`](../../devkit/index#task), `context`: [`HasherContext`](../../devkit/index#hashercontext)) => `Promise`<[`Hash`](../../devkit/index#hash)\>
#### Type declaration #### Type declaration
▸ (`task`, `context`): `Promise`<[`Hash`](../../nx-devkit/index#hash)\> ▸ (`task`, `context`): `Promise`<[`Hash`](../../devkit/index#hash)\>
##### Parameters ##### Parameters
| Name | Type | | Name | Type |
| :-------- | :----------------------------------------------------- | | :-------- | :-------------------------------------------------- |
| `task` | [`Task`](../../nx-devkit/index#task) | | `task` | [`Task`](../../devkit/index#task) |
| `context` | [`HasherContext`](../../nx-devkit/index#hashercontext) | | `context` | [`HasherContext`](../../devkit/index#hashercontext) |
##### Returns ##### Returns
`Promise`<[`Hash`](../../nx-devkit/index#hash)\> `Promise`<[`Hash`](../../devkit/index#hash)\>
--- ---
### Executor ### Executor
Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../nx-devkit/index#executorcontext)) => `Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\> Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/index#executorcontext)) => `Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\>
#### Type parameters #### Type parameters
@ -560,9 +560,9 @@ Implementation of a target of a project
##### Parameters ##### Parameters
| Name | Type | | Name | Type |
| :-------- | :--------------------------------------------------------- | | :-------- | :------------------------------------------------------ |
| `options` | `T` | | `options` | `T` |
| `context` | [`ExecutorContext`](../../nx-devkit/index#executorcontext) | | `context` | [`ExecutorContext`](../../devkit/index#executorcontext) |
##### Returns ##### Returns
@ -572,7 +572,7 @@ Implementation of a target of a project
### Generator ### Generator
Ƭ **Generator**<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../nx-devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../nx-devkit/index#generatorcallback)\> Ƭ **Generator**<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/index#generatorcallback)\>
#### Type parameters #### Type parameters
@ -582,7 +582,7 @@ Implementation of a target of a project
#### Type declaration #### Type declaration
▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../nx-devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../nx-devkit/index#generatorcallback)\> ▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../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
@ -595,7 +595,7 @@ A function that schedules updates to the filesystem to be done atomically
##### Returns ##### Returns
`void` \| [`GeneratorCallback`](../../nx-devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../nx-devkit/index#generatorcallback)\> `void` \| [`GeneratorCallback`](../../devkit/index#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/index#generatorcallback)\>
--- ---
@ -627,7 +627,7 @@ A callback function that is executed after changes are made to the file system
#### Index signature #### Index signature
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../nx-devkit/index#implicitjsonsubsetdependency)<`T`\> ▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/index#implicitjsonsubsetdependency)<`T`\>
--- ---
@ -639,7 +639,7 @@ A callback function that is executed after changes are made to the file system
### TaskGraphExecutor ### TaskGraphExecutor
Ƭ **TaskGraphExecutor**<`T`\>: (`taskGraph`: [`TaskGraph`](../../nx-devkit/index#taskgraph), `options`: `Record`<`string`, `T`\>, `overrides`: `T`, `context`: [`ExecutorContext`](../../nx-devkit/index#executorcontext)) => `Promise`<`Record`<`string`, `Object`\>\> Ƭ **TaskGraphExecutor**<`T`\>: (`taskGraph`: [`TaskGraph`](../../devkit/index#taskgraph), `options`: `Record`<`string`, `T`\>, `overrides`: `T`, `context`: [`ExecutorContext`](../../devkit/index#executorcontext)) => `Promise`<`Record`<`string`, `Object`\>\>
#### Type parameters #### Type parameters
@ -656,11 +656,11 @@ Implementation of a target of a project that handles multiple projects to be bat
##### Parameters ##### Parameters
| Name | Type | | Name | Type |
| :---------- | :--------------------------------------------------------- | | :---------- | :------------------------------------------------------ |
| `taskGraph` | [`TaskGraph`](../../nx-devkit/index#taskgraph) | | `taskGraph` | [`TaskGraph`](../../devkit/index#taskgraph) |
| `options` | `Record`<`string`, `T`\> | | `options` | `Record`<`string`, `T`\> |
| `overrides` | `T` | | `overrides` | `T` |
| `context` | [`ExecutorContext`](../../nx-devkit/index#executorcontext) | | `context` | [`ExecutorContext`](../../devkit/index#executorcontext) |
##### Returns ##### Returns
@ -713,7 +713,7 @@ Implementation of a target of a project that handles multiple projects to be bat
### addDependenciesToPackageJson ### addDependenciesToPackageJson
▸ **addDependenciesToPackageJson**(`tree`, `dependencies`, `devDependencies`, `packageJsonPath?`): [`GeneratorCallback`](../../nx-devkit/index#generatorcallback) ▸ **addDependenciesToPackageJson**(`tree`, `dependencies`, `devDependencies`, `packageJsonPath?`): [`GeneratorCallback`](../../devkit/index#generatorcallback)
Add Dependencies and Dev Dependencies to package.json Add Dependencies and Dev Dependencies to package.json
@ -728,15 +728,15 @@ 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`](../../nx-devkit/index#tree) | `undefined` | Tree representing file system to modify | | `tree` | [`Tree`](../../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`](../../nx-devkit/index#generatorcallback) [`GeneratorCallback`](../../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.
@ -754,10 +754,10 @@ The utility will update either files.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--------------------- | :------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | | :--------------------- | :---------------------------------------------------------------- | :----------------------------------------------------------------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | the file system tree | | `tree` | [`Tree`](../../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`](../../nx-devkit/index#projectconfiguration) | project configuration | | `projectConfiguration` | [`ProjectConfiguration`](../../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
@ -803,9 +803,9 @@ bootstrap({
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :-------- | :----------------------------------------------------- | | :-------- | :-------------------------------------------------- |
| `text` | `string` | | `text` | `string` |
| `changes` | [`StringChange`](../../nx-devkit/index#stringchange)[] | | `changes` | [`StringChange`](../../devkit/index#stringchange)[] |
#### Returns #### Returns
@ -824,8 +824,8 @@ Use this to expose a compatible Angular Builder
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :--------- | :--------------------------------------------------- | | :--------- | :------------------------------------------------ |
| `executor` | [`Executor`](../../nx-devkit/index#executor)<`any`\> | | `executor` | [`Executor`](../../devkit/index#executor)<`any`\> |
#### Returns #### Returns
@ -848,8 +848,8 @@ Convert an Nx Generator into an Angular Devkit Schematic.
#### Parameters #### Parameters
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| :----------------------------- | :--------------------------------------------------- | :------------ | :------------------------------------------------------------------------------------------------ | | :----------------------------- | :------------------------------------------------ | :------------ | :------------------------------------------------------------------------------------------------ |
| `generator` | [`Generator`](../../nx-devkit/index#generator)<`T`\> | `undefined` | The Nx generator to convert to an Angular Devkit Schematic. | | `generator` | [`Generator`](../../devkit/index#generator)<`T`\> | `undefined` | The Nx generator to convert to an Angular Devkit Schematic. |
| `skipWritingConfigInOldFormat` | `boolean` | `false` | Whether to skip writing the configuration in the old format (the one used by the Angular DevKit). | | `skipWritingConfigInOldFormat` | `boolean` | `false` | Whether to skip writing the configuration in the old format (the one used by the Angular DevKit). |
#### Returns #### Returns
@ -885,7 +885,7 @@ Convert an Nx Generator into an Angular Devkit Schematic.
### createProjectGraphAsync ### createProjectGraphAsync
▸ **createProjectGraphAsync**(): `Promise`<[`ProjectGraph`](../../nx-devkit/index#projectgraph)\> ▸ **createProjectGraphAsync**(): `Promise`<[`ProjectGraph`](../../devkit/index#projectgraph)\>
Computes and returns a ProjectGraph. Computes and returns a ProjectGraph.
@ -911,7 +911,7 @@ stored in the daemon process. To reset both run: `nx reset`.
#### Returns #### Returns
`Promise`<[`ProjectGraph`](../../nx-devkit/index#projectgraph)\> `Promise`<[`ProjectGraph`](../../devkit/index#projectgraph)\>
--- ---
@ -922,13 +922,13 @@ stored in the daemon process. To reset both run: `nx reset`.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :--------------------------- | :--------------------------------------------------------------------------------------- | | :--------------------------- | :------------------------------------------------------------------------------------ |
| `tasks` | [`Task`](../../nx-devkit/index#task)[] | | `tasks` | [`Task`](../../devkit/index#task)[] |
| `options` | [`DefaultTasksRunnerOptions`](../../nx-devkit/index#defaulttasksrunneroptions) | | `options` | [`DefaultTasksRunnerOptions`](../../devkit/index#defaulttasksrunneroptions) |
| `context?` | `Object` | | `context?` | `Object` |
| `context.initiatingProject?` | `string` | | `context.initiatingProject?` | `string` |
| `context.nxJson` | [`NxJsonConfiguration`](../../nx-devkit/index#nxjsonconfiguration)<`string`[] \| `"*"`\> | | `context.nxJson` | [`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)<`string`[] \| `"*"`\> |
| `context.projectGraph` | [`ProjectGraph`](../../nx-devkit/index#projectgraph)<`any`\> | | `context.projectGraph` | [`ProjectGraph`](../../devkit/index#projectgraph)<`any`\> |
| `context.target?` | `string` | | `context.target?` | `string` |
#### Returns #### Returns
@ -939,7 +939,7 @@ stored in the daemon process. To reset both run: `nx reset`.
### detectPackageManager ### detectPackageManager
▸ **detectPackageManager**(`dir?`): [`PackageManager`](../../nx-devkit/index#packagemanager) ▸ **detectPackageManager**(`dir?`): [`PackageManager`](../../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.
@ -951,7 +951,7 @@ Detects which package manager is used in the workspace based on the lock file.
#### Returns #### Returns
[`PackageManager`](../../nx-devkit/index#packagemanager) [`PackageManager`](../../devkit/index#packagemanager)
--- ---
@ -964,8 +964,8 @@ Formats all the created or updated files using Prettier
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :----- | :----------------------------------- | :------------------- | | :----- | :-------------------------------- | :------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | the file system tree | | `tree` | [`Tree`](../../devkit/index#tree) | the file system tree |
#### Returns #### Returns
@ -1002,8 +1002,8 @@ doesn't get confused about incorrect TypeScript files.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :-------------- | :----------------------------------- | :-------------------------------------------- | | :-------------- | :-------------------------------- | :-------------------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | the file system tree | | `tree` | [`Tree`](../../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 |
@ -1023,9 +1023,9 @@ Returns the list of outputs that will be cached.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :----- | :--------------------------------------------------------------------------------- | :-------------------------------------------------------- | | :----- | :------------------------------------------------------------------------------ | :-------------------------------------------------------- |
| `task` | `Pick`<[`Task`](../../nx-devkit/index#task), `"target"` \| `"overrides"`\> | target + overrides | | `task` | `Pick`<[`Task`](../../devkit/index#task), `"target"` \| `"overrides"`\> | target + overrides |
| `node` | [`ProjectGraphProjectNode`](../../nx-devkit/index#projectgraphprojectnode)<`any`\> | ProjectGraphProjectNode object that the task runs against | | `node` | [`ProjectGraphProjectNode`](../../devkit/index#projectgraphprojectnode)<`any`\> | ProjectGraphProjectNode object that the task runs against |
#### Returns #### Returns
@ -1050,8 +1050,8 @@ execSync(`${getPackageManagerCommand().addDev} my-dev-package`);
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :--------------- | :------------------------------------------------------- | | :--------------- | :---------------------------------------------------- |
| `packageManager` | [`PackageManager`](../../nx-devkit/index#packagemanager) | | `packageManager` | [`PackageManager`](../../devkit/index#packagemanager) |
#### Returns #### Returns
@ -1070,8 +1070,8 @@ but it can also be passed in explicitly.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :--------------- | :------------------------------------------------------- | | :--------------- | :---------------------------------------------------- |
| `packageManager` | [`PackageManager`](../../nx-devkit/index#packagemanager) | | `packageManager` | [`PackageManager`](../../devkit/index#packagemanager) |
#### Returns #### Returns
@ -1081,21 +1081,21 @@ but it can also be passed in explicitly.
### getProjects ### getProjects
▸ **getProjects**(`tree`): `Map`<`string`, [`ProjectConfiguration`](../../nx-devkit/index#projectconfiguration)\> ▸ **getProjects**(`tree`): `Map`<`string`, [`ProjectConfiguration`](../../devkit/index#projectconfiguration)\>
Get a map of all projects in a workspace. Get a map of all projects in a workspace.
Use [readProjectConfiguration](../../nx-devkit/index#readprojectconfiguration) if only one project is needed. Use [readProjectConfiguration](../../devkit/index#readprojectconfiguration) if only one project is needed.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :----- | :----------------------------------- | | :----- | :-------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | | `tree` | [`Tree`](../../devkit/index#tree) |
#### Returns #### Returns
`Map`<`string`, [`ProjectConfiguration`](../../nx-devkit/index#projectconfiguration)\> `Map`<`string`, [`ProjectConfiguration`](../../devkit/index#projectconfiguration)\>
--- ---
@ -1115,8 +1115,8 @@ Example:
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :----- | :----------------------------------- | :--------------- | | :----- | :-------------------------------- | :--------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | file system tree | | `tree` | [`Tree`](../../devkit/index#tree) | file system tree |
#### Returns #### Returns
@ -1138,8 +1138,8 @@ Example:
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :----- | :----------------------------------- | | :----- | :-------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | | `tree` | [`Tree`](../../devkit/index#tree) |
#### Returns #### Returns
@ -1157,11 +1157,11 @@ 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`](../../nx-devkit/index#tree) | `undefined` | the file system tree | | `tree` | [`Tree`](../../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`](../../nx-devkit/index#packagemanager) | `undefined` | - | | `packageManager` | [`PackageManager`](../../devkit/index#packagemanager) | `undefined` | - |
#### Returns #### Returns
@ -1178,8 +1178,8 @@ Returns if a project has a standalone configuration (project.json).
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :-------- | :----------------------------------- | :------------------- | | :-------- | :-------------------------------- | :------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | the file system tree | | `tree` | [`Tree`](../../devkit/index#tree) | the file system tree |
| `project` | `string` | the project name | | `project` | `string` | the project name |
#### Returns #### Returns
@ -1215,8 +1215,8 @@ Analogous to cp -r oldDir newDir
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------- | :----------------------------------- | | :------- | :-------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | | `tree` | [`Tree`](../../devkit/index#tree) |
| `oldDir` | `string` | | `oldDir` | `string` |
| `newDir` | `string` | | `newDir` | `string` |
@ -1318,9 +1318,9 @@ 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`](../../nx-devkit/index#jsonparseoptions) | JSON parse options | | `options?` | [`JsonParseOptions`](../../devkit/index#jsonparseoptions) | JSON parse options |
#### Returns #### Returns
@ -1332,7 +1332,7 @@ Object the JSON content represents
### parseTargetString ### parseTargetString
▸ **parseTargetString**(`targetString`): [`Target`](../../nx-devkit/index#target) ▸ **parseTargetString**(`targetString`): [`Target`](../../devkit/index#target)
Parses a target string into {project, target, configuration} Parses a target string into {project, target, configuration}
@ -1351,13 +1351,13 @@ parseTargetString('proj:test:production'); // returns { project: "proj", target:
#### Returns #### Returns
[`Target`](../../nx-devkit/index#target) [`Target`](../../devkit/index#target)
--- ---
### readCachedProjectGraph ### readCachedProjectGraph
▸ **readCachedProjectGraph**(): [`ProjectGraph`](../../nx-devkit/index#projectgraph) ▸ **readCachedProjectGraph**(): [`ProjectGraph`](../../devkit/index#projectgraph)
Synchronously reads the latest cached copy of the workspace's ProjectGraph. Synchronously reads the latest cached copy of the workspace's ProjectGraph.
@ -1365,7 +1365,7 @@ Synchronously reads the latest cached copy of the workspace's ProjectGraph.
#### Returns #### Returns
[`ProjectGraph`](../../nx-devkit/index#projectgraph) [`ProjectGraph`](../../devkit/index#projectgraph)
--- ---
@ -1384,10 +1384,10 @@ Reads a json file, removes all comments and parses JSON.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--------- | :----------------------------------------------------------- | :-------------------------- | | :--------- | :-------------------------------------------------------- | :-------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | file system tree | | `tree` | [`Tree`](../../devkit/index#tree) | file system tree |
| `path` | `string` | file path | | `path` | `string` | file path |
| `options?` | [`JsonParseOptions`](../../nx-devkit/index#jsonparseoptions) | Optional JSON Parse Options | | `options?` | [`JsonParseOptions`](../../devkit/index#jsonparseoptions) | Optional JSON Parse Options |
#### Returns #### Returns
@ -1424,7 +1424,7 @@ Object the JSON content of the file represents
### readNxJson ### readNxJson
▸ **readNxJson**(`path?`): [`NxJsonConfiguration`](../../nx-devkit/index#nxjsonconfiguration) ▸ **readNxJson**(`path?`): [`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)
Returns the contents of nx.json. Returns the contents of nx.json.
@ -1438,13 +1438,13 @@ If nx.json extends another config file, it will be inlined here.
#### Returns #### Returns
[`NxJsonConfiguration`](../../nx-devkit/index#nxjsonconfiguration) [`NxJsonConfiguration`](../../devkit/index#nxjsonconfiguration)
--- ---
### readProjectConfiguration ### readProjectConfiguration
▸ **readProjectConfiguration**(`tree`, `projectName`): [`ProjectConfiguration`](../../nx-devkit/index#projectconfiguration) ▸ **readProjectConfiguration**(`tree`, `projectName`): [`ProjectConfiguration`](../../devkit/index#projectconfiguration)
Reads a project configuration. Reads a project configuration.
@ -1456,13 +1456,13 @@ The utility will read from either file.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------------ | :----------------------------------- | :---------------------------------------------------------------------- | | :------------ | :-------------------------------- | :---------------------------------------------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | the file system tree | | `tree` | [`Tree`](../../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`](../../nx-devkit/index#projectconfiguration) [`ProjectConfiguration`](../../devkit/index#projectconfiguration)
--- ---
@ -1483,9 +1483,9 @@ Works as if you invoked the target yourself without passing any command lint ove
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------------------ | :--------------------------------------------------------- | | :------------------ | :------------------------------------------------------ |
| `__namedParameters` | [`Target`](../../nx-devkit/index#target) | | `__namedParameters` | [`Target`](../../devkit/index#target) |
| `context` | [`ExecutorContext`](../../nx-devkit/index#executorcontext) | | `context` | [`ExecutorContext`](../../devkit/index#executorcontext) |
#### Returns #### Returns
@ -1495,27 +1495,27 @@ Works as if you invoked the target yourself without passing any command lint ove
### readWorkspaceConfiguration ### readWorkspaceConfiguration
▸ **readWorkspaceConfiguration**(`tree`): [`WorkspaceConfiguration`](../../nx-devkit/index#workspaceconfiguration) ▸ **readWorkspaceConfiguration**(`tree`): [`WorkspaceConfiguration`](../../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](../../nx-devkit/index#readprojectconfiguration) instead. This does _not_ provide projects configuration, use [readProjectConfiguration](../../devkit/index#readprojectconfiguration) instead.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :----- | :----------------------------------- | | :----- | :-------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | | `tree` | [`Tree`](../../devkit/index#tree) |
#### Returns #### Returns
[`WorkspaceConfiguration`](../../nx-devkit/index#workspaceconfiguration) [`WorkspaceConfiguration`](../../devkit/index#workspaceconfiguration)
--- ---
### removeDependenciesFromPackageJson ### removeDependenciesFromPackageJson
▸ **removeDependenciesFromPackageJson**(`tree`, `dependencies`, `devDependencies`, `packageJsonPath?`): [`GeneratorCallback`](../../nx-devkit/index#generatorcallback) ▸ **removeDependenciesFromPackageJson**(`tree`, `dependencies`, `devDependencies`, `packageJsonPath?`): [`GeneratorCallback`](../../devkit/index#generatorcallback)
Remove Dependencies and Dev Dependencies from package.json Remove Dependencies and Dev Dependencies from package.json
@ -1530,15 +1530,15 @@ 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`](../../nx-devkit/index#tree) | `undefined` | - | | `tree` | [`Tree`](../../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`](../../nx-devkit/index#generatorcallback) [`GeneratorCallback`](../../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.
@ -1556,8 +1556,8 @@ The utility will update either file.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------------ | :----------------------------------- | | :------------ | :-------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | | `tree` | [`Tree`](../../devkit/index#tree) |
| `projectName` | `string` | | `projectName` | `string` |
#### Returns #### Returns
@ -1568,7 +1568,7 @@ The utility will update either file.
### reverse ### reverse
▸ **reverse**(`graph`): [`ProjectGraph`](../../nx-devkit/index#projectgraph) ▸ **reverse**(`graph`): [`ProjectGraph`](../../devkit/index#projectgraph)
Returns a new project graph where all the edges are reversed. Returns a new project graph where all the edges are reversed.
@ -1578,12 +1578,12 @@ B will depend on A.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :----------------------------------------------------------- | | :------ | :-------------------------------------------------------- |
| `graph` | [`ProjectGraph`](../../nx-devkit/index#projectgraph)<`any`\> | | `graph` | [`ProjectGraph`](../../devkit/index#projectgraph)<`any`\> |
#### Returns #### Returns
[`ProjectGraph`](../../nx-devkit/index#projectgraph) [`ProjectGraph`](../../devkit/index#projectgraph)
--- ---
@ -1628,13 +1628,13 @@ 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`](../../nx-devkit/index#executorcontext) | | `context` | [`ExecutorContext`](../../devkit/index#executorcontext) |
#### Returns #### Returns
@ -1658,9 +1658,9 @@ 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`](../../nx-devkit/index#jsonserializeoptions) | JSON serialize options | | `options?` | [`JsonSerializeOptions`](../../devkit/index#jsonserializeoptions) | JSON serialize options |
#### Returns #### Returns
@ -1729,8 +1729,8 @@ Returns a string in the format "project:target[:configuration]" for the target
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------- | :--------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :------- | :------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `target` | [`Target`](../../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`](../../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
@ -1747,8 +1747,8 @@ Rename and transpile any new typescript files created to javascript files
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :----- | :----------------------------------- | | :----- | :-------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | | `tree` | [`Tree`](../../devkit/index#tree) |
#### Returns #### Returns
@ -1772,11 +1772,11 @@ Updates a JSON value to the file system tree
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--------- | :---------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | | :--------- | :---------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | File system tree | | `tree` | [`Tree`](../../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`](../../nx-devkit/index#jsonparseoptions) & [`JsonSerializeOptions`](../../nx-devkit/index#jsonserializeoptions) | Optional JSON Parse and Serialize Options | | `options?` | [`JsonParseOptions`](../../devkit/index#jsonparseoptions) & [`JsonSerializeOptions`](../../devkit/index#jsonserializeoptions) | Optional JSON Parse and Serialize Options |
#### Returns #### Returns
@ -1796,10 +1796,10 @@ The utility will update either files.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--------------------- | :------------------------------------------------------------------- | :---------------------------------------------------------------------- | | :--------------------- | :---------------------------------------------------------------- | :---------------------------------------------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | the file system tree | | `tree` | [`Tree`](../../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`](../../nx-devkit/index#projectconfiguration) | project configuration | | `projectConfiguration` | [`ProjectConfiguration`](../../devkit/index#projectconfiguration) | project configuration |
#### Returns #### Returns
@ -1814,8 +1814,8 @@ The utility will update either files.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :-------------------- | :----------------------------------- | | :-------------------- | :-------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | | `tree` | [`Tree`](../../devkit/index#tree) |
| `options` | `Object` | | `options` | `Object` |
| `options.projectRoot` | `string` | | `options.projectRoot` | `string` |
@ -1831,14 +1831,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](../../nx-devkit/index#updateprojectconfiguration) or [addProjectConfiguration](../../nx-devkit/index#addprojectconfiguration) instead. This does _not_ update projects configuration, use [updateProjectConfiguration](../../devkit/index#updateprojectconfiguration) or [addProjectConfiguration](../../devkit/index#addprojectconfiguration) instead.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :---------------- | :----------------------------------------------------------------------- | | :---------------- | :-------------------------------------------------------------------- |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | | `tree` | [`Tree`](../../devkit/index#tree) |
| `workspaceConfig` | [`WorkspaceConfiguration`](../../nx-devkit/index#workspaceconfiguration) | | `workspaceConfig` | [`WorkspaceConfiguration`](../../devkit/index#workspaceconfiguration) |
#### Returns #### Returns
@ -1855,8 +1855,8 @@ 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`](../../nx-devkit/index#tree) | `undefined` | | `tree` | [`Tree`](../../devkit/index#tree) | `undefined` |
| `dirPath` | `string` | `tree.root` | | `dirPath` | `string` | `tree.root` |
| `visitor` | (`path`: `string`) => `void` | `undefined` | | `visitor` | (`path`: `string`) => `void` | `undefined` |
@ -1898,11 +1898,11 @@ Writes a JSON value to the file system tree
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--------- | :------------------------------------------------------------------- | :------------------------------ | | :--------- | :---------------------------------------------------------------- | :------------------------------ |
| `tree` | [`Tree`](../../nx-devkit/index#tree) | File system tree | | `tree` | [`Tree`](../../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`](../../nx-devkit/index#jsonserializeoptions) | Optional JSON Serialize Options | | `options?` | [`JsonSerializeOptions`](../../devkit/index#jsonserializeoptions) | Optional JSON Serialize Options |
#### Returns #### Returns

14
docs/generated/api-nx-devkit/ngcli_adapter.md → docs/generated/devkit/ngcli_adapter.md
View File

@ -4,13 +4,13 @@
### Ng CLI Adapter Classes ### Ng CLI Adapter Classes
- [NxScopedHost](../../nx-devkit/ngcli_adapter#nxscopedhost) - [NxScopedHost](../../devkit/ngcli_adapter#nxscopedhost)
### Functions ### Functions
- [mockSchematicsForTesting](../../nx-devkit/ngcli_adapter#mockschematicsfortesting) - [mockSchematicsForTesting](../../devkit/ngcli_adapter#mockschematicsfortesting)
- [overrideCollectionResolutionForTesting](../../nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting) - [overrideCollectionResolutionForTesting](../../devkit/ngcli_adapter#overridecollectionresolutionfortesting)
- [wrapAngularDevkitSchematic](../../nx-devkit/ngcli_adapter#wrapangulardevkitschematic) - [wrapAngularDevkitSchematic](../../devkit/ngcli_adapter#wrapangulardevkitschematic)
## Ng CLI Adapter Classes ## Ng CLI Adapter Classes
@ -91,7 +91,7 @@ overrideCollectionResolutionForTesting({
### wrapAngularDevkitSchematic ### wrapAngularDevkitSchematic
▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../nx-devkit/index#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\> ▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../devkit/index#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\>
#### Parameters #### Parameters
@ -109,8 +109,8 @@ overrideCollectionResolutionForTesting({
##### Parameters ##### Parameters
| Name | Type | | Name | Type |
| :----------------- | :----------------------------------- | | :----------------- | :-------------------------------- |
| `host` | [`Tree`](../../nx-devkit/index#tree) | | `host` | [`Tree`](../../devkit/index#tree) |
| `generatorOptions` | `Object` | | `generatorOptions` | `Object` |
##### Returns ##### Returns

8
docs/generated/packages/devkit.json
View File

File diff suppressed because one or more lines are too long

2
docs/generated/packages/nx-plugin.json
View File

File diff suppressed because one or more lines are too long

4
docs/map.json
View File

@ -1028,12 +1028,12 @@
{ {
"id": "index", "id": "index",
"name": "Overview", "name": "Overview",
"file": "generated/api-nx-devkit/index" "file": "generated/devkit/index"
}, },
{ {
"id": "ngcli_adapter", "id": "ngcli_adapter",
"name": "Ng CLI Adapter", "name": "Ng CLI Adapter",
"file": "generated/api-nx-devkit/ngcli_adapter" "file": "generated/devkit/ngcli_adapter"
} }
] ]
} }

2
docs/shared/guides/nx-devkit-angular-devkit.md
View File

@ -1,6 +1,6 @@
# Nx Devkit and Angular Devkit # Nx Devkit and Angular Devkit
> Note: this document covers the difference between Nx Devkit and Angular Devkit. See the [Nx Devkit](/getting-started/nx-devkit) guide for more in-depth details about Nx Devkit. > Note: this document covers the difference between Nx Devkit and Angular Devkit. See the [Nx Devkit](/devkit/index) guide for more in-depth details about Nx Devkit.
Nx comes with a devkit to write generators and executors, but you can also use Angular devkit (schematics and builders). In other words, you can use an Angular schematic to implement a generator, and you can use an Angular builder to implement an executor. Nx comes with a devkit to write generators and executors, but you can also use Angular devkit (schematics and builders). In other words, you can use an Angular schematic to implement a generator, and you can use an Angular builder to implement an executor.

2
docs/shared/nx-plugin.md
View File

@ -2,7 +2,7 @@ Nx plugins are npm packages that contain generators and executors to extend a Nx
> A list of plugins that is maintained by Nrwl is found in the [Nrwl/nx repo](https://github.com/nrwl/nx/tree/master/packages). \ > A list of plugins that is maintained by Nrwl is found in the [Nrwl/nx repo](https://github.com/nrwl/nx/tree/master/packages). \
> A list of custom plugins created by the community is found in the [Community](/community) section. > A list of custom plugins created by the community is found in the [Community](/community) section.
> Plugins are written using Nx Devkit. **Read [Nx Devkit](/getting-started/nx-devkit) for more information.** > Plugins are written using Nx Devkit. **Read [Nx Devkit](/devkit/index) for more information.**
<iframe loading="lazy" width="560" height="315" src="https://www.youtube.com/embed/fC1-4fAZDP4" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture; fullscreen"></iframe> <iframe loading="lazy" width="560" height="315" src="https://www.youtube.com/embed/fC1-4fAZDP4" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture; fullscreen"></iframe>

2
docs/shared/using-executors.md
View File

@ -239,7 +239,7 @@ The `runExecutor` utility will find the target in the configuration, find the ex
- `readTargetOptions` -- Reads and combines options for a given target. - `readTargetOptions` -- Reads and combines options for a given target.
- `runExecutor` -- Constructs options and invokes an executor. - `runExecutor` -- Constructs options and invokes an executor.
See more helper functions in the [Devkit API Docs](/nx-devkit/index#functions) See more helper functions in the [Devkit API Docs](/devkit/index#functions)
## Using RxJS observables ## Using RxJS observables

2
nx-dev/nx-dev/pages/community.tsx
View File

@ -65,7 +65,7 @@ export function Community(props: CommunityProps): ReactComponentElement<any> {
description: description:
'It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more.', 'It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more.',
name: '@nrwl/devkit', name: '@nrwl/devkit',
url: 'https://nx.dev/nx-devkit/index', url: 'https://nx.dev/devkit/index',
isOfficial: true, isOfficial: true,
}, },
{ {

2
nx-dev/nx-dev/redirect-rules.config.js
View File

@ -134,8 +134,6 @@ const schemaUrls = {
'/nx-plugin/plugin': '/packages/nx-plugin/generators/plugin', '/nx-plugin/plugin': '/packages/nx-plugin/generators/plugin',
'/nx-plugin/schematic': '/packages/nx-plugin/generators/generator', '/nx-plugin/schematic': '/packages/nx-plugin/generators/generator',
'/nx-plugin/e2e': '/packages/nx-plugin/executors/e2e', '/nx-plugin/e2e': '/packages/nx-plugin/executors/e2e',
'/nx-devkit/index': '/packages/nx-devkit/index',
'/nx-devkit/ngcli_adapter': '/packages/nx-devkit/ngcli_adapter',
}; };
/** /**

2
nx-dev/ui-home/src/lib/ecosystem-features.tsx
View File

@ -13,7 +13,7 @@ const featureItems: {
}[] = [ }[] = [
{ {
classNames: 'bg-green-nx-base', classNames: 'bg-green-nx-base',
link: '/getting-started/nx-devkit', link: '/devkit/index',
title: 'Plugins for everything', title: 'Plugins for everything',
subTitle: subTitle:
'React, React Native, Angular, NativeScript, Cypress, Nest.js, Storybook, Ionic, Go among others.', 'React, React Native, Angular, NativeScript, Cypress, Nest.js, Storybook, Ionic, Go among others.',

2
nx-dev/ui-home/src/lib/experience-features.tsx
View File

@ -119,7 +119,7 @@ const featureItems: {
}, },
{ {
classNames: 'bg-purple-nx-base', classNames: 'bg-purple-nx-base',
link: '/getting-started/nx-devkit', link: '/devkit/index',
title: 'Nx Devkit', title: 'Nx Devkit',
subTitle: subTitle:
'Nx enables a custom dev experience to match the needs of your organization.', 'Nx enables a custom dev experience to match the needs of your organization.',

8
scripts/documentation/generate-devkit-documentation.ts
View File

@ -12,19 +12,19 @@ export function generateDevkitDocumentation() {
execSync('nx build typedoc-theme', execSyncOptions); execSync('nx build typedoc-theme', execSyncOptions);
execSync( execSync(
`rm -rf docs/generated/api-nx-devkit && npx typedoc packages/devkit/index.ts packages/devkit/ngcli-adapter.ts --tsconfig packages/devkit/tsconfig.lib.json --out ./docs/generated/api-nx-devkit --hideBreadcrumbs true --disableSources --publicPath ../../nx-devkit/ --theme dist/typedoc-theme/src/lib --readme none`, `rm -rf docs/generated/devkit && npx typedoc packages/devkit/index.ts packages/devkit/ngcli-adapter.ts --tsconfig packages/devkit/tsconfig.lib.json --out ./docs/generated/devkit --hideBreadcrumbs true --disableSources --publicPath ../../devkit/ --theme dist/typedoc-theme/src/lib --readme none`,
execSyncOptions execSyncOptions
); );
execSync( execSync(
`rm -rf docs/generated/api-nx-devkit/modules.md docs/generated/api-nx-devkit/.nojekyll`, `rm -rf docs/generated/devkit/modules.md docs/generated/devkit/.nojekyll`,
execSyncOptions execSyncOptions
); );
execSync( execSync(
`rm -rf docs/generated/api-nx-devkit/modules.md docs/generated/api-nx-devkit/README.md`, `rm -rf docs/generated/devkit/modules.md docs/generated/devkit/README.md`,
execSyncOptions execSyncOptions
); );
execSync( execSync(
`npx prettier docs/generated/api-nx-devkit --write --config ${join( `npx prettier docs/generated/devkit --write --config ${join(
__dirname, __dirname,
'..', '..',
'..', '..',

24
scripts/documentation/package-schemas/generatePackageSchemas.ts
View File

@ -87,27 +87,3 @@ export function generatePackageSchemas(): void {
) )
); );
} }
// Temp, rework map API-reference
function updateMenuPathsInMapJson(): void {
const absoluteRoot = resolve(join(__dirname, '../../../'));
const outputPath: string = join(absoluteRoot, 'docs');
const jsonFile = readJsonSync(join(outputPath, 'map.json'));
jsonFile[0].itemList.forEach((itemA, indexA) => {
itemA.itemList.forEach((itemB, indexB) => {
if (
itemB.file &&
itemB.file.includes('generated/api-') &&
!itemB.file.include('api-nx-devkit')
) {
jsonFile[0].itemList[indexA].itemList[indexB] = {
...itemB,
path: '/packages/' + itemB.file.replace('generated/api-', ''),
};
}
});
});
writeJSONSync(join(outputPath, 'map.json'), jsonFile, 'utf-8');
}