tools: add bash completion for node

[danbev]

This commit adds a --completion-bash option to node which can be sourced to
provide bash code completion for node options.

Usage:

$ node --completion-bash > node_bash_completion
$ source node_bash_completion
$ ./node --[tab]  # (press the 'tab' key)
--abort_on_uncaught_exception  --inspect-brk-node=            --require
--check                        --inspect-brk=                 --security-reverts
--completion-bash              --inspect-port                 --stack_trace_limit
--debug                        --inspect=                     --throw-deprecation
--debug-brk                    --interactive                  --title
--debug-brk=                   --loader                       --tls-cipher-list
--debug-port                   --max_old_space_size           --trace-deprecation
--debug=                       --napi-modules                 --trace-event-categories
--eval                         --no-deprecation               --trace-event-file-pattern
--experimental-modules         --no-force-async-hooks-checks  --trace-events-enabled
--experimental-repl-await      --no-warnings                  --trace-sync-io
--experimental-vm-modules      --openssl-config               --trace-warnings
--experimental-worker          --pending-deprecation          --track-heap-objects
--expose-internals             --perf_basic_prof              --use-bundled-ca
--expose_internals             --perf_prof                    --use-openssl-ca
--help                         --preserve-symlinks            --v8-options
--icu-data-dir                 --preserve-symlinks-main       --v8-pool-size
--inspect                      --print                        --version
--inspect-brk                  --prof-process                 --zero-fill-buffers
--inspect-brk-node             --redirect-warnings

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• commit message follows commit guidelines

[danbev]

CI: https://ci.nodejs.org/job/node-test-pull-request/14858/

[mscdex]

Isn't that output missing some options, like --v8-options and --v8-pool-size=num?

[danbev]

Isn't that output missing some options, like --v8-options and --v8-pool-size=num?

Oh indeed, I missed that. I'll take a look. Thanks

[danbev]

With the latest update output looks like this:

$ ./node --
--                             --no-deprecation               --trace-deprecation
--abort-on-uncaught-exception  --no-force-async-hooks-checks  --trace-event-categories
--check                        --no-warnings                  --trace-event-file-pattern
--eval                         --openssl-config=file          --trace-events-enabled
--experimental-modules         --pending-deprecation          --trace-sync-io
--experimental-repl-await      --preserve-symlinks            --trace-warnings
--experimental-vm-modules      --preserve-symlinks-main       --track-heap-objects
--help                         --print                        --use-bundled-ca
--icu-data-dir=dir             --prof                         --use-openssl-ca
--inspect-brk[=[host:]port]    --prof-process                 --v8-options
--inspect-port=[host:]port     --redirect-warnings=file       --v8-pool-size=num
--inspect[=[host:]port]        --require                      --version
--interactive                  --throw-deprecation            --zero-fill-buffers
--napi-modules                 --tls-cipher-list=val

[addaleax]

I know some UNIX CLI tools ship something like tool --completion baked into the executable, which provides a source-able bash script as the output. Would that make sense?

[danbev]

Would that make sense?

That sounds interesting for sure!

[BridgeAR]

@danbev is this actually work in progress or ready to review?

[danbev]

@danbev is this actually work in progress or ready to review?

I'll mark it as in progress and follow up later this week. Thanks

[maclover7]

ping @danbev

[danbev]

I know some UNIX CLI tools ship something like tool --completion baked into the executable, which provides a source-able bash script as the output.

Sorry about the delay on this. Just to clarify, your suggestion is that we provide an option to node which returns the source-able bash script? Something like:

$ node --completion

[danbev]

Rebased CI: https://ci.nodejs.org/job/node-test-pull-request/16598/

[danbev]

Rebased CI: https://ci.nodejs.org/job/node-test-pull-request/16717/

[danbev]

@addaleax Would you be able to take a look at this once more when you get a chance, and see if this is what you had in mind regarding your suggestion of using the --completion option?

[refack]

How robust is this? That is how much can we change the output of node --help before this breaks?

[danbev]

Perhaps @addaleax suggestion about #22490 (which I've not looked into yet) might help making this more robust. I'll take a closer look next week.

[refack]

I'm tending toward -0 on this, as is. Since the real "magic" is baked into the --help logic, this seems like a too specific change for a specific target (IIUC just bash), that could be replaced with a simple independant snippet:

_node_complete()
{
  local cur_word options
  cur_word="${COMP_WORDS[COMP_CWORD]}"
  options="`$1 --help`"
  if [[ "${cur_word}" == -* ]] ; then
    COMPREPLY=( $(compgen -W '${options}' -- "${cur_word}") )
    return 0
  else
    COMPREPLY=( $(compgen -f "${cur_word}") )
    return 0
  fi
}
complete -F _node_complete node node_g

[refack]

can't we replace node node_g with argv[0]?

[danbev]

I'll take a look. Thanks

[addaleax]

@danbev Just to make sure, have you seen #22490? I don’t know whether this would help make this more robust or not, but it seems like it might.

[danbev]

Just to make sure, have you seen #22490?

Thanks I was not aware of it. I'll take a look closer look at it next week. Thanks

[danbev]

Since the real "magic" is baked into the --help logic, this seems like a too specific change for a specific target (IIUC just bash), that could be replaced with a simple independant snippet:

This was what the original commit did, but was changed after the suggestion in #20713 (comment).

[danbev]

New CI: https://ci.nodejs.org/job/node-test-pull-request/17026/

[jasnell]

A more complete example of how to use this would be good here.

[danbev]

I'll add an example. Thanks

[BridgeAR]

Maybe reword this to:

Print source-able bash completion script for Node.js.?

[danbev]

Sounds good, I'll update. Sorry for the late reply by the way, I just saw this comment.

[danbev]

Rebased CI: https://ci.nodejs.org/job/node-test-pull-request/17336/

[richardlau]

linuxone failures were a job configuration issue that is now fixed: nodejs/build#1501

[danbev]

@richardlau Thanks!

[danbev]

Re-build of failing node-test-commit-linuxone was successful.

[danbev]

Landed in 56493bf.