feat: deprecated --global, --local, --location=global

npm · May 10, 2022 · 08e0689 · 08e0689
1 parent 34829f8
commit 08e0689
Show file tree

Hide file tree

Showing 16 changed files with 100 additions and 56 deletions.
diff --git a/docs/content/commands/npm-bin.md b/docs/content/commands/npm-bin.md
@@ -34,6 +34,8 @@ Print the folder where npm will install executables.
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-config.md b/docs/content/commands/npm-config.md
@@ -124,6 +124,8 @@ Not supported by all npm commands.
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See
@@ -153,6 +155,8 @@ The command to run for `npm edit` and `npm config edit`.
 * Default: "user" unless `--global` is passed, which will also set this value
   to "global"
 * Type: "global", "user", or "project"
+* DEPRECATED: `--location=global` is deprecated, but the values "user" and
+  "project" are not.
 
 When passed to `npm config` this refers to which config file to use.
 

diff --git a/docs/content/commands/npm-diff.md b/docs/content/commands/npm-diff.md
@@ -248,6 +248,8 @@ Treat all files as text in `npm diff`.
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-install-test.md b/docs/content/commands/npm-install-test.md
@@ -70,6 +70,8 @@ rather than using npm's default semver range operator.
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-install.md b/docs/content/commands/npm-install.md
@@ -460,6 +460,8 @@ rather than using npm's default semver range operator.
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-link.md b/docs/content/commands/npm-link.md
@@ -153,6 +153,8 @@ rather than using npm's default semver range operator.
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-ls.md b/docs/content/commands/npm-ls.md
@@ -137,6 +137,8 @@ Output parseable results from commands that write to standard output. For
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-outdated.md b/docs/content/commands/npm-outdated.md
@@ -150,6 +150,8 @@ Output parseable results from commands that write to standard output. For
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-prefix.md b/docs/content/commands/npm-prefix.md
@@ -51,6 +51,8 @@ npm prefix -g
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-rebuild.md b/docs/content/commands/npm-rebuild.md
@@ -42,6 +42,8 @@ will be rebuilt.
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-root.md b/docs/content/commands/npm-root.md
@@ -41,6 +41,8 @@ echo "Global packages installed in: ${global_node_modules}"
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/commands/npm-update.md b/docs/content/commands/npm-update.md
@@ -188,6 +188,8 @@ Will also prevent writing to `package-lock.json` if set to `false`.
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the `prefix`
 folder instead of the current working directory. See

diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md
@@ -687,23 +687,6 @@ results in no commit being made at all.
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->
 
-#### `global`
-
-* Default: false
-* Type: Boolean
-
-Operates in "global" mode, so that packages are installed into the `prefix`
-folder instead of the current working directory. See
-[folders](/configuring-npm/folders) for more on the differences in behavior.
-
-* packages are installed into the `{prefix}/lib/node_modules` folder, instead
-  of the current working directory.
-* bin files are linked to `{prefix}/bin`
-* man pages are linked to `{prefix}/share/man`
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
 #### `global-style`
 
 * Default: false
@@ -993,17 +976,6 @@ npm registry. Must be IPv4 in versions of Node prior to 0.12.
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->
 
-#### `location`
-
-* Default: "user" unless `--global` is passed, which will also set this value
-  to "global"
-* Type: "global", "user", or "project"
-
-When passed to `npm config` this refers to which config file to use.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
 #### `lockfile-version`
 
 * Default: Version 2 if no lockfile or current lockfile version less than or
@@ -1928,6 +1900,25 @@ Alias for `--include=dev`.
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->
 
+#### `global`
+
+* Default: false
+* Type: Boolean
+* DEPRECATED: `--global`, `--location=global`, `--no-global`, and `--local`
+  are all deprecated
+
+Operates in "global" mode, so that packages are installed into the `prefix`
+folder instead of the current working directory. See
+[folders](/configuring-npm/folders) for more on the differences in behavior.
+
+* packages are installed into the `{prefix}/lib/node_modules` folder, instead
+  of the current working directory.
+* bin files are linked to `{prefix}/bin`
+* man pages are linked to `{prefix}/share/man`
+
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `init.author.email`
 
 * Default: ""
@@ -1994,6 +1985,19 @@ Alias for `--init-version`
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->
 
+#### `location`
+
+* Default: "user" unless `--global` is passed, which will also set this value
+  to "global"
+* Type: "global", "user", or "project"
+* DEPRECATED: `--location=global` is deprecated, but the values "user" and
+  "project" are not.
+
+When passed to `npm config` this refers to which config file to use.
+
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `only`
 
 * Default: null

diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
@@ -811,6 +811,9 @@ define('global', {
   default: false,
   type: Boolean,
   short: 'g',
+  deprecated: `
+    \`--global\`, \`--location=global\`, \`--no-global\`, and \`--local\` are all deprecated
+  `,
   description: `
     Operates in "global" mode, so that packages are installed into the
     \`prefix\` folder instead of the current working directory.  See
@@ -1177,6 +1180,9 @@ define('location', {
   defaultDescription: `
     "user" unless \`--global\` is passed, which will also set this value to "global"
   `,
+  deprecated: `
+    \`--location=global\` is deprecated, but the values "user" and "project" are not.
+  `,
   description: `
     When passed to \`npm config\` this refers to which config file to use.
   `,

diff --git a/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
@@ -730,6 +730,8 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for globa
 
 * Default: false
 * Type: Boolean
+* DEPRECATED: \`--global\`, \`--location=global\`, \`--no-global\`, and \`--local\`
+  are all deprecated
 
 Operates in "global" mode, so that packages are installed into the \`prefix\`
 folder instead of the current working directory. See
@@ -1074,6 +1076,8 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for locat
 * Default: "user" unless \`--global\` is passed, which will also set this value
   to "global"
 * Type: "global", "user", or "project"
+* DEPRECATED: \`--location=global\` is deprecated, but the values "user" and
+  "project" are not.
 
 When passed to \`npm config\` this refers to which config file to use.
 `

diff --git a/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs
@@ -560,23 +560,6 @@ results in no commit being made at all.
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->
 
-#### \`global\`
-
-* Default: false
-* Type: Boolean
-
-Operates in "global" mode, so that packages are installed into the \`prefix\`
-folder instead of the current working directory. See
-[folders](/configuring-npm/folders) for more on the differences in behavior.
-
-* packages are installed into the \`{prefix}/lib/node_modules\` folder, instead
-  of the current working directory.
-* bin files are linked to \`{prefix}/bin\`
-* man pages are linked to \`{prefix}/share/man\`
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
 #### \`global-style\`
 
 * Default: false
@@ -866,17 +849,6 @@ npm registry. Must be IPv4 in versions of Node prior to 0.12.
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->
 
-#### \`location\`
-
-* Default: "user" unless \`--global\` is passed, which will also set this value
-  to "global"
-* Type: "global", "user", or "project"
-
-When passed to \`npm config\` this refers to which config file to use.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
 #### \`lockfile-version\`
 
 * Default: Version 2 if no lockfile or current lockfile version less than or
@@ -1801,6 +1773,25 @@ Alias for \`--include=dev\`.
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->
 
+#### \`global\`
+
+* Default: false
+* Type: Boolean
+* DEPRECATED: \`--global\`, \`--location=global\`, \`--no-global\`, and \`--local\`
+  are all deprecated
+
+Operates in "global" mode, so that packages are installed into the \`prefix\`
+folder instead of the current working directory. See
+[folders](/configuring-npm/folders) for more on the differences in behavior.
+
+* packages are installed into the \`{prefix}/lib/node_modules\` folder, instead
+  of the current working directory.
+* bin files are linked to \`{prefix}/bin\`
+* man pages are linked to \`{prefix}/share/man\`
+
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### \`init.author.email\`
 
 * Default: ""
@@ -1867,6 +1858,19 @@ Alias for \`--init-version\`
 <!-- automatically generated, do not edit manually -->
 <!-- see lib/utils/config/definitions.js -->
 
+#### \`location\`
+
+* Default: "user" unless \`--global\` is passed, which will also set this value
+  to "global"
+* Type: "global", "user", or "project"
+* DEPRECATED: \`--location=global\` is deprecated, but the values "user" and
+  "project" are not.
+
+When passed to \`npm config\` this refers to which config file to use.
+
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### \`only\`
 
 * Default: null