使用 --experimental-specifier-resolution=node 时如何让 yargs 自动完成工作

我的目标是在 Typescript/node.js 中编写一个 CLI，它使用--experimental-specifier-resolution=node，用 yargs 编写，支持自动完成。

为了使这项工作正常进行，我使用这个entry.sh文件，感谢这有帮助所以答案 https://stackoverflow.com/a/68154775/3694288（以及bin: {eddy: "./entry.sh"}package.json 中的选项指向此文件）

#!/usr/bin/env bash

full_path=$(realpath $0)
dir_path=$(dirname $full_path)
script_path="$dir_path/dist/src/cli/entry.js"

# Path is made thanks to: https://code-maven.com/bash-shell-relative-path
# Combined with knowledge from: https://stackoverflow.com/questions/68111434/how-to-run-node-js-cli-with-experimental-specifier-resolution-node

/usr/bin/env node --experimental-specifier-resolution=node $script_path "$@"

这很好用，我可以使用 CLI。但是，自动完成功能不起作用。根据 yargs 我应该能够通过输出结果来获得自动补全./entry.sh completion to the ~/.bashrc轮廓。然而这似乎不起作用。

输出来自./entry.sh completion:

###-begin-entry.js-completions-###
#
# yargs command completion script
#
# Installation: ./dist/src/cli/entry.js completion >> ~/.bashrc
#    or ./dist/src/cli/entry.js completion >> ~/.bash_profile on OSX.
#
_entry.js_yargs_completions()
{
    local cur_word args type_list

    cur_word="${COMP_WORDS[COMP_CWORD]}"
    args=("${COMP_WORDS[@]}")

    # ask yargs to generate completions.
    type_list=$(./dist/src/cli/entry.js --get-yargs-completions "${args[@]}")

    COMPREPLY=( $(compgen -W "${type_list}" -- ${cur_word}) )

    # if no match was found, fall back to filename completion
    if [ ${#COMPREPLY[@]} -eq 0 ]; then
      COMPREPLY=()
    fi

    return 0
}
complete -o default -F _entry.js_yargs_completions entry.js
###-end-entry.js-completions-###

我尝试修改completion输出，但我还不太了解 bash - 还没有 ????

Update

正在研究可重现的示例（WIP）。 回购协议是here https://github.com/21RISK/yargs-autocomplete.

目前最大的区别之一是npm link在两种不同的环境中工作方式不同。它只是在我试图重现的存储库中/usr/local/share/npm-global/bin/实际上已更新。目前正在尝试调查此事。

您可以尝试指定脚本名称 https://github.com/yargs/yargs/pull/1143/files在你的entry.js文件到你的包装脚本的名称。这可能会强制使用它生成完成名称。我还没有尝试过，但是查看 yargs 的源代码，它看起来像$0可以使用更改参数scriptName，这反过来又会影响完成生成函数如何生成完成代码：

In yargs-factor.ts:

  scriptName(scriptName: string): YargsInstance {
    this.customScriptName = true;
    this.$0 = scriptName;
    return this;
  }

In completion.ts:

  generateCompletionScript($0: string, cmd: string): string {
    let script = this.zshShell
      ? templates.completionZshTemplate
      : templates.completionShTemplate;
    const name = this.shim.path.basename($0);

    // add ./ to applications not yet installed as bin.
    if ($0.match(/\.js$/)) $0 = `./${$0}`;

    script = script.replace(/{{app_name}}/g, name);
    script = script.replace(/{{completion_command}}/g, cmd);
    return script.replace(/{{app_path}}/g, $0);
  }

我也不确定如何"bin"配置有效，但可能是因为scriptName您将不再需要包装纸。

确保您使用的 yargs 版本支持此功能。

另外，作为旁注，我考虑建议直接修改生成的完成脚本，但除了黑客行为之外，还可能导致脚本名称在完成过程中无法识别。无论如何，我只是先看看正确的方法。

修改后的版本会是这样的：

_entry.sh_yargs_completions()
{
    local cur_word args type_list

    cur_word="${COMP_WORDS[COMP_CWORD]}"
    args=("${COMP_WORDS[@]}")

    # ask yargs to generate completions.
    type_list=$(/path/to/entry.sh --get-yargs-completions "${args[@]}")

    COMPREPLY=( $(compgen -W "${type_list}" -- ${cur_word}) )

    # if no match was found, fall back to filename completion
    if [ ${#COMPREPLY[@]} -eq 0 ]; then
      COMPREPLY=()
    fi

    return 0
}
complete -o default -F _entry.sh_yargs_completions entry.sh

另请注意：如果脚本名称需要根据其调用者的名称是动态的，您可以通过环境变量使其可识别，因此在entry.sh你可以这样声明它：

export ENTRY_JS_SCRIPT_NAME=entry.sh
node ...

然后在某个地方entry.js，您可以通过以下方式访问变量名称：

process.env.ENTRY_JS_SCRIPT_NAME

也许甚至只是指定$0 or ${0##*/}任何有效的方法：

export ENTRY_JS_SCRIPT_NAME=$0