diff options
author | isaacs <i@izs.me> | 2021-05-13 23:46:30 +0300 |
---|---|---|
committer | Gar <gar+gh@danger.computer> | 2021-05-14 18:39:54 +0300 |
commit | 2f5c28a68719e948d2efedf463ebcb35972aaefb (patch) | |
tree | 69b3c3d7aa81decaaccbe4c11831f16f12301180 /lib/owner.js | |
parent | 3bd758387f0f4668ae1eb2bfe420051da2a74c8e (diff) |
fix(docs): autogenerate config docs for commands
Add a script and Makefile rule to build the "Configuration" section for
all command documentation based on the command classes' `params` list.
Also correct several minor problems in the documentation, and add
`params` listings for commands that were lacking them, to match the
existing documentation and/or behavior within the code.
PR-URL: https://github.com/npm/cli/pull/3243
Credit: @isaacs
Close: #3243
Reviewed-by: @wraithgar
Diffstat (limited to 'lib/owner.js')
-rw-r--r-- | lib/owner.js | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/owner.js b/lib/owner.js index e537d82d0..e57d2268d 100644 --- a/lib/owner.js +++ b/lib/owner.js @@ -18,6 +18,14 @@ class Owner extends BaseCommand { } /* istanbul ignore next - see test/lib/load-all-commands.js */ + static get params () { + return [ + 'registry', + 'otp', + ] + } + + /* istanbul ignore next - see test/lib/load-all-commands.js */ static get usage () { return [ 'add <user> [<@scope>/]<pkg>', |