node/doc/api
willhayslett a43e8896f2 doc, src: sort + fill up cli options and env vars
* Alphabetize the command line options and environment
  variables in doc/api/cli.md for consistency and readability.

* Update doc/api/cli.md to include command line options
  being printed in the `node.PrintHelp()` function in src/node.cc
  but weren't otherwise documented in the cli spec. Options added
  include:

  --napi-modules
  --v8-pool-size=num
  --experimental-modules
  --experimental-vm-modules

* ASCII sort the node man page command line options.
  This change brings sort order consistency between the
  cli options displayed in doc/node.1 and the cli options
  enumerated in other areas of the project.

  Also rearrange the language for `--use-bundled-ca`, `--use-openssl-ca`
  to correspond with the order of the options as displayed.

* Update `node.PrintHelp()` function to return command line options
  and environment variables sorted in ASCII order. Additionally,
  add missing options as sourced from doc/api/cli.md. Options
  added include `--`, `--help` and the `NODE_PRESERVE_SYMLINKS`
  environment variable.

  Also update the comments in the `node.PrintHelp()` method
  to C++ style.

* Create tests to validate that the newly ASCII sorted
  cli options in the `node.PrintHelp()` function are being
  returned according to build configurations as expected.

PR-URL: https://github.com/nodejs/node/pull/19878
Refs: https://github.com/nodejs/node/issues/19814
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-04-13 23:14:54 +03:00
..
_toc.md doc: add introduced_in metadata to _toc.md 2018-03-06 09:18:37 +01:00
addons.md doc, tools: make type parsing more strict 2018-04-11 14:11:29 +03:00
all.md doc: prepare for v8/V8 linting in doc text 2017-11-22 08:24:46 -08:00
assert.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
async_hooks.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
buffer.md doc: fix errors in sample code comments 2018-04-12 15:26:55 +02:00
child_process.md doc: fix parameter type format 2018-04-11 22:19:22 -07:00
cli.md doc, src: sort + fill up cli options and env vars 2018-04-13 23:14:54 +03:00
cluster.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
console.md console: auto-detect color support by default 2018-04-12 23:23:57 +02:00
crypto.md doc: mention CCM along with GCM in crypto APIs 2018-04-13 16:29:42 +02:00
debugger.md src: add punctuation in --inspector doc url message 2018-04-10 01:28:02 +02:00
deprecations.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
dgram.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
dns.md doc: add and unify even more return values 2018-04-12 03:18:01 +03:00
documentation.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
domain.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
errors.md assert: detect faulty throws usage 2018-04-13 19:56:33 +02:00
esm.md doc: fix various nits 2018-04-04 13:45:39 +03:00
events.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
fs.md doc: added ready events to fs/streams,net/socket 2018-04-12 15:23:55 +02:00
globals.md url: expose the WHATWG URL API globally 2018-01-31 16:00:51 +01:00
http2.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
http.md doc: improve http.setHeader and getHeader typeinfo 2018-04-13 20:28:01 +02:00
https.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
index.md doc: git mv to .md 2016-04-20 16:34:27 -07:00
inspector.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
intl.md doc: add RegExp Unicode Property Escapes to intl 2018-03-02 02:34:37 +02:00
modules.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
n-api.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
net.md doc: add net socket write signature 2018-04-13 20:41:52 +02:00
os.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
path.md doc: fix various nits 2018-04-04 13:45:39 +03:00
perf_hooks.md doc: specify definite Array types 2018-04-09 17:04:48 +03:00
process.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
punycode.md doc: add and unify even more return values 2018-04-12 03:18:01 +03:00
querystring.md doc,tools: formalize, unify, codify default values 2018-04-04 12:30:36 +03:00
readline.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
repl.md doc: add and unify even more return values 2018-04-12 03:18:01 +03:00
stream.md doc: remove _writableState reference 2018-04-13 20:52:49 +02:00
string_decoder.md doc: add and unify even more return values 2018-04-12 03:18:01 +03:00
synopsis.md doc: be more explicit in the sypnosis 2018-02-07 15:06:14 +01:00
timers.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
tls.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00
tracing.md perf_hooks,trace_events: emit perf milestone trace events 2018-03-16 10:54:05 -07:00
tty.md doc,tools: formalize, unify, codify default values 2018-04-04 12:30:36 +03:00
url.md doc: add and unify even more return values 2018-04-12 03:18:01 +03:00
util.md console: add color support 2018-04-12 23:23:56 +02:00
v8.md doc: add and unify even more return values 2018-04-12 03:18:01 +03:00
vm.md doc: vm.runIn*Context can accept a string as options 2018-04-11 21:38:41 -07:00
zlib.md doc: add quotes for event names + fix similar nits 2018-04-11 21:42:38 -07:00