From 9e5d7f8c0105a17c1da83493d3afe7c03d0efac0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leosvel=20P=C3=A9rez=20Espinosa?= Date: Mon, 27 Mar 2023 10:48:28 +0100 Subject: [PATCH] docs(nx-dev): update typedoc version --- docs/generated/devkit/ngcli_adapter.md | 6 +- docs/generated/devkit/nrwl_devkit.md | 892 +++++++++--------- .../devkit/documents/ngcli_adapter.md | 6 +- .../packages/devkit/documents/nrwl_devkit.md | 892 +++++++++--------- package.json | 4 +- .../generate-devkit-documentation.ts | 7 +- typedoc-theme/package.json | 5 +- typedoc-theme/src/index.ts | 8 +- typedoc-theme/src/lib/theme.ts | 2 +- yarn.lock | 72 +- 10 files changed, 989 insertions(+), 905 deletions(-) diff --git a/docs/generated/devkit/ngcli_adapter.md b/docs/generated/devkit/ngcli_adapter.md index 19fdc03ad8702..281b0570b0bc9 100644 --- a/docs/generated/devkit/ngcli_adapter.md +++ b/docs/generated/devkit/ngcli_adapter.md @@ -2,7 +2,7 @@ ## Table of contents -### Ng CLI Adapter Classes +### Classes - [NxScopedHost](../../devkit/documents/ngcli_adapter#nxscopedhost) @@ -12,7 +12,7 @@ - [overrideCollectionResolutionForTesting](../../devkit/documents/ngcli_adapter#overridecollectionresolutionfortesting) - [wrapAngularDevkitSchematic](../../devkit/documents/ngcli_adapter#wrapangulardevkitschematic) -## Ng CLI Adapter Classes +## Classes ### NxScopedHost @@ -91,7 +91,7 @@ overrideCollectionResolutionForTesting({ ### wrapAngularDevkitSchematic -▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../devkit/documents/nrwl_devkit#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\> +▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../devkit/documents/nrwl_devkit#tree), `generatorOptions`: { `[k: string]`: `any`; }) => `Promise`<`any`\> #### Parameters diff --git a/docs/generated/devkit/nrwl_devkit.md b/docs/generated/devkit/nrwl_devkit.md index fdb635ef7225c..a253317955679 100644 --- a/docs/generated/devkit/nrwl_devkit.md +++ b/docs/generated/devkit/nrwl_devkit.md @@ -11,130 +11,88 @@ It only uses language primitives and immutable objects ## Table of contents -### Project Graph Enumerations - -- [DependencyType](../../devkit/documents/nrwl_devkit#dependencytype) - -### Utils Enumerations +### Enumerations - [ChangeType](../../devkit/documents/nrwl_devkit#changetype) +- [DependencyType](../../devkit/documents/nrwl_devkit#dependencytype) -### Project Graph Classes - -- [ProjectGraphBuilder](../../devkit/documents/nrwl_devkit#projectgraphbuilder) - -### Utils Classes +### Classes - [Hasher](../../devkit/documents/nrwl_devkit#hasher) - -### Workspace Classes - +- [ProjectGraphBuilder](../../devkit/documents/nrwl_devkit#projectgraphbuilder) - [Workspaces](../../devkit/documents/nrwl_devkit#workspaces) -### Commands Interfaces - -- [Target](../../devkit/documents/nrwl_devkit#target) - -### Other Interfaces - -- [NxPlugin](../../devkit/documents/nrwl_devkit#nxplugin) - -### Project Graph Interfaces - -- [FileData](../../devkit/documents/nrwl_devkit#filedata) -- [ProjectFileMap](../../devkit/documents/nrwl_devkit#projectfilemap) -- [ProjectGraph](../../devkit/documents/nrwl_devkit#projectgraph) -- [ProjectGraphDependency](../../devkit/documents/nrwl_devkit#projectgraphdependency) -- [ProjectGraphExternalNode](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) -- [ProjectGraphProcessorContext](../../devkit/documents/nrwl_devkit#projectgraphprocessorcontext) -- [ProjectGraphProjectNode](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) - -### Tree Interfaces - -- [FileChange](../../devkit/documents/nrwl_devkit#filechange) -- [Tree](../../devkit/documents/nrwl_devkit#tree) - -### Utils Interfaces +### Interfaces - [DefaultTasksRunnerOptions](../../devkit/documents/nrwl_devkit#defaulttasksrunneroptions) -- [Hash](../../devkit/documents/nrwl_devkit#hash) -- [JsonParseOptions](../../devkit/documents/nrwl_devkit#jsonparseoptions) -- [JsonSerializeOptions](../../devkit/documents/nrwl_devkit#jsonserializeoptions) -- [ModuleFederationConfig](../../devkit/documents/nrwl_devkit#modulefederationconfig) -- [RemoteCache](../../devkit/documents/nrwl_devkit#remotecache) -- [SharedLibraryConfig](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) -- [StringDeletion](../../devkit/documents/nrwl_devkit#stringdeletion) -- [StringInsertion](../../devkit/documents/nrwl_devkit#stringinsertion) - -### Workspace Interfaces - - [ExecutorContext](../../devkit/documents/nrwl_devkit#executorcontext) - [ExecutorsJson](../../devkit/documents/nrwl_devkit#executorsjson) +- [FileChange](../../devkit/documents/nrwl_devkit#filechange) +- [FileData](../../devkit/documents/nrwl_devkit#filedata) - [GeneratorsJson](../../devkit/documents/nrwl_devkit#generatorsjson) +- [Hash](../../devkit/documents/nrwl_devkit#hash) - [HasherContext](../../devkit/documents/nrwl_devkit#hashercontext) - [ImplicitJsonSubsetDependency](../../devkit/documents/nrwl_devkit#implicitjsonsubsetdependency) +- [JsonParseOptions](../../devkit/documents/nrwl_devkit#jsonparseoptions) +- [JsonSerializeOptions](../../devkit/documents/nrwl_devkit#jsonserializeoptions) - [MigrationsJson](../../devkit/documents/nrwl_devkit#migrationsjson) +- [ModuleFederationConfig](../../devkit/documents/nrwl_devkit#modulefederationconfig) - [NxAffectedConfig](../../devkit/documents/nrwl_devkit#nxaffectedconfig) - [NxJsonConfiguration](../../devkit/documents/nrwl_devkit#nxjsonconfiguration) +- [NxPlugin](../../devkit/documents/nrwl_devkit#nxplugin) - [ProjectConfiguration](../../devkit/documents/nrwl_devkit#projectconfiguration) +- [ProjectFileMap](../../devkit/documents/nrwl_devkit#projectfilemap) +- [ProjectGraph](../../devkit/documents/nrwl_devkit#projectgraph) +- [ProjectGraphDependency](../../devkit/documents/nrwl_devkit#projectgraphdependency) +- [ProjectGraphExternalNode](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) +- [ProjectGraphProcessorContext](../../devkit/documents/nrwl_devkit#projectgraphprocessorcontext) +- [ProjectGraphProjectNode](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) - [ProjectsConfigurations](../../devkit/documents/nrwl_devkit#projectsconfigurations) +- [RemoteCache](../../devkit/documents/nrwl_devkit#remotecache) +- [SharedLibraryConfig](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) +- [StringDeletion](../../devkit/documents/nrwl_devkit#stringdeletion) +- [StringInsertion](../../devkit/documents/nrwl_devkit#stringinsertion) +- [Target](../../devkit/documents/nrwl_devkit#target) - [TargetConfiguration](../../devkit/documents/nrwl_devkit#targetconfiguration) - [TargetDependencyConfig](../../devkit/documents/nrwl_devkit#targetdependencyconfig) - [Task](../../devkit/documents/nrwl_devkit#task) - [TaskGraph](../../devkit/documents/nrwl_devkit#taskgraph) +- [Tree](../../devkit/documents/nrwl_devkit#tree) - [Workspace](../../devkit/documents/nrwl_devkit#workspace) -### Generators Type aliases - -- [WorkspaceConfiguration](../../devkit/documents/nrwl_devkit#workspaceconfiguration) - -### Other Type aliases - -- [ProjectTargetConfigurator](../../devkit/documents/nrwl_devkit#projecttargetconfigurator) - -### Package Manager Type aliases - -- [PackageManager](../../devkit/documents/nrwl_devkit#packagemanager) - -### Project Graph Type aliases - -- [ProjectGraphNode](../../devkit/documents/nrwl_devkit#projectgraphnode) - -### Utils Type aliases +### Type Aliases - [AdditionalSharedConfig](../../devkit/documents/nrwl_devkit#additionalsharedconfig) -- [ModuleFederationLibrary](../../devkit/documents/nrwl_devkit#modulefederationlibrary) -- [Remotes](../../devkit/documents/nrwl_devkit#remotes) -- [SharedFunction](../../devkit/documents/nrwl_devkit#sharedfunction) -- [SharedWorkspaceLibraryConfig](../../devkit/documents/nrwl_devkit#sharedworkspacelibraryconfig) -- [StringChange](../../devkit/documents/nrwl_devkit#stringchange) -- [WorkspaceLibrary](../../devkit/documents/nrwl_devkit#workspacelibrary) -- [WorkspaceLibrarySecondaryEntryPoint](../../devkit/documents/nrwl_devkit#workspacelibrarysecondaryentrypoint) - -### Workspace Type aliases - - [CustomHasher](../../devkit/documents/nrwl_devkit#customhasher) - [Executor](../../devkit/documents/nrwl_devkit#executor) - [Generator](../../devkit/documents/nrwl_devkit#generator) - [GeneratorCallback](../../devkit/documents/nrwl_devkit#generatorcallback) - [ImplicitDependencyEntry](../../devkit/documents/nrwl_devkit#implicitdependencyentry) +- [ModuleFederationLibrary](../../devkit/documents/nrwl_devkit#modulefederationlibrary) +- [PackageManager](../../devkit/documents/nrwl_devkit#packagemanager) +- [ProjectGraphNode](../../devkit/documents/nrwl_devkit#projectgraphnode) +- [ProjectTargetConfigurator](../../devkit/documents/nrwl_devkit#projecttargetconfigurator) - [ProjectType](../../devkit/documents/nrwl_devkit#projecttype) +- [Remotes](../../devkit/documents/nrwl_devkit#remotes) +- [SharedFunction](../../devkit/documents/nrwl_devkit#sharedfunction) +- [SharedWorkspaceLibraryConfig](../../devkit/documents/nrwl_devkit#sharedworkspacelibraryconfig) +- [StringChange](../../devkit/documents/nrwl_devkit#stringchange) - [TaskGraphExecutor](../../devkit/documents/nrwl_devkit#taskgraphexecutor) +- [WorkspaceConfiguration](../../devkit/documents/nrwl_devkit#workspaceconfiguration) - [WorkspaceJsonConfiguration](../../devkit/documents/nrwl_devkit#workspacejsonconfiguration) +- [WorkspaceLibrary](../../devkit/documents/nrwl_devkit#workspacelibrary) +- [WorkspaceLibrarySecondaryEntryPoint](../../devkit/documents/nrwl_devkit#workspacelibrarysecondaryentrypoint) -### Logger Variables - -- [logger](../../devkit/documents/nrwl_devkit#logger) - -### Utils Variables +### Variables - [NX_VERSION](../../devkit/documents/nrwl_devkit#nx_version) - [appRootPath](../../devkit/documents/nrwl_devkit#approotpath) - [cacheDir](../../devkit/documents/nrwl_devkit#cachedir) +- [logger](../../devkit/documents/nrwl_devkit#logger) - [output](../../devkit/documents/nrwl_devkit#output) - [workspaceRoot](../../devkit/documents/nrwl_devkit#workspaceroot) -### Other Functions +### Functions - [addDependenciesToPackageJson](../../devkit/documents/nrwl_devkit#adddependenciestopackagejson) - [addProjectConfiguration](../../devkit/documents/nrwl_devkit#addprojectconfiguration) @@ -149,6 +107,7 @@ It only uses language primitives and immutable objects - [defaultTasksRunner](../../devkit/documents/nrwl_devkit#defaulttasksrunner) - [detectPackageManager](../../devkit/documents/nrwl_devkit#detectpackagemanager) - [detectWorkspaceScope](../../devkit/documents/nrwl_devkit#detectworkspacescope) +- [ensurePackage](../../devkit/documents/nrwl_devkit#ensurepackage) - [extractLayoutDirectory](../../devkit/documents/nrwl_devkit#extractlayoutdirectory) - [formatFiles](../../devkit/documents/nrwl_devkit#formatfiles) - [generateFiles](../../devkit/documents/nrwl_devkit#generatefiles) @@ -203,25 +162,29 @@ It only uses language primitives and immutable objects - [writeJson](../../devkit/documents/nrwl_devkit#writejson) - [writeJsonFile](../../devkit/documents/nrwl_devkit#writejsonfile) -### Utils Functions +## Enumerations -- [ensurePackage](../../devkit/documents/nrwl_devkit#ensurepackage) +### ChangeType + +• **ChangeType**: `Object` -## Project Graph Enumerations +--- ### DependencyType • **DependencyType**: `Object` ---- +Type of dependency between projects -## Utils Enumerations +## Classes -### ChangeType +### Hasher -• **ChangeType**: `Object` +• **Hasher**: `Object` -## Project Graph Classes +The default hasher used by executors. + +--- ### ProjectGraphBuilder @@ -229,223 +192,235 @@ It only uses language primitives and immutable objects --- -## Utils Classes +### Workspaces -### Hasher +• **Workspaces**: `Object` -• **Hasher**: `Object` +## Interfaces + +### DefaultTasksRunnerOptions + +• **DefaultTasksRunnerOptions**: `Object` --- -## Workspace Classes +### ExecutorContext -### Workspaces +• **ExecutorContext**: `Object` -• **Workspaces**: `Object` +Context that is passed into an executor -## Commands Interfaces +--- -### Target +### ExecutorsJson -• **Target**: `Object` +• **ExecutorsJson**: `Object` --- -## Other Interfaces - -### NxPlugin +### FileChange -• **NxPlugin**: `Object` +• **FileChange**: `Object` -A plugin for Nx +Description of a file change in the Nx virtual file system/ --- -## Project Graph Interfaces - ### FileData • **FileData**: `Object` +Some metadata about a file + --- -### ProjectFileMap +### GeneratorsJson -• **ProjectFileMap**: `Object` +• **GeneratorsJson**: `Object` --- -### ProjectGraph +### Hash -• **ProjectGraph**: `Object` +• **Hash**: `Object` + +A data structure returned by the default hasher. --- -### ProjectGraphDependency +### HasherContext -• **ProjectGraphDependency**: `Object` +• **HasherContext**: `Object` --- -### ProjectGraphExternalNode - -• **ProjectGraphExternalNode**: `Object` +### ImplicitJsonSubsetDependency ---- +• **ImplicitJsonSubsetDependency**<`T`\>: `Object` -### ProjectGraphProcessorContext +#### Type parameters -• **ProjectGraphProcessorContext**: `Object` +| Name | Type | +| :--- | :------------------ | +| `T` | `"*"` \| `string`[] | --- -### ProjectGraphProjectNode +### JsonParseOptions -• **ProjectGraphProjectNode**: `Object` +• **JsonParseOptions**: `Object` --- -## Tree Interfaces - -### FileChange +### JsonSerializeOptions -• **FileChange**: `Object` +• **JsonSerializeOptions**: `Object` --- -### Tree +### MigrationsJson -• **Tree**: `Object` +• **MigrationsJson**: `Object` --- -## Utils Interfaces - -### DefaultTasksRunnerOptions +### ModuleFederationConfig -• **DefaultTasksRunnerOptions**: `Object` +• **ModuleFederationConfig**: `Object` --- -### Hash +### NxAffectedConfig -• **Hash**: `Object` +• **NxAffectedConfig**: `Object` --- -### JsonParseOptions +### NxJsonConfiguration -• **JsonParseOptions**: `Object` +• **NxJsonConfiguration**<`T`\>: `Object` ---- +Nx.json configuration -### JsonSerializeOptions +@note: when adding properties here add them to `allowedWorkspaceExtensions` in adapter/compat.ts -• **JsonSerializeOptions**: `Object` +#### Type parameters + +| Name | Type | +| :--- | :------------------ | +| `T` | `"*"` \| `string`[] | --- -### ModuleFederationConfig +### NxPlugin -• **ModuleFederationConfig**: `Object` +• **NxPlugin**: `Object` ---- +A plugin for Nx -### RemoteCache +--- -• **RemoteCache**: `Object` +### ProjectConfiguration ---- +• **ProjectConfiguration**: `Object` -### SharedLibraryConfig +Project configuration -• **SharedLibraryConfig**: `Object` +@note: when adding properties here add them to `allowedProjectExtensions` in adapter/compat.ts --- -### StringDeletion +### ProjectFileMap -• **StringDeletion**: `Object` +• **ProjectFileMap**: `Object` + +A list of files separated by the project they belong to --- -### StringInsertion +### ProjectGraph -• **StringInsertion**: `Object` +• **ProjectGraph**: `Object` + +A Graph of projects in the workspace and dependencies between them --- -## Workspace Interfaces +### ProjectGraphDependency -### ExecutorContext +• **ProjectGraphDependency**: `Object` -• **ExecutorContext**: `Object` +A dependency between two projects --- -### ExecutorsJson +### ProjectGraphExternalNode -• **ExecutorsJson**: `Object` +• **ProjectGraphExternalNode**: `Object` ---- +A node describing an external dependency +`name` has as form of: -### GeneratorsJson +- `npm:packageName` for root dependencies or +- `npm:packageName@version` for nested transitive dependencies -• **GeneratorsJson**: `Object` +This is vital for our node discovery to always point to root dependencies, +while allowing tracking of the full tree of different nested versions --- -### HasherContext +### ProjectGraphProcessorContext -• **HasherContext**: `Object` +• **ProjectGraphProcessorContext**: `Object` ---- +Additional information to be used to process a project graph -### ImplicitJsonSubsetDependency +--- -• **ImplicitJsonSubsetDependency**<`T`\>: `Object` +### ProjectGraphProjectNode -#### Type parameters +• **ProjectGraphProjectNode**: `Object` -| Name | Type | -| :--- | :------------------ | -| `T` | `"*"` \| `string`[] | +A node describing a project in a workspace --- -### MigrationsJson +### ProjectsConfigurations -• **MigrationsJson**: `Object` +• **ProjectsConfigurations**: `Object` + +Projects Configurations +@note: when adding properties here add them to `allowedWorkspaceExtensions` in adapter/compat.ts --- -### NxAffectedConfig +### RemoteCache -• **NxAffectedConfig**: `Object` +• **RemoteCache**: `Object` --- -### NxJsonConfiguration +### SharedLibraryConfig -• **NxJsonConfiguration**<`T`\>: `Object` +• **SharedLibraryConfig**: `Object` -#### Type parameters +--- -| Name | Type | -| :--- | :------------------ | -| `T` | `"*"` \| `string`[] | +### StringDeletion + +• **StringDeletion**: `Object` --- -### ProjectConfiguration +### StringInsertion -• **ProjectConfiguration**: `Object` +• **StringInsertion**: `Object` --- -### ProjectsConfigurations +### Target -• **ProjectsConfigurations**: `Object` +• **Target**: `Object` --- @@ -453,6 +428,8 @@ A plugin for Nx • **TargetConfiguration**<`T`\>: `Object` +Target's configuration + #### Type parameters | Name | Type | @@ -471,281 +448,262 @@ A plugin for Nx • **Task**: `Object` +A representation of the invocation of an Executor + --- ### TaskGraph • **TaskGraph**: `Object` +Graph of Tasks to be executed + +--- + +### Tree + +• **Tree**: `Object` + +Virtual file system tree. + --- ### Workspace • **Workspace**: `Object` -## Generators Type aliases +**`Deprecated`** -### WorkspaceConfiguration +use ProjectsConfigurations or NxJsonConfiguration -Ƭ **WorkspaceConfiguration**: `Omit`<[`ProjectsConfigurations`](../../devkit/documents/nrwl_devkit#projectsconfigurations), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../devkit/documents/nrwl_devkit#nxjsonconfiguration)\> +## Type Aliases ---- +### AdditionalSharedConfig -## Other Type aliases +Ƭ **AdditionalSharedConfig**: (`string` \| [libraryName: string, sharedConfig: SharedLibraryConfig] \| { `libraryName`: `string` ; `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) })[] -### ProjectTargetConfigurator +--- -Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> +### CustomHasher + +Ƭ **CustomHasher**: (`task`: [`Task`](../../devkit/documents/nrwl_devkit#task), `context`: [`HasherContext`](../../devkit/documents/nrwl_devkit#hashercontext)) => `Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> #### Type declaration -▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> +▸ (`task`, `context`): `Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> ##### Parameters -| Name | Type | -| :----- | :------- | -| `file` | `string` | +| Name | Type | +| :-------- | :------------------------------------------------------------------ | +| `task` | [`Task`](../../devkit/documents/nrwl_devkit#task) | +| `context` | [`HasherContext`](../../devkit/documents/nrwl_devkit#hashercontext) | ##### Returns -`Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> - ---- - -## Package Manager Type aliases - -### PackageManager - -Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"` +`Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> --- -## Project Graph Type aliases - -### ProjectGraphNode +### Executor -Ƭ **ProjectGraphNode**: [`ProjectGraphProjectNode`](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) \| [`ProjectGraphExternalNode`](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) +Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext)) => `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\> ---- +#### Type parameters -## Utils Type aliases +| Name | Type | +| :--- | :---- | +| `T` | `any` | -### AdditionalSharedConfig +#### Type declaration -Ƭ **AdditionalSharedConfig**: (`string` \| [libraryName: string, sharedConfig: SharedLibraryConfig] \| { `libraryName`: `string` ; `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) })[] +▸ (`options`, `context`): `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\> ---- +Implementation of a target of a project -### ModuleFederationLibrary +##### Parameters -Ƭ **ModuleFederationLibrary**: `Object` +| Name | Type | +| :-------- | :---------------------------------------------------------------------- | +| `options` | `T` | +| `context` | [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext) | -#### Type declaration +##### Returns -| Name | Type | -| :----- | :------- | -| `name` | `string` | -| `type` | `string` | +`Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\> --- -### Remotes - -Ƭ **Remotes**: `string`[] \| [remoteName: string, remoteUrl: string][] +### Generator ---- +Ƭ **Generator**<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> -### SharedFunction +#### Type parameters -Ƭ **SharedFunction**: (`libraryName`: `string`, `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig)) => `undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) +| Name | Type | +| :--- | :-------- | +| `T` | `unknown` | #### Type declaration -▸ (`libraryName`, `sharedConfig`): `undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) +▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> + +A function that schedules updates to the filesystem to be done atomically ##### Parameters -| Name | Type | -| :------------- | :------------------------------------------------------------------------------ | -| `libraryName` | `string` | -| `sharedConfig` | [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) | +| Name | Type | +| :------- | :---- | +| `tree` | `any` | +| `schema` | `T` | ##### Returns -`undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) +`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> --- -### SharedWorkspaceLibraryConfig +### GeneratorCallback -Ƭ **SharedWorkspaceLibraryConfig**: `Object` +Ƭ **GeneratorCallback**: () => `void` \| `Promise`<`void`\> #### Type declaration -| Name | Type | -| :--------------------- | :---------------------------------------------------------------------------------------------------------------------------- | -| `getAliases` | () => `Record`<`string`, `string`\> | -| `getLibraries` | (`eager?`: `boolean`) => `Record`<`string`, [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig)\> | -| `getReplacementPlugin` | () => `NormalModuleReplacementPlugin` | +▸ (): `void` \| `Promise`<`void`\> ---- +A callback function that is executed after changes are made to the file system -### StringChange +##### Returns -Ƭ **StringChange**: [`StringInsertion`](../../devkit/documents/nrwl_devkit#stringinsertion) \| [`StringDeletion`](../../devkit/documents/nrwl_devkit#stringdeletion) +`void` \| `Promise`<`void`\> --- -### WorkspaceLibrary +### ImplicitDependencyEntry -Ƭ **WorkspaceLibrary**: `Object` +Ƭ **ImplicitDependencyEntry**<`T`\>: `Object` -#### Type declaration +#### Type parameters -| Name | Type | -| :---------- | :---------------------- | -| `importKey` | `string` \| `undefined` | -| `name` | `string` | -| `root` | `string` | +| Name | Type | +| :--- | :------------------ | +| `T` | `"*"` \| `string`[] | + +#### Index signature + +▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/nrwl_devkit#implicitjsonsubsetdependency)<`T`\> --- -### WorkspaceLibrarySecondaryEntryPoint +### ModuleFederationLibrary -Ƭ **WorkspaceLibrarySecondaryEntryPoint**: `Object` +Ƭ **ModuleFederationLibrary**: `Object` #### Type declaration | Name | Type | | :----- | :------- | | `name` | `string` | -| `path` | `string` | +| `type` | `string` | --- -## Workspace Type aliases - -### CustomHasher - -Ƭ **CustomHasher**: (`task`: [`Task`](../../devkit/documents/nrwl_devkit#task), `context`: [`HasherContext`](../../devkit/documents/nrwl_devkit#hashercontext)) => `Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> +### PackageManager -#### Type declaration +Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"` -▸ (`task`, `context`): `Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> +--- -##### Parameters +### ProjectGraphNode -| Name | Type | -| :-------- | :------------------------------------------------------------------ | -| `task` | [`Task`](../../devkit/documents/nrwl_devkit#task) | -| `context` | [`HasherContext`](../../devkit/documents/nrwl_devkit#hashercontext) | +Ƭ **ProjectGraphNode**: [`ProjectGraphProjectNode`](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) \| [`ProjectGraphExternalNode`](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) -##### Returns +**`Deprecated`** -`Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> +this type will be removed in v16. Use [ProjectGraphProjectNode](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) or [ProjectGraphExternalNode](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) instead --- -### Executor - -Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext)) => `Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\> - -#### Type parameters +### ProjectTargetConfigurator -| Name | Type | -| :--- | :---- | -| `T` | `any` | +Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> #### Type declaration -▸ (`options`, `context`): `Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\> - -Implementation of a target of a project +▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> ##### Parameters -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `options` | `T` | -| `context` | [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext) | - -##### Returns - -`Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\> - ---- - -### Generator - -Ƭ **Generator**<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> +| Name | Type | +| :----- | :------- | +| `file` | `string` | -#### Type parameters +##### Returns -| Name | Type | -| :--- | :-------- | -| `T` | `unknown` | +`Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> -#### Type declaration +--- -▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> +### ProjectType -A function that schedules updates to the filesystem to be done atomically +Ƭ **ProjectType**: `"library"` \| `"application"` -##### Parameters +Type of project supported -| Name | Type | -| :------- | :---- | -| `tree` | `any` | -| `schema` | `T` | +--- -##### Returns +### Remotes -`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> +Ƭ **Remotes**: `string`[] \| [remoteName: string, remoteUrl: string][] --- -### GeneratorCallback +### SharedFunction -Ƭ **GeneratorCallback**: () => `void` \| `Promise`<`void`\> +Ƭ **SharedFunction**: (`libraryName`: `string`, `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig)) => `undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) #### Type declaration -▸ (): `void` \| `Promise`<`void`\> +▸ (`libraryName`, `sharedConfig`): `undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) -A callback function that is executed after changes are made to the file system +##### Parameters + +| Name | Type | +| :------------- | :------------------------------------------------------------------------------ | +| `libraryName` | `string` | +| `sharedConfig` | [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) | ##### Returns -`void` \| `Promise`<`void`\> +`undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) --- -### ImplicitDependencyEntry - -Ƭ **ImplicitDependencyEntry**<`T`\>: `Object` - -#### Type parameters +### SharedWorkspaceLibraryConfig -| Name | Type | -| :--- | :------------------ | -| `T` | `"*"` \| `string`[] | +Ƭ **SharedWorkspaceLibraryConfig**: `Object` -#### Index signature +#### Type declaration -▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/nrwl_devkit#implicitjsonsubsetdependency)<`T`\> +| Name | Type | +| :--------------------- | :---------------------------------------------------------------------------------------------------------------------------- | +| `getAliases` | () => `Record`<`string`, `string`\> | +| `getLibraries` | (`eager?`: `boolean`) => `Record`<`string`, [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig)\> | +| `getReplacementPlugin` | () => `NormalModuleReplacementPlugin` | --- -### ProjectType +### StringChange -Ƭ **ProjectType**: `"library"` \| `"application"` +Ƭ **StringChange**: [`StringInsertion`](../../devkit/documents/nrwl_devkit#stringinsertion) \| [`StringDeletion`](../../devkit/documents/nrwl_devkit#stringdeletion) + +A change to be made to a string --- ### TaskGraphExecutor -Ƭ **TaskGraphExecutor**<`T`\>: (`taskGraph`: [`TaskGraph`](../../devkit/documents/nrwl_devkit#taskgraph), `options`: `Record`<`string`, `T`\>, `overrides`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext)) => `Promise`<`Record`<`string`, `Object`\>\> +Ƭ **TaskGraphExecutor**<`T`\>: (`taskGraph`: [`TaskGraph`](../../devkit/documents/nrwl_devkit#taskgraph), `options`: `Record`<`string`, `T`\>, `overrides`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext)) => `Promise`<`Record`<`string`, { `success`: `boolean` ; `terminalOutput`: `string` }\>\> #### Type parameters @@ -755,7 +713,7 @@ A callback function that is executed after changes are made to the file system #### Type declaration -▸ (`taskGraph`, `options`, `overrides`, `context`): `Promise`<`Record`<`string`, `Object`\>\> +▸ (`taskGraph`, `options`, `overrides`, `context`): `Promise`<`Record`<`string`, { `success`: `boolean` ; `terminalOutput`: `string` }\>\> Implementation of a target of a project that handles multiple projects to be batched @@ -770,7 +728,17 @@ Implementation of a target of a project that handles multiple projects to be bat ##### Returns -`Promise`<`Record`<`string`, `Object`\>\> +`Promise`<`Record`<`string`, { `success`: `boolean` ; `terminalOutput`: `string` }\>\> + +--- + +### WorkspaceConfiguration + +Ƭ **WorkspaceConfiguration**: `Omit`<[`ProjectsConfigurations`](../../devkit/documents/nrwl_devkit#projectsconfigurations), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../devkit/documents/nrwl_devkit#nxjsonconfiguration)\> + +**`Deprecated`** + +using NxJsonConfiguration --- @@ -778,56 +746,99 @@ Implementation of a target of a project that handles multiple projects to be bat Ƭ **WorkspaceJsonConfiguration**: [`ProjectsConfigurations`](../../devkit/documents/nrwl_devkit#projectsconfigurations) -## Logger Variables +**`Deprecated`** -### logger +use ProjectsConfigurations + +--- + +### WorkspaceLibrary -• **logger**: `Object` +Ƭ **WorkspaceLibrary**: `Object` #### Type declaration -| Name | Type | -| :------ | :-------------------------- | -| `debug` | (...`s`: `any`[]) => `void` | -| `error` | (`s`: `any`) => `void` | -| `fatal` | (...`s`: `any`[]) => `void` | -| `info` | (`s`: `any`) => `void` | -| `log` | (...`s`: `any`[]) => `void` | -| `warn` | (`s`: `any`) => `void` | +| Name | Type | +| :---------- | :---------------------- | +| `importKey` | `string` \| `undefined` | +| `name` | `string` | +| `root` | `string` | --- -## Utils Variables +### WorkspaceLibrarySecondaryEntryPoint + +Ƭ **WorkspaceLibrarySecondaryEntryPoint**: `Object` + +#### Type declaration + +| Name | Type | +| :----- | :------- | +| `name` | `string` | +| `path` | `string` | + +## Variables ### NX_VERSION -• **NX_VERSION**: `string` +• `Const` **NX_VERSION**: `string` + +**`Description`** + +The version of Nx used by the workspace. Returns null if no version is found. --- ### appRootPath -• **appRootPath**: `string` = `workspaceRoot` +• `Const` **appRootPath**: `string` = `workspaceRoot` + +The root of the workspace. + +**`Deprecated`** + +use workspaceRoot instead --- ### cacheDir -• **cacheDir**: `string` +• `Const` **cacheDir**: `string` + +Path to the directory where Nx stores its cache and daemon-related files. + +--- + +### logger + +• `Const` **logger**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :-------------------------- | +| `debug` | (...`s`: `any`[]) => `void` | +| `error` | (`s`: `any`) => `void` | +| `fatal` | (...`s`: `any`[]) => `void` | +| `info` | (`s`: `any`) => `void` | +| `log` | (...`s`: `any`[]) => `void` | +| `warn` | (`s`: `any`) => `void` | --- ### output -• **output**: `CLIOutput` +• `Const` **output**: `CLIOutput` --- ### workspaceRoot -• **workspaceRoot**: `string` +• `Const` **workspaceRoot**: `string` -## Other Functions +The root of the workspace + +## Functions ### addDependenciesToPackageJson @@ -1045,9 +1056,11 @@ Convert an Nx Generator into an Angular Devkit Schematic. ### createLockFile -▸ `Const` **createLockFile**(`packageJson`, `packageManager?`): `string` +▸ **createLockFile**(`packageJson`, `packageManager?`): `string` + +**`Deprecated`** -**`deprecated`** Import this from @nrwl/js instead +Import this from @nrwl/js instead #### Parameters @@ -1064,9 +1077,11 @@ Convert an Nx Generator into an Angular Devkit Schematic. ### createPackageJson -▸ `Const` **createPackageJson**(`projectName`, `graph`, `options?`): `PackageJson` +▸ **createPackageJson**(`projectName`, `graph`, `options?`): `PackageJson` -**`deprecated`** Import this from @nrwl/js instead +**`Deprecated`** + +Import this from @nrwl/js instead #### Parameters @@ -1128,7 +1143,10 @@ stored in the daemon process. To reset both run: `nx reset`. ### defaultTasksRunner -▸ `Const` **defaultTasksRunner**(`tasks`, `options`, `context?`): `any` +▸ **defaultTasksRunner**(`tasks`, `options`, `context?`): `any` + +`any | Promise<{ [id: string]: TaskStatus }>` +will change to Promise<{ [id: string]: TaskStatus }> after Nx 15 is released. #### Parameters @@ -1188,6 +1206,69 @@ Detect workspace scope from the package.json name --- +### ensurePackage + +▸ **ensurePackage**(`tree`, `pkg`, `requiredVersion`, `options?`): `void` + +**`Deprecated`** + +Use the other function signature without a Tree + +Use a package that has not been installed as a dependency. + +For example: + +```typescript +ensurePackage(tree, '@nrwl/jest', nxVersion); +``` + +This install the @nrwl/jest@ and return the module +When running with --dryRun, the function will throw when dependencies are missing. + +#### Parameters + +| Name | Type | Description | +| :------------------------ | :------------------------------------------------ | :----------------------------------------------------------------- | +| `tree` | [`Tree`](../../devkit/documents/nrwl_devkit#tree) | the file system tree | +| `pkg` | `string` | the package to check (e.g. @nrwl/jest) | +| `requiredVersion` | `string` | the version or semver range to check (e.g. ~1.0.0, >=1.0.0 <2.0.0) | +| `options?` | `Object` | - | +| `options.dev?` | `boolean` | - | +| `options.throwOnMissing?` | `boolean` | - | + +#### Returns + +`void` + +▸ **ensurePackage**<`T`\>(`pkg`, `version`): `T` + +Ensure that dependencies and devDependencies from package.json are installed at the required versions. + +For example: + +```typescript +ensurePackage(tree, '@nrwl/jest', nxVersion); +``` + +#### Type parameters + +| Name | Type | +| :--- | :------------------------ | +| `T` | extends `unknown` = `any` | + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :---------------------------------------------------------- | +| `pkg` | `string` | the package to install and require | +| `version` | `string` | the version to install if the package doesn't exist already | + +#### Returns + +`T` + +--- + ### extractLayoutDirectory ▸ **extractLayoutDirectory**(`directory`): `Object` @@ -1452,7 +1533,9 @@ Example: ▸ **getWorkspacePath**(`tree`): `"angular.json"` \| `"workspace.json"` -**`deprecated`** all projects are configured using project.json +**`Deprecated`** + +all projects are configured using project.json #### Parameters @@ -1494,7 +1577,9 @@ Runs `npm install` or `yarn install`. It will skip running the install if Returns if a project has a standalone configuration (project.json). -**`deprecated`** non-standalone projects were deprecated +**`Deprecated`** + +non-standalone projects were deprecated #### Parameters @@ -1511,7 +1596,7 @@ Returns if a project has a standalone configuration (project.json). ### joinPathFragments -▸ **joinPathFragments**(...`fragments`): `string` +▸ **joinPathFragments**(`...fragments`): `string` Normalized path fragments and joins them @@ -1697,7 +1782,7 @@ Object the JSON content represents ▸ **parseTargetString**(`targetString`): [`Target`](../../devkit/documents/nrwl_devkit#target) -**`deprecated(v17)`** A project graph should be passed to parseTargetString for best accuracy. +@deprecated(v17) A project graph should be passed to parseTargetString for best accuracy. #### Parameters @@ -1739,7 +1824,9 @@ parseTargetString('proj:test:production', graph); // returns { project: "proj", TODO(vsavkin): Remove after Nx 16 is out -**`deprecated`** Use readProjectsConfigurationFromProjectGraph(await createProjectGraphAsync()) +**`Deprecated`** + +Use readProjectsConfigurationFromProjectGraph(await createProjectGraphAsync()) #### Returns @@ -1753,7 +1840,9 @@ TODO(vsavkin): Remove after Nx 16 is out Synchronously reads the latest cached copy of the workspace's ProjectGraph. -**`throws`** {Error} if there is no cached ProjectGraph to read from +**`Throws`** + +if there is no cached ProjectGraph to read from #### Returns @@ -1818,9 +1907,9 @@ Object the JSON content of the file represents ▸ **readNxJson**(): [`NxJsonConfiguration`](../../devkit/documents/nrwl_devkit#nxjsonconfiguration) \| `null` -Reads nx.json +**`Deprecated`** -**`deprecated`** You must pass a [Tree](../../devkit/documents/nrwl_devkit#tree) +You must pass a [Tree](../../devkit/documents/nrwl_devkit#tree) #### Returns @@ -1848,7 +1937,9 @@ Reads nx.json Reads a project configuration. -**`throws`** If supplied projectName cannot be found +**`Throws`** + +If supplied projectName cannot be found #### Parameters @@ -1871,16 +1962,16 @@ Reads a project configuration. `Object` -| Name | Type | -| :----------------- | :------- | -| `dependencies?` | `Object` | -| `devDependencies?` | `Object` | +| Name | Type | +| :----------------- | :----------------------------- | +| `dependencies?` | { `[key: string]`: `string`; } | +| `devDependencies?` | { `[key: string]`: `string`; } | --- ### readTargetOptions -▸ **readTargetOptions**<`T`\>(`__namedParameters`, `context`): `T` +▸ **readTargetOptions**<`T`\>(`«destructured»`, `context`): `T` Reads and combines options for a given target. @@ -1894,10 +1985,10 @@ Works as if you invoked the target yourself without passing any command lint ove #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------- | -| `__namedParameters` | [`Target`](../../devkit/documents/nrwl_devkit#target) | -| `context` | [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext) | +| Name | Type | +| :--------------- | :---------------------------------------------------------------------- | +| `«destructured»` | [`Target`](../../devkit/documents/nrwl_devkit#target) | +| `context` | [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext) | #### Returns @@ -1913,7 +2004,9 @@ Read general workspace configuration such as the default project or cli settings This does _not_ provide projects configuration, use [readProjectConfiguration](../../devkit/documents/nrwl_devkit#readprojectconfiguration) instead. -**`deprecated`** use readNxJson +**`Deprecated`** + +use readNxJson #### Parameters @@ -2055,7 +2148,7 @@ Note that the return value is a promise of an iterator, so you need to await bef ### runTasksInSerial -▸ **runTasksInSerial**(...`tasks`): [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) +▸ **runTasksInSerial**(`...tasks`): [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) Run tasks in serial @@ -2143,7 +2236,7 @@ share Nx Workspace Libraries between Hosts and Remotes. ### stripIndents -▸ **stripIndents**(`strings`, ...`values`): `string` +▸ **stripIndents**(`strings`, `...values`): `string` Removes indents, which is useful for printing warning and messages. @@ -2172,7 +2265,7 @@ stripIndents` ### stripJsonComments -▸ `Const` **stripJsonComments**(`text`, `replaceCh?`): `string` +▸ **stripJsonComments**(`text`, `replaceCh?`): `string` Takes JSON with JavaScript-style comments and remove them. Optionally replaces every none-newline character @@ -2320,7 +2413,9 @@ Update general workspace configuration such as the default project or cli settin This does _not_ update projects configuration, use [updateProjectConfiguration](../../devkit/documents/nrwl_devkit#updateprojectconfiguration) or [addProjectConfiguration](../../devkit/documents/nrwl_devkit#addprojectconfiguration) instead. -**`deprecated`** use updateNxJson +**`Deprecated`** + +use updateNxJson #### Parameters @@ -2422,66 +2517,3 @@ Serializes the given data to JSON and writes it to a file. #### Returns `void` - ---- - -## Utils Functions - -### ensurePackage - -▸ **ensurePackage**(`tree`, `pkg`, `requiredVersion`, `options?`): `void` - -**`deprecated`** Use the other function signature without a Tree - -Use a package that has not been installed as a dependency. - -For example: - -```typescript -ensurePackage(tree, '@nrwl/jest', nxVersion); -``` - -This install the @nrwl/jest@ and return the module -When running with --dryRun, the function will throw when dependencies are missing. - -#### Parameters - -| Name | Type | Description | -| :------------------------ | :------------------------------------------------ | :----------------------------------------------------------------- | -| `tree` | [`Tree`](../../devkit/documents/nrwl_devkit#tree) | the file system tree | -| `pkg` | `string` | the package to check (e.g. @nrwl/jest) | -| `requiredVersion` | `string` | the version or semver range to check (e.g. ~1.0.0, >=1.0.0 <2.0.0) | -| `options?` | `Object` | - | -| `options.dev?` | `boolean` | - | -| `options.throwOnMissing?` | `boolean` | - | - -#### Returns - -`void` - -▸ **ensurePackage**<`T`\>(`pkg`, `version`): `T` - -Ensure that dependencies and devDependencies from package.json are installed at the required versions. - -For example: - -```typescript -ensurePackage(tree, '@nrwl/jest', nxVersion); -``` - -#### Type parameters - -| Name | Type | -| :--- | :------------------------ | -| `T` | extends `unknown` = `any` | - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :---------------------------------------------------------- | -| `pkg` | `string` | the package to install and require | -| `version` | `string` | the version to install if the package doesn't exist already | - -#### Returns - -`T` diff --git a/docs/generated/packages/devkit/documents/ngcli_adapter.md b/docs/generated/packages/devkit/documents/ngcli_adapter.md index 19fdc03ad8702..281b0570b0bc9 100644 --- a/docs/generated/packages/devkit/documents/ngcli_adapter.md +++ b/docs/generated/packages/devkit/documents/ngcli_adapter.md @@ -2,7 +2,7 @@ ## Table of contents -### Ng CLI Adapter Classes +### Classes - [NxScopedHost](../../devkit/documents/ngcli_adapter#nxscopedhost) @@ -12,7 +12,7 @@ - [overrideCollectionResolutionForTesting](../../devkit/documents/ngcli_adapter#overridecollectionresolutionfortesting) - [wrapAngularDevkitSchematic](../../devkit/documents/ngcli_adapter#wrapangulardevkitschematic) -## Ng CLI Adapter Classes +## Classes ### NxScopedHost @@ -91,7 +91,7 @@ overrideCollectionResolutionForTesting({ ### wrapAngularDevkitSchematic -▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../devkit/documents/nrwl_devkit#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\> +▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../devkit/documents/nrwl_devkit#tree), `generatorOptions`: { `[k: string]`: `any`; }) => `Promise`<`any`\> #### Parameters diff --git a/docs/generated/packages/devkit/documents/nrwl_devkit.md b/docs/generated/packages/devkit/documents/nrwl_devkit.md index fdb635ef7225c..a253317955679 100644 --- a/docs/generated/packages/devkit/documents/nrwl_devkit.md +++ b/docs/generated/packages/devkit/documents/nrwl_devkit.md @@ -11,130 +11,88 @@ It only uses language primitives and immutable objects ## Table of contents -### Project Graph Enumerations - -- [DependencyType](../../devkit/documents/nrwl_devkit#dependencytype) - -### Utils Enumerations +### Enumerations - [ChangeType](../../devkit/documents/nrwl_devkit#changetype) +- [DependencyType](../../devkit/documents/nrwl_devkit#dependencytype) -### Project Graph Classes - -- [ProjectGraphBuilder](../../devkit/documents/nrwl_devkit#projectgraphbuilder) - -### Utils Classes +### Classes - [Hasher](../../devkit/documents/nrwl_devkit#hasher) - -### Workspace Classes - +- [ProjectGraphBuilder](../../devkit/documents/nrwl_devkit#projectgraphbuilder) - [Workspaces](../../devkit/documents/nrwl_devkit#workspaces) -### Commands Interfaces - -- [Target](../../devkit/documents/nrwl_devkit#target) - -### Other Interfaces - -- [NxPlugin](../../devkit/documents/nrwl_devkit#nxplugin) - -### Project Graph Interfaces - -- [FileData](../../devkit/documents/nrwl_devkit#filedata) -- [ProjectFileMap](../../devkit/documents/nrwl_devkit#projectfilemap) -- [ProjectGraph](../../devkit/documents/nrwl_devkit#projectgraph) -- [ProjectGraphDependency](../../devkit/documents/nrwl_devkit#projectgraphdependency) -- [ProjectGraphExternalNode](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) -- [ProjectGraphProcessorContext](../../devkit/documents/nrwl_devkit#projectgraphprocessorcontext) -- [ProjectGraphProjectNode](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) - -### Tree Interfaces - -- [FileChange](../../devkit/documents/nrwl_devkit#filechange) -- [Tree](../../devkit/documents/nrwl_devkit#tree) - -### Utils Interfaces +### Interfaces - [DefaultTasksRunnerOptions](../../devkit/documents/nrwl_devkit#defaulttasksrunneroptions) -- [Hash](../../devkit/documents/nrwl_devkit#hash) -- [JsonParseOptions](../../devkit/documents/nrwl_devkit#jsonparseoptions) -- [JsonSerializeOptions](../../devkit/documents/nrwl_devkit#jsonserializeoptions) -- [ModuleFederationConfig](../../devkit/documents/nrwl_devkit#modulefederationconfig) -- [RemoteCache](../../devkit/documents/nrwl_devkit#remotecache) -- [SharedLibraryConfig](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) -- [StringDeletion](../../devkit/documents/nrwl_devkit#stringdeletion) -- [StringInsertion](../../devkit/documents/nrwl_devkit#stringinsertion) - -### Workspace Interfaces - - [ExecutorContext](../../devkit/documents/nrwl_devkit#executorcontext) - [ExecutorsJson](../../devkit/documents/nrwl_devkit#executorsjson) +- [FileChange](../../devkit/documents/nrwl_devkit#filechange) +- [FileData](../../devkit/documents/nrwl_devkit#filedata) - [GeneratorsJson](../../devkit/documents/nrwl_devkit#generatorsjson) +- [Hash](../../devkit/documents/nrwl_devkit#hash) - [HasherContext](../../devkit/documents/nrwl_devkit#hashercontext) - [ImplicitJsonSubsetDependency](../../devkit/documents/nrwl_devkit#implicitjsonsubsetdependency) +- [JsonParseOptions](../../devkit/documents/nrwl_devkit#jsonparseoptions) +- [JsonSerializeOptions](../../devkit/documents/nrwl_devkit#jsonserializeoptions) - [MigrationsJson](../../devkit/documents/nrwl_devkit#migrationsjson) +- [ModuleFederationConfig](../../devkit/documents/nrwl_devkit#modulefederationconfig) - [NxAffectedConfig](../../devkit/documents/nrwl_devkit#nxaffectedconfig) - [NxJsonConfiguration](../../devkit/documents/nrwl_devkit#nxjsonconfiguration) +- [NxPlugin](../../devkit/documents/nrwl_devkit#nxplugin) - [ProjectConfiguration](../../devkit/documents/nrwl_devkit#projectconfiguration) +- [ProjectFileMap](../../devkit/documents/nrwl_devkit#projectfilemap) +- [ProjectGraph](../../devkit/documents/nrwl_devkit#projectgraph) +- [ProjectGraphDependency](../../devkit/documents/nrwl_devkit#projectgraphdependency) +- [ProjectGraphExternalNode](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) +- [ProjectGraphProcessorContext](../../devkit/documents/nrwl_devkit#projectgraphprocessorcontext) +- [ProjectGraphProjectNode](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) - [ProjectsConfigurations](../../devkit/documents/nrwl_devkit#projectsconfigurations) +- [RemoteCache](../../devkit/documents/nrwl_devkit#remotecache) +- [SharedLibraryConfig](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) +- [StringDeletion](../../devkit/documents/nrwl_devkit#stringdeletion) +- [StringInsertion](../../devkit/documents/nrwl_devkit#stringinsertion) +- [Target](../../devkit/documents/nrwl_devkit#target) - [TargetConfiguration](../../devkit/documents/nrwl_devkit#targetconfiguration) - [TargetDependencyConfig](../../devkit/documents/nrwl_devkit#targetdependencyconfig) - [Task](../../devkit/documents/nrwl_devkit#task) - [TaskGraph](../../devkit/documents/nrwl_devkit#taskgraph) +- [Tree](../../devkit/documents/nrwl_devkit#tree) - [Workspace](../../devkit/documents/nrwl_devkit#workspace) -### Generators Type aliases - -- [WorkspaceConfiguration](../../devkit/documents/nrwl_devkit#workspaceconfiguration) - -### Other Type aliases - -- [ProjectTargetConfigurator](../../devkit/documents/nrwl_devkit#projecttargetconfigurator) - -### Package Manager Type aliases - -- [PackageManager](../../devkit/documents/nrwl_devkit#packagemanager) - -### Project Graph Type aliases - -- [ProjectGraphNode](../../devkit/documents/nrwl_devkit#projectgraphnode) - -### Utils Type aliases +### Type Aliases - [AdditionalSharedConfig](../../devkit/documents/nrwl_devkit#additionalsharedconfig) -- [ModuleFederationLibrary](../../devkit/documents/nrwl_devkit#modulefederationlibrary) -- [Remotes](../../devkit/documents/nrwl_devkit#remotes) -- [SharedFunction](../../devkit/documents/nrwl_devkit#sharedfunction) -- [SharedWorkspaceLibraryConfig](../../devkit/documents/nrwl_devkit#sharedworkspacelibraryconfig) -- [StringChange](../../devkit/documents/nrwl_devkit#stringchange) -- [WorkspaceLibrary](../../devkit/documents/nrwl_devkit#workspacelibrary) -- [WorkspaceLibrarySecondaryEntryPoint](../../devkit/documents/nrwl_devkit#workspacelibrarysecondaryentrypoint) - -### Workspace Type aliases - - [CustomHasher](../../devkit/documents/nrwl_devkit#customhasher) - [Executor](../../devkit/documents/nrwl_devkit#executor) - [Generator](../../devkit/documents/nrwl_devkit#generator) - [GeneratorCallback](../../devkit/documents/nrwl_devkit#generatorcallback) - [ImplicitDependencyEntry](../../devkit/documents/nrwl_devkit#implicitdependencyentry) +- [ModuleFederationLibrary](../../devkit/documents/nrwl_devkit#modulefederationlibrary) +- [PackageManager](../../devkit/documents/nrwl_devkit#packagemanager) +- [ProjectGraphNode](../../devkit/documents/nrwl_devkit#projectgraphnode) +- [ProjectTargetConfigurator](../../devkit/documents/nrwl_devkit#projecttargetconfigurator) - [ProjectType](../../devkit/documents/nrwl_devkit#projecttype) +- [Remotes](../../devkit/documents/nrwl_devkit#remotes) +- [SharedFunction](../../devkit/documents/nrwl_devkit#sharedfunction) +- [SharedWorkspaceLibraryConfig](../../devkit/documents/nrwl_devkit#sharedworkspacelibraryconfig) +- [StringChange](../../devkit/documents/nrwl_devkit#stringchange) - [TaskGraphExecutor](../../devkit/documents/nrwl_devkit#taskgraphexecutor) +- [WorkspaceConfiguration](../../devkit/documents/nrwl_devkit#workspaceconfiguration) - [WorkspaceJsonConfiguration](../../devkit/documents/nrwl_devkit#workspacejsonconfiguration) +- [WorkspaceLibrary](../../devkit/documents/nrwl_devkit#workspacelibrary) +- [WorkspaceLibrarySecondaryEntryPoint](../../devkit/documents/nrwl_devkit#workspacelibrarysecondaryentrypoint) -### Logger Variables - -- [logger](../../devkit/documents/nrwl_devkit#logger) - -### Utils Variables +### Variables - [NX_VERSION](../../devkit/documents/nrwl_devkit#nx_version) - [appRootPath](../../devkit/documents/nrwl_devkit#approotpath) - [cacheDir](../../devkit/documents/nrwl_devkit#cachedir) +- [logger](../../devkit/documents/nrwl_devkit#logger) - [output](../../devkit/documents/nrwl_devkit#output) - [workspaceRoot](../../devkit/documents/nrwl_devkit#workspaceroot) -### Other Functions +### Functions - [addDependenciesToPackageJson](../../devkit/documents/nrwl_devkit#adddependenciestopackagejson) - [addProjectConfiguration](../../devkit/documents/nrwl_devkit#addprojectconfiguration) @@ -149,6 +107,7 @@ It only uses language primitives and immutable objects - [defaultTasksRunner](../../devkit/documents/nrwl_devkit#defaulttasksrunner) - [detectPackageManager](../../devkit/documents/nrwl_devkit#detectpackagemanager) - [detectWorkspaceScope](../../devkit/documents/nrwl_devkit#detectworkspacescope) +- [ensurePackage](../../devkit/documents/nrwl_devkit#ensurepackage) - [extractLayoutDirectory](../../devkit/documents/nrwl_devkit#extractlayoutdirectory) - [formatFiles](../../devkit/documents/nrwl_devkit#formatfiles) - [generateFiles](../../devkit/documents/nrwl_devkit#generatefiles) @@ -203,25 +162,29 @@ It only uses language primitives and immutable objects - [writeJson](../../devkit/documents/nrwl_devkit#writejson) - [writeJsonFile](../../devkit/documents/nrwl_devkit#writejsonfile) -### Utils Functions +## Enumerations -- [ensurePackage](../../devkit/documents/nrwl_devkit#ensurepackage) +### ChangeType + +• **ChangeType**: `Object` -## Project Graph Enumerations +--- ### DependencyType • **DependencyType**: `Object` ---- +Type of dependency between projects -## Utils Enumerations +## Classes -### ChangeType +### Hasher -• **ChangeType**: `Object` +• **Hasher**: `Object` -## Project Graph Classes +The default hasher used by executors. + +--- ### ProjectGraphBuilder @@ -229,223 +192,235 @@ It only uses language primitives and immutable objects --- -## Utils Classes +### Workspaces -### Hasher +• **Workspaces**: `Object` -• **Hasher**: `Object` +## Interfaces + +### DefaultTasksRunnerOptions + +• **DefaultTasksRunnerOptions**: `Object` --- -## Workspace Classes +### ExecutorContext -### Workspaces +• **ExecutorContext**: `Object` -• **Workspaces**: `Object` +Context that is passed into an executor -## Commands Interfaces +--- -### Target +### ExecutorsJson -• **Target**: `Object` +• **ExecutorsJson**: `Object` --- -## Other Interfaces - -### NxPlugin +### FileChange -• **NxPlugin**: `Object` +• **FileChange**: `Object` -A plugin for Nx +Description of a file change in the Nx virtual file system/ --- -## Project Graph Interfaces - ### FileData • **FileData**: `Object` +Some metadata about a file + --- -### ProjectFileMap +### GeneratorsJson -• **ProjectFileMap**: `Object` +• **GeneratorsJson**: `Object` --- -### ProjectGraph +### Hash -• **ProjectGraph**: `Object` +• **Hash**: `Object` + +A data structure returned by the default hasher. --- -### ProjectGraphDependency +### HasherContext -• **ProjectGraphDependency**: `Object` +• **HasherContext**: `Object` --- -### ProjectGraphExternalNode - -• **ProjectGraphExternalNode**: `Object` +### ImplicitJsonSubsetDependency ---- +• **ImplicitJsonSubsetDependency**<`T`\>: `Object` -### ProjectGraphProcessorContext +#### Type parameters -• **ProjectGraphProcessorContext**: `Object` +| Name | Type | +| :--- | :------------------ | +| `T` | `"*"` \| `string`[] | --- -### ProjectGraphProjectNode +### JsonParseOptions -• **ProjectGraphProjectNode**: `Object` +• **JsonParseOptions**: `Object` --- -## Tree Interfaces - -### FileChange +### JsonSerializeOptions -• **FileChange**: `Object` +• **JsonSerializeOptions**: `Object` --- -### Tree +### MigrationsJson -• **Tree**: `Object` +• **MigrationsJson**: `Object` --- -## Utils Interfaces - -### DefaultTasksRunnerOptions +### ModuleFederationConfig -• **DefaultTasksRunnerOptions**: `Object` +• **ModuleFederationConfig**: `Object` --- -### Hash +### NxAffectedConfig -• **Hash**: `Object` +• **NxAffectedConfig**: `Object` --- -### JsonParseOptions +### NxJsonConfiguration -• **JsonParseOptions**: `Object` +• **NxJsonConfiguration**<`T`\>: `Object` ---- +Nx.json configuration -### JsonSerializeOptions +@note: when adding properties here add them to `allowedWorkspaceExtensions` in adapter/compat.ts -• **JsonSerializeOptions**: `Object` +#### Type parameters + +| Name | Type | +| :--- | :------------------ | +| `T` | `"*"` \| `string`[] | --- -### ModuleFederationConfig +### NxPlugin -• **ModuleFederationConfig**: `Object` +• **NxPlugin**: `Object` ---- +A plugin for Nx -### RemoteCache +--- -• **RemoteCache**: `Object` +### ProjectConfiguration ---- +• **ProjectConfiguration**: `Object` -### SharedLibraryConfig +Project configuration -• **SharedLibraryConfig**: `Object` +@note: when adding properties here add them to `allowedProjectExtensions` in adapter/compat.ts --- -### StringDeletion +### ProjectFileMap -• **StringDeletion**: `Object` +• **ProjectFileMap**: `Object` + +A list of files separated by the project they belong to --- -### StringInsertion +### ProjectGraph -• **StringInsertion**: `Object` +• **ProjectGraph**: `Object` + +A Graph of projects in the workspace and dependencies between them --- -## Workspace Interfaces +### ProjectGraphDependency -### ExecutorContext +• **ProjectGraphDependency**: `Object` -• **ExecutorContext**: `Object` +A dependency between two projects --- -### ExecutorsJson +### ProjectGraphExternalNode -• **ExecutorsJson**: `Object` +• **ProjectGraphExternalNode**: `Object` ---- +A node describing an external dependency +`name` has as form of: -### GeneratorsJson +- `npm:packageName` for root dependencies or +- `npm:packageName@version` for nested transitive dependencies -• **GeneratorsJson**: `Object` +This is vital for our node discovery to always point to root dependencies, +while allowing tracking of the full tree of different nested versions --- -### HasherContext +### ProjectGraphProcessorContext -• **HasherContext**: `Object` +• **ProjectGraphProcessorContext**: `Object` ---- +Additional information to be used to process a project graph -### ImplicitJsonSubsetDependency +--- -• **ImplicitJsonSubsetDependency**<`T`\>: `Object` +### ProjectGraphProjectNode -#### Type parameters +• **ProjectGraphProjectNode**: `Object` -| Name | Type | -| :--- | :------------------ | -| `T` | `"*"` \| `string`[] | +A node describing a project in a workspace --- -### MigrationsJson +### ProjectsConfigurations -• **MigrationsJson**: `Object` +• **ProjectsConfigurations**: `Object` + +Projects Configurations +@note: when adding properties here add them to `allowedWorkspaceExtensions` in adapter/compat.ts --- -### NxAffectedConfig +### RemoteCache -• **NxAffectedConfig**: `Object` +• **RemoteCache**: `Object` --- -### NxJsonConfiguration +### SharedLibraryConfig -• **NxJsonConfiguration**<`T`\>: `Object` +• **SharedLibraryConfig**: `Object` -#### Type parameters +--- -| Name | Type | -| :--- | :------------------ | -| `T` | `"*"` \| `string`[] | +### StringDeletion + +• **StringDeletion**: `Object` --- -### ProjectConfiguration +### StringInsertion -• **ProjectConfiguration**: `Object` +• **StringInsertion**: `Object` --- -### ProjectsConfigurations +### Target -• **ProjectsConfigurations**: `Object` +• **Target**: `Object` --- @@ -453,6 +428,8 @@ A plugin for Nx • **TargetConfiguration**<`T`\>: `Object` +Target's configuration + #### Type parameters | Name | Type | @@ -471,281 +448,262 @@ A plugin for Nx • **Task**: `Object` +A representation of the invocation of an Executor + --- ### TaskGraph • **TaskGraph**: `Object` +Graph of Tasks to be executed + +--- + +### Tree + +• **Tree**: `Object` + +Virtual file system tree. + --- ### Workspace • **Workspace**: `Object` -## Generators Type aliases +**`Deprecated`** -### WorkspaceConfiguration +use ProjectsConfigurations or NxJsonConfiguration -Ƭ **WorkspaceConfiguration**: `Omit`<[`ProjectsConfigurations`](../../devkit/documents/nrwl_devkit#projectsconfigurations), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../devkit/documents/nrwl_devkit#nxjsonconfiguration)\> +## Type Aliases ---- +### AdditionalSharedConfig -## Other Type aliases +Ƭ **AdditionalSharedConfig**: (`string` \| [libraryName: string, sharedConfig: SharedLibraryConfig] \| { `libraryName`: `string` ; `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) })[] -### ProjectTargetConfigurator +--- -Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> +### CustomHasher + +Ƭ **CustomHasher**: (`task`: [`Task`](../../devkit/documents/nrwl_devkit#task), `context`: [`HasherContext`](../../devkit/documents/nrwl_devkit#hashercontext)) => `Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> #### Type declaration -▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> +▸ (`task`, `context`): `Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> ##### Parameters -| Name | Type | -| :----- | :------- | -| `file` | `string` | +| Name | Type | +| :-------- | :------------------------------------------------------------------ | +| `task` | [`Task`](../../devkit/documents/nrwl_devkit#task) | +| `context` | [`HasherContext`](../../devkit/documents/nrwl_devkit#hashercontext) | ##### Returns -`Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> - ---- - -## Package Manager Type aliases - -### PackageManager - -Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"` +`Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> --- -## Project Graph Type aliases - -### ProjectGraphNode +### Executor -Ƭ **ProjectGraphNode**: [`ProjectGraphProjectNode`](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) \| [`ProjectGraphExternalNode`](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) +Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext)) => `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\> ---- +#### Type parameters -## Utils Type aliases +| Name | Type | +| :--- | :---- | +| `T` | `any` | -### AdditionalSharedConfig +#### Type declaration -Ƭ **AdditionalSharedConfig**: (`string` \| [libraryName: string, sharedConfig: SharedLibraryConfig] \| { `libraryName`: `string` ; `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) })[] +▸ (`options`, `context`): `Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\> ---- +Implementation of a target of a project -### ModuleFederationLibrary +##### Parameters -Ƭ **ModuleFederationLibrary**: `Object` +| Name | Type | +| :-------- | :---------------------------------------------------------------------- | +| `options` | `T` | +| `context` | [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext) | -#### Type declaration +##### Returns -| Name | Type | -| :----- | :------- | -| `name` | `string` | -| `type` | `string` | +`Promise`<{ `success`: `boolean` }\> \| `AsyncIterableIterator`<{ `success`: `boolean` }\> --- -### Remotes - -Ƭ **Remotes**: `string`[] \| [remoteName: string, remoteUrl: string][] +### Generator ---- +Ƭ **Generator**<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> -### SharedFunction +#### Type parameters -Ƭ **SharedFunction**: (`libraryName`: `string`, `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig)) => `undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) +| Name | Type | +| :--- | :-------- | +| `T` | `unknown` | #### Type declaration -▸ (`libraryName`, `sharedConfig`): `undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) +▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> + +A function that schedules updates to the filesystem to be done atomically ##### Parameters -| Name | Type | -| :------------- | :------------------------------------------------------------------------------ | -| `libraryName` | `string` | -| `sharedConfig` | [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) | +| Name | Type | +| :------- | :---- | +| `tree` | `any` | +| `schema` | `T` | ##### Returns -`undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) +`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> --- -### SharedWorkspaceLibraryConfig +### GeneratorCallback -Ƭ **SharedWorkspaceLibraryConfig**: `Object` +Ƭ **GeneratorCallback**: () => `void` \| `Promise`<`void`\> #### Type declaration -| Name | Type | -| :--------------------- | :---------------------------------------------------------------------------------------------------------------------------- | -| `getAliases` | () => `Record`<`string`, `string`\> | -| `getLibraries` | (`eager?`: `boolean`) => `Record`<`string`, [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig)\> | -| `getReplacementPlugin` | () => `NormalModuleReplacementPlugin` | +▸ (): `void` \| `Promise`<`void`\> ---- +A callback function that is executed after changes are made to the file system -### StringChange +##### Returns -Ƭ **StringChange**: [`StringInsertion`](../../devkit/documents/nrwl_devkit#stringinsertion) \| [`StringDeletion`](../../devkit/documents/nrwl_devkit#stringdeletion) +`void` \| `Promise`<`void`\> --- -### WorkspaceLibrary +### ImplicitDependencyEntry -Ƭ **WorkspaceLibrary**: `Object` +Ƭ **ImplicitDependencyEntry**<`T`\>: `Object` -#### Type declaration +#### Type parameters -| Name | Type | -| :---------- | :---------------------- | -| `importKey` | `string` \| `undefined` | -| `name` | `string` | -| `root` | `string` | +| Name | Type | +| :--- | :------------------ | +| `T` | `"*"` \| `string`[] | + +#### Index signature + +▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/nrwl_devkit#implicitjsonsubsetdependency)<`T`\> --- -### WorkspaceLibrarySecondaryEntryPoint +### ModuleFederationLibrary -Ƭ **WorkspaceLibrarySecondaryEntryPoint**: `Object` +Ƭ **ModuleFederationLibrary**: `Object` #### Type declaration | Name | Type | | :----- | :------- | | `name` | `string` | -| `path` | `string` | +| `type` | `string` | --- -## Workspace Type aliases - -### CustomHasher - -Ƭ **CustomHasher**: (`task`: [`Task`](../../devkit/documents/nrwl_devkit#task), `context`: [`HasherContext`](../../devkit/documents/nrwl_devkit#hashercontext)) => `Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> +### PackageManager -#### Type declaration +Ƭ **PackageManager**: `"yarn"` \| `"pnpm"` \| `"npm"` -▸ (`task`, `context`): `Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> +--- -##### Parameters +### ProjectGraphNode -| Name | Type | -| :-------- | :------------------------------------------------------------------ | -| `task` | [`Task`](../../devkit/documents/nrwl_devkit#task) | -| `context` | [`HasherContext`](../../devkit/documents/nrwl_devkit#hashercontext) | +Ƭ **ProjectGraphNode**: [`ProjectGraphProjectNode`](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) \| [`ProjectGraphExternalNode`](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) -##### Returns +**`Deprecated`** -`Promise`<[`Hash`](../../devkit/documents/nrwl_devkit#hash)\> +this type will be removed in v16. Use [ProjectGraphProjectNode](../../devkit/documents/nrwl_devkit#projectgraphprojectnode) or [ProjectGraphExternalNode](../../devkit/documents/nrwl_devkit#projectgraphexternalnode) instead --- -### Executor - -Ƭ **Executor**<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext)) => `Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\> - -#### Type parameters +### ProjectTargetConfigurator -| Name | Type | -| :--- | :---- | -| `T` | `any` | +Ƭ **ProjectTargetConfigurator**: (`file`: `string`) => `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> #### Type declaration -▸ (`options`, `context`): `Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\> - -Implementation of a target of a project +▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> ##### Parameters -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `options` | `T` | -| `context` | [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext) | - -##### Returns - -`Promise`<`Object`\> \| `AsyncIterableIterator`<`Object`\> - ---- - -### Generator - -Ƭ **Generator**<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> +| Name | Type | +| :----- | :------- | +| `file` | `string` | -#### Type parameters +##### Returns -| Name | Type | -| :--- | :-------- | -| `T` | `unknown` | +`Record`<`string`, [`TargetConfiguration`](../../devkit/documents/nrwl_devkit#targetconfiguration)\> -#### Type declaration +--- -▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> +### ProjectType -A function that schedules updates to the filesystem to be done atomically +Ƭ **ProjectType**: `"library"` \| `"application"` -##### Parameters +Type of project supported -| Name | Type | -| :------- | :---- | -| `tree` | `any` | -| `schema` | `T` | +--- -##### Returns +### Remotes -`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) \| `Promise`<`void` \| [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback)\> +Ƭ **Remotes**: `string`[] \| [remoteName: string, remoteUrl: string][] --- -### GeneratorCallback +### SharedFunction -Ƭ **GeneratorCallback**: () => `void` \| `Promise`<`void`\> +Ƭ **SharedFunction**: (`libraryName`: `string`, `sharedConfig`: [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig)) => `undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) #### Type declaration -▸ (): `void` \| `Promise`<`void`\> +▸ (`libraryName`, `sharedConfig`): `undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) -A callback function that is executed after changes are made to the file system +##### Parameters + +| Name | Type | +| :------------- | :------------------------------------------------------------------------------ | +| `libraryName` | `string` | +| `sharedConfig` | [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) | ##### Returns -`void` \| `Promise`<`void`\> +`undefined` \| `false` \| [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig) --- -### ImplicitDependencyEntry - -Ƭ **ImplicitDependencyEntry**<`T`\>: `Object` - -#### Type parameters +### SharedWorkspaceLibraryConfig -| Name | Type | -| :--- | :------------------ | -| `T` | `"*"` \| `string`[] | +Ƭ **SharedWorkspaceLibraryConfig**: `Object` -#### Index signature +#### Type declaration -▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/nrwl_devkit#implicitjsonsubsetdependency)<`T`\> +| Name | Type | +| :--------------------- | :---------------------------------------------------------------------------------------------------------------------------- | +| `getAliases` | () => `Record`<`string`, `string`\> | +| `getLibraries` | (`eager?`: `boolean`) => `Record`<`string`, [`SharedLibraryConfig`](../../devkit/documents/nrwl_devkit#sharedlibraryconfig)\> | +| `getReplacementPlugin` | () => `NormalModuleReplacementPlugin` | --- -### ProjectType +### StringChange -Ƭ **ProjectType**: `"library"` \| `"application"` +Ƭ **StringChange**: [`StringInsertion`](../../devkit/documents/nrwl_devkit#stringinsertion) \| [`StringDeletion`](../../devkit/documents/nrwl_devkit#stringdeletion) + +A change to be made to a string --- ### TaskGraphExecutor -Ƭ **TaskGraphExecutor**<`T`\>: (`taskGraph`: [`TaskGraph`](../../devkit/documents/nrwl_devkit#taskgraph), `options`: `Record`<`string`, `T`\>, `overrides`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext)) => `Promise`<`Record`<`string`, `Object`\>\> +Ƭ **TaskGraphExecutor**<`T`\>: (`taskGraph`: [`TaskGraph`](../../devkit/documents/nrwl_devkit#taskgraph), `options`: `Record`<`string`, `T`\>, `overrides`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext)) => `Promise`<`Record`<`string`, { `success`: `boolean` ; `terminalOutput`: `string` }\>\> #### Type parameters @@ -755,7 +713,7 @@ A callback function that is executed after changes are made to the file system #### Type declaration -▸ (`taskGraph`, `options`, `overrides`, `context`): `Promise`<`Record`<`string`, `Object`\>\> +▸ (`taskGraph`, `options`, `overrides`, `context`): `Promise`<`Record`<`string`, { `success`: `boolean` ; `terminalOutput`: `string` }\>\> Implementation of a target of a project that handles multiple projects to be batched @@ -770,7 +728,17 @@ Implementation of a target of a project that handles multiple projects to be bat ##### Returns -`Promise`<`Record`<`string`, `Object`\>\> +`Promise`<`Record`<`string`, { `success`: `boolean` ; `terminalOutput`: `string` }\>\> + +--- + +### WorkspaceConfiguration + +Ƭ **WorkspaceConfiguration**: `Omit`<[`ProjectsConfigurations`](../../devkit/documents/nrwl_devkit#projectsconfigurations), `"projects"`\> & `Partial`<[`NxJsonConfiguration`](../../devkit/documents/nrwl_devkit#nxjsonconfiguration)\> + +**`Deprecated`** + +using NxJsonConfiguration --- @@ -778,56 +746,99 @@ Implementation of a target of a project that handles multiple projects to be bat Ƭ **WorkspaceJsonConfiguration**: [`ProjectsConfigurations`](../../devkit/documents/nrwl_devkit#projectsconfigurations) -## Logger Variables +**`Deprecated`** -### logger +use ProjectsConfigurations + +--- + +### WorkspaceLibrary -• **logger**: `Object` +Ƭ **WorkspaceLibrary**: `Object` #### Type declaration -| Name | Type | -| :------ | :-------------------------- | -| `debug` | (...`s`: `any`[]) => `void` | -| `error` | (`s`: `any`) => `void` | -| `fatal` | (...`s`: `any`[]) => `void` | -| `info` | (`s`: `any`) => `void` | -| `log` | (...`s`: `any`[]) => `void` | -| `warn` | (`s`: `any`) => `void` | +| Name | Type | +| :---------- | :---------------------- | +| `importKey` | `string` \| `undefined` | +| `name` | `string` | +| `root` | `string` | --- -## Utils Variables +### WorkspaceLibrarySecondaryEntryPoint + +Ƭ **WorkspaceLibrarySecondaryEntryPoint**: `Object` + +#### Type declaration + +| Name | Type | +| :----- | :------- | +| `name` | `string` | +| `path` | `string` | + +## Variables ### NX_VERSION -• **NX_VERSION**: `string` +• `Const` **NX_VERSION**: `string` + +**`Description`** + +The version of Nx used by the workspace. Returns null if no version is found. --- ### appRootPath -• **appRootPath**: `string` = `workspaceRoot` +• `Const` **appRootPath**: `string` = `workspaceRoot` + +The root of the workspace. + +**`Deprecated`** + +use workspaceRoot instead --- ### cacheDir -• **cacheDir**: `string` +• `Const` **cacheDir**: `string` + +Path to the directory where Nx stores its cache and daemon-related files. + +--- + +### logger + +• `Const` **logger**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :-------------------------- | +| `debug` | (...`s`: `any`[]) => `void` | +| `error` | (`s`: `any`) => `void` | +| `fatal` | (...`s`: `any`[]) => `void` | +| `info` | (`s`: `any`) => `void` | +| `log` | (...`s`: `any`[]) => `void` | +| `warn` | (`s`: `any`) => `void` | --- ### output -• **output**: `CLIOutput` +• `Const` **output**: `CLIOutput` --- ### workspaceRoot -• **workspaceRoot**: `string` +• `Const` **workspaceRoot**: `string` -## Other Functions +The root of the workspace + +## Functions ### addDependenciesToPackageJson @@ -1045,9 +1056,11 @@ Convert an Nx Generator into an Angular Devkit Schematic. ### createLockFile -▸ `Const` **createLockFile**(`packageJson`, `packageManager?`): `string` +▸ **createLockFile**(`packageJson`, `packageManager?`): `string` + +**`Deprecated`** -**`deprecated`** Import this from @nrwl/js instead +Import this from @nrwl/js instead #### Parameters @@ -1064,9 +1077,11 @@ Convert an Nx Generator into an Angular Devkit Schematic. ### createPackageJson -▸ `Const` **createPackageJson**(`projectName`, `graph`, `options?`): `PackageJson` +▸ **createPackageJson**(`projectName`, `graph`, `options?`): `PackageJson` -**`deprecated`** Import this from @nrwl/js instead +**`Deprecated`** + +Import this from @nrwl/js instead #### Parameters @@ -1128,7 +1143,10 @@ stored in the daemon process. To reset both run: `nx reset`. ### defaultTasksRunner -▸ `Const` **defaultTasksRunner**(`tasks`, `options`, `context?`): `any` +▸ **defaultTasksRunner**(`tasks`, `options`, `context?`): `any` + +`any | Promise<{ [id: string]: TaskStatus }>` +will change to Promise<{ [id: string]: TaskStatus }> after Nx 15 is released. #### Parameters @@ -1188,6 +1206,69 @@ Detect workspace scope from the package.json name --- +### ensurePackage + +▸ **ensurePackage**(`tree`, `pkg`, `requiredVersion`, `options?`): `void` + +**`Deprecated`** + +Use the other function signature without a Tree + +Use a package that has not been installed as a dependency. + +For example: + +```typescript +ensurePackage(tree, '@nrwl/jest', nxVersion); +``` + +This install the @nrwl/jest@ and return the module +When running with --dryRun, the function will throw when dependencies are missing. + +#### Parameters + +| Name | Type | Description | +| :------------------------ | :------------------------------------------------ | :----------------------------------------------------------------- | +| `tree` | [`Tree`](../../devkit/documents/nrwl_devkit#tree) | the file system tree | +| `pkg` | `string` | the package to check (e.g. @nrwl/jest) | +| `requiredVersion` | `string` | the version or semver range to check (e.g. ~1.0.0, >=1.0.0 <2.0.0) | +| `options?` | `Object` | - | +| `options.dev?` | `boolean` | - | +| `options.throwOnMissing?` | `boolean` | - | + +#### Returns + +`void` + +▸ **ensurePackage**<`T`\>(`pkg`, `version`): `T` + +Ensure that dependencies and devDependencies from package.json are installed at the required versions. + +For example: + +```typescript +ensurePackage(tree, '@nrwl/jest', nxVersion); +``` + +#### Type parameters + +| Name | Type | +| :--- | :------------------------ | +| `T` | extends `unknown` = `any` | + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :---------------------------------------------------------- | +| `pkg` | `string` | the package to install and require | +| `version` | `string` | the version to install if the package doesn't exist already | + +#### Returns + +`T` + +--- + ### extractLayoutDirectory ▸ **extractLayoutDirectory**(`directory`): `Object` @@ -1452,7 +1533,9 @@ Example: ▸ **getWorkspacePath**(`tree`): `"angular.json"` \| `"workspace.json"` -**`deprecated`** all projects are configured using project.json +**`Deprecated`** + +all projects are configured using project.json #### Parameters @@ -1494,7 +1577,9 @@ Runs `npm install` or `yarn install`. It will skip running the install if Returns if a project has a standalone configuration (project.json). -**`deprecated`** non-standalone projects were deprecated +**`Deprecated`** + +non-standalone projects were deprecated #### Parameters @@ -1511,7 +1596,7 @@ Returns if a project has a standalone configuration (project.json). ### joinPathFragments -▸ **joinPathFragments**(...`fragments`): `string` +▸ **joinPathFragments**(`...fragments`): `string` Normalized path fragments and joins them @@ -1697,7 +1782,7 @@ Object the JSON content represents ▸ **parseTargetString**(`targetString`): [`Target`](../../devkit/documents/nrwl_devkit#target) -**`deprecated(v17)`** A project graph should be passed to parseTargetString for best accuracy. +@deprecated(v17) A project graph should be passed to parseTargetString for best accuracy. #### Parameters @@ -1739,7 +1824,9 @@ parseTargetString('proj:test:production', graph); // returns { project: "proj", TODO(vsavkin): Remove after Nx 16 is out -**`deprecated`** Use readProjectsConfigurationFromProjectGraph(await createProjectGraphAsync()) +**`Deprecated`** + +Use readProjectsConfigurationFromProjectGraph(await createProjectGraphAsync()) #### Returns @@ -1753,7 +1840,9 @@ TODO(vsavkin): Remove after Nx 16 is out Synchronously reads the latest cached copy of the workspace's ProjectGraph. -**`throws`** {Error} if there is no cached ProjectGraph to read from +**`Throws`** + +if there is no cached ProjectGraph to read from #### Returns @@ -1818,9 +1907,9 @@ Object the JSON content of the file represents ▸ **readNxJson**(): [`NxJsonConfiguration`](../../devkit/documents/nrwl_devkit#nxjsonconfiguration) \| `null` -Reads nx.json +**`Deprecated`** -**`deprecated`** You must pass a [Tree](../../devkit/documents/nrwl_devkit#tree) +You must pass a [Tree](../../devkit/documents/nrwl_devkit#tree) #### Returns @@ -1848,7 +1937,9 @@ Reads nx.json Reads a project configuration. -**`throws`** If supplied projectName cannot be found +**`Throws`** + +If supplied projectName cannot be found #### Parameters @@ -1871,16 +1962,16 @@ Reads a project configuration. `Object` -| Name | Type | -| :----------------- | :------- | -| `dependencies?` | `Object` | -| `devDependencies?` | `Object` | +| Name | Type | +| :----------------- | :----------------------------- | +| `dependencies?` | { `[key: string]`: `string`; } | +| `devDependencies?` | { `[key: string]`: `string`; } | --- ### readTargetOptions -▸ **readTargetOptions**<`T`\>(`__namedParameters`, `context`): `T` +▸ **readTargetOptions**<`T`\>(`«destructured»`, `context`): `T` Reads and combines options for a given target. @@ -1894,10 +1985,10 @@ Works as if you invoked the target yourself without passing any command lint ove #### Parameters -| Name | Type | -| :------------------ | :---------------------------------------------------------------------- | -| `__namedParameters` | [`Target`](../../devkit/documents/nrwl_devkit#target) | -| `context` | [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext) | +| Name | Type | +| :--------------- | :---------------------------------------------------------------------- | +| `«destructured»` | [`Target`](../../devkit/documents/nrwl_devkit#target) | +| `context` | [`ExecutorContext`](../../devkit/documents/nrwl_devkit#executorcontext) | #### Returns @@ -1913,7 +2004,9 @@ Read general workspace configuration such as the default project or cli settings This does _not_ provide projects configuration, use [readProjectConfiguration](../../devkit/documents/nrwl_devkit#readprojectconfiguration) instead. -**`deprecated`** use readNxJson +**`Deprecated`** + +use readNxJson #### Parameters @@ -2055,7 +2148,7 @@ Note that the return value is a promise of an iterator, so you need to await bef ### runTasksInSerial -▸ **runTasksInSerial**(...`tasks`): [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) +▸ **runTasksInSerial**(`...tasks`): [`GeneratorCallback`](../../devkit/documents/nrwl_devkit#generatorcallback) Run tasks in serial @@ -2143,7 +2236,7 @@ share Nx Workspace Libraries between Hosts and Remotes. ### stripIndents -▸ **stripIndents**(`strings`, ...`values`): `string` +▸ **stripIndents**(`strings`, `...values`): `string` Removes indents, which is useful for printing warning and messages. @@ -2172,7 +2265,7 @@ stripIndents` ### stripJsonComments -▸ `Const` **stripJsonComments**(`text`, `replaceCh?`): `string` +▸ **stripJsonComments**(`text`, `replaceCh?`): `string` Takes JSON with JavaScript-style comments and remove them. Optionally replaces every none-newline character @@ -2320,7 +2413,9 @@ Update general workspace configuration such as the default project or cli settin This does _not_ update projects configuration, use [updateProjectConfiguration](../../devkit/documents/nrwl_devkit#updateprojectconfiguration) or [addProjectConfiguration](../../devkit/documents/nrwl_devkit#addprojectconfiguration) instead. -**`deprecated`** use updateNxJson +**`Deprecated`** + +use updateNxJson #### Parameters @@ -2422,66 +2517,3 @@ Serializes the given data to JSON and writes it to a file. #### Returns `void` - ---- - -## Utils Functions - -### ensurePackage - -▸ **ensurePackage**(`tree`, `pkg`, `requiredVersion`, `options?`): `void` - -**`deprecated`** Use the other function signature without a Tree - -Use a package that has not been installed as a dependency. - -For example: - -```typescript -ensurePackage(tree, '@nrwl/jest', nxVersion); -``` - -This install the @nrwl/jest@ and return the module -When running with --dryRun, the function will throw when dependencies are missing. - -#### Parameters - -| Name | Type | Description | -| :------------------------ | :------------------------------------------------ | :----------------------------------------------------------------- | -| `tree` | [`Tree`](../../devkit/documents/nrwl_devkit#tree) | the file system tree | -| `pkg` | `string` | the package to check (e.g. @nrwl/jest) | -| `requiredVersion` | `string` | the version or semver range to check (e.g. ~1.0.0, >=1.0.0 <2.0.0) | -| `options?` | `Object` | - | -| `options.dev?` | `boolean` | - | -| `options.throwOnMissing?` | `boolean` | - | - -#### Returns - -`void` - -▸ **ensurePackage**<`T`\>(`pkg`, `version`): `T` - -Ensure that dependencies and devDependencies from package.json are installed at the required versions. - -For example: - -```typescript -ensurePackage(tree, '@nrwl/jest', nxVersion); -``` - -#### Type parameters - -| Name | Type | -| :--- | :------------------------ | -| `T` | extends `unknown` = `any` | - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :---------------------------------------------------------- | -| `pkg` | `string` | the package to install and require | -| `version` | `string` | the version to install if the package doesn't exist already | - -#### Returns - -`T` diff --git a/package.json b/package.json index a507c5b356bcc..fed1e63d7514e 100644 --- a/package.json +++ b/package.json @@ -249,8 +249,8 @@ "tsconfig-paths": "^4.1.2", "tsconfig-paths-webpack-plugin": "4.0.0", "tslint-to-eslint-config": "^2.13.0", - "typedoc": "0.22.9", - "typedoc-plugin-markdown": "3.11.6", + "typedoc": "0.23.28", + "typedoc-plugin-markdown": "3.14.0", "typescript": "~4.9.5", "unzipper": "^0.10.11", "url-loader": "^4.1.1", diff --git a/scripts/documentation/generators/generate-devkit-documentation.ts b/scripts/documentation/generators/generate-devkit-documentation.ts index 8adf762cef7a1..39703b1f4d945 100644 --- a/scripts/documentation/generators/generate-devkit-documentation.ts +++ b/scripts/documentation/generators/generate-devkit-documentation.ts @@ -9,10 +9,13 @@ export function generateDevkitDocumentation() { stdio: process.env.CI === 'true' ? 'inherit' : 'ignore', }; - execSync('nx build typedoc-theme', execSyncOptions); + execSync( + 'nx build typedoc-theme && rm -rf node_modules/@nrwl/typedoc-theme && cp -R dist/typedoc-theme node_modules/@nrwl/typedoc-theme', + execSyncOptions + ); execSync( - `rm -rf docs/generated/devkit && npx typedoc packages/devkit/index.d.ts packages/devkit/ngcli-adapter.ts --tsconfig packages/devkit/tsconfig.lib.json --out ./docs/generated/devkit --hideBreadcrumbs true --disableSources --publicPath ../../devkit/ --theme dist/typedoc-theme/src/lib --readme none`, + `rm -rf docs/generated/devkit && npx typedoc packages/devkit/index.d.ts packages/devkit/ngcli-adapter.ts --tsconfig packages/devkit/tsconfig.lib.json --out ./docs/generated/devkit --hideBreadcrumbs true --disableSources --publicPath ../../devkit/ --theme nx-markdown-theme --readme none`, execSyncOptions ); execSync( diff --git a/typedoc-theme/package.json b/typedoc-theme/package.json index 9240fecc513df..85222f5b230a5 100644 --- a/typedoc-theme/package.json +++ b/typedoc-theme/package.json @@ -1,4 +1,7 @@ { "name": "@nrwl/typedoc-theme", - "version": "0.0.1" + "version": "0.0.1", + "keywords": [ + "typedocplugin" + ] } diff --git a/typedoc-theme/src/index.ts b/typedoc-theme/src/index.ts index 0aba4424b2c37..d155b8ed1c642 100644 --- a/typedoc-theme/src/index.ts +++ b/typedoc-theme/src/index.ts @@ -1,4 +1,6 @@ -import NrwlMarkdownTheme from './lib/theme'; +import { Application } from 'typedoc'; +import NxMarkdownTheme from './lib/theme'; -export * from './lib/theme'; -export default NrwlMarkdownTheme; +export function load(app: Application) { + app.renderer.defineTheme('nx-markdown-theme', NxMarkdownTheme); +} diff --git a/typedoc-theme/src/lib/theme.ts b/typedoc-theme/src/lib/theme.ts index 90fcaf3ceef71..654ea022f7b66 100644 --- a/typedoc-theme/src/lib/theme.ts +++ b/typedoc-theme/src/lib/theme.ts @@ -7,7 +7,7 @@ import { MarkdownTheme } from 'typedoc-plugin-markdown/dist/theme'; * - markdown specefic components have been added */ -export default class NrwlMarkdownTheme extends MarkdownTheme { +export default class NxMarkdownTheme extends MarkdownTheme { constructor(renderer) { super(renderer); } diff --git a/yarn.lock b/yarn.lock index 53f44ac751158..708b5013a1394 100644 --- a/yarn.lock +++ b/yarn.lock @@ -9175,6 +9175,11 @@ ansi-regex@^5.0.1: resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== +ansi-sequence-parser@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/ansi-sequence-parser/-/ansi-sequence-parser-1.1.0.tgz#4d790f31236ac20366b23b3916b789e1bde39aed" + integrity sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ== + ansi-styles@^2.2.1: version "2.2.1" resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-2.2.1.tgz#b432dd3358b634cf75e1e4664368240533c1ddbe" @@ -14766,7 +14771,7 @@ glob@^6.0.1: once "^1.3.0" path-is-absolute "^1.0.0" -glob@^7.0.0, glob@^7.1.1, glob@^7.1.3, glob@^7.1.4, glob@^7.1.6, glob@^7.2.0: +glob@^7.0.0, glob@^7.1.1, glob@^7.1.3, glob@^7.1.4, glob@^7.1.6: version "7.2.3" resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== @@ -17501,7 +17506,7 @@ jsonc-parser@3.1.0: resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.1.0.tgz#73b8f0e5c940b83d03476bc2e51a20ef0932615d" integrity sha512-DRf0QjnNeCUds3xTjKlQQ3DpJD51GvDjJfnxUVWg6PZTo2otSm+slzNAxU/35hF8/oJIKoG9slq30JYOsF2azg== -jsonc-parser@3.2.0, jsonc-parser@^3.0.0, jsonc-parser@^3.2.0: +jsonc-parser@3.2.0, jsonc-parser@^3.2.0: version "3.2.0" resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.0.tgz#31ff3f4c2b9793f89c67212627c51c6394f88e76" integrity sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w== @@ -18373,10 +18378,10 @@ marked@4.1.0: resolved "https://registry.yarnpkg.com/marked/-/marked-4.1.0.tgz#3fc6e7485f21c1ca5d6ec4a39de820e146954796" integrity sha512-+Z6KDjSPa6/723PQYyc1axYZpYYpDnECDaU6hkaf5gqBieBkMKYReL5hteF2QizhlMbgbo8umXl/clZ67+GlsA== -marked@^3.0.8: - version "3.0.8" - resolved "https://registry.yarnpkg.com/marked/-/marked-3.0.8.tgz#2785f0dc79cbdc6034be4bb4f0f0a396bd3f8aeb" - integrity sha512-0gVrAjo5m0VZSJb4rpL59K1unJAMb/hm8HRXqasD8VeC8m91ytDPMritgFSlKonfdt+rRYYpP/JfLxgIX8yoSw== +marked@^4.2.12: + version "4.3.0" + resolved "https://registry.yarnpkg.com/marked/-/marked-4.3.0.tgz#796362821b019f734054582038b116481b456cf3" + integrity sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A== md5.js@^1.3.4: version "1.3.5" @@ -18717,6 +18722,13 @@ minimatch@^6.1.0: dependencies: brace-expansion "^2.0.1" +minimatch@^7.1.3: + version "7.4.3" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-7.4.3.tgz#012cbf110a65134bb354ae9773b55256cdb045a2" + integrity sha512-5UB4yYusDtkRPbRiy1cqZ1IpGNcJCGlEMG17RKzPddpyiPKoCdwohbED8g4QXT0ewCt8LTkQXuljsUfQ3FKM4A== + dependencies: + brace-expansion "^2.0.1" + minimatch@~3.0.4: version "3.0.8" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.8.tgz#5e6a59bd11e2ab0de1cfb843eb2d82e546c321c1" @@ -23138,14 +23150,15 @@ shelljs@0.8.5: interpret "^1.0.0" rechoir "^0.6.2" -shiki@^0.9.12: - version "0.9.15" - resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.9.15.tgz#2481b46155364f236651319d2c18e329ead6fa44" - integrity sha512-/Y0z9IzhJ8nD9nbceORCqu6NgT9X6I8Fk8c3SICHI5NbZRLdZYFaB233gwct9sU0vvSypyaL/qaKvzyQGJBZSw== +shiki@^0.14.1: + version "0.14.1" + resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.14.1.tgz#9fbe082d0a8aa2ad63df4fbf2ee11ec924aa7ee1" + integrity sha512-+Jz4nBkCBe0mEDqo1eKRcCdjRtrCjozmcbTUjbPTX7OOJfEbTZzlUWlZtGe3Gb5oV1/jnojhG//YZc3rs9zSEw== dependencies: - jsonc-parser "^3.0.0" - vscode-oniguruma "^1.6.1" - vscode-textmate "5.2.0" + ansi-sequence-parser "^1.1.0" + jsonc-parser "^3.2.0" + vscode-oniguruma "^1.7.0" + vscode-textmate "^8.0.0" side-channel@^1.0.3, side-channel@^1.0.4: version "1.0.4" @@ -24862,23 +24875,22 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA== -typedoc-plugin-markdown@3.11.6: - version "3.11.6" - resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.11.6.tgz#6690e8f25fa9c031c0615ee912744fc151a997b8" - integrity sha512-CV1BuxL7HR/EE1ctnPXOWzf4/Exl0FzkwtFVYaKTVWTnD/dkFLgABOfWuOL4lPmzLUOsAL85pmq+/PB6cdRppw== +typedoc-plugin-markdown@3.14.0: + version "3.14.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.14.0.tgz#17b99ee3ab0d21046d253f185f7669e80d0d7891" + integrity sha512-UyQLkLRkfTFhLdhSf3RRpA3nNInGn+k6sll2vRXjflaMNwQAAiB61SYbisNZTg16t4K1dt1bPQMMGLrxS0GZ0Q== dependencies: handlebars "^4.7.7" -typedoc@0.22.9: - version "0.22.9" - resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.22.9.tgz#7e3f4f72586bbef4c2382f0afcea8e0f9270b712" - integrity sha512-84PjudoXVcap6bwdZFbYIUWlgdz/iLV09ZHwrCzhtHWXaDQG6mlosJ8te6DSThuRkRvQjp46HO+qY/P7Gpm78g== +typedoc@0.23.28: + version "0.23.28" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.23.28.tgz#3ce9c36ef1c273fa849d2dea18651855100d3ccd" + integrity sha512-9x1+hZWTHEQcGoP7qFmlo4unUoVJLB0H/8vfO/7wqTnZxg4kPuji9y3uRzEu0ZKez63OJAUmiGhUrtukC6Uj3w== dependencies: - glob "^7.2.0" lunr "^2.3.9" - marked "^3.0.8" - minimatch "^3.0.4" - shiki "^0.9.12" + marked "^4.2.12" + minimatch "^7.1.3" + shiki "^0.14.1" typescript@4.8.2: version "4.8.2" @@ -25492,15 +25504,15 @@ vm-browserify@^1.0.1: resolved "https://registry.yarnpkg.com/vm-browserify/-/vm-browserify-1.1.2.tgz#78641c488b8e6ca91a75f511e7a3b32a86e5dda0" integrity sha512-2ham8XPWTONajOR0ohOKOHXkm3+gaBmGut3SRuu75xLd/RRaY6vqgh8NBYYk7+RW3u5AtzPQZG8F10LHkl0lAQ== -vscode-oniguruma@^1.6.1: +vscode-oniguruma@^1.7.0: version "1.7.0" resolved "https://registry.yarnpkg.com/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz#439bfad8fe71abd7798338d1cd3dc53a8beea94b" integrity sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA== -vscode-textmate@5.2.0: - version "5.2.0" - resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-5.2.0.tgz#01f01760a391e8222fe4f33fbccbd1ad71aed74e" - integrity sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ== +vscode-textmate@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-8.0.0.tgz#2c7a3b1163ef0441097e0b5d6389cd5504b59e5d" + integrity sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg== w3c-hr-time@^1.0.2: version "1.0.2"