docs(core): add categories typed comment for nxdevk (#7286)
This commit is contained in:
parent
de680d3ace
commit
5ae45b63dd
@ -1,58 +1,91 @@
|
|||||||
# Module: index
|
# Module: index
|
||||||
|
|
||||||
|
The Nx Devkit is the underlying technology used to customize Nx to support
|
||||||
|
different technologies and custom use-cases. It contains many utility
|
||||||
|
functions for reading and writing files, updating configuration,
|
||||||
|
working with Abstract Syntax Trees(ASTs), and more.
|
||||||
|
|
||||||
|
As with most things in Nx, the core of Nx Devkit is very simple.
|
||||||
|
It only uses language primitives and immutable objects
|
||||||
|
(the tree being the only exception).
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Enumerations
|
### Project Graph Enumerations
|
||||||
|
|
||||||
- [ChangeType](../../angular/nx-devkit/index#changetype)
|
|
||||||
- [DependencyType](../../angular/nx-devkit/index#dependencytype)
|
- [DependencyType](../../angular/nx-devkit/index#dependencytype)
|
||||||
|
|
||||||
### Classes
|
### Utils Enumerations
|
||||||
|
|
||||||
|
- [ChangeType](../../angular/nx-devkit/index#changetype)
|
||||||
|
|
||||||
|
### Project Graph Classes
|
||||||
|
|
||||||
- [ProjectGraphBuilder](../../angular/nx-devkit/index#projectgraphbuilder)
|
- [ProjectGraphBuilder](../../angular/nx-devkit/index#projectgraphbuilder)
|
||||||
|
|
||||||
### Interfaces
|
### Commands Interfaces
|
||||||
|
|
||||||
|
- [Target](../../angular/nx-devkit/index#target)
|
||||||
|
|
||||||
|
### Project Graph Interfaces
|
||||||
|
|
||||||
- [ExecutorContext](../../angular/nx-devkit/index#executorcontext)
|
|
||||||
- [FileChange](../../angular/nx-devkit/index#filechange)
|
|
||||||
- [FileData](../../angular/nx-devkit/index#filedata)
|
- [FileData](../../angular/nx-devkit/index#filedata)
|
||||||
- [ImplicitJsonSubsetDependency](../../angular/nx-devkit/index#implicitjsonsubsetdependency)
|
|
||||||
- [JsonParseOptions](../../angular/nx-devkit/index#jsonparseoptions)
|
|
||||||
- [JsonSerializeOptions](../../angular/nx-devkit/index#jsonserializeoptions)
|
|
||||||
- [NxAffectedConfig](../../angular/nx-devkit/index#nxaffectedconfig)
|
|
||||||
- [NxJsonConfiguration](../../angular/nx-devkit/index#nxjsonconfiguration)
|
|
||||||
- [NxJsonProjectConfiguration](../../angular/nx-devkit/index#nxjsonprojectconfiguration)
|
|
||||||
- [NxPlugin](../../angular/nx-devkit/index#nxplugin)
|
- [NxPlugin](../../angular/nx-devkit/index#nxplugin)
|
||||||
- [ProjectConfiguration](../../angular/nx-devkit/index#projectconfiguration)
|
|
||||||
- [ProjectFileMap](../../angular/nx-devkit/index#projectfilemap)
|
- [ProjectFileMap](../../angular/nx-devkit/index#projectfilemap)
|
||||||
- [ProjectGraph](../../angular/nx-devkit/index#projectgraph)
|
- [ProjectGraph](../../angular/nx-devkit/index#projectgraph)
|
||||||
- [ProjectGraphDependency](../../angular/nx-devkit/index#projectgraphdependency)
|
- [ProjectGraphDependency](../../angular/nx-devkit/index#projectgraphdependency)
|
||||||
- [ProjectGraphNode](../../angular/nx-devkit/index#projectgraphnode)
|
- [ProjectGraphNode](../../angular/nx-devkit/index#projectgraphnode)
|
||||||
- [ProjectGraphProcessorContext](../../angular/nx-devkit/index#projectgraphprocessorcontext)
|
- [ProjectGraphProcessorContext](../../angular/nx-devkit/index#projectgraphprocessorcontext)
|
||||||
|
|
||||||
|
### Tree Interfaces
|
||||||
|
|
||||||
|
- [FileChange](../../angular/nx-devkit/index#filechange)
|
||||||
|
- [Tree](../../angular/nx-devkit/index#tree)
|
||||||
|
|
||||||
|
### Utils Interfaces
|
||||||
|
|
||||||
|
- [JsonParseOptions](../../angular/nx-devkit/index#jsonparseoptions)
|
||||||
|
- [JsonSerializeOptions](../../angular/nx-devkit/index#jsonserializeoptions)
|
||||||
- [StringDeletion](../../angular/nx-devkit/index#stringdeletion)
|
- [StringDeletion](../../angular/nx-devkit/index#stringdeletion)
|
||||||
- [StringInsertion](../../angular/nx-devkit/index#stringinsertion)
|
- [StringInsertion](../../angular/nx-devkit/index#stringinsertion)
|
||||||
- [Target](../../angular/nx-devkit/index#target)
|
|
||||||
|
### Workspace Interfaces
|
||||||
|
|
||||||
|
- [ExecutorContext](../../angular/nx-devkit/index#executorcontext)
|
||||||
|
- [ImplicitJsonSubsetDependency](../../angular/nx-devkit/index#implicitjsonsubsetdependency)
|
||||||
|
- [NxAffectedConfig](../../angular/nx-devkit/index#nxaffectedconfig)
|
||||||
|
- [NxJsonConfiguration](../../angular/nx-devkit/index#nxjsonconfiguration)
|
||||||
|
- [NxJsonProjectConfiguration](../../angular/nx-devkit/index#nxjsonprojectconfiguration)
|
||||||
|
- [ProjectConfiguration](../../angular/nx-devkit/index#projectconfiguration)
|
||||||
- [TargetConfiguration](../../angular/nx-devkit/index#targetconfiguration)
|
- [TargetConfiguration](../../angular/nx-devkit/index#targetconfiguration)
|
||||||
- [TargetDependencyConfig](../../angular/nx-devkit/index#targetdependencyconfig)
|
- [TargetDependencyConfig](../../angular/nx-devkit/index#targetdependencyconfig)
|
||||||
- [Task](../../angular/nx-devkit/index#task)
|
- [Task](../../angular/nx-devkit/index#task)
|
||||||
- [TaskGraph](../../angular/nx-devkit/index#taskgraph)
|
- [TaskGraph](../../angular/nx-devkit/index#taskgraph)
|
||||||
- [Tree](../../angular/nx-devkit/index#tree)
|
|
||||||
- [Workspace](../../angular/nx-devkit/index#workspace)
|
- [Workspace](../../angular/nx-devkit/index#workspace)
|
||||||
- [WorkspaceJsonConfiguration](../../angular/nx-devkit/index#workspacejsonconfiguration)
|
- [WorkspaceJsonConfiguration](../../angular/nx-devkit/index#workspacejsonconfiguration)
|
||||||
|
|
||||||
### Type aliases
|
### Generators Type aliases
|
||||||
|
|
||||||
|
- [WorkspaceConfiguration](../../angular/nx-devkit/index#workspaceconfiguration)
|
||||||
|
|
||||||
|
### Package Manager Type aliases
|
||||||
|
|
||||||
|
- [PackageManager](../../angular/nx-devkit/index#packagemanager)
|
||||||
|
|
||||||
|
### Utils Type aliases
|
||||||
|
|
||||||
|
- [StringChange](../../angular/nx-devkit/index#stringchange)
|
||||||
|
|
||||||
|
### Workspace Type aliases
|
||||||
|
|
||||||
- [Executor](../../angular/nx-devkit/index#executor)
|
- [Executor](../../angular/nx-devkit/index#executor)
|
||||||
- [Generator](../../angular/nx-devkit/index#generator)
|
- [Generator](../../angular/nx-devkit/index#generator)
|
||||||
- [GeneratorCallback](../../angular/nx-devkit/index#generatorcallback)
|
- [GeneratorCallback](../../angular/nx-devkit/index#generatorcallback)
|
||||||
- [ImplicitDependencyEntry](../../angular/nx-devkit/index#implicitdependencyentry)
|
- [ImplicitDependencyEntry](../../angular/nx-devkit/index#implicitdependencyentry)
|
||||||
- [PackageManager](../../angular/nx-devkit/index#packagemanager)
|
|
||||||
- [ProjectType](../../angular/nx-devkit/index#projecttype)
|
- [ProjectType](../../angular/nx-devkit/index#projecttype)
|
||||||
- [StringChange](../../angular/nx-devkit/index#stringchange)
|
|
||||||
- [TaskGraphExecutor](../../angular/nx-devkit/index#taskgraphexecutor)
|
- [TaskGraphExecutor](../../angular/nx-devkit/index#taskgraphexecutor)
|
||||||
- [WorkspaceConfiguration](../../angular/nx-devkit/index#workspaceconfiguration)
|
|
||||||
|
|
||||||
### Variables
|
### Logger Variables
|
||||||
|
|
||||||
- [logger](../../angular/nx-devkit/index#logger)
|
- [logger](../../angular/nx-devkit/index#logger)
|
||||||
|
|
||||||
@ -101,134 +134,58 @@
|
|||||||
- [writeJson](../../angular/nx-devkit/index#writejson)
|
- [writeJson](../../angular/nx-devkit/index#writejson)
|
||||||
- [writeJsonFile](../../angular/nx-devkit/index#writejsonfile)
|
- [writeJsonFile](../../angular/nx-devkit/index#writejsonfile)
|
||||||
|
|
||||||
## Enumerations
|
## Project Graph Enumerations
|
||||||
|
|
||||||
### ChangeType
|
|
||||||
|
|
||||||
• **ChangeType**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### DependencyType
|
### DependencyType
|
||||||
|
|
||||||
• **DependencyType**: `Object`
|
• **DependencyType**: `Object`
|
||||||
|
|
||||||
Type of dependency between projects
|
---
|
||||||
|
|
||||||
## Classes
|
## Utils Enumerations
|
||||||
|
|
||||||
|
### ChangeType
|
||||||
|
|
||||||
|
• **ChangeType**: `Object`
|
||||||
|
|
||||||
|
## Project Graph Classes
|
||||||
|
|
||||||
### ProjectGraphBuilder
|
### ProjectGraphBuilder
|
||||||
|
|
||||||
• **ProjectGraphBuilder**: `Object`
|
• **ProjectGraphBuilder**: `Object`
|
||||||
|
|
||||||
Builder for adding nodes and dependencies to a [ProjectGraph](../../angular/nx-devkit/index#projectgraph)
|
## Commands Interfaces
|
||||||
|
|
||||||
## Interfaces
|
### Target
|
||||||
|
|
||||||
### ExecutorContext
|
• **Target**: `Object`
|
||||||
|
|
||||||
• **ExecutorContext**: `Object`
|
|
||||||
|
|
||||||
Context that is passed into an executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### FileChange
|
## Project Graph Interfaces
|
||||||
|
|
||||||
• **FileChange**: `Object`
|
|
||||||
|
|
||||||
Description of a file change in the Nx virtual file system/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### FileData
|
### FileData
|
||||||
|
|
||||||
• **FileData**: `Object`
|
• **FileData**: `Object`
|
||||||
|
|
||||||
Some metadata about a file
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ImplicitJsonSubsetDependency
|
|
||||||
|
|
||||||
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonParseOptions
|
|
||||||
|
|
||||||
• **JsonParseOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonSerializeOptions
|
|
||||||
|
|
||||||
• **JsonSerializeOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxAffectedConfig
|
|
||||||
|
|
||||||
• **NxAffectedConfig**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonConfiguration
|
|
||||||
|
|
||||||
• **NxJsonConfiguration**<`T`\>: `Object`
|
|
||||||
|
|
||||||
Nx.json configuration
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonProjectConfiguration
|
|
||||||
|
|
||||||
• **NxJsonProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### NxPlugin
|
### NxPlugin
|
||||||
|
|
||||||
• **NxPlugin**: `Object`
|
• **NxPlugin**: `Object`
|
||||||
|
|
||||||
A plugin for Nx
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectConfiguration
|
|
||||||
|
|
||||||
• **ProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
Project configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectFileMap
|
### ProjectFileMap
|
||||||
|
|
||||||
• **ProjectFileMap**: `Object`
|
• **ProjectFileMap**: `Object`
|
||||||
|
|
||||||
A list of files separated by the project they belong to
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraph
|
### ProjectGraph
|
||||||
|
|
||||||
• **ProjectGraph**<`T`\>: `Object`
|
• **ProjectGraph**<`T`\>: `Object`
|
||||||
|
|
||||||
A Graph of projects in the workspace and dependencies between them
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -241,16 +198,12 @@ A Graph of projects in the workspace and dependencies between them
|
|||||||
|
|
||||||
• **ProjectGraphDependency**: `Object`
|
• **ProjectGraphDependency**: `Object`
|
||||||
|
|
||||||
A dependency between two projects
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraphNode
|
### ProjectGraphNode
|
||||||
|
|
||||||
• **ProjectGraphNode**<`T`\>: `Object`
|
• **ProjectGraphNode**<`T`\>: `Object`
|
||||||
|
|
||||||
A node describing a project in a workspace
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -263,7 +216,33 @@ A node describing a project in a workspace
|
|||||||
|
|
||||||
• **ProjectGraphProcessorContext**: `Object`
|
• **ProjectGraphProcessorContext**: `Object`
|
||||||
|
|
||||||
Additional information to be used to process a project graph
|
---
|
||||||
|
|
||||||
|
## Tree Interfaces
|
||||||
|
|
||||||
|
### FileChange
|
||||||
|
|
||||||
|
• **FileChange**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Tree
|
||||||
|
|
||||||
|
• **Tree**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Interfaces
|
||||||
|
|
||||||
|
### JsonParseOptions
|
||||||
|
|
||||||
|
• **JsonParseOptions**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### JsonSerializeOptions
|
||||||
|
|
||||||
|
• **JsonSerializeOptions**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -279,9 +258,53 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Target
|
## Workspace Interfaces
|
||||||
|
|
||||||
• **Target**: `Object`
|
### ExecutorContext
|
||||||
|
|
||||||
|
• **ExecutorContext**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ImplicitJsonSubsetDependency
|
||||||
|
|
||||||
|
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxAffectedConfig
|
||||||
|
|
||||||
|
• **NxAffectedConfig**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonConfiguration
|
||||||
|
|
||||||
|
• **NxJsonConfiguration**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonProjectConfiguration
|
||||||
|
|
||||||
|
• **NxJsonProjectConfiguration**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ProjectConfiguration
|
||||||
|
|
||||||
|
• **ProjectConfiguration**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -289,8 +312,6 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
• **TargetConfiguration**: `Object`
|
• **TargetConfiguration**: `Object`
|
||||||
|
|
||||||
Target's configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TargetDependencyConfig
|
### TargetDependencyConfig
|
||||||
@ -303,24 +324,12 @@ Target's configuration
|
|||||||
|
|
||||||
• **Task**: `Object`
|
• **Task**: `Object`
|
||||||
|
|
||||||
A representation of the invocation of an Executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraph
|
### TaskGraph
|
||||||
|
|
||||||
• **TaskGraph**: `Object`
|
• **TaskGraph**: `Object`
|
||||||
|
|
||||||
Graph of Tasks to be executed
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Tree
|
|
||||||
|
|
||||||
• **Tree**: `Object`
|
|
||||||
|
|
||||||
Virtual file system tree.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Workspace
|
### Workspace
|
||||||
@ -333,9 +342,31 @@ Virtual file system tree.
|
|||||||
|
|
||||||
• **WorkspaceJsonConfiguration**: `Object`
|
• **WorkspaceJsonConfiguration**: `Object`
|
||||||
|
|
||||||
Workspace configuration
|
## Generators Type aliases
|
||||||
|
|
||||||
## Type aliases
|
### WorkspaceConfiguration
|
||||||
|
|
||||||
|
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../angular/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../angular/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Package Manager Type aliases
|
||||||
|
|
||||||
|
### PackageManager
|
||||||
|
|
||||||
|
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Type aliases
|
||||||
|
|
||||||
|
### StringChange
|
||||||
|
|
||||||
|
Ƭ **StringChange**: [`StringInsertion`](../../angular/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../angular/nx-devkit/index#stringdeletion)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workspace Type aliases
|
||||||
|
|
||||||
### Executor
|
### Executor
|
||||||
|
|
||||||
@ -427,26 +458,10 @@ A callback function that is executed after changes are made to the file system
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### PackageManager
|
|
||||||
|
|
||||||
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectType
|
### ProjectType
|
||||||
|
|
||||||
Ƭ **ProjectType**: `"library"` \| `"application"`
|
Ƭ **ProjectType**: `"library"` \| `"application"`
|
||||||
|
|
||||||
Type of project supported
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### StringChange
|
|
||||||
|
|
||||||
Ƭ **StringChange**: [`StringInsertion`](../../angular/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../angular/nx-devkit/index#stringdeletion)
|
|
||||||
|
|
||||||
A change to be made to a string
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraphExecutor
|
### TaskGraphExecutor
|
||||||
@ -478,13 +493,7 @@ Implementation of a target of a project that handles multiple projects to be bat
|
|||||||
|
|
||||||
`Promise`<`Record`<`string`, `Object`\>\>
|
`Promise`<`Record`<`string`, `Object`\>\>
|
||||||
|
|
||||||
---
|
## Logger Variables
|
||||||
|
|
||||||
### WorkspaceConfiguration
|
|
||||||
|
|
||||||
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../angular/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../angular/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
### logger
|
### logger
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Classes
|
### Ng CLI Adapter Classes
|
||||||
|
|
||||||
- [NxScopedHost](../../angular/nx-devkit/ngcli_adapter#nxscopedhost)
|
- [NxScopedHost](../../angular/nx-devkit/ngcli_adapter#nxscopedhost)
|
||||||
|
|
||||||
@ -12,7 +12,7 @@
|
|||||||
- [overrideCollectionResolutionForTesting](../../angular/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
- [overrideCollectionResolutionForTesting](../../angular/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
||||||
- [wrapAngularDevkitSchematic](../../angular/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
- [wrapAngularDevkitSchematic](../../angular/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
||||||
|
|
||||||
## Classes
|
## Ng CLI Adapter Classes
|
||||||
|
|
||||||
### NxScopedHost
|
### NxScopedHost
|
||||||
|
|
||||||
|
|||||||
@ -1033,13 +1033,13 @@
|
|||||||
"itemList": [
|
"itemList": [
|
||||||
{
|
{
|
||||||
"id": "index",
|
"id": "index",
|
||||||
"name": "index",
|
"name": "Overview",
|
||||||
"searchResultsName": "Nx Devkit",
|
"searchResultsName": "Nx Devkit",
|
||||||
"file": "angular/api-nx-devkit/index"
|
"file": "angular/api-nx-devkit/index"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "ngcli_adapter",
|
"id": "ngcli_adapter",
|
||||||
"name": "ngcli_adapter",
|
"name": "Ng CLI Adapter",
|
||||||
"searchResultsName": "Ng CLI Adapter",
|
"searchResultsName": "Ng CLI Adapter",
|
||||||
"file": "angular/api-nx-devkit/ngcli_adapter"
|
"file": "angular/api-nx-devkit/ngcli_adapter"
|
||||||
}
|
}
|
||||||
@ -2348,13 +2348,13 @@
|
|||||||
"itemList": [
|
"itemList": [
|
||||||
{
|
{
|
||||||
"id": "index",
|
"id": "index",
|
||||||
"name": "index",
|
"name": "Overview",
|
||||||
"searchResultsName": "Nx Devkit",
|
"searchResultsName": "Nx Devkit",
|
||||||
"file": "react/api-nx-devkit/index"
|
"file": "react/api-nx-devkit/index"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "ngcli_adapter",
|
"id": "ngcli_adapter",
|
||||||
"name": "ngcli_adapter",
|
"name": "Ng CLI Adapter",
|
||||||
"searchResultsName": "Ng CLI Adapter",
|
"searchResultsName": "Ng CLI Adapter",
|
||||||
"file": "react/api-nx-devkit/ngcli_adapter"
|
"file": "react/api-nx-devkit/ngcli_adapter"
|
||||||
}
|
}
|
||||||
@ -3562,13 +3562,13 @@
|
|||||||
"itemList": [
|
"itemList": [
|
||||||
{
|
{
|
||||||
"id": "index",
|
"id": "index",
|
||||||
"name": "index",
|
"name": "Overview",
|
||||||
"searchResultsName": "Nx Devkit",
|
"searchResultsName": "Nx Devkit",
|
||||||
"file": "node/api-nx-devkit/index"
|
"file": "node/api-nx-devkit/index"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "ngcli_adapter",
|
"id": "ngcli_adapter",
|
||||||
"name": "ngcli_adapter",
|
"name": "Ng CLI Adapter",
|
||||||
"searchResultsName": "Ng CLI Adapter",
|
"searchResultsName": "Ng CLI Adapter",
|
||||||
"file": "node/api-nx-devkit/ngcli_adapter"
|
"file": "node/api-nx-devkit/ngcli_adapter"
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,58 +1,91 @@
|
|||||||
# Module: index
|
# Module: index
|
||||||
|
|
||||||
|
The Nx Devkit is the underlying technology used to customize Nx to support
|
||||||
|
different technologies and custom use-cases. It contains many utility
|
||||||
|
functions for reading and writing files, updating configuration,
|
||||||
|
working with Abstract Syntax Trees(ASTs), and more.
|
||||||
|
|
||||||
|
As with most things in Nx, the core of Nx Devkit is very simple.
|
||||||
|
It only uses language primitives and immutable objects
|
||||||
|
(the tree being the only exception).
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Enumerations
|
### Project Graph Enumerations
|
||||||
|
|
||||||
- [ChangeType](../../node/nx-devkit/index#changetype)
|
|
||||||
- [DependencyType](../../node/nx-devkit/index#dependencytype)
|
- [DependencyType](../../node/nx-devkit/index#dependencytype)
|
||||||
|
|
||||||
### Classes
|
### Utils Enumerations
|
||||||
|
|
||||||
|
- [ChangeType](../../node/nx-devkit/index#changetype)
|
||||||
|
|
||||||
|
### Project Graph Classes
|
||||||
|
|
||||||
- [ProjectGraphBuilder](../../node/nx-devkit/index#projectgraphbuilder)
|
- [ProjectGraphBuilder](../../node/nx-devkit/index#projectgraphbuilder)
|
||||||
|
|
||||||
### Interfaces
|
### Commands Interfaces
|
||||||
|
|
||||||
|
- [Target](../../node/nx-devkit/index#target)
|
||||||
|
|
||||||
|
### Project Graph Interfaces
|
||||||
|
|
||||||
- [ExecutorContext](../../node/nx-devkit/index#executorcontext)
|
|
||||||
- [FileChange](../../node/nx-devkit/index#filechange)
|
|
||||||
- [FileData](../../node/nx-devkit/index#filedata)
|
- [FileData](../../node/nx-devkit/index#filedata)
|
||||||
- [ImplicitJsonSubsetDependency](../../node/nx-devkit/index#implicitjsonsubsetdependency)
|
|
||||||
- [JsonParseOptions](../../node/nx-devkit/index#jsonparseoptions)
|
|
||||||
- [JsonSerializeOptions](../../node/nx-devkit/index#jsonserializeoptions)
|
|
||||||
- [NxAffectedConfig](../../node/nx-devkit/index#nxaffectedconfig)
|
|
||||||
- [NxJsonConfiguration](../../node/nx-devkit/index#nxjsonconfiguration)
|
|
||||||
- [NxJsonProjectConfiguration](../../node/nx-devkit/index#nxjsonprojectconfiguration)
|
|
||||||
- [NxPlugin](../../node/nx-devkit/index#nxplugin)
|
- [NxPlugin](../../node/nx-devkit/index#nxplugin)
|
||||||
- [ProjectConfiguration](../../node/nx-devkit/index#projectconfiguration)
|
|
||||||
- [ProjectFileMap](../../node/nx-devkit/index#projectfilemap)
|
- [ProjectFileMap](../../node/nx-devkit/index#projectfilemap)
|
||||||
- [ProjectGraph](../../node/nx-devkit/index#projectgraph)
|
- [ProjectGraph](../../node/nx-devkit/index#projectgraph)
|
||||||
- [ProjectGraphDependency](../../node/nx-devkit/index#projectgraphdependency)
|
- [ProjectGraphDependency](../../node/nx-devkit/index#projectgraphdependency)
|
||||||
- [ProjectGraphNode](../../node/nx-devkit/index#projectgraphnode)
|
- [ProjectGraphNode](../../node/nx-devkit/index#projectgraphnode)
|
||||||
- [ProjectGraphProcessorContext](../../node/nx-devkit/index#projectgraphprocessorcontext)
|
- [ProjectGraphProcessorContext](../../node/nx-devkit/index#projectgraphprocessorcontext)
|
||||||
|
|
||||||
|
### Tree Interfaces
|
||||||
|
|
||||||
|
- [FileChange](../../node/nx-devkit/index#filechange)
|
||||||
|
- [Tree](../../node/nx-devkit/index#tree)
|
||||||
|
|
||||||
|
### Utils Interfaces
|
||||||
|
|
||||||
|
- [JsonParseOptions](../../node/nx-devkit/index#jsonparseoptions)
|
||||||
|
- [JsonSerializeOptions](../../node/nx-devkit/index#jsonserializeoptions)
|
||||||
- [StringDeletion](../../node/nx-devkit/index#stringdeletion)
|
- [StringDeletion](../../node/nx-devkit/index#stringdeletion)
|
||||||
- [StringInsertion](../../node/nx-devkit/index#stringinsertion)
|
- [StringInsertion](../../node/nx-devkit/index#stringinsertion)
|
||||||
- [Target](../../node/nx-devkit/index#target)
|
|
||||||
|
### Workspace Interfaces
|
||||||
|
|
||||||
|
- [ExecutorContext](../../node/nx-devkit/index#executorcontext)
|
||||||
|
- [ImplicitJsonSubsetDependency](../../node/nx-devkit/index#implicitjsonsubsetdependency)
|
||||||
|
- [NxAffectedConfig](../../node/nx-devkit/index#nxaffectedconfig)
|
||||||
|
- [NxJsonConfiguration](../../node/nx-devkit/index#nxjsonconfiguration)
|
||||||
|
- [NxJsonProjectConfiguration](../../node/nx-devkit/index#nxjsonprojectconfiguration)
|
||||||
|
- [ProjectConfiguration](../../node/nx-devkit/index#projectconfiguration)
|
||||||
- [TargetConfiguration](../../node/nx-devkit/index#targetconfiguration)
|
- [TargetConfiguration](../../node/nx-devkit/index#targetconfiguration)
|
||||||
- [TargetDependencyConfig](../../node/nx-devkit/index#targetdependencyconfig)
|
- [TargetDependencyConfig](../../node/nx-devkit/index#targetdependencyconfig)
|
||||||
- [Task](../../node/nx-devkit/index#task)
|
- [Task](../../node/nx-devkit/index#task)
|
||||||
- [TaskGraph](../../node/nx-devkit/index#taskgraph)
|
- [TaskGraph](../../node/nx-devkit/index#taskgraph)
|
||||||
- [Tree](../../node/nx-devkit/index#tree)
|
|
||||||
- [Workspace](../../node/nx-devkit/index#workspace)
|
- [Workspace](../../node/nx-devkit/index#workspace)
|
||||||
- [WorkspaceJsonConfiguration](../../node/nx-devkit/index#workspacejsonconfiguration)
|
- [WorkspaceJsonConfiguration](../../node/nx-devkit/index#workspacejsonconfiguration)
|
||||||
|
|
||||||
### Type aliases
|
### Generators Type aliases
|
||||||
|
|
||||||
|
- [WorkspaceConfiguration](../../node/nx-devkit/index#workspaceconfiguration)
|
||||||
|
|
||||||
|
### Package Manager Type aliases
|
||||||
|
|
||||||
|
- [PackageManager](../../node/nx-devkit/index#packagemanager)
|
||||||
|
|
||||||
|
### Utils Type aliases
|
||||||
|
|
||||||
|
- [StringChange](../../node/nx-devkit/index#stringchange)
|
||||||
|
|
||||||
|
### Workspace Type aliases
|
||||||
|
|
||||||
- [Executor](../../node/nx-devkit/index#executor)
|
- [Executor](../../node/nx-devkit/index#executor)
|
||||||
- [Generator](../../node/nx-devkit/index#generator)
|
- [Generator](../../node/nx-devkit/index#generator)
|
||||||
- [GeneratorCallback](../../node/nx-devkit/index#generatorcallback)
|
- [GeneratorCallback](../../node/nx-devkit/index#generatorcallback)
|
||||||
- [ImplicitDependencyEntry](../../node/nx-devkit/index#implicitdependencyentry)
|
- [ImplicitDependencyEntry](../../node/nx-devkit/index#implicitdependencyentry)
|
||||||
- [PackageManager](../../node/nx-devkit/index#packagemanager)
|
|
||||||
- [ProjectType](../../node/nx-devkit/index#projecttype)
|
- [ProjectType](../../node/nx-devkit/index#projecttype)
|
||||||
- [StringChange](../../node/nx-devkit/index#stringchange)
|
|
||||||
- [TaskGraphExecutor](../../node/nx-devkit/index#taskgraphexecutor)
|
- [TaskGraphExecutor](../../node/nx-devkit/index#taskgraphexecutor)
|
||||||
- [WorkspaceConfiguration](../../node/nx-devkit/index#workspaceconfiguration)
|
|
||||||
|
|
||||||
### Variables
|
### Logger Variables
|
||||||
|
|
||||||
- [logger](../../node/nx-devkit/index#logger)
|
- [logger](../../node/nx-devkit/index#logger)
|
||||||
|
|
||||||
@ -101,134 +134,58 @@
|
|||||||
- [writeJson](../../node/nx-devkit/index#writejson)
|
- [writeJson](../../node/nx-devkit/index#writejson)
|
||||||
- [writeJsonFile](../../node/nx-devkit/index#writejsonfile)
|
- [writeJsonFile](../../node/nx-devkit/index#writejsonfile)
|
||||||
|
|
||||||
## Enumerations
|
## Project Graph Enumerations
|
||||||
|
|
||||||
### ChangeType
|
|
||||||
|
|
||||||
• **ChangeType**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### DependencyType
|
### DependencyType
|
||||||
|
|
||||||
• **DependencyType**: `Object`
|
• **DependencyType**: `Object`
|
||||||
|
|
||||||
Type of dependency between projects
|
---
|
||||||
|
|
||||||
## Classes
|
## Utils Enumerations
|
||||||
|
|
||||||
|
### ChangeType
|
||||||
|
|
||||||
|
• **ChangeType**: `Object`
|
||||||
|
|
||||||
|
## Project Graph Classes
|
||||||
|
|
||||||
### ProjectGraphBuilder
|
### ProjectGraphBuilder
|
||||||
|
|
||||||
• **ProjectGraphBuilder**: `Object`
|
• **ProjectGraphBuilder**: `Object`
|
||||||
|
|
||||||
Builder for adding nodes and dependencies to a [ProjectGraph](../../node/nx-devkit/index#projectgraph)
|
## Commands Interfaces
|
||||||
|
|
||||||
## Interfaces
|
### Target
|
||||||
|
|
||||||
### ExecutorContext
|
• **Target**: `Object`
|
||||||
|
|
||||||
• **ExecutorContext**: `Object`
|
|
||||||
|
|
||||||
Context that is passed into an executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### FileChange
|
## Project Graph Interfaces
|
||||||
|
|
||||||
• **FileChange**: `Object`
|
|
||||||
|
|
||||||
Description of a file change in the Nx virtual file system/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### FileData
|
### FileData
|
||||||
|
|
||||||
• **FileData**: `Object`
|
• **FileData**: `Object`
|
||||||
|
|
||||||
Some metadata about a file
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ImplicitJsonSubsetDependency
|
|
||||||
|
|
||||||
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonParseOptions
|
|
||||||
|
|
||||||
• **JsonParseOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonSerializeOptions
|
|
||||||
|
|
||||||
• **JsonSerializeOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxAffectedConfig
|
|
||||||
|
|
||||||
• **NxAffectedConfig**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonConfiguration
|
|
||||||
|
|
||||||
• **NxJsonConfiguration**<`T`\>: `Object`
|
|
||||||
|
|
||||||
Nx.json configuration
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonProjectConfiguration
|
|
||||||
|
|
||||||
• **NxJsonProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### NxPlugin
|
### NxPlugin
|
||||||
|
|
||||||
• **NxPlugin**: `Object`
|
• **NxPlugin**: `Object`
|
||||||
|
|
||||||
A plugin for Nx
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectConfiguration
|
|
||||||
|
|
||||||
• **ProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
Project configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectFileMap
|
### ProjectFileMap
|
||||||
|
|
||||||
• **ProjectFileMap**: `Object`
|
• **ProjectFileMap**: `Object`
|
||||||
|
|
||||||
A list of files separated by the project they belong to
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraph
|
### ProjectGraph
|
||||||
|
|
||||||
• **ProjectGraph**<`T`\>: `Object`
|
• **ProjectGraph**<`T`\>: `Object`
|
||||||
|
|
||||||
A Graph of projects in the workspace and dependencies between them
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -241,16 +198,12 @@ A Graph of projects in the workspace and dependencies between them
|
|||||||
|
|
||||||
• **ProjectGraphDependency**: `Object`
|
• **ProjectGraphDependency**: `Object`
|
||||||
|
|
||||||
A dependency between two projects
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraphNode
|
### ProjectGraphNode
|
||||||
|
|
||||||
• **ProjectGraphNode**<`T`\>: `Object`
|
• **ProjectGraphNode**<`T`\>: `Object`
|
||||||
|
|
||||||
A node describing a project in a workspace
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -263,7 +216,33 @@ A node describing a project in a workspace
|
|||||||
|
|
||||||
• **ProjectGraphProcessorContext**: `Object`
|
• **ProjectGraphProcessorContext**: `Object`
|
||||||
|
|
||||||
Additional information to be used to process a project graph
|
---
|
||||||
|
|
||||||
|
## Tree Interfaces
|
||||||
|
|
||||||
|
### FileChange
|
||||||
|
|
||||||
|
• **FileChange**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Tree
|
||||||
|
|
||||||
|
• **Tree**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Interfaces
|
||||||
|
|
||||||
|
### JsonParseOptions
|
||||||
|
|
||||||
|
• **JsonParseOptions**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### JsonSerializeOptions
|
||||||
|
|
||||||
|
• **JsonSerializeOptions**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -279,9 +258,53 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Target
|
## Workspace Interfaces
|
||||||
|
|
||||||
• **Target**: `Object`
|
### ExecutorContext
|
||||||
|
|
||||||
|
• **ExecutorContext**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ImplicitJsonSubsetDependency
|
||||||
|
|
||||||
|
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxAffectedConfig
|
||||||
|
|
||||||
|
• **NxAffectedConfig**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonConfiguration
|
||||||
|
|
||||||
|
• **NxJsonConfiguration**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonProjectConfiguration
|
||||||
|
|
||||||
|
• **NxJsonProjectConfiguration**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ProjectConfiguration
|
||||||
|
|
||||||
|
• **ProjectConfiguration**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -289,8 +312,6 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
• **TargetConfiguration**: `Object`
|
• **TargetConfiguration**: `Object`
|
||||||
|
|
||||||
Target's configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TargetDependencyConfig
|
### TargetDependencyConfig
|
||||||
@ -303,24 +324,12 @@ Target's configuration
|
|||||||
|
|
||||||
• **Task**: `Object`
|
• **Task**: `Object`
|
||||||
|
|
||||||
A representation of the invocation of an Executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraph
|
### TaskGraph
|
||||||
|
|
||||||
• **TaskGraph**: `Object`
|
• **TaskGraph**: `Object`
|
||||||
|
|
||||||
Graph of Tasks to be executed
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Tree
|
|
||||||
|
|
||||||
• **Tree**: `Object`
|
|
||||||
|
|
||||||
Virtual file system tree.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Workspace
|
### Workspace
|
||||||
@ -333,9 +342,31 @@ Virtual file system tree.
|
|||||||
|
|
||||||
• **WorkspaceJsonConfiguration**: `Object`
|
• **WorkspaceJsonConfiguration**: `Object`
|
||||||
|
|
||||||
Workspace configuration
|
## Generators Type aliases
|
||||||
|
|
||||||
## Type aliases
|
### WorkspaceConfiguration
|
||||||
|
|
||||||
|
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../node/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../node/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Package Manager Type aliases
|
||||||
|
|
||||||
|
### PackageManager
|
||||||
|
|
||||||
|
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Type aliases
|
||||||
|
|
||||||
|
### StringChange
|
||||||
|
|
||||||
|
Ƭ **StringChange**: [`StringInsertion`](../../node/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../node/nx-devkit/index#stringdeletion)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workspace Type aliases
|
||||||
|
|
||||||
### Executor
|
### Executor
|
||||||
|
|
||||||
@ -427,26 +458,10 @@ A callback function that is executed after changes are made to the file system
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### PackageManager
|
|
||||||
|
|
||||||
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectType
|
### ProjectType
|
||||||
|
|
||||||
Ƭ **ProjectType**: `"library"` \| `"application"`
|
Ƭ **ProjectType**: `"library"` \| `"application"`
|
||||||
|
|
||||||
Type of project supported
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### StringChange
|
|
||||||
|
|
||||||
Ƭ **StringChange**: [`StringInsertion`](../../node/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../node/nx-devkit/index#stringdeletion)
|
|
||||||
|
|
||||||
A change to be made to a string
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraphExecutor
|
### TaskGraphExecutor
|
||||||
@ -478,13 +493,7 @@ Implementation of a target of a project that handles multiple projects to be bat
|
|||||||
|
|
||||||
`Promise`<`Record`<`string`, `Object`\>\>
|
`Promise`<`Record`<`string`, `Object`\>\>
|
||||||
|
|
||||||
---
|
## Logger Variables
|
||||||
|
|
||||||
### WorkspaceConfiguration
|
|
||||||
|
|
||||||
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../node/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../node/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
### logger
|
### logger
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Classes
|
### Ng CLI Adapter Classes
|
||||||
|
|
||||||
- [NxScopedHost](../../node/nx-devkit/ngcli_adapter#nxscopedhost)
|
- [NxScopedHost](../../node/nx-devkit/ngcli_adapter#nxscopedhost)
|
||||||
|
|
||||||
@ -12,7 +12,7 @@
|
|||||||
- [overrideCollectionResolutionForTesting](../../node/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
- [overrideCollectionResolutionForTesting](../../node/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
||||||
- [wrapAngularDevkitSchematic](../../node/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
- [wrapAngularDevkitSchematic](../../node/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
||||||
|
|
||||||
## Classes
|
## Ng CLI Adapter Classes
|
||||||
|
|
||||||
### NxScopedHost
|
### NxScopedHost
|
||||||
|
|
||||||
|
|||||||
@ -1,58 +1,91 @@
|
|||||||
# Module: index
|
# Module: index
|
||||||
|
|
||||||
|
The Nx Devkit is the underlying technology used to customize Nx to support
|
||||||
|
different technologies and custom use-cases. It contains many utility
|
||||||
|
functions for reading and writing files, updating configuration,
|
||||||
|
working with Abstract Syntax Trees(ASTs), and more.
|
||||||
|
|
||||||
|
As with most things in Nx, the core of Nx Devkit is very simple.
|
||||||
|
It only uses language primitives and immutable objects
|
||||||
|
(the tree being the only exception).
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Enumerations
|
### Project Graph Enumerations
|
||||||
|
|
||||||
- [ChangeType](../../react/nx-devkit/index#changetype)
|
|
||||||
- [DependencyType](../../react/nx-devkit/index#dependencytype)
|
- [DependencyType](../../react/nx-devkit/index#dependencytype)
|
||||||
|
|
||||||
### Classes
|
### Utils Enumerations
|
||||||
|
|
||||||
|
- [ChangeType](../../react/nx-devkit/index#changetype)
|
||||||
|
|
||||||
|
### Project Graph Classes
|
||||||
|
|
||||||
- [ProjectGraphBuilder](../../react/nx-devkit/index#projectgraphbuilder)
|
- [ProjectGraphBuilder](../../react/nx-devkit/index#projectgraphbuilder)
|
||||||
|
|
||||||
### Interfaces
|
### Commands Interfaces
|
||||||
|
|
||||||
|
- [Target](../../react/nx-devkit/index#target)
|
||||||
|
|
||||||
|
### Project Graph Interfaces
|
||||||
|
|
||||||
- [ExecutorContext](../../react/nx-devkit/index#executorcontext)
|
|
||||||
- [FileChange](../../react/nx-devkit/index#filechange)
|
|
||||||
- [FileData](../../react/nx-devkit/index#filedata)
|
- [FileData](../../react/nx-devkit/index#filedata)
|
||||||
- [ImplicitJsonSubsetDependency](../../react/nx-devkit/index#implicitjsonsubsetdependency)
|
|
||||||
- [JsonParseOptions](../../react/nx-devkit/index#jsonparseoptions)
|
|
||||||
- [JsonSerializeOptions](../../react/nx-devkit/index#jsonserializeoptions)
|
|
||||||
- [NxAffectedConfig](../../react/nx-devkit/index#nxaffectedconfig)
|
|
||||||
- [NxJsonConfiguration](../../react/nx-devkit/index#nxjsonconfiguration)
|
|
||||||
- [NxJsonProjectConfiguration](../../react/nx-devkit/index#nxjsonprojectconfiguration)
|
|
||||||
- [NxPlugin](../../react/nx-devkit/index#nxplugin)
|
- [NxPlugin](../../react/nx-devkit/index#nxplugin)
|
||||||
- [ProjectConfiguration](../../react/nx-devkit/index#projectconfiguration)
|
|
||||||
- [ProjectFileMap](../../react/nx-devkit/index#projectfilemap)
|
- [ProjectFileMap](../../react/nx-devkit/index#projectfilemap)
|
||||||
- [ProjectGraph](../../react/nx-devkit/index#projectgraph)
|
- [ProjectGraph](../../react/nx-devkit/index#projectgraph)
|
||||||
- [ProjectGraphDependency](../../react/nx-devkit/index#projectgraphdependency)
|
- [ProjectGraphDependency](../../react/nx-devkit/index#projectgraphdependency)
|
||||||
- [ProjectGraphNode](../../react/nx-devkit/index#projectgraphnode)
|
- [ProjectGraphNode](../../react/nx-devkit/index#projectgraphnode)
|
||||||
- [ProjectGraphProcessorContext](../../react/nx-devkit/index#projectgraphprocessorcontext)
|
- [ProjectGraphProcessorContext](../../react/nx-devkit/index#projectgraphprocessorcontext)
|
||||||
|
|
||||||
|
### Tree Interfaces
|
||||||
|
|
||||||
|
- [FileChange](../../react/nx-devkit/index#filechange)
|
||||||
|
- [Tree](../../react/nx-devkit/index#tree)
|
||||||
|
|
||||||
|
### Utils Interfaces
|
||||||
|
|
||||||
|
- [JsonParseOptions](../../react/nx-devkit/index#jsonparseoptions)
|
||||||
|
- [JsonSerializeOptions](../../react/nx-devkit/index#jsonserializeoptions)
|
||||||
- [StringDeletion](../../react/nx-devkit/index#stringdeletion)
|
- [StringDeletion](../../react/nx-devkit/index#stringdeletion)
|
||||||
- [StringInsertion](../../react/nx-devkit/index#stringinsertion)
|
- [StringInsertion](../../react/nx-devkit/index#stringinsertion)
|
||||||
- [Target](../../react/nx-devkit/index#target)
|
|
||||||
|
### Workspace Interfaces
|
||||||
|
|
||||||
|
- [ExecutorContext](../../react/nx-devkit/index#executorcontext)
|
||||||
|
- [ImplicitJsonSubsetDependency](../../react/nx-devkit/index#implicitjsonsubsetdependency)
|
||||||
|
- [NxAffectedConfig](../../react/nx-devkit/index#nxaffectedconfig)
|
||||||
|
- [NxJsonConfiguration](../../react/nx-devkit/index#nxjsonconfiguration)
|
||||||
|
- [NxJsonProjectConfiguration](../../react/nx-devkit/index#nxjsonprojectconfiguration)
|
||||||
|
- [ProjectConfiguration](../../react/nx-devkit/index#projectconfiguration)
|
||||||
- [TargetConfiguration](../../react/nx-devkit/index#targetconfiguration)
|
- [TargetConfiguration](../../react/nx-devkit/index#targetconfiguration)
|
||||||
- [TargetDependencyConfig](../../react/nx-devkit/index#targetdependencyconfig)
|
- [TargetDependencyConfig](../../react/nx-devkit/index#targetdependencyconfig)
|
||||||
- [Task](../../react/nx-devkit/index#task)
|
- [Task](../../react/nx-devkit/index#task)
|
||||||
- [TaskGraph](../../react/nx-devkit/index#taskgraph)
|
- [TaskGraph](../../react/nx-devkit/index#taskgraph)
|
||||||
- [Tree](../../react/nx-devkit/index#tree)
|
|
||||||
- [Workspace](../../react/nx-devkit/index#workspace)
|
- [Workspace](../../react/nx-devkit/index#workspace)
|
||||||
- [WorkspaceJsonConfiguration](../../react/nx-devkit/index#workspacejsonconfiguration)
|
- [WorkspaceJsonConfiguration](../../react/nx-devkit/index#workspacejsonconfiguration)
|
||||||
|
|
||||||
### Type aliases
|
### Generators Type aliases
|
||||||
|
|
||||||
|
- [WorkspaceConfiguration](../../react/nx-devkit/index#workspaceconfiguration)
|
||||||
|
|
||||||
|
### Package Manager Type aliases
|
||||||
|
|
||||||
|
- [PackageManager](../../react/nx-devkit/index#packagemanager)
|
||||||
|
|
||||||
|
### Utils Type aliases
|
||||||
|
|
||||||
|
- [StringChange](../../react/nx-devkit/index#stringchange)
|
||||||
|
|
||||||
|
### Workspace Type aliases
|
||||||
|
|
||||||
- [Executor](../../react/nx-devkit/index#executor)
|
- [Executor](../../react/nx-devkit/index#executor)
|
||||||
- [Generator](../../react/nx-devkit/index#generator)
|
- [Generator](../../react/nx-devkit/index#generator)
|
||||||
- [GeneratorCallback](../../react/nx-devkit/index#generatorcallback)
|
- [GeneratorCallback](../../react/nx-devkit/index#generatorcallback)
|
||||||
- [ImplicitDependencyEntry](../../react/nx-devkit/index#implicitdependencyentry)
|
- [ImplicitDependencyEntry](../../react/nx-devkit/index#implicitdependencyentry)
|
||||||
- [PackageManager](../../react/nx-devkit/index#packagemanager)
|
|
||||||
- [ProjectType](../../react/nx-devkit/index#projecttype)
|
- [ProjectType](../../react/nx-devkit/index#projecttype)
|
||||||
- [StringChange](../../react/nx-devkit/index#stringchange)
|
|
||||||
- [TaskGraphExecutor](../../react/nx-devkit/index#taskgraphexecutor)
|
- [TaskGraphExecutor](../../react/nx-devkit/index#taskgraphexecutor)
|
||||||
- [WorkspaceConfiguration](../../react/nx-devkit/index#workspaceconfiguration)
|
|
||||||
|
|
||||||
### Variables
|
### Logger Variables
|
||||||
|
|
||||||
- [logger](../../react/nx-devkit/index#logger)
|
- [logger](../../react/nx-devkit/index#logger)
|
||||||
|
|
||||||
@ -101,134 +134,58 @@
|
|||||||
- [writeJson](../../react/nx-devkit/index#writejson)
|
- [writeJson](../../react/nx-devkit/index#writejson)
|
||||||
- [writeJsonFile](../../react/nx-devkit/index#writejsonfile)
|
- [writeJsonFile](../../react/nx-devkit/index#writejsonfile)
|
||||||
|
|
||||||
## Enumerations
|
## Project Graph Enumerations
|
||||||
|
|
||||||
### ChangeType
|
|
||||||
|
|
||||||
• **ChangeType**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### DependencyType
|
### DependencyType
|
||||||
|
|
||||||
• **DependencyType**: `Object`
|
• **DependencyType**: `Object`
|
||||||
|
|
||||||
Type of dependency between projects
|
---
|
||||||
|
|
||||||
## Classes
|
## Utils Enumerations
|
||||||
|
|
||||||
|
### ChangeType
|
||||||
|
|
||||||
|
• **ChangeType**: `Object`
|
||||||
|
|
||||||
|
## Project Graph Classes
|
||||||
|
|
||||||
### ProjectGraphBuilder
|
### ProjectGraphBuilder
|
||||||
|
|
||||||
• **ProjectGraphBuilder**: `Object`
|
• **ProjectGraphBuilder**: `Object`
|
||||||
|
|
||||||
Builder for adding nodes and dependencies to a [ProjectGraph](../../react/nx-devkit/index#projectgraph)
|
## Commands Interfaces
|
||||||
|
|
||||||
## Interfaces
|
### Target
|
||||||
|
|
||||||
### ExecutorContext
|
• **Target**: `Object`
|
||||||
|
|
||||||
• **ExecutorContext**: `Object`
|
|
||||||
|
|
||||||
Context that is passed into an executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### FileChange
|
## Project Graph Interfaces
|
||||||
|
|
||||||
• **FileChange**: `Object`
|
|
||||||
|
|
||||||
Description of a file change in the Nx virtual file system/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### FileData
|
### FileData
|
||||||
|
|
||||||
• **FileData**: `Object`
|
• **FileData**: `Object`
|
||||||
|
|
||||||
Some metadata about a file
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ImplicitJsonSubsetDependency
|
|
||||||
|
|
||||||
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonParseOptions
|
|
||||||
|
|
||||||
• **JsonParseOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonSerializeOptions
|
|
||||||
|
|
||||||
• **JsonSerializeOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxAffectedConfig
|
|
||||||
|
|
||||||
• **NxAffectedConfig**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonConfiguration
|
|
||||||
|
|
||||||
• **NxJsonConfiguration**<`T`\>: `Object`
|
|
||||||
|
|
||||||
Nx.json configuration
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonProjectConfiguration
|
|
||||||
|
|
||||||
• **NxJsonProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### NxPlugin
|
### NxPlugin
|
||||||
|
|
||||||
• **NxPlugin**: `Object`
|
• **NxPlugin**: `Object`
|
||||||
|
|
||||||
A plugin for Nx
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectConfiguration
|
|
||||||
|
|
||||||
• **ProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
Project configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectFileMap
|
### ProjectFileMap
|
||||||
|
|
||||||
• **ProjectFileMap**: `Object`
|
• **ProjectFileMap**: `Object`
|
||||||
|
|
||||||
A list of files separated by the project they belong to
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraph
|
### ProjectGraph
|
||||||
|
|
||||||
• **ProjectGraph**<`T`\>: `Object`
|
• **ProjectGraph**<`T`\>: `Object`
|
||||||
|
|
||||||
A Graph of projects in the workspace and dependencies between them
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -241,16 +198,12 @@ A Graph of projects in the workspace and dependencies between them
|
|||||||
|
|
||||||
• **ProjectGraphDependency**: `Object`
|
• **ProjectGraphDependency**: `Object`
|
||||||
|
|
||||||
A dependency between two projects
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraphNode
|
### ProjectGraphNode
|
||||||
|
|
||||||
• **ProjectGraphNode**<`T`\>: `Object`
|
• **ProjectGraphNode**<`T`\>: `Object`
|
||||||
|
|
||||||
A node describing a project in a workspace
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -263,7 +216,33 @@ A node describing a project in a workspace
|
|||||||
|
|
||||||
• **ProjectGraphProcessorContext**: `Object`
|
• **ProjectGraphProcessorContext**: `Object`
|
||||||
|
|
||||||
Additional information to be used to process a project graph
|
---
|
||||||
|
|
||||||
|
## Tree Interfaces
|
||||||
|
|
||||||
|
### FileChange
|
||||||
|
|
||||||
|
• **FileChange**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Tree
|
||||||
|
|
||||||
|
• **Tree**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Interfaces
|
||||||
|
|
||||||
|
### JsonParseOptions
|
||||||
|
|
||||||
|
• **JsonParseOptions**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### JsonSerializeOptions
|
||||||
|
|
||||||
|
• **JsonSerializeOptions**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -279,9 +258,53 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Target
|
## Workspace Interfaces
|
||||||
|
|
||||||
• **Target**: `Object`
|
### ExecutorContext
|
||||||
|
|
||||||
|
• **ExecutorContext**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ImplicitJsonSubsetDependency
|
||||||
|
|
||||||
|
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxAffectedConfig
|
||||||
|
|
||||||
|
• **NxAffectedConfig**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonConfiguration
|
||||||
|
|
||||||
|
• **NxJsonConfiguration**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonProjectConfiguration
|
||||||
|
|
||||||
|
• **NxJsonProjectConfiguration**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ProjectConfiguration
|
||||||
|
|
||||||
|
• **ProjectConfiguration**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -289,8 +312,6 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
• **TargetConfiguration**: `Object`
|
• **TargetConfiguration**: `Object`
|
||||||
|
|
||||||
Target's configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TargetDependencyConfig
|
### TargetDependencyConfig
|
||||||
@ -303,24 +324,12 @@ Target's configuration
|
|||||||
|
|
||||||
• **Task**: `Object`
|
• **Task**: `Object`
|
||||||
|
|
||||||
A representation of the invocation of an Executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraph
|
### TaskGraph
|
||||||
|
|
||||||
• **TaskGraph**: `Object`
|
• **TaskGraph**: `Object`
|
||||||
|
|
||||||
Graph of Tasks to be executed
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Tree
|
|
||||||
|
|
||||||
• **Tree**: `Object`
|
|
||||||
|
|
||||||
Virtual file system tree.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Workspace
|
### Workspace
|
||||||
@ -333,9 +342,31 @@ Virtual file system tree.
|
|||||||
|
|
||||||
• **WorkspaceJsonConfiguration**: `Object`
|
• **WorkspaceJsonConfiguration**: `Object`
|
||||||
|
|
||||||
Workspace configuration
|
## Generators Type aliases
|
||||||
|
|
||||||
## Type aliases
|
### WorkspaceConfiguration
|
||||||
|
|
||||||
|
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../react/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../react/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Package Manager Type aliases
|
||||||
|
|
||||||
|
### PackageManager
|
||||||
|
|
||||||
|
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Type aliases
|
||||||
|
|
||||||
|
### StringChange
|
||||||
|
|
||||||
|
Ƭ **StringChange**: [`StringInsertion`](../../react/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../react/nx-devkit/index#stringdeletion)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workspace Type aliases
|
||||||
|
|
||||||
### Executor
|
### Executor
|
||||||
|
|
||||||
@ -427,26 +458,10 @@ A callback function that is executed after changes are made to the file system
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### PackageManager
|
|
||||||
|
|
||||||
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectType
|
### ProjectType
|
||||||
|
|
||||||
Ƭ **ProjectType**: `"library"` \| `"application"`
|
Ƭ **ProjectType**: `"library"` \| `"application"`
|
||||||
|
|
||||||
Type of project supported
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### StringChange
|
|
||||||
|
|
||||||
Ƭ **StringChange**: [`StringInsertion`](../../react/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../react/nx-devkit/index#stringdeletion)
|
|
||||||
|
|
||||||
A change to be made to a string
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraphExecutor
|
### TaskGraphExecutor
|
||||||
@ -478,13 +493,7 @@ Implementation of a target of a project that handles multiple projects to be bat
|
|||||||
|
|
||||||
`Promise`<`Record`<`string`, `Object`\>\>
|
`Promise`<`Record`<`string`, `Object`\>\>
|
||||||
|
|
||||||
---
|
## Logger Variables
|
||||||
|
|
||||||
### WorkspaceConfiguration
|
|
||||||
|
|
||||||
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../react/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../react/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
### logger
|
### logger
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Classes
|
### Ng CLI Adapter Classes
|
||||||
|
|
||||||
- [NxScopedHost](../../react/nx-devkit/ngcli_adapter#nxscopedhost)
|
- [NxScopedHost](../../react/nx-devkit/ngcli_adapter#nxscopedhost)
|
||||||
|
|
||||||
@ -12,7 +12,7 @@
|
|||||||
- [overrideCollectionResolutionForTesting](../../react/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
- [overrideCollectionResolutionForTesting](../../react/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
||||||
- [wrapAngularDevkitSchematic](../../react/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
- [wrapAngularDevkitSchematic](../../react/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
||||||
|
|
||||||
## Classes
|
## Ng CLI Adapter Classes
|
||||||
|
|
||||||
### NxScopedHost
|
### NxScopedHost
|
||||||
|
|
||||||
|
|||||||
@ -1,58 +1,91 @@
|
|||||||
# Module: index
|
# Module: index
|
||||||
|
|
||||||
|
The Nx Devkit is the underlying technology used to customize Nx to support
|
||||||
|
different technologies and custom use-cases. It contains many utility
|
||||||
|
functions for reading and writing files, updating configuration,
|
||||||
|
working with Abstract Syntax Trees(ASTs), and more.
|
||||||
|
|
||||||
|
As with most things in Nx, the core of Nx Devkit is very simple.
|
||||||
|
It only uses language primitives and immutable objects
|
||||||
|
(the tree being the only exception).
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Enumerations
|
### Project Graph Enumerations
|
||||||
|
|
||||||
- [ChangeType](../../angular/nx-devkit/index#changetype)
|
|
||||||
- [DependencyType](../../angular/nx-devkit/index#dependencytype)
|
- [DependencyType](../../angular/nx-devkit/index#dependencytype)
|
||||||
|
|
||||||
### Classes
|
### Utils Enumerations
|
||||||
|
|
||||||
|
- [ChangeType](../../angular/nx-devkit/index#changetype)
|
||||||
|
|
||||||
|
### Project Graph Classes
|
||||||
|
|
||||||
- [ProjectGraphBuilder](../../angular/nx-devkit/index#projectgraphbuilder)
|
- [ProjectGraphBuilder](../../angular/nx-devkit/index#projectgraphbuilder)
|
||||||
|
|
||||||
### Interfaces
|
### Commands Interfaces
|
||||||
|
|
||||||
|
- [Target](../../angular/nx-devkit/index#target)
|
||||||
|
|
||||||
|
### Project Graph Interfaces
|
||||||
|
|
||||||
- [ExecutorContext](../../angular/nx-devkit/index#executorcontext)
|
|
||||||
- [FileChange](../../angular/nx-devkit/index#filechange)
|
|
||||||
- [FileData](../../angular/nx-devkit/index#filedata)
|
- [FileData](../../angular/nx-devkit/index#filedata)
|
||||||
- [ImplicitJsonSubsetDependency](../../angular/nx-devkit/index#implicitjsonsubsetdependency)
|
|
||||||
- [JsonParseOptions](../../angular/nx-devkit/index#jsonparseoptions)
|
|
||||||
- [JsonSerializeOptions](../../angular/nx-devkit/index#jsonserializeoptions)
|
|
||||||
- [NxAffectedConfig](../../angular/nx-devkit/index#nxaffectedconfig)
|
|
||||||
- [NxJsonConfiguration](../../angular/nx-devkit/index#nxjsonconfiguration)
|
|
||||||
- [NxJsonProjectConfiguration](../../angular/nx-devkit/index#nxjsonprojectconfiguration)
|
|
||||||
- [NxPlugin](../../angular/nx-devkit/index#nxplugin)
|
- [NxPlugin](../../angular/nx-devkit/index#nxplugin)
|
||||||
- [ProjectConfiguration](../../angular/nx-devkit/index#projectconfiguration)
|
|
||||||
- [ProjectFileMap](../../angular/nx-devkit/index#projectfilemap)
|
- [ProjectFileMap](../../angular/nx-devkit/index#projectfilemap)
|
||||||
- [ProjectGraph](../../angular/nx-devkit/index#projectgraph)
|
- [ProjectGraph](../../angular/nx-devkit/index#projectgraph)
|
||||||
- [ProjectGraphDependency](../../angular/nx-devkit/index#projectgraphdependency)
|
- [ProjectGraphDependency](../../angular/nx-devkit/index#projectgraphdependency)
|
||||||
- [ProjectGraphNode](../../angular/nx-devkit/index#projectgraphnode)
|
- [ProjectGraphNode](../../angular/nx-devkit/index#projectgraphnode)
|
||||||
- [ProjectGraphProcessorContext](../../angular/nx-devkit/index#projectgraphprocessorcontext)
|
- [ProjectGraphProcessorContext](../../angular/nx-devkit/index#projectgraphprocessorcontext)
|
||||||
|
|
||||||
|
### Tree Interfaces
|
||||||
|
|
||||||
|
- [FileChange](../../angular/nx-devkit/index#filechange)
|
||||||
|
- [Tree](../../angular/nx-devkit/index#tree)
|
||||||
|
|
||||||
|
### Utils Interfaces
|
||||||
|
|
||||||
|
- [JsonParseOptions](../../angular/nx-devkit/index#jsonparseoptions)
|
||||||
|
- [JsonSerializeOptions](../../angular/nx-devkit/index#jsonserializeoptions)
|
||||||
- [StringDeletion](../../angular/nx-devkit/index#stringdeletion)
|
- [StringDeletion](../../angular/nx-devkit/index#stringdeletion)
|
||||||
- [StringInsertion](../../angular/nx-devkit/index#stringinsertion)
|
- [StringInsertion](../../angular/nx-devkit/index#stringinsertion)
|
||||||
- [Target](../../angular/nx-devkit/index#target)
|
|
||||||
|
### Workspace Interfaces
|
||||||
|
|
||||||
|
- [ExecutorContext](../../angular/nx-devkit/index#executorcontext)
|
||||||
|
- [ImplicitJsonSubsetDependency](../../angular/nx-devkit/index#implicitjsonsubsetdependency)
|
||||||
|
- [NxAffectedConfig](../../angular/nx-devkit/index#nxaffectedconfig)
|
||||||
|
- [NxJsonConfiguration](../../angular/nx-devkit/index#nxjsonconfiguration)
|
||||||
|
- [NxJsonProjectConfiguration](../../angular/nx-devkit/index#nxjsonprojectconfiguration)
|
||||||
|
- [ProjectConfiguration](../../angular/nx-devkit/index#projectconfiguration)
|
||||||
- [TargetConfiguration](../../angular/nx-devkit/index#targetconfiguration)
|
- [TargetConfiguration](../../angular/nx-devkit/index#targetconfiguration)
|
||||||
- [TargetDependencyConfig](../../angular/nx-devkit/index#targetdependencyconfig)
|
- [TargetDependencyConfig](../../angular/nx-devkit/index#targetdependencyconfig)
|
||||||
- [Task](../../angular/nx-devkit/index#task)
|
- [Task](../../angular/nx-devkit/index#task)
|
||||||
- [TaskGraph](../../angular/nx-devkit/index#taskgraph)
|
- [TaskGraph](../../angular/nx-devkit/index#taskgraph)
|
||||||
- [Tree](../../angular/nx-devkit/index#tree)
|
|
||||||
- [Workspace](../../angular/nx-devkit/index#workspace)
|
- [Workspace](../../angular/nx-devkit/index#workspace)
|
||||||
- [WorkspaceJsonConfiguration](../../angular/nx-devkit/index#workspacejsonconfiguration)
|
- [WorkspaceJsonConfiguration](../../angular/nx-devkit/index#workspacejsonconfiguration)
|
||||||
|
|
||||||
### Type aliases
|
### Generators Type aliases
|
||||||
|
|
||||||
|
- [WorkspaceConfiguration](../../angular/nx-devkit/index#workspaceconfiguration)
|
||||||
|
|
||||||
|
### Package Manager Type aliases
|
||||||
|
|
||||||
|
- [PackageManager](../../angular/nx-devkit/index#packagemanager)
|
||||||
|
|
||||||
|
### Utils Type aliases
|
||||||
|
|
||||||
|
- [StringChange](../../angular/nx-devkit/index#stringchange)
|
||||||
|
|
||||||
|
### Workspace Type aliases
|
||||||
|
|
||||||
- [Executor](../../angular/nx-devkit/index#executor)
|
- [Executor](../../angular/nx-devkit/index#executor)
|
||||||
- [Generator](../../angular/nx-devkit/index#generator)
|
- [Generator](../../angular/nx-devkit/index#generator)
|
||||||
- [GeneratorCallback](../../angular/nx-devkit/index#generatorcallback)
|
- [GeneratorCallback](../../angular/nx-devkit/index#generatorcallback)
|
||||||
- [ImplicitDependencyEntry](../../angular/nx-devkit/index#implicitdependencyentry)
|
- [ImplicitDependencyEntry](../../angular/nx-devkit/index#implicitdependencyentry)
|
||||||
- [PackageManager](../../angular/nx-devkit/index#packagemanager)
|
|
||||||
- [ProjectType](../../angular/nx-devkit/index#projecttype)
|
- [ProjectType](../../angular/nx-devkit/index#projecttype)
|
||||||
- [StringChange](../../angular/nx-devkit/index#stringchange)
|
|
||||||
- [TaskGraphExecutor](../../angular/nx-devkit/index#taskgraphexecutor)
|
- [TaskGraphExecutor](../../angular/nx-devkit/index#taskgraphexecutor)
|
||||||
- [WorkspaceConfiguration](../../angular/nx-devkit/index#workspaceconfiguration)
|
|
||||||
|
|
||||||
### Variables
|
### Logger Variables
|
||||||
|
|
||||||
- [logger](../../angular/nx-devkit/index#logger)
|
- [logger](../../angular/nx-devkit/index#logger)
|
||||||
|
|
||||||
@ -101,134 +134,58 @@
|
|||||||
- [writeJson](../../angular/nx-devkit/index#writejson)
|
- [writeJson](../../angular/nx-devkit/index#writejson)
|
||||||
- [writeJsonFile](../../angular/nx-devkit/index#writejsonfile)
|
- [writeJsonFile](../../angular/nx-devkit/index#writejsonfile)
|
||||||
|
|
||||||
## Enumerations
|
## Project Graph Enumerations
|
||||||
|
|
||||||
### ChangeType
|
|
||||||
|
|
||||||
• **ChangeType**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### DependencyType
|
### DependencyType
|
||||||
|
|
||||||
• **DependencyType**: `Object`
|
• **DependencyType**: `Object`
|
||||||
|
|
||||||
Type of dependency between projects
|
---
|
||||||
|
|
||||||
## Classes
|
## Utils Enumerations
|
||||||
|
|
||||||
|
### ChangeType
|
||||||
|
|
||||||
|
• **ChangeType**: `Object`
|
||||||
|
|
||||||
|
## Project Graph Classes
|
||||||
|
|
||||||
### ProjectGraphBuilder
|
### ProjectGraphBuilder
|
||||||
|
|
||||||
• **ProjectGraphBuilder**: `Object`
|
• **ProjectGraphBuilder**: `Object`
|
||||||
|
|
||||||
Builder for adding nodes and dependencies to a [ProjectGraph](../../angular/nx-devkit/index#projectgraph)
|
## Commands Interfaces
|
||||||
|
|
||||||
## Interfaces
|
### Target
|
||||||
|
|
||||||
### ExecutorContext
|
• **Target**: `Object`
|
||||||
|
|
||||||
• **ExecutorContext**: `Object`
|
|
||||||
|
|
||||||
Context that is passed into an executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### FileChange
|
## Project Graph Interfaces
|
||||||
|
|
||||||
• **FileChange**: `Object`
|
|
||||||
|
|
||||||
Description of a file change in the Nx virtual file system/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### FileData
|
### FileData
|
||||||
|
|
||||||
• **FileData**: `Object`
|
• **FileData**: `Object`
|
||||||
|
|
||||||
Some metadata about a file
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ImplicitJsonSubsetDependency
|
|
||||||
|
|
||||||
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonParseOptions
|
|
||||||
|
|
||||||
• **JsonParseOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonSerializeOptions
|
|
||||||
|
|
||||||
• **JsonSerializeOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxAffectedConfig
|
|
||||||
|
|
||||||
• **NxAffectedConfig**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonConfiguration
|
|
||||||
|
|
||||||
• **NxJsonConfiguration**<`T`\>: `Object`
|
|
||||||
|
|
||||||
Nx.json configuration
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonProjectConfiguration
|
|
||||||
|
|
||||||
• **NxJsonProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### NxPlugin
|
### NxPlugin
|
||||||
|
|
||||||
• **NxPlugin**: `Object`
|
• **NxPlugin**: `Object`
|
||||||
|
|
||||||
A plugin for Nx
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectConfiguration
|
|
||||||
|
|
||||||
• **ProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
Project configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectFileMap
|
### ProjectFileMap
|
||||||
|
|
||||||
• **ProjectFileMap**: `Object`
|
• **ProjectFileMap**: `Object`
|
||||||
|
|
||||||
A list of files separated by the project they belong to
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraph
|
### ProjectGraph
|
||||||
|
|
||||||
• **ProjectGraph**<`T`\>: `Object`
|
• **ProjectGraph**<`T`\>: `Object`
|
||||||
|
|
||||||
A Graph of projects in the workspace and dependencies between them
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -241,16 +198,12 @@ A Graph of projects in the workspace and dependencies between them
|
|||||||
|
|
||||||
• **ProjectGraphDependency**: `Object`
|
• **ProjectGraphDependency**: `Object`
|
||||||
|
|
||||||
A dependency between two projects
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraphNode
|
### ProjectGraphNode
|
||||||
|
|
||||||
• **ProjectGraphNode**<`T`\>: `Object`
|
• **ProjectGraphNode**<`T`\>: `Object`
|
||||||
|
|
||||||
A node describing a project in a workspace
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -263,7 +216,33 @@ A node describing a project in a workspace
|
|||||||
|
|
||||||
• **ProjectGraphProcessorContext**: `Object`
|
• **ProjectGraphProcessorContext**: `Object`
|
||||||
|
|
||||||
Additional information to be used to process a project graph
|
---
|
||||||
|
|
||||||
|
## Tree Interfaces
|
||||||
|
|
||||||
|
### FileChange
|
||||||
|
|
||||||
|
• **FileChange**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Tree
|
||||||
|
|
||||||
|
• **Tree**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Interfaces
|
||||||
|
|
||||||
|
### JsonParseOptions
|
||||||
|
|
||||||
|
• **JsonParseOptions**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### JsonSerializeOptions
|
||||||
|
|
||||||
|
• **JsonSerializeOptions**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -279,9 +258,53 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Target
|
## Workspace Interfaces
|
||||||
|
|
||||||
• **Target**: `Object`
|
### ExecutorContext
|
||||||
|
|
||||||
|
• **ExecutorContext**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ImplicitJsonSubsetDependency
|
||||||
|
|
||||||
|
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxAffectedConfig
|
||||||
|
|
||||||
|
• **NxAffectedConfig**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonConfiguration
|
||||||
|
|
||||||
|
• **NxJsonConfiguration**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonProjectConfiguration
|
||||||
|
|
||||||
|
• **NxJsonProjectConfiguration**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ProjectConfiguration
|
||||||
|
|
||||||
|
• **ProjectConfiguration**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -289,8 +312,6 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
• **TargetConfiguration**: `Object`
|
• **TargetConfiguration**: `Object`
|
||||||
|
|
||||||
Target's configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TargetDependencyConfig
|
### TargetDependencyConfig
|
||||||
@ -303,24 +324,12 @@ Target's configuration
|
|||||||
|
|
||||||
• **Task**: `Object`
|
• **Task**: `Object`
|
||||||
|
|
||||||
A representation of the invocation of an Executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraph
|
### TaskGraph
|
||||||
|
|
||||||
• **TaskGraph**: `Object`
|
• **TaskGraph**: `Object`
|
||||||
|
|
||||||
Graph of Tasks to be executed
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Tree
|
|
||||||
|
|
||||||
• **Tree**: `Object`
|
|
||||||
|
|
||||||
Virtual file system tree.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Workspace
|
### Workspace
|
||||||
@ -333,9 +342,31 @@ Virtual file system tree.
|
|||||||
|
|
||||||
• **WorkspaceJsonConfiguration**: `Object`
|
• **WorkspaceJsonConfiguration**: `Object`
|
||||||
|
|
||||||
Workspace configuration
|
## Generators Type aliases
|
||||||
|
|
||||||
## Type aliases
|
### WorkspaceConfiguration
|
||||||
|
|
||||||
|
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../angular/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../angular/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Package Manager Type aliases
|
||||||
|
|
||||||
|
### PackageManager
|
||||||
|
|
||||||
|
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Type aliases
|
||||||
|
|
||||||
|
### StringChange
|
||||||
|
|
||||||
|
Ƭ **StringChange**: [`StringInsertion`](../../angular/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../angular/nx-devkit/index#stringdeletion)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workspace Type aliases
|
||||||
|
|
||||||
### Executor
|
### Executor
|
||||||
|
|
||||||
@ -427,26 +458,10 @@ A callback function that is executed after changes are made to the file system
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### PackageManager
|
|
||||||
|
|
||||||
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectType
|
### ProjectType
|
||||||
|
|
||||||
Ƭ **ProjectType**: `"library"` \| `"application"`
|
Ƭ **ProjectType**: `"library"` \| `"application"`
|
||||||
|
|
||||||
Type of project supported
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### StringChange
|
|
||||||
|
|
||||||
Ƭ **StringChange**: [`StringInsertion`](../../angular/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../angular/nx-devkit/index#stringdeletion)
|
|
||||||
|
|
||||||
A change to be made to a string
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraphExecutor
|
### TaskGraphExecutor
|
||||||
@ -478,13 +493,7 @@ Implementation of a target of a project that handles multiple projects to be bat
|
|||||||
|
|
||||||
`Promise`<`Record`<`string`, `Object`\>\>
|
`Promise`<`Record`<`string`, `Object`\>\>
|
||||||
|
|
||||||
---
|
## Logger Variables
|
||||||
|
|
||||||
### WorkspaceConfiguration
|
|
||||||
|
|
||||||
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../angular/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../angular/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
### logger
|
### logger
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Classes
|
### Ng CLI Adapter Classes
|
||||||
|
|
||||||
- [NxScopedHost](../../angular/nx-devkit/ngcli_adapter#nxscopedhost)
|
- [NxScopedHost](../../angular/nx-devkit/ngcli_adapter#nxscopedhost)
|
||||||
|
|
||||||
@ -12,7 +12,7 @@
|
|||||||
- [overrideCollectionResolutionForTesting](../../angular/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
- [overrideCollectionResolutionForTesting](../../angular/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
||||||
- [wrapAngularDevkitSchematic](../../angular/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
- [wrapAngularDevkitSchematic](../../angular/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
||||||
|
|
||||||
## Classes
|
## Ng CLI Adapter Classes
|
||||||
|
|
||||||
### NxScopedHost
|
### NxScopedHost
|
||||||
|
|
||||||
|
|||||||
@ -32,8 +32,6 @@ List of static application assets.
|
|||||||
|
|
||||||
### baseHref
|
### baseHref
|
||||||
|
|
||||||
Default: `/`
|
|
||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Base url for the application being built.
|
Base url for the application being built.
|
||||||
|
|||||||
@ -102,6 +102,12 @@ Default: `false`
|
|||||||
|
|
||||||
Isolate projects which previously failed
|
Isolate projects which previously failed
|
||||||
|
|
||||||
|
### open
|
||||||
|
|
||||||
|
Default: `true`
|
||||||
|
|
||||||
|
Open the dependency graph in the browser.
|
||||||
|
|
||||||
### port
|
### port
|
||||||
|
|
||||||
Bind the dependecy graph server to a specific port.
|
Bind the dependecy graph server to a specific port.
|
||||||
|
|||||||
@ -86,6 +86,12 @@ Show help
|
|||||||
|
|
||||||
Bind the dependency graph server to a specific ip address.
|
Bind the dependency graph server to a specific ip address.
|
||||||
|
|
||||||
|
### open
|
||||||
|
|
||||||
|
Default: `true`
|
||||||
|
|
||||||
|
Open the dependency graph in the browser.
|
||||||
|
|
||||||
### port
|
### port
|
||||||
|
|
||||||
Bind the dependecy graph server to a specific port.
|
Bind the dependecy graph server to a specific port.
|
||||||
|
|||||||
@ -1033,13 +1033,13 @@
|
|||||||
"itemList": [
|
"itemList": [
|
||||||
{
|
{
|
||||||
"id": "index",
|
"id": "index",
|
||||||
"name": "index",
|
"name": "Overview",
|
||||||
"searchResultsName": "Nx Devkit",
|
"searchResultsName": "Nx Devkit",
|
||||||
"file": "angular/api-nx-devkit/index"
|
"file": "angular/api-nx-devkit/index"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "ngcli_adapter",
|
"id": "ngcli_adapter",
|
||||||
"name": "ngcli_adapter",
|
"name": "Ng CLI Adapter",
|
||||||
"searchResultsName": "Ng CLI Adapter",
|
"searchResultsName": "Ng CLI Adapter",
|
||||||
"file": "angular/api-nx-devkit/ngcli_adapter"
|
"file": "angular/api-nx-devkit/ngcli_adapter"
|
||||||
}
|
}
|
||||||
@ -2348,13 +2348,13 @@
|
|||||||
"itemList": [
|
"itemList": [
|
||||||
{
|
{
|
||||||
"id": "index",
|
"id": "index",
|
||||||
"name": "index",
|
"name": "Overview",
|
||||||
"searchResultsName": "Nx Devkit",
|
"searchResultsName": "Nx Devkit",
|
||||||
"file": "react/api-nx-devkit/index"
|
"file": "react/api-nx-devkit/index"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "ngcli_adapter",
|
"id": "ngcli_adapter",
|
||||||
"name": "ngcli_adapter",
|
"name": "Ng CLI Adapter",
|
||||||
"searchResultsName": "Ng CLI Adapter",
|
"searchResultsName": "Ng CLI Adapter",
|
||||||
"file": "react/api-nx-devkit/ngcli_adapter"
|
"file": "react/api-nx-devkit/ngcli_adapter"
|
||||||
}
|
}
|
||||||
@ -3562,13 +3562,13 @@
|
|||||||
"itemList": [
|
"itemList": [
|
||||||
{
|
{
|
||||||
"id": "index",
|
"id": "index",
|
||||||
"name": "index",
|
"name": "Overview",
|
||||||
"searchResultsName": "Nx Devkit",
|
"searchResultsName": "Nx Devkit",
|
||||||
"file": "node/api-nx-devkit/index"
|
"file": "node/api-nx-devkit/index"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "ngcli_adapter",
|
"id": "ngcli_adapter",
|
||||||
"name": "ngcli_adapter",
|
"name": "Ng CLI Adapter",
|
||||||
"searchResultsName": "Ng CLI Adapter",
|
"searchResultsName": "Ng CLI Adapter",
|
||||||
"file": "node/api-nx-devkit/ngcli_adapter"
|
"file": "node/api-nx-devkit/ngcli_adapter"
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,58 +1,91 @@
|
|||||||
# Module: index
|
# Module: index
|
||||||
|
|
||||||
|
The Nx Devkit is the underlying technology used to customize Nx to support
|
||||||
|
different technologies and custom use-cases. It contains many utility
|
||||||
|
functions for reading and writing files, updating configuration,
|
||||||
|
working with Abstract Syntax Trees(ASTs), and more.
|
||||||
|
|
||||||
|
As with most things in Nx, the core of Nx Devkit is very simple.
|
||||||
|
It only uses language primitives and immutable objects
|
||||||
|
(the tree being the only exception).
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Enumerations
|
### Project Graph Enumerations
|
||||||
|
|
||||||
- [ChangeType](../../node/nx-devkit/index#changetype)
|
|
||||||
- [DependencyType](../../node/nx-devkit/index#dependencytype)
|
- [DependencyType](../../node/nx-devkit/index#dependencytype)
|
||||||
|
|
||||||
### Classes
|
### Utils Enumerations
|
||||||
|
|
||||||
|
- [ChangeType](../../node/nx-devkit/index#changetype)
|
||||||
|
|
||||||
|
### Project Graph Classes
|
||||||
|
|
||||||
- [ProjectGraphBuilder](../../node/nx-devkit/index#projectgraphbuilder)
|
- [ProjectGraphBuilder](../../node/nx-devkit/index#projectgraphbuilder)
|
||||||
|
|
||||||
### Interfaces
|
### Commands Interfaces
|
||||||
|
|
||||||
|
- [Target](../../node/nx-devkit/index#target)
|
||||||
|
|
||||||
|
### Project Graph Interfaces
|
||||||
|
|
||||||
- [ExecutorContext](../../node/nx-devkit/index#executorcontext)
|
|
||||||
- [FileChange](../../node/nx-devkit/index#filechange)
|
|
||||||
- [FileData](../../node/nx-devkit/index#filedata)
|
- [FileData](../../node/nx-devkit/index#filedata)
|
||||||
- [ImplicitJsonSubsetDependency](../../node/nx-devkit/index#implicitjsonsubsetdependency)
|
|
||||||
- [JsonParseOptions](../../node/nx-devkit/index#jsonparseoptions)
|
|
||||||
- [JsonSerializeOptions](../../node/nx-devkit/index#jsonserializeoptions)
|
|
||||||
- [NxAffectedConfig](../../node/nx-devkit/index#nxaffectedconfig)
|
|
||||||
- [NxJsonConfiguration](../../node/nx-devkit/index#nxjsonconfiguration)
|
|
||||||
- [NxJsonProjectConfiguration](../../node/nx-devkit/index#nxjsonprojectconfiguration)
|
|
||||||
- [NxPlugin](../../node/nx-devkit/index#nxplugin)
|
- [NxPlugin](../../node/nx-devkit/index#nxplugin)
|
||||||
- [ProjectConfiguration](../../node/nx-devkit/index#projectconfiguration)
|
|
||||||
- [ProjectFileMap](../../node/nx-devkit/index#projectfilemap)
|
- [ProjectFileMap](../../node/nx-devkit/index#projectfilemap)
|
||||||
- [ProjectGraph](../../node/nx-devkit/index#projectgraph)
|
- [ProjectGraph](../../node/nx-devkit/index#projectgraph)
|
||||||
- [ProjectGraphDependency](../../node/nx-devkit/index#projectgraphdependency)
|
- [ProjectGraphDependency](../../node/nx-devkit/index#projectgraphdependency)
|
||||||
- [ProjectGraphNode](../../node/nx-devkit/index#projectgraphnode)
|
- [ProjectGraphNode](../../node/nx-devkit/index#projectgraphnode)
|
||||||
- [ProjectGraphProcessorContext](../../node/nx-devkit/index#projectgraphprocessorcontext)
|
- [ProjectGraphProcessorContext](../../node/nx-devkit/index#projectgraphprocessorcontext)
|
||||||
|
|
||||||
|
### Tree Interfaces
|
||||||
|
|
||||||
|
- [FileChange](../../node/nx-devkit/index#filechange)
|
||||||
|
- [Tree](../../node/nx-devkit/index#tree)
|
||||||
|
|
||||||
|
### Utils Interfaces
|
||||||
|
|
||||||
|
- [JsonParseOptions](../../node/nx-devkit/index#jsonparseoptions)
|
||||||
|
- [JsonSerializeOptions](../../node/nx-devkit/index#jsonserializeoptions)
|
||||||
- [StringDeletion](../../node/nx-devkit/index#stringdeletion)
|
- [StringDeletion](../../node/nx-devkit/index#stringdeletion)
|
||||||
- [StringInsertion](../../node/nx-devkit/index#stringinsertion)
|
- [StringInsertion](../../node/nx-devkit/index#stringinsertion)
|
||||||
- [Target](../../node/nx-devkit/index#target)
|
|
||||||
|
### Workspace Interfaces
|
||||||
|
|
||||||
|
- [ExecutorContext](../../node/nx-devkit/index#executorcontext)
|
||||||
|
- [ImplicitJsonSubsetDependency](../../node/nx-devkit/index#implicitjsonsubsetdependency)
|
||||||
|
- [NxAffectedConfig](../../node/nx-devkit/index#nxaffectedconfig)
|
||||||
|
- [NxJsonConfiguration](../../node/nx-devkit/index#nxjsonconfiguration)
|
||||||
|
- [NxJsonProjectConfiguration](../../node/nx-devkit/index#nxjsonprojectconfiguration)
|
||||||
|
- [ProjectConfiguration](../../node/nx-devkit/index#projectconfiguration)
|
||||||
- [TargetConfiguration](../../node/nx-devkit/index#targetconfiguration)
|
- [TargetConfiguration](../../node/nx-devkit/index#targetconfiguration)
|
||||||
- [TargetDependencyConfig](../../node/nx-devkit/index#targetdependencyconfig)
|
- [TargetDependencyConfig](../../node/nx-devkit/index#targetdependencyconfig)
|
||||||
- [Task](../../node/nx-devkit/index#task)
|
- [Task](../../node/nx-devkit/index#task)
|
||||||
- [TaskGraph](../../node/nx-devkit/index#taskgraph)
|
- [TaskGraph](../../node/nx-devkit/index#taskgraph)
|
||||||
- [Tree](../../node/nx-devkit/index#tree)
|
|
||||||
- [Workspace](../../node/nx-devkit/index#workspace)
|
- [Workspace](../../node/nx-devkit/index#workspace)
|
||||||
- [WorkspaceJsonConfiguration](../../node/nx-devkit/index#workspacejsonconfiguration)
|
- [WorkspaceJsonConfiguration](../../node/nx-devkit/index#workspacejsonconfiguration)
|
||||||
|
|
||||||
### Type aliases
|
### Generators Type aliases
|
||||||
|
|
||||||
|
- [WorkspaceConfiguration](../../node/nx-devkit/index#workspaceconfiguration)
|
||||||
|
|
||||||
|
### Package Manager Type aliases
|
||||||
|
|
||||||
|
- [PackageManager](../../node/nx-devkit/index#packagemanager)
|
||||||
|
|
||||||
|
### Utils Type aliases
|
||||||
|
|
||||||
|
- [StringChange](../../node/nx-devkit/index#stringchange)
|
||||||
|
|
||||||
|
### Workspace Type aliases
|
||||||
|
|
||||||
- [Executor](../../node/nx-devkit/index#executor)
|
- [Executor](../../node/nx-devkit/index#executor)
|
||||||
- [Generator](../../node/nx-devkit/index#generator)
|
- [Generator](../../node/nx-devkit/index#generator)
|
||||||
- [GeneratorCallback](../../node/nx-devkit/index#generatorcallback)
|
- [GeneratorCallback](../../node/nx-devkit/index#generatorcallback)
|
||||||
- [ImplicitDependencyEntry](../../node/nx-devkit/index#implicitdependencyentry)
|
- [ImplicitDependencyEntry](../../node/nx-devkit/index#implicitdependencyentry)
|
||||||
- [PackageManager](../../node/nx-devkit/index#packagemanager)
|
|
||||||
- [ProjectType](../../node/nx-devkit/index#projecttype)
|
- [ProjectType](../../node/nx-devkit/index#projecttype)
|
||||||
- [StringChange](../../node/nx-devkit/index#stringchange)
|
|
||||||
- [TaskGraphExecutor](../../node/nx-devkit/index#taskgraphexecutor)
|
- [TaskGraphExecutor](../../node/nx-devkit/index#taskgraphexecutor)
|
||||||
- [WorkspaceConfiguration](../../node/nx-devkit/index#workspaceconfiguration)
|
|
||||||
|
|
||||||
### Variables
|
### Logger Variables
|
||||||
|
|
||||||
- [logger](../../node/nx-devkit/index#logger)
|
- [logger](../../node/nx-devkit/index#logger)
|
||||||
|
|
||||||
@ -101,134 +134,58 @@
|
|||||||
- [writeJson](../../node/nx-devkit/index#writejson)
|
- [writeJson](../../node/nx-devkit/index#writejson)
|
||||||
- [writeJsonFile](../../node/nx-devkit/index#writejsonfile)
|
- [writeJsonFile](../../node/nx-devkit/index#writejsonfile)
|
||||||
|
|
||||||
## Enumerations
|
## Project Graph Enumerations
|
||||||
|
|
||||||
### ChangeType
|
|
||||||
|
|
||||||
• **ChangeType**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### DependencyType
|
### DependencyType
|
||||||
|
|
||||||
• **DependencyType**: `Object`
|
• **DependencyType**: `Object`
|
||||||
|
|
||||||
Type of dependency between projects
|
---
|
||||||
|
|
||||||
## Classes
|
## Utils Enumerations
|
||||||
|
|
||||||
|
### ChangeType
|
||||||
|
|
||||||
|
• **ChangeType**: `Object`
|
||||||
|
|
||||||
|
## Project Graph Classes
|
||||||
|
|
||||||
### ProjectGraphBuilder
|
### ProjectGraphBuilder
|
||||||
|
|
||||||
• **ProjectGraphBuilder**: `Object`
|
• **ProjectGraphBuilder**: `Object`
|
||||||
|
|
||||||
Builder for adding nodes and dependencies to a [ProjectGraph](../../node/nx-devkit/index#projectgraph)
|
## Commands Interfaces
|
||||||
|
|
||||||
## Interfaces
|
### Target
|
||||||
|
|
||||||
### ExecutorContext
|
• **Target**: `Object`
|
||||||
|
|
||||||
• **ExecutorContext**: `Object`
|
|
||||||
|
|
||||||
Context that is passed into an executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### FileChange
|
## Project Graph Interfaces
|
||||||
|
|
||||||
• **FileChange**: `Object`
|
|
||||||
|
|
||||||
Description of a file change in the Nx virtual file system/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### FileData
|
### FileData
|
||||||
|
|
||||||
• **FileData**: `Object`
|
• **FileData**: `Object`
|
||||||
|
|
||||||
Some metadata about a file
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ImplicitJsonSubsetDependency
|
|
||||||
|
|
||||||
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonParseOptions
|
|
||||||
|
|
||||||
• **JsonParseOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonSerializeOptions
|
|
||||||
|
|
||||||
• **JsonSerializeOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxAffectedConfig
|
|
||||||
|
|
||||||
• **NxAffectedConfig**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonConfiguration
|
|
||||||
|
|
||||||
• **NxJsonConfiguration**<`T`\>: `Object`
|
|
||||||
|
|
||||||
Nx.json configuration
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonProjectConfiguration
|
|
||||||
|
|
||||||
• **NxJsonProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### NxPlugin
|
### NxPlugin
|
||||||
|
|
||||||
• **NxPlugin**: `Object`
|
• **NxPlugin**: `Object`
|
||||||
|
|
||||||
A plugin for Nx
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectConfiguration
|
|
||||||
|
|
||||||
• **ProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
Project configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectFileMap
|
### ProjectFileMap
|
||||||
|
|
||||||
• **ProjectFileMap**: `Object`
|
• **ProjectFileMap**: `Object`
|
||||||
|
|
||||||
A list of files separated by the project they belong to
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraph
|
### ProjectGraph
|
||||||
|
|
||||||
• **ProjectGraph**<`T`\>: `Object`
|
• **ProjectGraph**<`T`\>: `Object`
|
||||||
|
|
||||||
A Graph of projects in the workspace and dependencies between them
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -241,16 +198,12 @@ A Graph of projects in the workspace and dependencies between them
|
|||||||
|
|
||||||
• **ProjectGraphDependency**: `Object`
|
• **ProjectGraphDependency**: `Object`
|
||||||
|
|
||||||
A dependency between two projects
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraphNode
|
### ProjectGraphNode
|
||||||
|
|
||||||
• **ProjectGraphNode**<`T`\>: `Object`
|
• **ProjectGraphNode**<`T`\>: `Object`
|
||||||
|
|
||||||
A node describing a project in a workspace
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -263,7 +216,33 @@ A node describing a project in a workspace
|
|||||||
|
|
||||||
• **ProjectGraphProcessorContext**: `Object`
|
• **ProjectGraphProcessorContext**: `Object`
|
||||||
|
|
||||||
Additional information to be used to process a project graph
|
---
|
||||||
|
|
||||||
|
## Tree Interfaces
|
||||||
|
|
||||||
|
### FileChange
|
||||||
|
|
||||||
|
• **FileChange**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Tree
|
||||||
|
|
||||||
|
• **Tree**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Interfaces
|
||||||
|
|
||||||
|
### JsonParseOptions
|
||||||
|
|
||||||
|
• **JsonParseOptions**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### JsonSerializeOptions
|
||||||
|
|
||||||
|
• **JsonSerializeOptions**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -279,9 +258,53 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Target
|
## Workspace Interfaces
|
||||||
|
|
||||||
• **Target**: `Object`
|
### ExecutorContext
|
||||||
|
|
||||||
|
• **ExecutorContext**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ImplicitJsonSubsetDependency
|
||||||
|
|
||||||
|
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxAffectedConfig
|
||||||
|
|
||||||
|
• **NxAffectedConfig**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonConfiguration
|
||||||
|
|
||||||
|
• **NxJsonConfiguration**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonProjectConfiguration
|
||||||
|
|
||||||
|
• **NxJsonProjectConfiguration**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ProjectConfiguration
|
||||||
|
|
||||||
|
• **ProjectConfiguration**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -289,8 +312,6 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
• **TargetConfiguration**: `Object`
|
• **TargetConfiguration**: `Object`
|
||||||
|
|
||||||
Target's configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TargetDependencyConfig
|
### TargetDependencyConfig
|
||||||
@ -303,24 +324,12 @@ Target's configuration
|
|||||||
|
|
||||||
• **Task**: `Object`
|
• **Task**: `Object`
|
||||||
|
|
||||||
A representation of the invocation of an Executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraph
|
### TaskGraph
|
||||||
|
|
||||||
• **TaskGraph**: `Object`
|
• **TaskGraph**: `Object`
|
||||||
|
|
||||||
Graph of Tasks to be executed
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Tree
|
|
||||||
|
|
||||||
• **Tree**: `Object`
|
|
||||||
|
|
||||||
Virtual file system tree.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Workspace
|
### Workspace
|
||||||
@ -333,9 +342,31 @@ Virtual file system tree.
|
|||||||
|
|
||||||
• **WorkspaceJsonConfiguration**: `Object`
|
• **WorkspaceJsonConfiguration**: `Object`
|
||||||
|
|
||||||
Workspace configuration
|
## Generators Type aliases
|
||||||
|
|
||||||
## Type aliases
|
### WorkspaceConfiguration
|
||||||
|
|
||||||
|
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../node/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../node/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Package Manager Type aliases
|
||||||
|
|
||||||
|
### PackageManager
|
||||||
|
|
||||||
|
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Type aliases
|
||||||
|
|
||||||
|
### StringChange
|
||||||
|
|
||||||
|
Ƭ **StringChange**: [`StringInsertion`](../../node/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../node/nx-devkit/index#stringdeletion)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workspace Type aliases
|
||||||
|
|
||||||
### Executor
|
### Executor
|
||||||
|
|
||||||
@ -427,26 +458,10 @@ A callback function that is executed after changes are made to the file system
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### PackageManager
|
|
||||||
|
|
||||||
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectType
|
### ProjectType
|
||||||
|
|
||||||
Ƭ **ProjectType**: `"library"` \| `"application"`
|
Ƭ **ProjectType**: `"library"` \| `"application"`
|
||||||
|
|
||||||
Type of project supported
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### StringChange
|
|
||||||
|
|
||||||
Ƭ **StringChange**: [`StringInsertion`](../../node/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../node/nx-devkit/index#stringdeletion)
|
|
||||||
|
|
||||||
A change to be made to a string
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraphExecutor
|
### TaskGraphExecutor
|
||||||
@ -478,13 +493,7 @@ Implementation of a target of a project that handles multiple projects to be bat
|
|||||||
|
|
||||||
`Promise`<`Record`<`string`, `Object`\>\>
|
`Promise`<`Record`<`string`, `Object`\>\>
|
||||||
|
|
||||||
---
|
## Logger Variables
|
||||||
|
|
||||||
### WorkspaceConfiguration
|
|
||||||
|
|
||||||
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../node/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../node/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
### logger
|
### logger
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Classes
|
### Ng CLI Adapter Classes
|
||||||
|
|
||||||
- [NxScopedHost](../../node/nx-devkit/ngcli_adapter#nxscopedhost)
|
- [NxScopedHost](../../node/nx-devkit/ngcli_adapter#nxscopedhost)
|
||||||
|
|
||||||
@ -12,7 +12,7 @@
|
|||||||
- [overrideCollectionResolutionForTesting](../../node/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
- [overrideCollectionResolutionForTesting](../../node/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
||||||
- [wrapAngularDevkitSchematic](../../node/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
- [wrapAngularDevkitSchematic](../../node/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
||||||
|
|
||||||
## Classes
|
## Ng CLI Adapter Classes
|
||||||
|
|
||||||
### NxScopedHost
|
### NxScopedHost
|
||||||
|
|
||||||
|
|||||||
@ -32,8 +32,6 @@ List of static application assets.
|
|||||||
|
|
||||||
### baseHref
|
### baseHref
|
||||||
|
|
||||||
Default: `/`
|
|
||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Base url for the application being built.
|
Base url for the application being built.
|
||||||
|
|||||||
@ -102,6 +102,12 @@ Default: `false`
|
|||||||
|
|
||||||
Isolate projects which previously failed
|
Isolate projects which previously failed
|
||||||
|
|
||||||
|
### open
|
||||||
|
|
||||||
|
Default: `true`
|
||||||
|
|
||||||
|
Open the dependency graph in the browser.
|
||||||
|
|
||||||
### port
|
### port
|
||||||
|
|
||||||
Bind the dependecy graph server to a specific port.
|
Bind the dependecy graph server to a specific port.
|
||||||
|
|||||||
@ -86,6 +86,12 @@ Show help
|
|||||||
|
|
||||||
Bind the dependency graph server to a specific ip address.
|
Bind the dependency graph server to a specific ip address.
|
||||||
|
|
||||||
|
### open
|
||||||
|
|
||||||
|
Default: `true`
|
||||||
|
|
||||||
|
Open the dependency graph in the browser.
|
||||||
|
|
||||||
### port
|
### port
|
||||||
|
|
||||||
Bind the dependecy graph server to a specific port.
|
Bind the dependecy graph server to a specific port.
|
||||||
|
|||||||
@ -1,58 +1,91 @@
|
|||||||
# Module: index
|
# Module: index
|
||||||
|
|
||||||
|
The Nx Devkit is the underlying technology used to customize Nx to support
|
||||||
|
different technologies and custom use-cases. It contains many utility
|
||||||
|
functions for reading and writing files, updating configuration,
|
||||||
|
working with Abstract Syntax Trees(ASTs), and more.
|
||||||
|
|
||||||
|
As with most things in Nx, the core of Nx Devkit is very simple.
|
||||||
|
It only uses language primitives and immutable objects
|
||||||
|
(the tree being the only exception).
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Enumerations
|
### Project Graph Enumerations
|
||||||
|
|
||||||
- [ChangeType](../../react/nx-devkit/index#changetype)
|
|
||||||
- [DependencyType](../../react/nx-devkit/index#dependencytype)
|
- [DependencyType](../../react/nx-devkit/index#dependencytype)
|
||||||
|
|
||||||
### Classes
|
### Utils Enumerations
|
||||||
|
|
||||||
|
- [ChangeType](../../react/nx-devkit/index#changetype)
|
||||||
|
|
||||||
|
### Project Graph Classes
|
||||||
|
|
||||||
- [ProjectGraphBuilder](../../react/nx-devkit/index#projectgraphbuilder)
|
- [ProjectGraphBuilder](../../react/nx-devkit/index#projectgraphbuilder)
|
||||||
|
|
||||||
### Interfaces
|
### Commands Interfaces
|
||||||
|
|
||||||
|
- [Target](../../react/nx-devkit/index#target)
|
||||||
|
|
||||||
|
### Project Graph Interfaces
|
||||||
|
|
||||||
- [ExecutorContext](../../react/nx-devkit/index#executorcontext)
|
|
||||||
- [FileChange](../../react/nx-devkit/index#filechange)
|
|
||||||
- [FileData](../../react/nx-devkit/index#filedata)
|
- [FileData](../../react/nx-devkit/index#filedata)
|
||||||
- [ImplicitJsonSubsetDependency](../../react/nx-devkit/index#implicitjsonsubsetdependency)
|
|
||||||
- [JsonParseOptions](../../react/nx-devkit/index#jsonparseoptions)
|
|
||||||
- [JsonSerializeOptions](../../react/nx-devkit/index#jsonserializeoptions)
|
|
||||||
- [NxAffectedConfig](../../react/nx-devkit/index#nxaffectedconfig)
|
|
||||||
- [NxJsonConfiguration](../../react/nx-devkit/index#nxjsonconfiguration)
|
|
||||||
- [NxJsonProjectConfiguration](../../react/nx-devkit/index#nxjsonprojectconfiguration)
|
|
||||||
- [NxPlugin](../../react/nx-devkit/index#nxplugin)
|
- [NxPlugin](../../react/nx-devkit/index#nxplugin)
|
||||||
- [ProjectConfiguration](../../react/nx-devkit/index#projectconfiguration)
|
|
||||||
- [ProjectFileMap](../../react/nx-devkit/index#projectfilemap)
|
- [ProjectFileMap](../../react/nx-devkit/index#projectfilemap)
|
||||||
- [ProjectGraph](../../react/nx-devkit/index#projectgraph)
|
- [ProjectGraph](../../react/nx-devkit/index#projectgraph)
|
||||||
- [ProjectGraphDependency](../../react/nx-devkit/index#projectgraphdependency)
|
- [ProjectGraphDependency](../../react/nx-devkit/index#projectgraphdependency)
|
||||||
- [ProjectGraphNode](../../react/nx-devkit/index#projectgraphnode)
|
- [ProjectGraphNode](../../react/nx-devkit/index#projectgraphnode)
|
||||||
- [ProjectGraphProcessorContext](../../react/nx-devkit/index#projectgraphprocessorcontext)
|
- [ProjectGraphProcessorContext](../../react/nx-devkit/index#projectgraphprocessorcontext)
|
||||||
|
|
||||||
|
### Tree Interfaces
|
||||||
|
|
||||||
|
- [FileChange](../../react/nx-devkit/index#filechange)
|
||||||
|
- [Tree](../../react/nx-devkit/index#tree)
|
||||||
|
|
||||||
|
### Utils Interfaces
|
||||||
|
|
||||||
|
- [JsonParseOptions](../../react/nx-devkit/index#jsonparseoptions)
|
||||||
|
- [JsonSerializeOptions](../../react/nx-devkit/index#jsonserializeoptions)
|
||||||
- [StringDeletion](../../react/nx-devkit/index#stringdeletion)
|
- [StringDeletion](../../react/nx-devkit/index#stringdeletion)
|
||||||
- [StringInsertion](../../react/nx-devkit/index#stringinsertion)
|
- [StringInsertion](../../react/nx-devkit/index#stringinsertion)
|
||||||
- [Target](../../react/nx-devkit/index#target)
|
|
||||||
|
### Workspace Interfaces
|
||||||
|
|
||||||
|
- [ExecutorContext](../../react/nx-devkit/index#executorcontext)
|
||||||
|
- [ImplicitJsonSubsetDependency](../../react/nx-devkit/index#implicitjsonsubsetdependency)
|
||||||
|
- [NxAffectedConfig](../../react/nx-devkit/index#nxaffectedconfig)
|
||||||
|
- [NxJsonConfiguration](../../react/nx-devkit/index#nxjsonconfiguration)
|
||||||
|
- [NxJsonProjectConfiguration](../../react/nx-devkit/index#nxjsonprojectconfiguration)
|
||||||
|
- [ProjectConfiguration](../../react/nx-devkit/index#projectconfiguration)
|
||||||
- [TargetConfiguration](../../react/nx-devkit/index#targetconfiguration)
|
- [TargetConfiguration](../../react/nx-devkit/index#targetconfiguration)
|
||||||
- [TargetDependencyConfig](../../react/nx-devkit/index#targetdependencyconfig)
|
- [TargetDependencyConfig](../../react/nx-devkit/index#targetdependencyconfig)
|
||||||
- [Task](../../react/nx-devkit/index#task)
|
- [Task](../../react/nx-devkit/index#task)
|
||||||
- [TaskGraph](../../react/nx-devkit/index#taskgraph)
|
- [TaskGraph](../../react/nx-devkit/index#taskgraph)
|
||||||
- [Tree](../../react/nx-devkit/index#tree)
|
|
||||||
- [Workspace](../../react/nx-devkit/index#workspace)
|
- [Workspace](../../react/nx-devkit/index#workspace)
|
||||||
- [WorkspaceJsonConfiguration](../../react/nx-devkit/index#workspacejsonconfiguration)
|
- [WorkspaceJsonConfiguration](../../react/nx-devkit/index#workspacejsonconfiguration)
|
||||||
|
|
||||||
### Type aliases
|
### Generators Type aliases
|
||||||
|
|
||||||
|
- [WorkspaceConfiguration](../../react/nx-devkit/index#workspaceconfiguration)
|
||||||
|
|
||||||
|
### Package Manager Type aliases
|
||||||
|
|
||||||
|
- [PackageManager](../../react/nx-devkit/index#packagemanager)
|
||||||
|
|
||||||
|
### Utils Type aliases
|
||||||
|
|
||||||
|
- [StringChange](../../react/nx-devkit/index#stringchange)
|
||||||
|
|
||||||
|
### Workspace Type aliases
|
||||||
|
|
||||||
- [Executor](../../react/nx-devkit/index#executor)
|
- [Executor](../../react/nx-devkit/index#executor)
|
||||||
- [Generator](../../react/nx-devkit/index#generator)
|
- [Generator](../../react/nx-devkit/index#generator)
|
||||||
- [GeneratorCallback](../../react/nx-devkit/index#generatorcallback)
|
- [GeneratorCallback](../../react/nx-devkit/index#generatorcallback)
|
||||||
- [ImplicitDependencyEntry](../../react/nx-devkit/index#implicitdependencyentry)
|
- [ImplicitDependencyEntry](../../react/nx-devkit/index#implicitdependencyentry)
|
||||||
- [PackageManager](../../react/nx-devkit/index#packagemanager)
|
|
||||||
- [ProjectType](../../react/nx-devkit/index#projecttype)
|
- [ProjectType](../../react/nx-devkit/index#projecttype)
|
||||||
- [StringChange](../../react/nx-devkit/index#stringchange)
|
|
||||||
- [TaskGraphExecutor](../../react/nx-devkit/index#taskgraphexecutor)
|
- [TaskGraphExecutor](../../react/nx-devkit/index#taskgraphexecutor)
|
||||||
- [WorkspaceConfiguration](../../react/nx-devkit/index#workspaceconfiguration)
|
|
||||||
|
|
||||||
### Variables
|
### Logger Variables
|
||||||
|
|
||||||
- [logger](../../react/nx-devkit/index#logger)
|
- [logger](../../react/nx-devkit/index#logger)
|
||||||
|
|
||||||
@ -101,134 +134,58 @@
|
|||||||
- [writeJson](../../react/nx-devkit/index#writejson)
|
- [writeJson](../../react/nx-devkit/index#writejson)
|
||||||
- [writeJsonFile](../../react/nx-devkit/index#writejsonfile)
|
- [writeJsonFile](../../react/nx-devkit/index#writejsonfile)
|
||||||
|
|
||||||
## Enumerations
|
## Project Graph Enumerations
|
||||||
|
|
||||||
### ChangeType
|
|
||||||
|
|
||||||
• **ChangeType**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### DependencyType
|
### DependencyType
|
||||||
|
|
||||||
• **DependencyType**: `Object`
|
• **DependencyType**: `Object`
|
||||||
|
|
||||||
Type of dependency between projects
|
---
|
||||||
|
|
||||||
## Classes
|
## Utils Enumerations
|
||||||
|
|
||||||
|
### ChangeType
|
||||||
|
|
||||||
|
• **ChangeType**: `Object`
|
||||||
|
|
||||||
|
## Project Graph Classes
|
||||||
|
|
||||||
### ProjectGraphBuilder
|
### ProjectGraphBuilder
|
||||||
|
|
||||||
• **ProjectGraphBuilder**: `Object`
|
• **ProjectGraphBuilder**: `Object`
|
||||||
|
|
||||||
Builder for adding nodes and dependencies to a [ProjectGraph](../../react/nx-devkit/index#projectgraph)
|
## Commands Interfaces
|
||||||
|
|
||||||
## Interfaces
|
### Target
|
||||||
|
|
||||||
### ExecutorContext
|
• **Target**: `Object`
|
||||||
|
|
||||||
• **ExecutorContext**: `Object`
|
|
||||||
|
|
||||||
Context that is passed into an executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### FileChange
|
## Project Graph Interfaces
|
||||||
|
|
||||||
• **FileChange**: `Object`
|
|
||||||
|
|
||||||
Description of a file change in the Nx virtual file system/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### FileData
|
### FileData
|
||||||
|
|
||||||
• **FileData**: `Object`
|
• **FileData**: `Object`
|
||||||
|
|
||||||
Some metadata about a file
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ImplicitJsonSubsetDependency
|
|
||||||
|
|
||||||
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonParseOptions
|
|
||||||
|
|
||||||
• **JsonParseOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### JsonSerializeOptions
|
|
||||||
|
|
||||||
• **JsonSerializeOptions**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxAffectedConfig
|
|
||||||
|
|
||||||
• **NxAffectedConfig**: `Object`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonConfiguration
|
|
||||||
|
|
||||||
• **NxJsonConfiguration**<`T`\>: `Object`
|
|
||||||
|
|
||||||
Nx.json configuration
|
|
||||||
|
|
||||||
#### Type parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :--- | :------------------ |
|
|
||||||
| `T` | `"*"` \| `string`[] |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### NxJsonProjectConfiguration
|
|
||||||
|
|
||||||
• **NxJsonProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### NxPlugin
|
### NxPlugin
|
||||||
|
|
||||||
• **NxPlugin**: `Object`
|
• **NxPlugin**: `Object`
|
||||||
|
|
||||||
A plugin for Nx
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectConfiguration
|
|
||||||
|
|
||||||
• **ProjectConfiguration**: `Object`
|
|
||||||
|
|
||||||
Project configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectFileMap
|
### ProjectFileMap
|
||||||
|
|
||||||
• **ProjectFileMap**: `Object`
|
• **ProjectFileMap**: `Object`
|
||||||
|
|
||||||
A list of files separated by the project they belong to
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraph
|
### ProjectGraph
|
||||||
|
|
||||||
• **ProjectGraph**<`T`\>: `Object`
|
• **ProjectGraph**<`T`\>: `Object`
|
||||||
|
|
||||||
A Graph of projects in the workspace and dependencies between them
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -241,16 +198,12 @@ A Graph of projects in the workspace and dependencies between them
|
|||||||
|
|
||||||
• **ProjectGraphDependency**: `Object`
|
• **ProjectGraphDependency**: `Object`
|
||||||
|
|
||||||
A dependency between two projects
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### ProjectGraphNode
|
### ProjectGraphNode
|
||||||
|
|
||||||
• **ProjectGraphNode**<`T`\>: `Object`
|
• **ProjectGraphNode**<`T`\>: `Object`
|
||||||
|
|
||||||
A node describing a project in a workspace
|
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@ -263,7 +216,33 @@ A node describing a project in a workspace
|
|||||||
|
|
||||||
• **ProjectGraphProcessorContext**: `Object`
|
• **ProjectGraphProcessorContext**: `Object`
|
||||||
|
|
||||||
Additional information to be used to process a project graph
|
---
|
||||||
|
|
||||||
|
## Tree Interfaces
|
||||||
|
|
||||||
|
### FileChange
|
||||||
|
|
||||||
|
• **FileChange**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Tree
|
||||||
|
|
||||||
|
• **Tree**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Interfaces
|
||||||
|
|
||||||
|
### JsonParseOptions
|
||||||
|
|
||||||
|
• **JsonParseOptions**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### JsonSerializeOptions
|
||||||
|
|
||||||
|
• **JsonSerializeOptions**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -279,9 +258,53 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Target
|
## Workspace Interfaces
|
||||||
|
|
||||||
• **Target**: `Object`
|
### ExecutorContext
|
||||||
|
|
||||||
|
• **ExecutorContext**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ImplicitJsonSubsetDependency
|
||||||
|
|
||||||
|
• **ImplicitJsonSubsetDependency**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxAffectedConfig
|
||||||
|
|
||||||
|
• **NxAffectedConfig**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonConfiguration
|
||||||
|
|
||||||
|
• **NxJsonConfiguration**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :--- | :------------------ |
|
||||||
|
| `T` | `"*"` \| `string`[] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### NxJsonProjectConfiguration
|
||||||
|
|
||||||
|
• **NxJsonProjectConfiguration**: `Object`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ProjectConfiguration
|
||||||
|
|
||||||
|
• **ProjectConfiguration**: `Object`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -289,8 +312,6 @@ Additional information to be used to process a project graph
|
|||||||
|
|
||||||
• **TargetConfiguration**: `Object`
|
• **TargetConfiguration**: `Object`
|
||||||
|
|
||||||
Target's configuration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TargetDependencyConfig
|
### TargetDependencyConfig
|
||||||
@ -303,24 +324,12 @@ Target's configuration
|
|||||||
|
|
||||||
• **Task**: `Object`
|
• **Task**: `Object`
|
||||||
|
|
||||||
A representation of the invocation of an Executor
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraph
|
### TaskGraph
|
||||||
|
|
||||||
• **TaskGraph**: `Object`
|
• **TaskGraph**: `Object`
|
||||||
|
|
||||||
Graph of Tasks to be executed
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Tree
|
|
||||||
|
|
||||||
• **Tree**: `Object`
|
|
||||||
|
|
||||||
Virtual file system tree.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Workspace
|
### Workspace
|
||||||
@ -333,9 +342,31 @@ Virtual file system tree.
|
|||||||
|
|
||||||
• **WorkspaceJsonConfiguration**: `Object`
|
• **WorkspaceJsonConfiguration**: `Object`
|
||||||
|
|
||||||
Workspace configuration
|
## Generators Type aliases
|
||||||
|
|
||||||
## Type aliases
|
### WorkspaceConfiguration
|
||||||
|
|
||||||
|
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../react/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../react/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Package Manager Type aliases
|
||||||
|
|
||||||
|
### PackageManager
|
||||||
|
|
||||||
|
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Utils Type aliases
|
||||||
|
|
||||||
|
### StringChange
|
||||||
|
|
||||||
|
Ƭ **StringChange**: [`StringInsertion`](../../react/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../react/nx-devkit/index#stringdeletion)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workspace Type aliases
|
||||||
|
|
||||||
### Executor
|
### Executor
|
||||||
|
|
||||||
@ -427,26 +458,10 @@ A callback function that is executed after changes are made to the file system
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### PackageManager
|
|
||||||
|
|
||||||
Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### ProjectType
|
### ProjectType
|
||||||
|
|
||||||
Ƭ **ProjectType**: `"library"` \| `"application"`
|
Ƭ **ProjectType**: `"library"` \| `"application"`
|
||||||
|
|
||||||
Type of project supported
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### StringChange
|
|
||||||
|
|
||||||
Ƭ **StringChange**: [`StringInsertion`](../../react/nx-devkit/index#stringinsertion) \| [`StringDeletion`](../../react/nx-devkit/index#stringdeletion)
|
|
||||||
|
|
||||||
A change to be made to a string
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### TaskGraphExecutor
|
### TaskGraphExecutor
|
||||||
@ -478,13 +493,7 @@ Implementation of a target of a project that handles multiple projects to be bat
|
|||||||
|
|
||||||
`Promise`<`Record`<`string`, `Object`\>\>
|
`Promise`<`Record`<`string`, `Object`\>\>
|
||||||
|
|
||||||
---
|
## Logger Variables
|
||||||
|
|
||||||
### WorkspaceConfiguration
|
|
||||||
|
|
||||||
Ƭ **WorkspaceConfiguration**: `Omit`<[`WorkspaceJsonConfiguration`](../../react/nx-devkit/index#workspacejsonconfiguration), `"projects"`\> & `Partial`<`Omit`<[`NxJsonConfiguration`](../../react/nx-devkit/index#nxjsonconfiguration), `"projects"`\>\>
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
### logger
|
### logger
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
### Classes
|
### Ng CLI Adapter Classes
|
||||||
|
|
||||||
- [NxScopedHost](../../react/nx-devkit/ngcli_adapter#nxscopedhost)
|
- [NxScopedHost](../../react/nx-devkit/ngcli_adapter#nxscopedhost)
|
||||||
|
|
||||||
@ -12,7 +12,7 @@
|
|||||||
- [overrideCollectionResolutionForTesting](../../react/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
- [overrideCollectionResolutionForTesting](../../react/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
|
||||||
- [wrapAngularDevkitSchematic](../../react/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
- [wrapAngularDevkitSchematic](../../react/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
|
||||||
|
|
||||||
## Classes
|
## Ng CLI Adapter Classes
|
||||||
|
|
||||||
### NxScopedHost
|
### NxScopedHost
|
||||||
|
|
||||||
|
|||||||
@ -32,8 +32,6 @@ List of static application assets.
|
|||||||
|
|
||||||
### baseHref
|
### baseHref
|
||||||
|
|
||||||
Default: `/`
|
|
||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Base url for the application being built.
|
Base url for the application being built.
|
||||||
|
|||||||
@ -102,6 +102,12 @@ Default: `false`
|
|||||||
|
|
||||||
Isolate projects which previously failed
|
Isolate projects which previously failed
|
||||||
|
|
||||||
|
### open
|
||||||
|
|
||||||
|
Default: `true`
|
||||||
|
|
||||||
|
Open the dependency graph in the browser.
|
||||||
|
|
||||||
### port
|
### port
|
||||||
|
|
||||||
Bind the dependecy graph server to a specific port.
|
Bind the dependecy graph server to a specific port.
|
||||||
|
|||||||
@ -86,6 +86,12 @@ Show help
|
|||||||
|
|
||||||
Bind the dependency graph server to a specific ip address.
|
Bind the dependency graph server to a specific ip address.
|
||||||
|
|
||||||
|
### open
|
||||||
|
|
||||||
|
Default: `true`
|
||||||
|
|
||||||
|
Open the dependency graph in the browser.
|
||||||
|
|
||||||
### port
|
### port
|
||||||
|
|
||||||
Bind the dependecy graph server to a specific port.
|
Bind the dependecy graph server to a specific port.
|
||||||
|
|||||||
@ -1,4 +1,22 @@
|
|||||||
|
/**
|
||||||
|
* The Nx Devkit is the underlying technology used to customize Nx to support
|
||||||
|
* different technologies and custom use-cases. It contains many utility
|
||||||
|
* functions for reading and writing files, updating configuration,
|
||||||
|
* working with Abstract Syntax Trees(ASTs), and more.
|
||||||
|
*
|
||||||
|
* As with most things in Nx, the core of Nx Devkit is very simple.
|
||||||
|
* It only uses language primitives and immutable objects
|
||||||
|
* (the tree being the only exception).
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Tree
|
||||||
|
*/
|
||||||
export type { Tree, FileChange } from '@nrwl/tao/src/shared/tree';
|
export type { Tree, FileChange } from '@nrwl/tao/src/shared/tree';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Workspace
|
||||||
|
*/
|
||||||
export type {
|
export type {
|
||||||
WorkspaceJsonConfiguration,
|
WorkspaceJsonConfiguration,
|
||||||
TargetDependencyConfig,
|
TargetDependencyConfig,
|
||||||
@ -12,7 +30,15 @@ export type {
|
|||||||
TaskGraphExecutor,
|
TaskGraphExecutor,
|
||||||
Workspace,
|
Workspace,
|
||||||
} from '@nrwl/tao/src/shared/workspace';
|
} from '@nrwl/tao/src/shared/workspace';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Workspace
|
||||||
|
*/
|
||||||
export type { Task, TaskGraph } from '@nrwl/tao/src/shared/tasks';
|
export type { Task, TaskGraph } from '@nrwl/tao/src/shared/tasks';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Workspace
|
||||||
|
*/
|
||||||
export type {
|
export type {
|
||||||
ImplicitDependencyEntry,
|
ImplicitDependencyEntry,
|
||||||
ImplicitJsonSubsetDependency,
|
ImplicitJsonSubsetDependency,
|
||||||
@ -20,19 +46,53 @@ export type {
|
|||||||
NxJsonProjectConfiguration,
|
NxJsonProjectConfiguration,
|
||||||
NxAffectedConfig,
|
NxAffectedConfig,
|
||||||
} from '@nrwl/tao/src/shared/nx';
|
} from '@nrwl/tao/src/shared/nx';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Logger
|
||||||
|
*/
|
||||||
export { logger } from '@nrwl/tao/src/shared/logger';
|
export { logger } from '@nrwl/tao/src/shared/logger';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Package Manager
|
||||||
|
*/
|
||||||
export type { PackageManager } from '@nrwl/tao/src/shared/package-manager';
|
export type { PackageManager } from '@nrwl/tao/src/shared/package-manager';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Package Manager
|
||||||
|
*/
|
||||||
export {
|
export {
|
||||||
getPackageManagerCommand,
|
getPackageManagerCommand,
|
||||||
detectPackageManager,
|
detectPackageManager,
|
||||||
getPackageManagerVersion,
|
getPackageManagerVersion,
|
||||||
} from '@nrwl/tao/src/shared/package-manager';
|
} from '@nrwl/tao/src/shared/package-manager';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Commands
|
||||||
|
*/
|
||||||
export type { Target } from '@nrwl/tao/src/commands/run';
|
export type { Target } from '@nrwl/tao/src/commands/run';
|
||||||
|
/**
|
||||||
|
* @category Commands
|
||||||
|
*/
|
||||||
export { runExecutor } from '@nrwl/tao/src/commands/run';
|
export { runExecutor } from '@nrwl/tao/src/commands/run';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Generators
|
||||||
|
*/
|
||||||
export { formatFiles } from './src/generators/format-files';
|
export { formatFiles } from './src/generators/format-files';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Generators
|
||||||
|
*/
|
||||||
export { generateFiles } from './src/generators/generate-files';
|
export { generateFiles } from './src/generators/generate-files';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Generators
|
||||||
|
*/
|
||||||
export type { WorkspaceConfiguration } from './src/generators/project-configuration';
|
export type { WorkspaceConfiguration } from './src/generators/project-configuration';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Generators
|
||||||
|
*/
|
||||||
export {
|
export {
|
||||||
addProjectConfiguration,
|
addProjectConfiguration,
|
||||||
readProjectConfiguration,
|
readProjectConfiguration,
|
||||||
@ -43,16 +103,38 @@ export {
|
|||||||
getProjects,
|
getProjects,
|
||||||
isStandaloneProject,
|
isStandaloneProject,
|
||||||
} from './src/generators/project-configuration';
|
} from './src/generators/project-configuration';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Generators
|
||||||
|
*/
|
||||||
export { toJS } from './src/generators/to-js';
|
export { toJS } from './src/generators/to-js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Generators
|
||||||
|
*/
|
||||||
export { updateTsConfigsToJs } from './src/generators/update-ts-configs-to-js';
|
export { updateTsConfigsToJs } from './src/generators/update-ts-configs-to-js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Generators
|
||||||
|
*/
|
||||||
export { visitNotIgnoredFiles } from './src/generators/visit-not-ignored-files';
|
export { visitNotIgnoredFiles } from './src/generators/visit-not-ignored-files';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Executors
|
||||||
|
*/
|
||||||
export {
|
export {
|
||||||
parseTargetString,
|
parseTargetString,
|
||||||
targetToTargetString,
|
targetToTargetString,
|
||||||
} from './src/executors/parse-target-string';
|
} from './src/executors/parse-target-string';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Executors
|
||||||
|
*/
|
||||||
export { readTargetOptions } from './src/executors/read-target-options';
|
export { readTargetOptions } from './src/executors/read-target-options';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Project Graph
|
||||||
|
*/
|
||||||
export type {
|
export type {
|
||||||
ProjectFileMap,
|
ProjectFileMap,
|
||||||
FileData,
|
FileData,
|
||||||
@ -62,42 +144,110 @@ export type {
|
|||||||
NxPlugin,
|
NxPlugin,
|
||||||
ProjectGraphProcessorContext,
|
ProjectGraphProcessorContext,
|
||||||
} from './src/project-graph/interfaces';
|
} from './src/project-graph/interfaces';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Project Graph
|
||||||
|
*/
|
||||||
export { DependencyType } from './src/project-graph/interfaces';
|
export { DependencyType } from './src/project-graph/interfaces';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Project Graph
|
||||||
|
*/
|
||||||
export { ProjectGraphBuilder } from './src/project-graph/project-graph-builder';
|
export { ProjectGraphBuilder } from './src/project-graph/project-graph-builder';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { readJson, writeJson, updateJson } from './src/utils/json';
|
export { readJson, writeJson, updateJson } from './src/utils/json';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export {
|
export {
|
||||||
parseJson,
|
parseJson,
|
||||||
serializeJson,
|
serializeJson,
|
||||||
stripJsonComments,
|
stripJsonComments,
|
||||||
} from '@nrwl/tao/src/utils/json';
|
} from '@nrwl/tao/src/utils/json';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export type {
|
export type {
|
||||||
JsonParseOptions,
|
JsonParseOptions,
|
||||||
JsonSerializeOptions,
|
JsonSerializeOptions,
|
||||||
} from '@nrwl/tao/src/utils/json';
|
} from '@nrwl/tao/src/utils/json';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { readJsonFile, writeJsonFile } from '@nrwl/tao/src/utils/fileutils';
|
export { readJsonFile, writeJsonFile } from '@nrwl/tao/src/utils/fileutils';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export {
|
export {
|
||||||
addDependenciesToPackageJson,
|
addDependenciesToPackageJson,
|
||||||
removeDependenciesFromPackageJson,
|
removeDependenciesFromPackageJson,
|
||||||
} from './src/utils/package-json';
|
} from './src/utils/package-json';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { installPackagesTask } from './src/tasks/install-packages-task';
|
export { installPackagesTask } from './src/tasks/install-packages-task';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { names } from './src/utils/names';
|
export { names } from './src/utils/names';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export {
|
export {
|
||||||
getWorkspaceLayout,
|
getWorkspaceLayout,
|
||||||
getWorkspacePath,
|
getWorkspacePath,
|
||||||
} from './src/utils/get-workspace-layout';
|
} from './src/utils/get-workspace-layout';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export type {
|
export type {
|
||||||
StringChange,
|
StringChange,
|
||||||
StringDeletion,
|
StringDeletion,
|
||||||
StringInsertion,
|
StringInsertion,
|
||||||
} from './src/utils/string-change';
|
} from './src/utils/string-change';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { applyChangesToString, ChangeType } from './src/utils/string-change';
|
export { applyChangesToString, ChangeType } from './src/utils/string-change';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { offsetFromRoot } from './src/utils/offset-from-root';
|
export { offsetFromRoot } from './src/utils/offset-from-root';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { convertNxGenerator } from './src/utils/invoke-nx-generator';
|
export { convertNxGenerator } from './src/utils/invoke-nx-generator';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { convertNxExecutor } from './src/utils/convert-nx-executor';
|
export { convertNxExecutor } from './src/utils/convert-nx-executor';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { stripIndents } from './src/utils/strip-indents';
|
export { stripIndents } from './src/utils/strip-indents';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { joinPathFragments, normalizePath } from './src/utils/path';
|
export { joinPathFragments, normalizePath } from './src/utils/path';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @category Utils
|
||||||
|
*/
|
||||||
export { moveFilesToNewDirectory } from './src/utils/move-dir';
|
export { moveFilesToNewDirectory } from './src/utils/move-dir';
|
||||||
|
|||||||
@ -1,3 +1,6 @@
|
|||||||
|
/**
|
||||||
|
* @category Ng CLI Adapter
|
||||||
|
*/
|
||||||
export {
|
export {
|
||||||
wrapAngularDevkitSchematic,
|
wrapAngularDevkitSchematic,
|
||||||
overrideCollectionResolutionForTesting,
|
overrideCollectionResolutionForTesting,
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user