Skip to content

Commit 22f3bbb

Browse files
isaacswraithgar
isaacs
authored and
wraithgar
committed
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.
1 parent 4314490 commit 22f3bbb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+1745
-5
lines changed

‎docs/content/commands/npm-access.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,17 @@ Management of teams and team memberships is done with the `npm team` command.
8585
8686
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
8787
<!-- automatically generated, do not edit manually -->
88+
<!-- see lib/utils/config/definitions.js -->
8889
#### `registry`
8990
9091
* Default: "https://registry.npmjs.org/"
9192
* Type: URL
9293
9394
The base URL of the npm registry.
9495
96+
<!-- automatically generated, do not edit manually -->
97+
<!-- see lib/utils/config/definitions.js -->
98+
9599
#### `otp`
96100
97101
* Default: null
@@ -103,6 +107,9 @@ when publishing or changing package permissions with `npm access`.
103107
If not set, and a registry response fails with a challenge for a one-time
104108
password, npm will prompt on the command line for one.
105109
110+
<!-- automatically generated, do not edit manually -->
111+
<!-- see lib/utils/config/definitions.js -->
112+
106113
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
107114
108115
### See Also

‎docs/content/commands/npm-adduser.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,17 @@ your existing record.
3737

3838
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
3939
<!-- automatically generated, do not edit manually -->
40+
<!-- see lib/utils/config/definitions.js -->
4041
#### `registry`
4142

4243
* Default: "https://registry.npmjs.org/"
4344
* Type: URL
4445

4546
The base URL of the npm registry.
4647

48+
<!-- automatically generated, do not edit manually -->
49+
<!-- see lib/utils/config/definitions.js -->
50+
4751
#### `scope`
4852

4953
* Default: the scope of the current project, if any, or ""
@@ -74,6 +78,9 @@ npm init --scope=@foo --yes
7478
```
7579

7680

81+
<!-- automatically generated, do not edit manually -->
82+
<!-- see lib/utils/config/definitions.js -->
83+
7784
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
7885

7986
### See Also

‎docs/content/commands/npm-audit.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ $ npm audit --audit-level=moderate
191191

192192
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
193193
<!-- automatically generated, do not edit manually -->
194+
<!-- see lib/utils/config/definitions.js -->
194195
#### `audit-level`
195196

196197
* Default: null
@@ -199,6 +200,9 @@ $ npm audit --audit-level=moderate
199200
The minimum level of vulnerability for `npm audit` to exit with a non-zero
200201
exit code.
201202

203+
<!-- automatically generated, do not edit manually -->
204+
<!-- see lib/utils/config/definitions.js -->
205+
202206
#### `dry-run`
203207

204208
* Default: false
@@ -212,6 +216,9 @@ commands that modify your local installation, eg, `install`, `update`,
212216
Note: This is NOT honored by other network related commands, eg `dist-tags`,
213217
`owner`, etc.
214218

219+
<!-- automatically generated, do not edit manually -->
220+
<!-- see lib/utils/config/definitions.js -->
221+
215222
#### `force`
216223

217224
* Default: false
@@ -237,6 +244,9 @@ mistakes, unnecessary performance degradation, and malicious input.
237244
If you don't have a clear idea of what you want to do, it is strongly
238245
recommended that you do not use this option!
239246

247+
<!-- automatically generated, do not edit manually -->
248+
<!-- see lib/utils/config/definitions.js -->
249+
240250
#### `json`
241251

242252
* Default: false
@@ -249,6 +259,9 @@ Whether or not to output JSON data, rather than the normal output.
249259

250260
Not supported by all npm commands.
251261

262+
<!-- automatically generated, do not edit manually -->
263+
<!-- see lib/utils/config/definitions.js -->
264+
252265
#### `package-lock-only`
253266

254267
* Default: false
@@ -263,6 +276,9 @@ instead of checking `node_modules` and downloading dependencies.
263276
For `list` this means the output will be based on the tree described by the
264277
`package-lock.json`, rather than the contents of `node_modules`.
265278

279+
<!-- automatically generated, do not edit manually -->
280+
<!-- see lib/utils/config/definitions.js -->
281+
266282
#### `omit`
267283

268284
* Default: 'dev' if the `NODE_ENV` environment variable is set to
@@ -281,6 +297,9 @@ it will be included.
281297
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
282298
variable will be set to `'production'` for all lifecycle scripts.
283299

300+
<!-- automatically generated, do not edit manually -->
301+
<!-- see lib/utils/config/definitions.js -->
302+
284303
#### `workspace`
285304

286305
* Default:
@@ -303,6 +322,9 @@ brand new workspace within the project.
303322

304323
This value is not exported to the environment for child processes.
305324

325+
<!-- automatically generated, do not edit manually -->
326+
<!-- see lib/utils/config/definitions.js -->
327+
306328
#### `workspaces`
307329

308330
* Default: false
@@ -313,6 +335,9 @@ workspaces.
313335

314336
This value is not exported to the environment for child processes.
315337

338+
<!-- automatically generated, do not edit manually -->
339+
<!-- see lib/utils/config/definitions.js -->
340+
316341
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
317342

318343
### See Also

‎docs/content/commands/npm-bin.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Print the folder where npm will install executables.
2020

2121
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
2222
<!-- automatically generated, do not edit manually -->
23+
<!-- see lib/utils/config/definitions.js -->
2324
#### `global`
2425

2526
* Default: false
@@ -34,6 +35,9 @@ folder instead of the current working directory. See
3435
* bin files are linked to `{prefix}/bin`
3536
* man pages are linked to `{prefix}/share/man`
3637

38+
<!-- automatically generated, do not edit manually -->
39+
<!-- see lib/utils/config/definitions.js -->
40+
3741
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
3842

3943
### See Also

‎docs/content/commands/npm-bugs.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ will search for a `package.json` in the current folder and use the `name` proper
2323
2424
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
2525
<!-- automatically generated, do not edit manually -->
26+
<!-- see lib/utils/config/definitions.js -->
2627
#### `browser`
2728
2829
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
@@ -35,13 +36,19 @@ terminal.
3536
3637
Set to `true` to use default system URL opener.
3738
39+
<!-- automatically generated, do not edit manually -->
40+
<!-- see lib/utils/config/definitions.js -->
41+
3842
#### `registry`
3943
4044
* Default: "https://registry.npmjs.org/"
4145
* Type: URL
4246
4347
The base URL of the npm registry.
4448
49+
<!-- automatically generated, do not edit manually -->
50+
<!-- see lib/utils/config/definitions.js -->
51+
4552
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
4653
4754
### See Also

‎docs/content/commands/npm-cache.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ verify`.
7777

7878
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
7979
<!-- automatically generated, do not edit manually -->
80+
<!-- see lib/utils/config/definitions.js -->
8081
#### `cache`
8182

8283
* Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm`
@@ -85,6 +86,9 @@ verify`.
8586
The location of npm's cache directory. See [`npm
8687
cache`](/commands/npm-cache)
8788

89+
<!-- automatically generated, do not edit manually -->
90+
<!-- see lib/utils/config/definitions.js -->
91+
8892
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
8993

9094
### See Also

‎docs/content/commands/npm-ci.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ cache:
6969

7070
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
7171
<!-- automatically generated, do not edit manually -->
72+
<!-- see lib/utils/config/definitions.js -->
7273
#### `audit`
7374

7475
* Default: true
@@ -79,6 +80,9 @@ default registry and all registries configured for scopes. See the
7980
documentation for [`npm audit`](/commands/npm-audit) for details on what is
8081
submitted.
8182

83+
<!-- automatically generated, do not edit manually -->
84+
<!-- see lib/utils/config/definitions.js -->
85+
8286
#### `ignore-scripts`
8387

8488
* Default: false
@@ -91,6 +95,9 @@ Note that commands explicitly intended to run a particular script, such as
9195
will still run their intended script if `ignore-scripts` is set, but they
9296
will *not* run any pre- or post-scripts.
9397

98+
<!-- automatically generated, do not edit manually -->
99+
<!-- see lib/utils/config/definitions.js -->
100+
94101
#### `script-shell`
95102

96103
* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
@@ -99,6 +106,9 @@ will *not* run any pre- or post-scripts.
99106
The shell to use for scripts run with the `npm exec`, `npm run` and `npm
100107
init <pkg>` commands.
101108

109+
<!-- automatically generated, do not edit manually -->
110+
<!-- see lib/utils/config/definitions.js -->
111+
102112
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
103113

104114
### See Also

‎docs/content/commands/npm-config.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ global config.
9797
9898
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
9999
<!-- automatically generated, do not edit manually -->
100+
<!-- see lib/utils/config/definitions.js -->
100101
#### `json`
101102
102103
* Default: false
@@ -109,6 +110,9 @@ Whether or not to output JSON data, rather than the normal output.
109110
110111
Not supported by all npm commands.
111112
113+
<!-- automatically generated, do not edit manually -->
114+
<!-- see lib/utils/config/definitions.js -->
115+
112116
#### `global`
113117
114118
* Default: false
@@ -123,6 +127,9 @@ folder instead of the current working directory. See
123127
* bin files are linked to `{prefix}/bin`
124128
* man pages are linked to `{prefix}/share/man`
125129
130+
<!-- automatically generated, do not edit manually -->
131+
<!-- see lib/utils/config/definitions.js -->
132+
126133
#### `editor`
127134
128135
* Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on
@@ -131,6 +138,9 @@ folder instead of the current working directory. See
131138
132139
The command to run for `npm edit` and `npm config edit`.
133140
141+
<!-- automatically generated, do not edit manually -->
142+
<!-- see lib/utils/config/definitions.js -->
143+
134144
#### `location`
135145
136146
* Default: "user" unless `--global` is passed, which will also set this value
@@ -139,13 +149,19 @@ The command to run for `npm edit` and `npm config edit`.
139149
140150
When passed to `npm config` this refers to which config file to use.
141151
152+
<!-- automatically generated, do not edit manually -->
153+
<!-- see lib/utils/config/definitions.js -->
154+
142155
#### `long`
143156
144157
* Default: false
145158
* Type: Boolean
146159
147160
Show extended information in `ls`, `search`, and `help-search`.
148161
162+
<!-- automatically generated, do not edit manually -->
163+
<!-- see lib/utils/config/definitions.js -->
164+
149165
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
150166
151167
### See Also

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy