docs(core): workspace-lint deprecation (#17799)

This commit is contained in:
Isaac Mann 2023-06-26 15:17:06 -04:00 committed by GitHub
parent 47c95ae5d4
commit 8f563d32ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 60 additions and 1 deletions

View File

@ -1525,6 +1525,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "workspace-lint",
"path": "/deprecated/workspace-lint",
"id": "workspace-lint",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Workspace Generators",
"path": "/deprecated/workspace-generators",
@ -1633,6 +1641,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "workspace-lint",
"path": "/deprecated/workspace-lint",
"id": "workspace-lint",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Workspace Generators",
"path": "/deprecated/workspace-generators",

View File

@ -1898,6 +1898,16 @@
"path": "/deprecated/workspace-json",
"tags": []
},
{
"id": "workspace-lint",
"name": "workspace-lint",
"description": "",
"file": "shared/deprecated/workspace-lint",
"itemList": [],
"isExternal": false,
"path": "/deprecated/workspace-lint",
"tags": []
},
{
"id": "workspace-generators",
"name": "Workspace Generators",
@ -2034,6 +2044,16 @@
"path": "/deprecated/workspace-json",
"tags": []
},
"/deprecated/workspace-lint": {
"id": "workspace-lint",
"name": "workspace-lint",
"description": "",
"file": "shared/deprecated/workspace-lint",
"itemList": [],
"isExternal": false,
"path": "/deprecated/workspace-lint",
"tags": []
},
"/deprecated/workspace-generators": {
"id": "workspace-generators",
"name": "Workspace Generators",

View File

@ -596,6 +596,11 @@
"id": "workspace-json",
"file": "shared/deprecated/workspace-json"
},
{
"name": "workspace-lint",
"id": "workspace-lint",
"file": "shared/deprecated/workspace-lint"
},
{
"name": "Workspace Generators",
"id": "workspace-generators",

View File

@ -0,0 +1,13 @@
# workspace-lint
Before Nx 15, the `workspace-lint` command performed workspace wide lint checks including:
1. Checking for projects with no files in them
2. Checking for files that do not belong to a project
3. Ensuring that all the versions of Nx packages are in sync
Checks (1) and (2) are no longer necessary because [Nx no longer uses a `workspace.json` file](../workspace-json) to define project locations. Instead, Nx dynamically detects projects anywhere in the workspace based on the presence of `package.json` or `project.json` files.
Check (3) is now accomplished manually with the [`nx report` command](/packages/nx/documents/report).
In Nx 15 and 16, `nx workspace-lint` does nothing except display a deprecation message. In Nx 17, `workspace-lint` will be completely removed.

View File

@ -17,6 +17,10 @@
- [list](/packages/nx/documents/list)
- [workspace-lint](/packages/nx/documents/workspace-lint)
- [workspace-generator](/packages/nx/documents/workspace-generator)
- [connect](/packages/nx/documents/connect-to-nx-cloud)
- [connect-to-nx-cloud](/packages/nx/documents/connect-to-nx-cloud)
- [reset](/packages/nx/documents/reset)
- [repair](/packages/nx/documents/repair)
- [exec](/packages/nx/documents/exec)
- [watch](/packages/nx/documents/watch)
- [show](/packages/nx/documents/show)
- [view-logs](/packages/nx/documents/view-logs)

View File

@ -102,6 +102,7 @@
- [Glossary](/reference/glossary)
- [Deprecated](/deprecated)
- [workspace.json](/deprecated/workspace-json)
- [workspace-lint](/deprecated/workspace-lint)
- [Workspace Generators](/deprecated/workspace-generators)
- [Workspace Executors](/deprecated/workspace-executors)
- [defaultCollection](/deprecated/default-collection)