chore(docs): add more 'autogenerated' comments

This should prevent the kind of thing we've seen where people edit the generated docs, as in #3654 and #3630, and provide them with a helpful pointer so they put the config documentation changes in the right place.
npm · Aug 16, 2021 · af29f62 · af29f62
1 parent 59b9851
commit af29f62
Show file tree

Hide file tree

Showing 65 changed files with 1,318 additions and 9 deletions.
diff --git a/docs/content/commands/npm-access.md b/docs/content/commands/npm-access.md
@@ -85,13 +85,17 @@ Management of teams and team memberships is done with the `npm team` command.
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
 <!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
 #### `registry`
 
 * Default: "https://registry.npmjs.org/"
 * Type: URL
 
 The base URL of the npm registry.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `otp`
 
 * Default: null
@@ -102,6 +106,9 @@ when publishing or changing package permissions with `npm access`.
 
 If not set, and a registry response fails with a challenge for a one-time
 password, npm will prompt on the command line for one.
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
 

diff --git a/docs/content/commands/npm-adduser.md b/docs/content/commands/npm-adduser.md
@@ -37,13 +37,17 @@ your existing record.
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
 <!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
 #### `registry`
 
 * Default: "https://registry.npmjs.org/"
 * Type: URL
 
 The base URL of the npm registry.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `scope`
 
 * Default: the scope of the current project, if any, or ""
@@ -73,6 +77,9 @@ This will also cause `npm init` to create a scoped package.
 npm init --scope=@foo --yes
 ```
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
 

diff --git a/docs/content/commands/npm-audit.md b/docs/content/commands/npm-audit.md
@@ -191,6 +191,7 @@ $ npm audit --audit-level=moderate
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
 <!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
 #### `audit-level`
 
 * Default: null
@@ -199,6 +200,9 @@ $ npm audit --audit-level=moderate
 The minimum level of vulnerability for `npm audit` to exit with a non-zero
 exit code.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `dry-run`
 
 * Default: false
@@ -212,6 +216,9 @@ commands that modify your local installation, eg, `install`, `update`,
 Note: This is NOT honored by other network related commands, eg `dist-tags`,
 `owner`, etc.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `force`
 
 * Default: false
@@ -237,6 +244,9 @@ mistakes, unnecessary performance degradation, and malicious input.
 If you don't have a clear idea of what you want to do, it is strongly
 recommended that you do not use this option!
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `json`
 
 * Default: false
@@ -249,6 +259,9 @@ Whether or not to output JSON data, rather than the normal output.
 
 Not supported by all npm commands.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `package-lock-only`
 
 * Default: false
@@ -263,6 +276,9 @@ instead of checking `node_modules` and downloading dependencies.
 For `list` this means the output will be based on the tree described by the
 `package-lock.json`, rather than the contents of `node_modules`.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `omit`
 
 * Default: 'dev' if the `NODE_ENV` environment variable is set to
@@ -281,6 +297,9 @@ it will be included.
 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
 variable will be set to `'production'` for all lifecycle scripts.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `workspace`
 
 * Default:
@@ -303,6 +322,9 @@ brand new workspace within the project.
 
 This value is not exported to the environment for child processes.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `workspaces`
 
 * Default: false
@@ -312,6 +334,9 @@ Enable running a command in the context of **all** the configured
 workspaces.
 
 This value is not exported to the environment for child processes.
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
 

diff --git a/docs/content/commands/npm-bin.md b/docs/content/commands/npm-bin.md
@@ -20,6 +20,7 @@ Print the folder where npm will install executables.
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
 <!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
 #### `global`
 
 * Default: false
@@ -33,6 +34,9 @@ folder instead of the current working directory. See
   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 -->
+
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
 

diff --git a/docs/content/commands/npm-bugs.md b/docs/content/commands/npm-bugs.md
@@ -23,6 +23,7 @@ will search for a `package.json` in the current folder and use the `name` proper
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
 <!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
 #### `browser`
 
 * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
@@ -35,12 +36,18 @@ terminal.
 
 Set to `true` to use default system URL opener.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `registry`
 
 * Default: "https://registry.npmjs.org/"
 * Type: URL
 
 The base URL of the npm registry.
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
 

diff --git a/docs/content/commands/npm-cache.md b/docs/content/commands/npm-cache.md
@@ -77,13 +77,17 @@ verify`.
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
 <!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
 #### `cache`
 
 * Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm`
 * Type: Path
 
 The location of npm's cache directory. See [`npm
 cache`](/commands/npm-cache)
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
 

diff --git a/docs/content/commands/npm-ci.md b/docs/content/commands/npm-ci.md
@@ -69,6 +69,7 @@ cache:
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
 <!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
 #### `audit`
 
 * Default: true
@@ -79,6 +80,9 @@ default registry and all registries configured for scopes. See the
 documentation for [`npm audit`](/commands/npm-audit) for details on what is
 submitted.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `ignore-scripts`
 
 * Default: false
@@ -91,13 +95,19 @@ Note that commands explicitly intended to run a particular script, such as
 will still run their intended script if `ignore-scripts` is set, but they
 will *not* run any pre- or post-scripts.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `script-shell`
 
 * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
 * Type: null or String
 
 The shell to use for scripts run with the `npm exec`, `npm run` and `npm
 init <pkg>` commands.
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
 

diff --git a/docs/content/commands/npm-config.md b/docs/content/commands/npm-config.md
@@ -97,6 +97,7 @@ global config.
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
 <!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
 #### `json`
 
 * Default: false
@@ -109,6 +110,9 @@ Whether or not to output JSON data, rather than the normal output.
 
 Not supported by all npm commands.
 
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 #### `global`
 
 * Default: false
@@ -123,6 +127,9 @@ folder instead of the current working directory. See
 * 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 -->
+
 #### `editor`
 
 * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on
@@ -131,6 +138,9 @@ folder instead of the current working directory. See
 
 The command to run for `npm edit` and `npm config edit`.
 
+<!-- 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
@@ -139,12 +149,18 @@ The command to run for `npm edit` and `npm config edit`.
 
 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 -->
+
 #### `long`
 
 * Default: false
 * Type: Boolean
 
 Show extended information in `ls`, `search`, and `help-search`.
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/utils/config/definitions.js -->
+
 
 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->