fix(misc): mark workspace-lint as deprecated in yargs config

nrwl · Apr 19, 2023 · 6ac3f03 · 6ac3f03
1 parent c8960b7
commit 6ac3f03
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/docs/generated/cli/workspace-lint.md b/docs/generated/cli/workspace-lint.md
@@ -5,7 +5,9 @@ description: 'Lint nx specific workspace files (nx.json, workspace.json)'
 
 # workspace-lint
 
-Lint nx specific workspace files (nx.json, workspace.json)
+    **Deprecated:** workspace-lint is deprecated, and will be removed in v17. The checks it used to perform are no longer relevant.
+
+    Lint nx specific workspace files (nx.json, workspace.json)
 
 ## Usage
 

diff --git a/docs/generated/packages/nx/documents/workspace-lint.md b/docs/generated/packages/nx/documents/workspace-lint.md
@@ -5,7 +5,9 @@ description: 'Lint nx specific workspace files (nx.json, workspace.json)'
 
 # workspace-lint
 
-Lint nx specific workspace files (nx.json, workspace.json)
+    **Deprecated:** workspace-lint is deprecated, and will be removed in v17. The checks it used to perform are no longer relevant.
+
+    Lint nx specific workspace files (nx.json, workspace.json)
 
 ## Usage
 

diff --git a/packages/nx/src/command-line/nx-commands.ts b/packages/nx/src/command-line/nx-commands.ts
@@ -263,6 +263,8 @@ export const commandsObject = yargs
   .command({
     command: 'workspace-lint [files..]',
     describe: 'Lint nx specific workspace files (nx.json, workspace.json)',
+    deprecated:
+      'workspace-lint is deprecated, and will be removed in v17. The checks it used to perform are no longer relevant.',
     handler: async () => {
       await (await import('./lint')).workspaceLint();
       process.exit(0);