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

chore(repo): bump deprecation messages to v19 (#21430)

Browse Source
This commit is contained in:
Craigory Coppola 2024-01-30 16:29:05 -05:00 committed by GitHub
parent ce465dcff4
commit deb0f1a492
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
191 changed files with 350 additions and 350 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/generated/cli/affected-graph.md
View File

@ -5,7 +5,7 @@ description: 'Graph dependencies affected by changes'
# affected:graph # affected:graph
**Deprecated:** Use `nx graph --affected`, or `nx affected --graph` instead depending on which best suits your use case. The `affected:graph` command will be removed in Nx 18. **Deprecated:** Use `nx graph --affected`, or `nx affected --graph` instead depending on which best suits your use case. The `affected:graph` command will be removed in Nx 19.
Graph dependencies affected by changes Graph dependencies affected by changes

2
docs/generated/cli/print-affected.md
View File

@ -5,7 +5,7 @@ description: 'Prints information about the projects and targets affected by chan
# print-affected # print-affected
**Deprecated:** Use `nx show projects --affected`, `nx affected --graph -t build` or `nx graph --affected` depending on which best suits your use case. The `print-affected` command will be removed in Nx 18. **Deprecated:** Use `nx show projects --affected`, `nx affected --graph -t build` or `nx graph --affected` depending on which best suits your use case. The `print-affected` command will be removed in Nx 19.
Prints information about the projects and targets affected by changes Prints information about the projects and targets affected by changes

8
docs/generated/devkit/NxPluginV1.md
View File

@ -4,13 +4,13 @@
**`Deprecated`** **`Deprecated`**
Use [NxPluginV2](../../devkit/documents/NxPluginV2) instead. This will be removed in Nx 18 Use [NxPluginV2](../../devkit/documents/NxPluginV2) instead. This will be removed in Nx 19
#### Type declaration #### Type declaration
| Name | Type | Description | | Name | Type | Description |
| :------------------------ | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :------------------------ | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | `string` | - | | `name` | `string` | - |
| `processProjectGraph?` | `ProjectGraphProcessor` | **`Deprecated`** Use [CreateNodes](../../devkit/documents/CreateNodes) and [CreateDependencies](../../devkit/documents/CreateDependencies) instead. This will be removed in Nx 18 | | `processProjectGraph?` | `ProjectGraphProcessor` | **`Deprecated`** Use [CreateNodes](../../devkit/documents/CreateNodes) and [CreateDependencies](../../devkit/documents/CreateDependencies) instead. This will be removed in Nx 19 |
| `projectFilePatterns?` | `string`[] | A glob pattern to search for non-standard project files. @example: ["*.csproj", "pom.xml"] **`Deprecated`** Use [CreateNodes](../../devkit/documents/CreateNodes) instead. This will be removed in Nx 18 | | `projectFilePatterns?` | `string`[] | A glob pattern to search for non-standard project files. @example: ["*.csproj", "pom.xml"] **`Deprecated`** Use [CreateNodes](../../devkit/documents/CreateNodes) instead. This will be removed in Nx 19 |
| `registerProjectTargets?` | [`ProjectTargetConfigurator`](../../devkit/documents/ProjectTargetConfigurator) | **`Deprecated`** Add targets to the projects inside of [CreateNodes](../../devkit/documents/CreateNodes) instead. This will be removed in Nx 18 | | `registerProjectTargets?` | [`ProjectTargetConfigurator`](../../devkit/documents/ProjectTargetConfigurator) | **`Deprecated`** Add targets to the projects inside of [CreateNodes](../../devkit/documents/CreateNodes) instead. This will be removed in Nx 19 |

2
docs/generated/devkit/ProjectGraphBuilder.md
View File

@ -4,7 +4,7 @@ A class which builds up a project graph
**`Deprecated`** **`Deprecated`**
The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/documents/CreateNodes) and/or a [CreateDependencies](../../devkit/documents/CreateDependencies) instead. This will be removed in Nx 18. The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/documents/CreateNodes) and/or a [CreateDependencies](../../devkit/documents/CreateDependencies) instead. This will be removed in Nx 19.
## Table of contents ## Table of contents

2
docs/generated/devkit/ProjectGraphProcessorContext.md
View File

@ -4,7 +4,7 @@ Additional information to be used to process a project graph
**`Deprecated`** **`Deprecated`**
The ProjectGraphProcessor is deprecated. This will be removed in Nx 18. The ProjectGraphProcessor is deprecated. This will be removed in Nx 19.
## Table of contents ## Table of contents

2
docs/generated/devkit/ProjectTargetConfigurator.md
View File

@ -18,4 +18,4 @@
**`Deprecated`** **`Deprecated`**
Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNodes) function instead. This will be removed in Nx 18 Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNodes) function instead. This will be removed in Nx 19

8
docs/generated/devkit/TaskHasher.md
View File

@ -25,7 +25,7 @@
**`Deprecated`** **`Deprecated`**
use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18 use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v19
▸ **hashTask**(`task`, `taskGraph`): `Promise`\<[`Hash`](../../devkit/documents/Hash)\> ▸ **hashTask**(`task`, `taskGraph`): `Promise`\<[`Hash`](../../devkit/documents/Hash)\>
@ -42,7 +42,7 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
**`Deprecated`** **`Deprecated`**
use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18 use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v19
▸ **hashTask**(`task`, `taskGraph`, `env`): `Promise`\<[`Hash`](../../devkit/documents/Hash)\> ▸ **hashTask**(`task`, `taskGraph`, `env`): `Promise`\<[`Hash`](../../devkit/documents/Hash)\>
@ -76,7 +76,7 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
**`Deprecated`** **`Deprecated`**
use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18 use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v19
▸ **hashTasks**(`tasks`, `taskGraph`): `Promise`\<[`Hash`](../../devkit/documents/Hash)[]\> ▸ **hashTasks**(`tasks`, `taskGraph`): `Promise`\<[`Hash`](../../devkit/documents/Hash)[]\>
@ -93,7 +93,7 @@ use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instea
**`Deprecated`** **`Deprecated`**
use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18 use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v19
▸ **hashTasks**(`tasks`, `taskGraph`, `env`): `Promise`\<[`Hash`](../../devkit/documents/Hash)[]\> ▸ **hashTasks**(`tasks`, `taskGraph`, `env`): `Promise`\<[`Hash`](../../devkit/documents/Hash)[]\>

2
docs/generated/devkit/Workspaces.md
View File

@ -2,7 +2,7 @@
**`Deprecated`** **`Deprecated`**
This will be removed in v18. Use [readProjectsConfigurationFromProjectGraph](../../devkit/documents/readProjectsConfigurationFromProjectGraph) instead. This will be removed in v19. Use [readProjectsConfigurationFromProjectGraph](../../devkit/documents/readProjectsConfigurationFromProjectGraph) instead.
## Table of contents ## Table of contents

2
docs/generated/devkit/getOutputsForTargetAndConfiguration.md
View File

@ -15,7 +15,7 @@
**`Deprecated`** **`Deprecated`**
Pass the target and overrides instead. This will be removed in v18. Pass the target and overrides instead. This will be removed in v19.
▸ **getOutputsForTargetAndConfiguration**(`target`, `overrides`, `node`): `string`[] ▸ **getOutputsForTargetAndConfiguration**(`target`, `overrides`, `node`): `string`[]

2
docs/generated/packages/angular/executors/dev-server.json
View File

@ -17,7 +17,7 @@
"type": "string", "type": "string",
"description": "A browser builder target to serve in the format of `project:target[:configuration]`. Ignored if `buildTarget` is set.", "description": "A browser builder target to serve in the format of `project:target[:configuration]`. Ignored if `buildTarget` is set.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$", "pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$",
"x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v18." "x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v19."
}, },
"buildTarget": { "buildTarget": {
"type": "string", "type": "string",

2
docs/generated/packages/angular/executors/module-federation-dev-server.json
View File

@ -15,7 +15,7 @@
"type": "string", "type": "string",
"description": "A browser builder target to serve in the format of `project:target[:configuration]`.", "description": "A browser builder target to serve in the format of `project:target[:configuration]`.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$", "pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$",
"x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v18." "x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v19."
}, },
"buildTarget": { "buildTarget": {
"type": "string", "type": "string",

4
docs/generated/packages/angular/generators/component.json
View File

@ -32,7 +32,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"prefix": { "prefix": {
"type": "string", "type": "string",
@ -96,7 +96,7 @@
"type": "boolean", "type": "boolean",
"description": "Create the new files at the top level of the current project.", "description": "Create the new files at the top level of the current project.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"skipImport": { "skipImport": {
"type": "boolean", "type": "boolean",

4
docs/generated/packages/angular/generators/directive.json
View File

@ -32,7 +32,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"prefix": { "prefix": {
"type": "string", "type": "string",
@ -67,7 +67,7 @@
"type": "boolean", "type": "boolean",
"description": "When true (the default), creates the new files at the top level of the current project.", "description": "When true (the default), creates the new files at the top level of the current project.",
"default": true, "default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"module": { "module": {
"type": "string", "type": "string",

2
docs/generated/packages/angular/generators/move.json
View File

@ -62,7 +62,7 @@
}, },
"aliases": ["mv"], "aliases": ["mv"],
"description": "Moves an Angular application or library to another folder within the workspace and updates the project configuration.", "description": "Moves an Angular application or library to another folder within the workspace and updates the project configuration.",
"x-deprecated": "Use the `@nx/workspace:move` generator instead. This generator will be removed in Nx v18.", "x-deprecated": "Use the `@nx/workspace:move` generator instead. This generator will be removed in Nx v19.",
"implementation": "/packages/angular/src/generators/move/move#angularMoveGeneratorInternal.ts", "implementation": "/packages/angular/src/generators/move/move#angularMoveGeneratorInternal.ts",
"hidden": false, "hidden": false,
"path": "/packages/angular/src/generators/move/schema.json", "path": "/packages/angular/src/generators/move/schema.json",

4
docs/generated/packages/angular/generators/pipe.json
View File

@ -32,13 +32,13 @@
"description": "The name of the project.", "description": "The name of the project.",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"flat": { "flat": {
"type": "boolean", "type": "boolean",
"default": true, "default": true,
"description": "When true (the default) creates files at the top level of the project.", "description": "When true (the default) creates files at the top level of the project.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"skipTests": { "skipTests": {
"type": "boolean", "type": "boolean",

4
docs/generated/packages/angular/generators/scam-directive.json
View File

@ -39,7 +39,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"skipTests": { "skipTests": {
"type": "boolean", "type": "boolean",
@ -56,7 +56,7 @@
"type": "boolean", "type": "boolean",
"description": "Create the new files at the top level of the current project.", "description": "Create the new files at the top level of the current project.",
"default": true, "default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"selector": { "selector": {
"type": "string", "type": "string",

4
docs/generated/packages/angular/generators/scam-pipe.json
View File

@ -39,7 +39,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"skipTests": { "skipTests": {
"type": "boolean", "type": "boolean",
@ -56,7 +56,7 @@
"type": "boolean", "type": "boolean",
"description": "Create the new files at the top level of the current project.", "description": "Create the new files at the top level of the current project.",
"default": true, "default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"export": { "export": {
"type": "boolean", "type": "boolean",

4
docs/generated/packages/angular/generators/scam.json
View File

@ -38,7 +38,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"displayBlock": { "displayBlock": {
"description": "Specifies if the style will contain `:host { display: block; }`.", "description": "Specifies if the style will contain `:host { display: block; }`.",
@ -92,7 +92,7 @@
"type": "boolean", "type": "boolean",
"description": "Create the new files at the top level of the current project.", "description": "Create the new files at the top level of the current project.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"selector": { "selector": {
"type": "string", "type": "string",

6
docs/generated/packages/angular/generators/storybook-configuration.json
View File

@ -29,7 +29,7 @@
"configureCypress": { "configureCypress": {
"type": "boolean", "type": "boolean",
"description": "Specifies whether to configure Cypress or not.", "description": "Specifies whether to configure Cypress or not.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"generateStories": { "generateStories": {
"type": "boolean", "type": "boolean",
@ -41,7 +41,7 @@
"generateCypressSpecs": { "generateCypressSpecs": {
"type": "boolean", "type": "boolean",
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.", "description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"configureStaticServe": { "configureStaticServe": {
"type": "boolean", "type": "boolean",
@ -53,7 +53,7 @@
"cypressDirectory": { "cypressDirectory": {
"type": "string", "type": "string",
"description": "A directory where the Cypress project will be placed. Placed at the root by default.", "description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"linter": { "linter": {
"description": "The tool to use for running lint checks.", "description": "The tool to use for running lint checks.",

6
docs/generated/packages/expo/generators/component.json
View File

@ -23,7 +23,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"name": { "name": {
"type": "string", "type": "string",
@ -61,7 +61,7 @@
"type": "boolean", "type": "boolean",
"description": "Create component at the source root rather than its own directory.", "description": "Create component at the source root rather than its own directory.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"export": { "export": {
"type": "boolean", "type": "boolean",
@ -75,7 +75,7 @@
"description": "Use pascal case component file name (e.g. App.tsx).", "description": "Use pascal case component file name (e.g. App.tsx).",
"alias": "P", "alias": "P",
"default": false, "default": false,
"x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"classComponent": { "classComponent": {
"type": "boolean", "type": "boolean",

4
docs/generated/packages/nest/generators/class.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
docs/generated/packages/nest/generators/controller.json
View File

@ -20,7 +20,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"nameAndDirectoryFormat": { "nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).", "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },

4
docs/generated/packages/nest/generators/decorator.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -40,7 +40,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
docs/generated/packages/nest/generators/filter.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
docs/generated/packages/nest/generators/gateway.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
docs/generated/packages/nest/generators/guard.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
docs/generated/packages/nest/generators/interceptor.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
docs/generated/packages/nest/generators/interface.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -40,7 +40,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
} }

4
docs/generated/packages/nest/generators/middleware.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
docs/generated/packages/nest/generators/module.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -40,7 +40,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },

4
docs/generated/packages/nest/generators/pipe.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
docs/generated/packages/nest/generators/provider.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
docs/generated/packages/nest/generators/resolver.json
View File

@ -20,7 +20,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -41,7 +41,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },

4
docs/generated/packages/nest/generators/resource.json
View File

@ -20,7 +20,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -41,7 +41,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },

4
docs/generated/packages/nest/generators/service.json
View File

@ -25,7 +25,7 @@
"type": "string", "type": "string",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -46,7 +46,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },

8
docs/generated/packages/next/generators/component.json
View File

@ -14,7 +14,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"name": { "name": {
"type": "string", "type": "string",
@ -89,21 +89,21 @@
"type": "boolean", "type": "boolean",
"description": "Create component at the source root rather than its own directory.", "description": "Create component at the source root rather than its own directory.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"pascalCaseFiles": { "pascalCaseFiles": {
"type": "boolean", "type": "boolean",
"description": "Use pascal case component file name (e.g. `App.tsx`).", "description": "Use pascal case component file name (e.g. `App.tsx`).",
"alias": "P", "alias": "P",
"default": false, "default": false,
"x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"pascalCaseDirectory": { "pascalCaseDirectory": {
"type": "boolean", "type": "boolean",
"description": "Use pascal case directory name (e.g. `App/App.tsx`).", "description": "Use pascal case directory name (e.g. `App/App.tsx`).",
"alias": "R", "alias": "R",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"skipFormat": { "skipFormat": {
"description": "Skip formatting files.", "description": "Skip formatting files.",

2
docs/generated/packages/next/generators/cypress-component-configuration.json
View File

@ -41,7 +41,7 @@
} }
}, },
"required": ["project"], "required": ["project"],
"examplesFile": "{% callout type=\"caution\" title=\"Can I use component testing?\" %}\nNext component testing with Nx requires **Cypress version 10.7.0** and up.\n\nYou can migrate with to v10 via the [migrate-to-cypress-11 generator](/packages/cypress/generators/migrate-to-cypress-11).\n\nThis generator is for Cypress based component testing.\n\nIf you want to test components via Storybook with Cypress, then check out the [storybook-configuration generator docs](/nx-api/react/generators/storybook-configuration). However, this functionality is deprecated, and will be removed on Nx version 18.\n{% /callout %}\n\nThis generator is designed to get your Next project up and running with Cypress Component Testing.\n\n```shell\nnx g @nx/next:cypress-component-configuration --project=my-cool-next-project\n```\n\nRunning this generator, adds the required files to the specified project with a preconfigured `cypress.config.ts` designed for Nx workspaces.\n\n```ts {% fileName=\"cypress.config.ts\" %}\nimport { defineConfig } from 'cypress';\nimport { nxComponentTestingPreset } from '@nx/next/plugins/component-testing';\n\nexport default defineConfig({\n component: nxComponentTestingPreset(__filename),\n});\n```\n\nHere is an example on how to add custom options to the configuration\n\n```ts {% fileName=\"cypress.config.ts\" %}\nimport { defineConfig } from 'cypress';\nimport { nxComponentTestingPreset } from '@nx/next/plugins/component-testing';\n\nexport default defineConfig({\n component: {\n ...nxComponentTestingPreset(__filename),\n // extra options here\n },\n});\n```\n\n```shell\nnx g @nx/next:cypress-component-project --project=my-cool-next-project\n```\n\n## Auto Generating Tests\n\nYou can optionally use the `--generate-tests` flag to generate a test file for each component in your project.\n\n```shell\nnx g @nx/next:cypress-component-configuration --project=my-cool-next-project --generate-tests\n```\n\n## Running Component Tests\n\nA new `component-test` target will be added to the specified project to run your component tests.\n\n```shell\nnx g component-test my-cool-next-project\n```\n\nHere is an example of the project configuration that is generated.\n\n```json {% fileName=\"project.json\" %}\n{\n \"targets\" {\n \"component-test\": {\n \"executor\": \"@nx/cypress:cypress\",\n \"options\": {\n \"cypressConfig\": \"<path-to-project-root>/cypress.config.ts\",\n \"testingType\": \"component\",\n \"skipServe\": true\n }\n }\n }\n}\n```\n\nNx also supports [Angular component testing](/packages/angular/generators/cypress-component-configuration).\n", "examplesFile": "{% callout type=\"caution\" title=\"Can I use component testing?\" %}\nNext component testing with Nx requires **Cypress version 10.7.0** and up.\n\nYou can migrate with to v10 via the [migrate-to-cypress-11 generator](/packages/cypress/generators/migrate-to-cypress-11).\n\nThis generator is for Cypress based component testing.\n\nIf you want to test components via Storybook with Cypress, then check out the [storybook-configuration generator docs](/nx-api/react/generators/storybook-configuration). However, this functionality is deprecated, and will be removed on Nx version 19.\n{% /callout %}\n\nThis generator is designed to get your Next project up and running with Cypress Component Testing.\n\n```shell\nnx g @nx/next:cypress-component-configuration --project=my-cool-next-project\n```\n\nRunning this generator, adds the required files to the specified project with a preconfigured `cypress.config.ts` designed for Nx workspaces.\n\n```ts {% fileName=\"cypress.config.ts\" %}\nimport { defineConfig } from 'cypress';\nimport { nxComponentTestingPreset } from '@nx/next/plugins/component-testing';\n\nexport default defineConfig({\n component: nxComponentTestingPreset(__filename),\n});\n```\n\nHere is an example on how to add custom options to the configuration\n\n```ts {% fileName=\"cypress.config.ts\" %}\nimport { defineConfig } from 'cypress';\nimport { nxComponentTestingPreset } from '@nx/next/plugins/component-testing';\n\nexport default defineConfig({\n component: {\n ...nxComponentTestingPreset(__filename),\n // extra options here\n },\n});\n```\n\n```shell\nnx g @nx/next:cypress-component-project --project=my-cool-next-project\n```\n\n## Auto Generating Tests\n\nYou can optionally use the `--generate-tests` flag to generate a test file for each component in your project.\n\n```shell\nnx g @nx/next:cypress-component-configuration --project=my-cool-next-project --generate-tests\n```\n\n## Running Component Tests\n\nA new `component-test` target will be added to the specified project to run your component tests.\n\n```shell\nnx g component-test my-cool-next-project\n```\n\nHere is an example of the project configuration that is generated.\n\n```json {% fileName=\"project.json\" %}\n{\n \"targets\" {\n \"component-test\": {\n \"executor\": \"@nx/cypress:cypress\",\n \"options\": {\n \"cypressConfig\": \"<path-to-project-root>/cypress.config.ts\",\n \"testingType\": \"component\",\n \"skipServe\": true\n }\n }\n }\n}\n```\n\nNx also supports [Angular component testing](/packages/angular/generators/cypress-component-configuration).\n",
"presets": [] "presets": []
}, },
"description": "cypress-component-configuration generator", "description": "cypress-component-configuration generator",

4
docs/generated/packages/next/generators/page.json
View File

@ -14,7 +14,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"name": { "name": {
"type": "string", "type": "string",
@ -89,7 +89,7 @@
"type": "boolean", "type": "boolean",
"description": "Create component at the source root rather than its own directory.", "description": "Create component at the source root rather than its own directory.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"skipFormat": { "skipFormat": {
"description": "Skip formatting files.", "description": "Skip formatting files.",

2
docs/generated/packages/nx/documents/affected-dep-graph.md
View File

@ -5,7 +5,7 @@ description: 'Graph dependencies affected by changes'
# affected:graph # affected:graph
**Deprecated:** Use `nx graph --affected`, or `nx affected --graph` instead depending on which best suits your use case. The `affected:graph` command will be removed in Nx 18. **Deprecated:** Use `nx graph --affected`, or `nx affected --graph` instead depending on which best suits your use case. The `affected:graph` command will be removed in Nx 19.
Graph dependencies affected by changes Graph dependencies affected by changes

2
docs/generated/packages/nx/documents/print-affected.md
View File

@ -5,7 +5,7 @@ description: 'Prints information about the projects and targets affected by chan
# print-affected # print-affected
**Deprecated:** Use `nx show projects --affected`, `nx affected --graph -t build` or `nx graph --affected` depending on which best suits your use case. The `print-affected` command will be removed in Nx 18. **Deprecated:** Use `nx show projects --affected`, `nx affected --graph -t build` or `nx graph --affected` depending on which best suits your use case. The `print-affected` command will be removed in Nx 19.
Prints information about the projects and targets affected by changes Prints information about the projects and targets affected by changes

2
docs/generated/packages/plugin/executors/e2e.json
View File

@ -201,7 +201,7 @@
"presets": [] "presets": []
}, },
"description": "Creates and runs the E2E tests for an Nx Plugin.", "description": "Creates and runs the E2E tests for an Nx Plugin.",
"x-deprecated": "@nx/plugin:e2e is deprecated and will be removed in Nx 18. Use @nx/jest:jest instead.", "x-deprecated": "@nx/plugin:e2e is deprecated and will be removed in Nx v19. Use @nx/jest:jest instead.",
"aliases": [], "aliases": [],
"hidden": false, "hidden": false,
"path": "/packages/plugin/src/executors/e2e/schema.json", "path": "/packages/plugin/src/executors/e2e/schema.json",

2
docs/generated/packages/plugin/generators/executor.json
View File

@ -60,7 +60,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"skipFormat": { "skipFormat": {
"type": "boolean", "type": "boolean",

2
docs/generated/packages/plugin/generators/generator.json
View File

@ -49,7 +49,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"skipFormat": { "skipFormat": {
"type": "boolean", "type": "boolean",

2
docs/generated/packages/plugin/generators/migration.json
View File

@ -42,7 +42,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"packageJsonUpdates": { "packageJsonUpdates": {
"type": "boolean", "type": "boolean",

6
docs/generated/packages/react-native/generators/component.json
View File

@ -24,7 +24,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"name": { "name": {
"type": "string", "type": "string",
@ -56,7 +56,7 @@
"type": "boolean", "type": "boolean",
"description": "Create component at the source root rather than its own directory.", "description": "Create component at the source root rather than its own directory.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"export": { "export": {
"type": "boolean", "type": "boolean",
@ -70,7 +70,7 @@
"description": "Use pascal case component file name (e.g. `App.tsx`).", "description": "Use pascal case component file name (e.g. `App.tsx`).",
"alias": "P", "alias": "P",
"default": false, "default": false,
"x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"classComponent": { "classComponent": {
"type": "boolean", "type": "boolean",

8
docs/generated/packages/react/generators/component.json
View File

@ -14,7 +14,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"name": { "name": {
"type": "string", "type": "string",
@ -83,7 +83,7 @@
"type": "boolean", "type": "boolean",
"description": "Create component at the source root rather than its own directory.", "description": "Create component at the source root rather than its own directory.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"export": { "export": {
"type": "boolean", "type": "boolean",
@ -97,14 +97,14 @@
"description": "Use pascal case component file name (e.g. `App.tsx`).", "description": "Use pascal case component file name (e.g. `App.tsx`).",
"alias": "P", "alias": "P",
"default": false, "default": false,
"x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"pascalCaseDirectory": { "pascalCaseDirectory": {
"type": "boolean", "type": "boolean",
"description": "Use pascal case directory name (e.g. `App/App.tsx`).", "description": "Use pascal case directory name (e.g. `App/App.tsx`).",
"alias": "R", "alias": "R",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"classComponent": { "classComponent": {
"type": "boolean", "type": "boolean",

2
docs/generated/packages/react/generators/cypress-component-configuration.json
View File

File diff suppressed because one or more lines are too long

8
docs/generated/packages/react/generators/hook.json
View File

@ -20,7 +20,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"name": { "name": {
"type": "string", "type": "string",
@ -54,7 +54,7 @@
"type": "boolean", "type": "boolean",
"description": "Create hook at the source root rather than its own directory.", "description": "Create hook at the source root rather than its own directory.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"export": { "export": {
"type": "boolean", "type": "boolean",
@ -68,14 +68,14 @@
"description": "Use pascal case hook file name (e.g. `useHook.ts`).", "description": "Use pascal case hook file name (e.g. `useHook.ts`).",
"alias": "P", "alias": "P",
"default": false, "default": false,
"x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"pascalCaseDirectory": { "pascalCaseDirectory": {
"type": "boolean", "type": "boolean",
"description": "Use pascal case directory name (e.g. `useHook/useHook.ts`).", "description": "Use pascal case directory name (e.g. `useHook/useHook.ts`).",
"alias": "R", "alias": "R",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
} }
}, },
"required": ["name"], "required": ["name"],

2
docs/generated/packages/react/generators/redux.json
View File

@ -20,7 +20,7 @@
"description": "The name of the project to add the slice to. If it is an application, then the store configuration will be updated too.", "description": "The name of the project to add the slice to. If it is an application, then the store configuration will be updated too.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"directory": { "directory": {
"type": "string", "type": "string",

6
docs/generated/packages/react/generators/storybook-configuration.json
View File

@ -29,7 +29,7 @@
"configureCypress": { "configureCypress": {
"type": "boolean", "type": "boolean",
"description": "Run the cypress-configure generator.", "description": "Run the cypress-configure generator.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"generateStories": { "generateStories": {
"type": "boolean", "type": "boolean",
@ -41,7 +41,7 @@
"generateCypressSpecs": { "generateCypressSpecs": {
"type": "boolean", "type": "boolean",
"description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.", "description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"configureStaticServe": { "configureStaticServe": {
"type": "boolean", "type": "boolean",
@ -53,7 +53,7 @@
"cypressDirectory": { "cypressDirectory": {
"type": "string", "type": "string",
"description": "A directory where the Cypress project will be placed. Placed at the root by default.", "description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"js": { "js": {
"type": "boolean", "type": "boolean",

2
docs/generated/packages/remix/generators/action.json
View File

@ -22,7 +22,7 @@
"type": "string", "type": "string",
"description": "The name of the project.", "description": "The name of the project.",
"pattern": "^[a-zA-Z].*$", "pattern": "^[a-zA-Z].*$",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18." "x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
} }
}, },
"required": ["path"], "required": ["path"],

2
docs/generated/packages/remix/generators/error-boundary.json
View File

@ -27,7 +27,7 @@
"type": "string", "type": "string",
"description": "The name of the project.", "description": "The name of the project.",
"pattern": "^[a-zA-Z].*$", "pattern": "^[a-zA-Z].*$",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18." "x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
}, },
"skipFormat": { "skipFormat": {
"type": "boolean", "type": "boolean",

2
docs/generated/packages/remix/generators/loader.json
View File

@ -22,7 +22,7 @@
"type": "string", "type": "string",
"description": "The name of the project.", "description": "The name of the project.",
"pattern": "^[a-zA-Z].*$", "pattern": "^[a-zA-Z].*$",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18." "x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
} }
}, },
"required": ["path"], "required": ["path"],

2
docs/generated/packages/remix/generators/meta.json
View File

@ -22,7 +22,7 @@
"type": "string", "type": "string",
"description": "The name of the project.", "description": "The name of the project.",
"pattern": "^[a-zA-Z].*$", "pattern": "^[a-zA-Z].*$",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18." "x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
} }
}, },
"required": ["path"], "required": ["path"],

2
docs/generated/packages/remix/generators/resource-route.json
View File

@ -29,7 +29,7 @@
"type": "string", "type": "string",
"description": "The name of the project.", "description": "The name of the project.",
"pattern": "^[a-zA-Z].*$", "pattern": "^[a-zA-Z].*$",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18." "x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
}, },
"action": { "action": {
"type": "boolean", "type": "boolean",

2
docs/generated/packages/remix/generators/route.json
View File

@ -29,7 +29,7 @@
"type": "string", "type": "string",
"description": "The name of the project.", "description": "The name of the project.",
"pattern": "^[a-zA-Z].*$", "pattern": "^[a-zA-Z].*$",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18." "x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
}, },
"style": { "style": {
"type": "string", "type": "string",

2
docs/generated/packages/remix/generators/style.json
View File

@ -29,7 +29,7 @@
"type": "string", "type": "string",
"description": "The name of the project.", "description": "The name of the project.",
"pattern": "^[a-zA-Z].*$", "pattern": "^[a-zA-Z].*$",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18." "x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
} }
}, },
"required": ["path"], "required": ["path"],

4
docs/generated/packages/storybook/generators/configuration.json
View File

@ -28,12 +28,12 @@
"configureCypress": { "configureCypress": {
"type": "boolean", "type": "boolean",
"description": "Run the cypress-configure generator.", "description": "Run the cypress-configure generator.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"cypressDirectory": { "cypressDirectory": {
"type": "string", "type": "string",
"description": "A directory where the Cypress project will be placed. Added at root by default.", "description": "A directory where the Cypress project will be placed. Added at root by default.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"linter": { "linter": {
"description": "The tool to use for running lint checks.", "description": "The tool to use for running lint checks.",

8
docs/generated/packages/vue/generators/component.json
View File

@ -20,7 +20,7 @@
"description": "The name of the project.", "description": "The name of the project.",
"alias": "p", "alias": "p",
"$default": { "$source": "projectName" }, "$default": { "$source": "projectName" },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"name": { "name": {
"type": "string", "type": "string",
@ -55,7 +55,7 @@
"type": "boolean", "type": "boolean",
"description": "Create component at the source root rather than its own directory.", "description": "Create component at the source root rather than its own directory.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"export": { "export": {
"type": "boolean", "type": "boolean",
@ -69,14 +69,14 @@
"description": "Use pascal case component file name (e.g. `App.tsx`).", "description": "Use pascal case component file name (e.g. `App.tsx`).",
"alias": "P", "alias": "P",
"default": false, "default": false,
"x-deprecated": "Provide the desired `name` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the desired `name` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"pascalCaseDirectory": { "pascalCaseDirectory": {
"type": "boolean", "type": "boolean",
"description": "Use pascal case directory name (e.g. `App/App.tsx`).", "description": "Use pascal case directory name (e.g. `App/App.tsx`).",
"alias": "R", "alias": "R",
"default": false, "default": false,
"x-deprecated": "Provide the desired `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the desired `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"routing": { "routing": {
"type": "boolean", "type": "boolean",

2
docs/generated/packages/webpack/executors/webpack.json
View File

@ -311,7 +311,7 @@
"type": "boolean", "type": "boolean",
"description": "Do not apply Nx webpack plugins automatically. Plugins need to be applied in the project's webpack.config.js file (e.g. withNx, withReact, etc.).", "description": "Do not apply Nx webpack plugins automatically. Plugins need to be applied in the project's webpack.config.js file (e.g. withNx, withReact, etc.).",
"default": true, "default": true,
"x-deprecated": "Automatic configuration of Webpack is deprecated in favor of an explicit 'webpack.config.js' file. This option will be removed in Nx 18. See https://nx.dev/recipes/webpack/webpack-config-setup." "x-deprecated": "Automatic configuration of Webpack is deprecated in favor of an explicit 'webpack.config.js' file. This option will be removed in Nx 19. See https://nx.dev/recipes/webpack/webpack-config-setup."
}, },
"standardWebpackConfigFunction": { "standardWebpackConfigFunction": {
"type": "boolean", "type": "boolean",

10
docs/shared/deprecated/as-provided-vs-derived.md
View File

@ -1,6 +1,6 @@
# As Provided vs. Derived Generator Path Options # As Provided vs. Derived Generator Path Options
Nx is moving toward a more transparent and predictable way of determining where code will be generated when you run a generator. The new behavior is to take generator options _as provided_ and place the generated code in the exact folder that you specify. Nx will only use the new behavior in Nx version 18. The directory can be specified with a `--directory` flag or use a fully specified path (i.e. `libs/shared/my-lib/src/my-component`). The `--directory` flag will be calculated relative to where you run the command. Nx is moving toward a more transparent and predictable way of determining where code will be generated when you run a generator. The new behavior is to take generator options _as provided_ and place the generated code in the exact folder that you specify. Nx will only use the new behavior in Nx version 19. The directory can be specified with a `--directory` flag or use a fully specified path (i.e. `libs/shared/my-lib/src/my-component`). The `--directory` flag will be calculated relative to where you run the command.
In the past, Nx had lots of logic to try and _derive_ the best place to put code for you. This approach worked for some people, but there were always people that wanted to generate their code in a slightly different location. Accounting for these variations lead to either (1) people in repos with a different structure not being able to use these generators or (2) Nx introducing lots of flags to allow people to tweak where code was generated (flags like `--project`, `--flat`, `--pascalCaseFiles`, `--pascalCaseDirectory`, `--fileName`). It also caused some confusion when code was not generated in the expected location or frustration when the user did not know how to get Nx to derive the right thing. In the past, Nx had lots of logic to try and _derive_ the best place to put code for you. This approach worked for some people, but there were always people that wanted to generate their code in a slightly different location. Accounting for these variations lead to either (1) people in repos with a different structure not being able to use these generators or (2) Nx introducing lots of flags to allow people to tweak where code was generated (flags like `--project`, `--flat`, `--pascalCaseFiles`, `--pascalCaseDirectory`, `--fileName`). It also caused some confusion when code was not generated in the expected location or frustration when the user did not know how to get Nx to derive the right thing.
@ -19,7 +19,7 @@ You can use [Nx Console](/core-features/integrate-with-editors) for an intuitive
## Prompting ## Prompting
To mitigate the impact of this change of direction, Nx will prompt you when running most generators until Nx 18. We know changing these habits may take time so this prompt allows you to choose the previous behavior. To mitigate the impact of this change of direction, Nx will prompt you when running most generators until Nx 19. We know changing these habits may take time so this prompt allows you to choose the previous behavior.
```{% command="nx g lib my-lib --directory=shared/my-lib" path="~/myorg" %} ```{% command="nx g lib my-lib --directory=shared/my-lib" path="~/myorg" %}
✔ Which generator would you like to use? · @nx/node:library ✔ Which generator would you like to use? · @nx/node:library
@ -44,7 +44,7 @@ Your intent is your intent. However, the commands you write and run are based on
## Project Generators ## Project Generators
As of Nx 16.8.0, generating a project will prompt you to choose how Nx will calculate where the project should be located. For now, you can choose between `as-provided` and `derived` but `as-provided` will be the only option in Nx 18. The CLI flag to choose between the two algorithms for project generators is `--projectNameAndRootFormat`. As of Nx 16.8.0, generating a project will prompt you to choose how Nx will calculate where the project should be located. For now, you can choose between `as-provided` and `derived` but `as-provided` will be the only option in Nx 19. The CLI flag to choose between the two algorithms for project generators is `--projectNameAndRootFormat`.
### Generate Paths and Names `as-provided` ### Generate Paths and Names `as-provided`
@ -83,7 +83,7 @@ If you accidentally generate a project in the wrong folder, use the [move genera
## Code Generators ## Code Generators
As of Nx 17, code generators such as `component`, `service`, and others will prompt you to choose whether or not Nx will derive the location based on your options or not. In Nx 18, Nx will take the generator options as provided. The following flags are deprecated and will be removed in Nx 18: `--project`, `--flat`, `--pascalCaseFiles`, `--pascalCaseDirectory`, `--fileName`. The CLI flag to choose between the two algorithms for code generators is `--nameAndDirectoryFormat`. As of Nx 17, code generators such as `component`, `service`, and others will prompt you to choose whether or not Nx will derive the location based on your options or not. In Nx 19, Nx will take the generator options as provided. The following flags are deprecated and will be removed in Nx 19: `--project`, `--flat`, `--pascalCaseFiles`, `--pascalCaseDirectory`, `--fileName`. The CLI flag to choose between the two algorithms for code generators is `--nameAndDirectoryFormat`.
### Generate Paths and Names `as-provided` ### Generate Paths and Names `as-provided`
@ -100,7 +100,7 @@ If the directory specified is not inside a project, an error will be thrown.
### Use the Old `derived` Paths and Names ### Use the Old `derived` Paths and Names
Choosing `derived` makes Nx behave the way it did before version 17. Nx will use the deprecated flags (`--project`, `--flat`, `--pascalCaseFiles`, `--pascalCaseDirectory`, `--fileName`) to calculate where to generate the code. This behavior will not be available in Nx 18. Choosing `derived` makes Nx behave the way it did before version 17. Nx will use the deprecated flags (`--project`, `--flat`, `--pascalCaseFiles`, `--pascalCaseDirectory`, `--fileName`) to calculate where to generate the code. This behavior will not be available in Nx 19.
This makes generators behave in the following way: This makes generators behave in the following way:

2
docs/shared/deprecated/v1-nx-plugin-api.md
View File

@ -1,7 +1,7 @@
# Extending the Project Graph of Nx (v1 API) # Extending the Project Graph of Nx (v1 API)
{% callout type="caution" title="Experimental" %} {% callout type="caution" title="Experimental" %}
This API has been superceded by the [v2 API](/extending-nx/recipes/project-graph-plugins) and will be removed in Nx 18. If targeting Nx version 16.7 or higher, please use the v2 API instead. This API has been superceded by the [v2 API](/extending-nx/recipes/project-graph-plugins) and will be removed in Nx 19. If targeting Nx version 16.7 or higher, please use the v2 API instead.
{% /callout %} {% /callout %}
The v1 plugin API for modifying the project graph was split into two parts: The v1 plugin API for modifying the project graph was split into two parts:

2
docs/shared/recipes/rescope.md
View File

@ -65,4 +65,4 @@ All other packages keep the same name, but change scope from `@nrwl` to `@nx`.
## @nrwl Scope End of Life ## @nrwl Scope End of Life
Starting in version 18, the `@nrwl` scoped packages will no longer be published to npm. Only the `@nx` scoped packages will be available on the npm registry. Starting in version 19, the `@nrwl` scoped packages will no longer be published to npm. Only the `@nx` scoped packages will be available on the npm registry.

4
packages/angular/executors.ts
View File

@ -11,9 +11,9 @@ export * from './src/executors/application/application.impl';
import { executeDevServerBuilder } from './src/builders/dev-server/dev-server.impl'; import { executeDevServerBuilder } from './src/builders/dev-server/dev-server.impl';
export { export {
// TODO(v18): remove this alias // TODO(v19): remove this alias
/** /**
* @deprecated Use executeDevServerBuilder instead. It will be removed in Nx v18. * @deprecated Use executeDevServerBuilder instead. It will be removed in Nx v19.
*/ */
executeDevServerBuilder as executeWebpackDevServerBuilder, executeDevServerBuilder as executeWebpackDevServerBuilder,
executeDevServerBuilder, executeDevServerBuilder,

2
packages/angular/generators.json
View File

@ -86,7 +86,7 @@
"schema": "./src/generators/move/schema.json", "schema": "./src/generators/move/schema.json",
"aliases": ["mv"], "aliases": ["mv"],
"description": "Moves an Angular application or library to another folder within the workspace and updates the project configuration.", "description": "Moves an Angular application or library to another folder within the workspace and updates the project configuration.",
"x-deprecated": "Use the `@nx/workspace:move` generator instead. This generator will be removed in Nx v18." "x-deprecated": "Use the `@nx/workspace:move` generator instead. This generator will be removed in Nx v19."
}, },
"convert-to-with-mf": { "convert-to-with-mf": {
"factory": "./src/generators/convert-to-with-mf/convert-to-with-mf", "factory": "./src/generators/convert-to-with-mf/convert-to-with-mf",

2
packages/angular/src/builders/dev-server/schema.json
View File

@ -17,7 +17,7 @@
"type": "string", "type": "string",
"description": "A browser builder target to serve in the format of `project:target[:configuration]`. Ignored if `buildTarget` is set.", "description": "A browser builder target to serve in the format of `project:target[:configuration]`. Ignored if `buildTarget` is set.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$", "pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$",
"x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v18." "x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v19."
}, },
"buildTarget": { "buildTarget": {
"type": "string", "type": "string",

2
packages/angular/src/executors/module-federation-dev-server/schema.json
View File

@ -15,7 +15,7 @@
"type": "string", "type": "string",
"description": "A browser builder target to serve in the format of `project:target[:configuration]`.", "description": "A browser builder target to serve in the format of `project:target[:configuration]`.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$", "pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$",
"x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v18." "x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v19."
}, },
"buildTarget": { "buildTarget": {
"type": "string", "type": "string",

6
packages/angular/src/generators/component/schema.d.ts vendored
View File

@ -22,15 +22,15 @@ export interface Schema {
skipFormat?: boolean; skipFormat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.
*/ */
flat?: boolean; flat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. It will be removed in Nx v19.
*/ */
path?: string; path?: string;
/** /**
* @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v19.
*/ */
project?: string; project?: string;
} }

4
packages/angular/src/generators/component/schema.json
View File

@ -34,7 +34,7 @@
"$source": "projectName" "$source": "projectName"
}, },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"prefix": { "prefix": {
"type": "string", "type": "string",
@ -98,7 +98,7 @@
"type": "boolean", "type": "boolean",
"description": "Create the new files at the top level of the current project.", "description": "Create the new files at the top level of the current project.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"skipImport": { "skipImport": {
"type": "boolean", "type": "boolean",

6
packages/angular/src/generators/directive/schema.d.ts vendored
View File

@ -13,15 +13,15 @@ export interface Schema {
export?: boolean; export?: boolean;
skipFormat?: boolean; skipFormat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.
*/ */
flat?: boolean; flat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. It will be removed in Nx v19.
*/ */
path?: string; path?: string;
/** /**
* @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v19.
*/ */
project?: string; project?: string;
} }

4
packages/angular/src/generators/directive/schema.json
View File

@ -34,7 +34,7 @@
"$source": "projectName" "$source": "projectName"
}, },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"prefix": { "prefix": {
"type": "string", "type": "string",
@ -74,7 +74,7 @@
"type": "boolean", "type": "boolean",
"description": "When true (the default), creates the new files at the top level of the current project.", "description": "When true (the default), creates the new files at the top level of the current project.",
"default": true, "default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"module": { "module": {
"type": "string", "type": "string",

6
packages/angular/src/generators/pipe/schema.d.ts vendored
View File

@ -11,15 +11,15 @@ export interface Schema {
export?: boolean; export?: boolean;
skipFormat?: boolean; skipFormat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.
*/ */
flat?: boolean; flat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. It will be removed in Nx v19.
*/ */
path?: string; path?: string;
/** /**
* @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v19.
*/ */
project?: string; project?: string;
} }

4
packages/angular/src/generators/pipe/schema.json
View File

@ -34,13 +34,13 @@
"$source": "projectName" "$source": "projectName"
}, },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"flat": { "flat": {
"type": "boolean", "type": "boolean",
"default": true, "default": true,
"description": "When true (the default) creates files at the top level of the project.", "description": "When true (the default) creates files at the top level of the project.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"skipTests": { "skipTests": {
"type": "boolean", "type": "boolean",

6
packages/angular/src/generators/scam-directive/schema.d.ts vendored
View File

@ -11,15 +11,15 @@ export interface Schema {
export?: boolean; export?: boolean;
skipFormat?: boolean; skipFormat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.
*/ */
flat?: boolean; flat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. It will be removed in Nx v19.
*/ */
path?: string; path?: string;
/** /**
* @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v19.
*/ */
project?: string; project?: string;
} }

4
packages/angular/src/generators/scam-directive/schema.json
View File

@ -41,7 +41,7 @@
"$source": "projectName" "$source": "projectName"
}, },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"skipTests": { "skipTests": {
"type": "boolean", "type": "boolean",
@ -58,7 +58,7 @@
"type": "boolean", "type": "boolean",
"description": "Create the new files at the top level of the current project.", "description": "Create the new files at the top level of the current project.",
"default": true, "default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"selector": { "selector": {
"type": "string", "type": "string",

6
packages/angular/src/generators/scam-pipe/schema.d.ts vendored
View File

@ -9,15 +9,15 @@ export interface Schema {
export?: boolean; export?: boolean;
skipFormat?: boolean; skipFormat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.
*/ */
flat?: boolean; flat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. It will be removed in Nx v19.
*/ */
path?: string; path?: string;
/** /**
* @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v19.
*/ */
project?: string; project?: string;
} }

4
packages/angular/src/generators/scam-pipe/schema.json
View File

@ -41,7 +41,7 @@
"$source": "projectName" "$source": "projectName"
}, },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"skipTests": { "skipTests": {
"type": "boolean", "type": "boolean",
@ -58,7 +58,7 @@
"type": "boolean", "type": "boolean",
"description": "Create the new files at the top level of the current project.", "description": "Create the new files at the top level of the current project.",
"default": true, "default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"export": { "export": {
"type": "boolean", "type": "boolean",

6
packages/angular/src/generators/scam/schema.d.ts vendored
View File

@ -19,15 +19,15 @@ export interface Schema {
export?: boolean; export?: boolean;
skipFormat?: boolean; skipFormat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.
*/ */
flat?: boolean; flat?: boolean;
/** /**
* @deprecated Provide the `directory` option instead. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. It will be removed in Nx v19.
*/ */
path?: string; path?: string;
/** /**
* @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead. The project will be determined from the directory provided. It will be removed in Nx v19.
*/ */
project?: string; project?: string;
} }

4
packages/angular/src/generators/scam/schema.json
View File

@ -40,7 +40,7 @@
"$source": "projectName" "$source": "projectName"
}, },
"x-dropdown": "projects", "x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"displayBlock": { "displayBlock": {
"description": "Specifies if the style will contain `:host { display: block; }`.", "description": "Specifies if the style will contain `:host { display: block; }`.",
@ -94,7 +94,7 @@
"type": "boolean", "type": "boolean",
"description": "Create the new files at the top level of the current project.", "description": "Create the new files at the top level of the current project.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
}, },
"selector": { "selector": {
"type": "string", "type": "string",

2
packages/angular/src/generators/stories/stories-app.spec.ts
View File

@ -11,7 +11,7 @@ import { stripIndents } from '@nx/devkit';
// which is v9 while we are testing for the new v10 version // which is v9 while we are testing for the new v10 version
jest.mock('@nx/cypress/src/utils/cypress-version'); jest.mock('@nx/cypress/src/utils/cypress-version');
// TODO(katerina): Nx 18 -> remove Cypress // TODO(katerina): Nx 19 -> remove Cypress
describe('angularStories generator: applications', () => { describe('angularStories generator: applications', () => {
let tree: Tree; let tree: Tree;

2
packages/angular/src/generators/stories/stories-lib.spec.ts
View File

@ -14,7 +14,7 @@ import { angularStoriesGenerator } from './stories';
// need to mock cypress otherwise it'll use the nx installed version from package.json // need to mock cypress otherwise it'll use the nx installed version from package.json
// which is v9 while we are testing for the new v10 version // which is v9 while we are testing for the new v10 version
jest.mock('@nx/cypress/src/utils/cypress-version'); jest.mock('@nx/cypress/src/utils/cypress-version');
// TODO(katerina): Nx 18 -> remove Cypress // TODO(katerina): Nx 19 -> remove Cypress
describe('angularStories generator: libraries', () => { describe('angularStories generator: libraries', () => {
const libName = 'test-ui-lib'; const libName = 'test-ui-lib';

6
packages/angular/src/generators/storybook-configuration/schema.json
View File

@ -29,7 +29,7 @@
"configureCypress": { "configureCypress": {
"type": "boolean", "type": "boolean",
"description": "Specifies whether to configure Cypress or not.", "description": "Specifies whether to configure Cypress or not.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"generateStories": { "generateStories": {
"type": "boolean", "type": "boolean",
@ -41,7 +41,7 @@
"generateCypressSpecs": { "generateCypressSpecs": {
"type": "boolean", "type": "boolean",
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.", "description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"configureStaticServe": { "configureStaticServe": {
"type": "boolean", "type": "boolean",
@ -53,7 +53,7 @@
"cypressDirectory": { "cypressDirectory": {
"type": "string", "type": "string",
"description": "A directory where the Cypress project will be placed. Placed at the root by default.", "description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v18." "x-deprecated": "Use interactionTests instead. This option will be removed in v19."
}, },
"linter": { "linter": {
"description": "The tool to use for running lint checks.", "description": "The tool to use for running lint checks.",

2
packages/angular/src/generators/storybook-configuration/storybook-configuration.ts
View File

@ -5,7 +5,7 @@ import { generateStorybookConfiguration } from './lib/generate-storybook-configu
import { validateOptions } from './lib/validate-options'; import { validateOptions } from './lib/validate-options';
import type { StorybookConfigurationOptions } from './schema'; import type { StorybookConfigurationOptions } from './schema';
// TODO(katerina): Nx 18 -> remove Cypress // TODO(katerina): Nx 19 -> remove Cypress
export async function storybookConfigurationGenerator( export async function storybookConfigurationGenerator(
tree: Tree, tree: Tree,
options: StorybookConfigurationOptions options: StorybookConfigurationOptions

2
packages/create-nx-workspace/bin/create-nx-workspace.ts
View File

@ -194,7 +194,7 @@ export const commandsObject: yargs.Argv<Arguments> = yargs
[ [
normalizeArgsMiddleware, normalizeArgsMiddleware,
normalizeAndWarnOnDeprecatedPreset({ normalizeAndWarnOnDeprecatedPreset({
// TODO(v18): Remove Empty and Core presets // TODO(v19): Remove Empty and Core presets
[Preset.Core]: Preset.NPM, [Preset.Core]: Preset.NPM,
[Preset.Empty]: Preset.Apps, [Preset.Empty]: Preset.Apps,
}), }),

8
packages/cypress/index.ts
View File

@ -5,13 +5,13 @@ import { cypressProjectGenerator as _cypressProjectGenerator } from './src/gener
export { configurationGenerator, componentConfigurationGenerator }; export { configurationGenerator, componentConfigurationGenerator };
// Maintain backwards compatibility with the old names in case community plugins used them. // Maintain backwards compatibility with the old names in case community plugins used them.
// TODO(v18): Remove old name // TODO(v19): Remove old name
/** @deprecated Use `configurationGenerator` instead. It will be removed in Nx 18. */ /** @deprecated Use `configurationGenerator` instead. It will be removed in Nx 19. */
export const cypressComponentConfiguration = componentConfigurationGenerator; export const cypressComponentConfiguration = componentConfigurationGenerator;
export { configurationGenerator as cypressE2EConfigurationGenerator }; export { configurationGenerator as cypressE2EConfigurationGenerator };
// TODO(v18): Remove project generator // TODO(v19): Remove project generator
/** @deprecated Add a new project and call `configurationGenerator` instead. It will be removed in Nx 18. */ /** @deprecated Add a new project and call `configurationGenerator` instead. It will be removed in Nx 19. */
export const cypressProjectGenerator = _cypressProjectGenerator; export const cypressProjectGenerator = _cypressProjectGenerator;
export { cypressInitGenerator } from './src/generators/init/init'; export { cypressInitGenerator } from './src/generators/init/init';
export { migrateCypressProject } from './src/generators/migrate-to-cypress-11/migrate-to-cypress-11'; export { migrateCypressProject } from './src/generators/migrate-to-cypress-11/migrate-to-cypress-11';

4
packages/devkit/nx.ts
View File

@ -1,4 +1,4 @@
// After Nx v18, this can be removed and replaced with either: // After Nx v19, this can be removed and replaced with either:
// - import {} from 'nx/src/devkit-exports' // - import {} from 'nx/src/devkit-exports'
// - import {} from 'nx/src/devkit-internals' // - import {} from 'nx/src/devkit-internals'
export function requireNx(): typeof import('nx/src/devkit-exports') & export function requireNx(): typeof import('nx/src/devkit-exports') &
@ -7,7 +7,7 @@ export function requireNx(): typeof import('nx/src/devkit-exports') &
try { try {
result = { result = {
...result, ...result,
// Remove in Nx v18, devkit should not support Nx v16.0.2 at that point. // Remove in Nx v19, devkit should not support Nx v16.0.2 at that point.
...require('nx/src/devkit-internals'), ...require('nx/src/devkit-internals'),
}; };
} catch {} } catch {}

2
packages/devkit/src/executors/parse-target-string.ts
View File

@ -6,7 +6,7 @@ import { requireNx } from '../../nx';
let { readCachedProjectGraph, splitTarget, splitByColons } = requireNx(); let { readCachedProjectGraph, splitTarget, splitByColons } = requireNx();
// TODO: Remove this in Nx 18 when Nx 16.7.0 is no longer supported // TODO: Remove this in Nx 19 when Nx 16.7.0 is no longer supported
splitTarget = splitTarget ?? require('nx/src/utils/split-target').splitTarget; splitTarget = splitTarget ?? require('nx/src/utils/split-target').splitTarget;
splitByColons = splitByColons =
splitByColons ?? ((s: string) => s.split(':') as [string, ...string[]]); splitByColons ?? ((s: string) => s.split(':') as [string, ...string[]]);

8
packages/devkit/src/executors/read-target-options.ts
View File

@ -10,7 +10,7 @@ let {
combineOptionsForExecutor, combineOptionsForExecutor,
} = requireNx(); } = requireNx();
// TODO: Remove this in Nx 18 when Nx 16.7.0 is no longer supported // TODO: Remove this in Nx 19 when Nx 16.7.0 is no longer supported
combineOptionsForExecutor = combineOptionsForExecutor =
combineOptionsForExecutor ?? combineOptionsForExecutor ??
require('nx/src/utils/params').combineOptionsForExecutor; require('nx/src/utils/params').combineOptionsForExecutor;
@ -38,7 +38,7 @@ export function readTargetOptions<T = any>(
throw new Error(`Unable to find target ${target} for project ${project}`); throw new Error(`Unable to find target ${target} for project ${project}`);
} }
// TODO(v18): remove Workspaces. // TODO(v19): remove Workspaces.
const ws = new Workspaces(context.root); const ws = new Workspaces(context.root);
const [nodeModule, executorName] = targetConfiguration.executor.split(':'); const [nodeModule, executorName] = targetConfiguration.executor.split(':');
const { schema } = getExecutorInformation const { schema } = getExecutorInformation
@ -48,7 +48,7 @@ export function readTargetOptions<T = any>(
context.root, context.root,
context.projectsConfigurations?.projects ?? context.workspace.projects context.projectsConfigurations?.projects ?? context.workspace.projects
) )
: // TODO(v18): remove readExecutor. This is to be backwards compatible with Nx 16.5 and below. : // TODO(v19): remove readExecutor. This is to be backwards compatible with Nx 16.5 and below.
(ws as any).readExecutor(nodeModule, executorName); (ws as any).readExecutor(nodeModule, executorName);
const defaultProject = calculateDefaultProjectName const defaultProject = calculateDefaultProjectName
@ -58,7 +58,7 @@ export function readTargetOptions<T = any>(
{ version: 2, projects: context.projectsConfigurations.projects }, { version: 2, projects: context.projectsConfigurations.projects },
context.nxJsonConfiguration context.nxJsonConfiguration
) )
: // TODO(v18): remove calculateDefaultProjectName. This is to be backwards compatible with Nx 16.5 and below. : // TODO(v19): remove calculateDefaultProjectName. This is to be backwards compatible with Nx 16.5 and below.
(ws as any).calculateDefaultProjectName( (ws as any).calculateDefaultProjectName(
context.cwd, context.cwd,
{ version: 2, projects: context.projectsConfigurations.projects }, { version: 2, projects: context.projectsConfigurations.projects },

2
packages/devkit/src/generators/artifact-name-and-directory-utils.ts
View File

@ -142,7 +142,7 @@ function logDeprecationMessage(
formats: NameAndDirectoryFormats formats: NameAndDirectoryFormats
) { ) {
logger.warn(` logger.warn(`
In Nx 18, generating a ${options.artifactType} will no longer support providing a project and deriving the directory. In Nx 19, generating a ${options.artifactType} will no longer support providing a project and deriving the directory.
Please provide the exact directory in the future. Please provide the exact directory in the future.
Example: nx g ${options.callingGenerator} ${formats['derived'].artifactName} --directory ${formats['derived'].directory} Example: nx g ${options.callingGenerator} ${formats['derived'].artifactName} --directory ${formats['derived'].directory}
NOTE: The example above assumes the command is being run from the workspace root. If the command is being run from a subdirectory, the directory option should be adjusted accordingly. NOTE: The example above assumes the command is being run from the workspace root. If the command is being run from a subdirectory, the directory option should be adjusted accordingly.

2
packages/devkit/src/generators/format-files.ts
View File

@ -5,7 +5,7 @@ import { requireNx } from '../../nx';
let { updateJson, readJson, sortObjectByKeys } = requireNx(); let { updateJson, readJson, sortObjectByKeys } = requireNx();
// TODO: Remove this in Nx 18 when Nx 16.7.0 is no longer supported // TODO: Remove this in Nx 19 when Nx 16.7.0 is no longer supported
sortObjectByKeys = sortObjectByKeys =
sortObjectByKeys ?? require('nx/src/utils/object-sort').sortObjectByKeys; sortObjectByKeys ?? require('nx/src/utils/object-sort').sortObjectByKeys;

2
packages/devkit/src/generators/project-name-and-root-utils.ts
View File

@ -130,7 +130,7 @@ function logDeprecationMessage(
formats: ProjectNameAndRootFormats formats: ProjectNameAndRootFormats
) { ) {
logger.warn(stripIndents` logger.warn(stripIndents`
In Nx 18, generating projects will no longer derive the name and root. In Nx 19, generating projects will no longer derive the name and root.
Please provide the exact project name and root in the future. Please provide the exact project name and root in the future.
Example: nx g ${callingGenerator} ${formats['derived'].projectName} --directory ${formats['derived'].projectRoot} Example: nx g ${callingGenerator} ${formats['derived'].projectName} --directory ${formats['derived'].projectRoot}
`); `);

4
packages/devkit/src/utils/convert-nx-executor.ts
View File

@ -21,7 +21,7 @@ export function convertNxExecutor(executor: Executor) {
const workspaces = new Workspaces(builderContext.workspaceRoot); const workspaces = new Workspaces(builderContext.workspaceRoot);
const nxJsonConfiguration = readNxJsonFromDisk const nxJsonConfiguration = readNxJsonFromDisk
? readNxJsonFromDisk(builderContext.workspaceRoot) ? readNxJsonFromDisk(builderContext.workspaceRoot)
: // TODO(v18): remove readNxJson. This is to be backwards compatible with Nx 16.5 and below. : // TODO(v19): remove readNxJson. This is to be backwards compatible with Nx 16.5 and below.
(workspaces as any).readNxJson(); (workspaces as any).readNxJson();
const promise = async () => { const promise = async () => {
@ -34,7 +34,7 @@ export function convertNxExecutor(executor: Executor) {
nxJsonConfiguration nxJsonConfiguration
).then((p) => (p as any).projectNodes ?? p.projects), ).then((p) => (p as any).projectNodes ?? p.projects),
} }
: // TODO(v18): remove retrieveProjectConfigurations. This is to be backwards compatible with Nx 16.5 and below. : // TODO(v19): remove retrieveProjectConfigurations. This is to be backwards compatible with Nx 16.5 and below.
(workspaces as any).readProjectsConfigurations({ (workspaces as any).readProjectsConfigurations({
_includeProjectsFromAngularJson: true, _includeProjectsFromAngularJson: true,
}); });

2
packages/devkit/src/utils/invoke-nx-generator.ts
View File

@ -13,7 +13,7 @@ import { requireNx } from '../../nx';
let { logger, stripIndent } = requireNx(); let { logger, stripIndent } = requireNx();
// TODO: Remove this in Nx 18 when Nx 16.7.0 is no longer supported // TODO: Remove this in Nx 19 when Nx 16.7.0 is no longer supported
stripIndent = stripIndent ?? require('nx/src/utils/logger').stripIndent; stripIndent = stripIndent ?? require('nx/src/utils/logger').stripIndent;
class RunCallbackTask { class RunCallbackTask {

6
packages/expo/src/generators/component/schema.d.ts vendored
View File

@ -4,21 +4,21 @@
export interface Schema { export interface Schema {
name: string; name: string;
/** /**
* @deprecated Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18. * @deprecated Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19.
*/ */
project: string; project: string;
directory?: string; directory?: string;
skipFormat: boolean; // default is false skipFormat: boolean; // default is false
skipTests: boolean; // default is false skipTests: boolean; // default is false
/** /**
* @deprecated Provide the name in pascal-case and use the `as-provided` format. This option will be removed in Nx v18. * @deprecated Provide the name in pascal-case and use the `as-provided` format. This option will be removed in Nx v19.
*/ */
export: boolean; // default is false export: boolean; // default is false
pascalCaseFiles: boolean; // default is false pascalCaseFiles: boolean; // default is false
classComponent: boolean; // default is false classComponent: boolean; // default is false
js: boolean; // default is false js: boolean; // default is false
/** /**
* @deprecated Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v18. * @deprecated Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v19.
*/ */
flat: boolean; // default is false flat: boolean; // default is false
nameAndDirectoryFormat?: 'as-provided' | 'derived'; nameAndDirectoryFormat?: 'as-provided' | 'derived';

6
packages/expo/src/generators/component/schema.json
View File

@ -22,7 +22,7 @@
"$default": { "$default": {
"$source": "projectName" "$source": "projectName"
}, },
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"name": { "name": {
"type": "string", "type": "string",
@ -63,7 +63,7 @@
"type": "boolean", "type": "boolean",
"description": "Create component at the source root rather than its own directory.", "description": "Create component at the source root rather than its own directory.",
"default": false, "default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"export": { "export": {
"type": "boolean", "type": "boolean",
@ -77,7 +77,7 @@
"description": "Use pascal case component file name (e.g. App.tsx).", "description": "Use pascal case component file name (e.g. App.tsx).",
"alias": "P", "alias": "P",
"default": false, "default": false,
"x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18." "x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
}, },
"classComponent": { "classComponent": {
"type": "boolean", "type": "boolean",

4
packages/js/babel.ts
View File

@ -36,11 +36,11 @@ module.exports = function (api: any, options: NxWebBabelPresetOptions = {}) {
// Determine settings for `@babel//babel-plugin-transform-class-properties`, // Determine settings for `@babel//babel-plugin-transform-class-properties`,
// so that we can sync the `loose` option with `@babel/preset-env`. // so that we can sync the `loose` option with `@babel/preset-env`.
// TODO(v18): Remove classProperties since it's no longer needed, now that the class props transform is in preset-env. // TODO(v19): Remove classProperties since it's no longer needed, now that the class props transform is in preset-env.
const loose = options.classProperties?.loose ?? options.loose ?? true; const loose = options.classProperties?.loose ?? options.loose ?? true;
if (options.classProperties) { if (options.classProperties) {
logger.warn( logger.warn(
`Use =\`loose\` option instead of \`classProperties.loose\`. The \`classProperties\` option will be removed in Nx 18` `Use =\`loose\` option instead of \`classProperties.loose\`. The \`classProperties\` option will be removed in Nx 19`
); );
} }

4
packages/nest/src/generators/class/schema.json
View File

@ -27,7 +27,7 @@
"$source": "projectName" "$source": "projectName"
}, },
"alias": "p", "alias": "p",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18." "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -48,7 +48,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
packages/nest/src/generators/controller/schema.json
View File

@ -22,7 +22,7 @@
"$source": "projectName" "$source": "projectName"
}, },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"nameAndDirectoryFormat": { "nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).", "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
@ -48,7 +48,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },

4
packages/nest/src/generators/decorator/schema.json
View File

@ -27,7 +27,7 @@
"$source": "projectName" "$source": "projectName"
}, },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -42,7 +42,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

4
packages/nest/src/generators/filter/schema.json
View File

@ -27,7 +27,7 @@
"$source": "projectName" "$source": "projectName"
}, },
"alias": "p", "alias": "p",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18." "x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
}, },
"directory": { "directory": {
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.", "description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
@ -48,7 +48,7 @@
}, },
"flat": { "flat": {
"description": "Flag to indicate if a directory is created.", "description": "Flag to indicate if a directory is created.",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v18.", "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19.",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },

Some files were not shown because too many files have changed in this diff Show More