Skip to content

Commit

Permalink
fix(misc): adjust deprecation messages to v20 (#23223)
Browse files Browse the repository at this point in the history
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

## Breaking Changes:


BREAKING CHANGE: `nx print-affected` was deprecated in 16.4.0 and has
been removed.
BREAKING CHANGE: `nx affected:graph` was deprecated in 16.4.0 and has
been removed.
BREAKING CHANGE: The `criticalPath` and `affectedProjects` properties of
the JSON created by `nx graph --file graph.json` was deprecated in
16.2.0 and has been removed.

## Current Behavior
<!-- This is the behavior we have today -->

Some deprecation messages still reference v19.

`nx print-affected` was deprecated in 16.4.0 to be removed in Nx 19 but
was not removed.
`nx affected:graph` was deprecated in 16.4.0 to be removed in Nx 19 but
was not removed.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

Deprecation messages reference v20 now.

`nx print-affected` is removed.
`nx affected:graph` is removed.

There are redirects to a `deprecated` page describing those commands for
Nx users using Nx <19

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
  • Loading branch information
FrozenPandaz authored May 9, 2024
1 parent dc20a3b commit 8f705e3
Show file tree
Hide file tree
Showing 159 changed files with 372 additions and 1,022 deletions.
8 changes: 4 additions & 4 deletions docs/generated/devkit/NxPluginV1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

**`Deprecated`**

Use [NxPluginV2](../../devkit/documents/NxPluginV2) instead. This will be removed in Nx 19
Use [NxPluginV2](../../devkit/documents/NxPluginV2) instead. This will be removed in Nx 20

#### Type declaration

| Name | Type | Description |
| :------------------------ | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | `string` | - |
| `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 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 19 |
| `processProjectGraph?` | `ProjectGraphProcessor` | **`Deprecated`** Use [CreateNodes](../../devkit/documents/CreateNodes) and [CreateDependencies](../../devkit/documents/CreateDependencies) instead. This will be removed in Nx 20 |
| `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 20 |
| `registerProjectTargets?` | [`ProjectTargetConfigurator`](../../devkit/documents/ProjectTargetConfigurator) | **`Deprecated`** Add targets to the projects inside of [CreateNodes](../../devkit/documents/CreateNodes) instead. This will be removed in Nx 20 |
2 changes: 1 addition & 1 deletion docs/generated/devkit/ProjectGraphBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A class which builds up a project graph

**`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 19.
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 20.

## Table of contents

Expand Down
2 changes: 1 addition & 1 deletion docs/generated/devkit/ProjectGraphProcessorContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Additional information to be used to process a project graph

**`Deprecated`**

The ProjectGraphProcessor is deprecated. This will be removed in Nx 19.
The ProjectGraphProcessor is deprecated. This will be removed in Nx 20.

## Table of contents

Expand Down
2 changes: 1 addition & 1 deletion docs/generated/devkit/ProjectTargetConfigurator.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**`Deprecated`**

Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNodes) function instead. This will be removed in Nx 19
Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNodes) function instead. This will be removed in Nx 20

#### Type declaration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

**`Deprecated`**

Pass the target and overrides instead. This will be removed in v19.
Pass the target and overrides instead. This will be removed in v20.

**getOutputsForTargetAndConfiguration**(`target`, `overrides`, `node`): `string`[]

Expand Down
48 changes: 32 additions & 16 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -4603,6 +4603,22 @@
"id": "deprecated",
"isExternal": false,
"children": [
{
"name": "affected:graph",
"path": "/deprecated/affected-graph",
"id": "affected-graph",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "print-affected",
"path": "/deprecated/print-affected",
"id": "print-affected",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "workspace.json",
"path": "/deprecated/workspace-json",
Expand Down Expand Up @@ -4686,6 +4702,22 @@
],
"disableCollapsible": false
},
{
"name": "affected:graph",
"path": "/deprecated/affected-graph",
"id": "affected-graph",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "print-affected",
"path": "/deprecated/print-affected",
"id": "print-affected",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "workspace.json",
"path": "/deprecated/workspace-json",
Expand Down Expand Up @@ -8378,22 +8410,6 @@
"children": [],
"disableCollapsible": false
},
{
"name": "affected:graph",
"path": "/nx-api/nx/documents/affected-dep-graph",
"id": "affected-dep-graph",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "print-affected",
"path": "/nx-api/nx/documents/print-affected",
"id": "print-affected",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "format:check",
"path": "/nx-api/nx/documents/format-check",
Expand Down
22 changes: 0 additions & 22 deletions docs/generated/manifests/nx-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -1778,28 +1778,6 @@
"tags": ["run-tasks"],
"originalFilePath": "generated/cli/affected"
},
"/nx-api/nx/documents/affected-dep-graph": {
"id": "affected-dep-graph",
"name": "affected:graph",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/affected-dep-graph",
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/affected-dep-graph",
"tags": [],
"originalFilePath": "generated/cli/affected-graph"
},
"/nx-api/nx/documents/print-affected": {
"id": "print-affected",
"name": "print-affected",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/print-affected",
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/print-affected",
"tags": [],
"originalFilePath": "generated/cli/print-affected"
},
"/nx-api/nx/documents/format-check": {
"id": "format-check",
"name": "format:check",
Expand Down
44 changes: 44 additions & 0 deletions docs/generated/manifests/nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -6302,6 +6302,28 @@
"mediaImage": "",
"file": "",
"itemList": [
{
"id": "affected-graph",
"name": "affected:graph",
"description": "",
"mediaImage": "",
"file": "shared/deprecated/affected-graph",
"itemList": [],
"isExternal": false,
"path": "/deprecated/affected-graph",
"tags": []
},
{
"id": "print-affected",
"name": "print-affected",
"description": "",
"mediaImage": "",
"file": "shared/deprecated/print-affected",
"itemList": [],
"isExternal": false,
"path": "/deprecated/print-affected",
"tags": []
},
{
"id": "workspace-json",
"name": "workspace.json",
Expand Down Expand Up @@ -6417,6 +6439,28 @@
"path": "/deprecated",
"tags": []
},
"/deprecated/affected-graph": {
"id": "affected-graph",
"name": "affected:graph",
"description": "",
"mediaImage": "",
"file": "shared/deprecated/affected-graph",
"itemList": [],
"isExternal": false,
"path": "/deprecated/affected-graph",
"tags": []
},
"/deprecated/print-affected": {
"id": "print-affected",
"name": "print-affected",
"description": "",
"mediaImage": "",
"file": "shared/deprecated/print-affected",
"itemList": [],
"isExternal": false,
"path": "/deprecated/print-affected",
"tags": []
},
"/deprecated/workspace-json": {
"id": "workspace-json",
"name": "workspace.json",
Expand Down
22 changes: 0 additions & 22 deletions docs/generated/packages-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -1757,28 +1757,6 @@
"tags": ["run-tasks"],
"originalFilePath": "generated/cli/affected"
},
{
"id": "affected-dep-graph",
"name": "affected:graph",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/affected-dep-graph",
"itemList": [],
"isExternal": false,
"path": "nx/documents/affected-dep-graph",
"tags": [],
"originalFilePath": "generated/cli/affected-graph"
},
{
"id": "print-affected",
"name": "print-affected",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/print-affected",
"itemList": [],
"isExternal": false,
"path": "nx/documents/print-affected",
"tags": [],
"originalFilePath": "generated/cli/print-affected"
},
{
"id": "format-check",
"name": "format:check",
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/angular/executors/dev-server.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"type": "string",
"description": "A browser builder target to serve in the format of `project:target[:configuration]`. Ignored if `buildTarget` is set.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$",
"x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v19."
"x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v20."
},
"buildTarget": {
"type": "string",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"type": "string",
"description": "A browser builder target to serve in the format of `project:target[:configuration]`.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$",
"x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v19."
"x-deprecated": "Use 'buildTarget' instead. It will be removed in Nx v20."
},
"buildTarget": {
"type": "string",
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/packages/angular/generators/component.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"description": "The name of the project.",
"$default": { "$source": "projectName" },
"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 v19."
"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 v20."
},
"prefix": {
"type": "string",
Expand Down Expand Up @@ -96,7 +96,7 @@
"type": "boolean",
"description": "Create the new files at the top level of the current project.",
"default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"skipImport": {
"type": "boolean",
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/packages/angular/generators/directive.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"description": "The name of the project.",
"$default": { "$source": "projectName" },
"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 v19."
"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 v20."
},
"prefix": {
"type": "string",
Expand Down Expand Up @@ -67,7 +67,7 @@
"type": "boolean",
"description": "When true (the default), creates the new files at the top level of the current project.",
"default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"module": {
"type": "string",
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/packages/angular/generators/pipe.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@
"description": "The name of the project.",
"$default": { "$source": "projectName" },
"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 v19."
"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 v20."
},
"flat": {
"type": "boolean",
"default": true,
"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 v19."
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"skipTests": {
"type": "boolean",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"description": "The name of the project.",
"$default": { "$source": "projectName" },
"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 v19."
"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 v20."
},
"skipTests": {
"type": "boolean",
Expand All @@ -56,7 +56,7 @@
"type": "boolean",
"description": "Create the new files at the top level of the current project.",
"default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"selector": {
"type": "string",
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/packages/angular/generators/scam-pipe.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"description": "The name of the project.",
"$default": { "$source": "projectName" },
"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 v19."
"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 v20."
},
"skipTests": {
"type": "boolean",
Expand All @@ -56,7 +56,7 @@
"type": "boolean",
"description": "Create the new files at the top level of the current project.",
"default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"export": {
"type": "boolean",
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/packages/angular/generators/scam.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"description": "The name of the project.",
"$default": { "$source": "projectName" },
"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 v19."
"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 v20."
},
"displayBlock": {
"description": "Specifies if the style will contain `:host { display: block; }`.",
Expand Down Expand Up @@ -92,7 +92,7 @@
"type": "boolean",
"description": "Create the new files at the top level of the current project.",
"default": false,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"selector": {
"type": "string",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"configureCypress": {
"type": "boolean",
"description": "Specifies whether to configure Cypress or not.",
"x-deprecated": "Use interactionTests instead. This option will be removed in v19."
"x-deprecated": "Use interactionTests instead. This option will be removed in v20."
},
"generateStories": {
"type": "boolean",
Expand All @@ -41,7 +41,7 @@
"generateCypressSpecs": {
"type": "boolean",
"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 v19."
"x-deprecated": "Use interactionTests instead. This option will be removed in v20."
},
"configureStaticServe": {
"type": "boolean",
Expand All @@ -53,7 +53,7 @@
"cypressDirectory": {
"type": "string",
"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 v19."
"x-deprecated": "Use interactionTests instead. This option will be removed in v20."
},
"linter": {
"description": "The tool to use for running lint checks.",
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/expo/generators/component.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"description": "The name of the project.",
"alias": "p",
"$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 v19."
"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 v20."
},
"name": {
"type": "string",
Expand Down
Loading

0 comments on commit 8f705e3

Please sign in to comment.