docs(config): document `no-` prefixed configs more clearly

npm / statusboard

Public monitor/status/health board for @npm/cli-team's maintained projects

https://npm.github.io/statusboard

Other

155 stars 54 forks source link

docs(config): document `no-` prefixed configs more clearly #398

Open darcyclarke opened 3 years ago

darcyclarke commented 3 years ago

Summary

Currently there doesn't seem to be any documentation around the no- prefix functionality that exists for all of our configs (ie. defining the config with the prefix sets the value of the config to false).

[ ] add a section outlining this behavior in https://docs.npmjs.com/cli/v7/using-npm/config

wraithgar commented 3 years ago

One of the things we did was add --no- to the boolean examples for given commands:

~ $ npm repo --help
npm repo

Open package repository page in the browser

Usage:
npm repo [<pkgname> [<pkgname> ...]]

Options:
[--no-browser|--browser <browser>]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]

We can probably do something similar to the long-form help of booleans?