npm run <Tab>无法补全monorepo子包脚本，如何配置实现？

问题背景 #

默认情况下，npm run <Tab>的自动补全逻辑会从当前目录向上查找第一个package.json（即项目根目录的配置文件），因此即使在子目录执行命令，也只会显示根目录的脚本。要实现显示当前目录package.json脚本或所有子目录脚本，需要修改Shell的npm补全配置。

Bash环境配置 #

1. 定位npm补全脚本
   通常路径为/usr/share/bash-completion/completions/npm，也可能在~/.bash_completion.d/npm。可通过locate npm | grep completion快速查找。

2. 修改补全逻辑
   打开脚本，找到_npm_run函数，定位获取package.json路径的行：

   local pkgjson=$(npm prefix --quiet 2>/dev/null)/package.json
   

   • 若要仅显示当前目录的脚本，替换为：

     local pkgjson=./package.json
     

   • 若要显示所有子目录的脚本，可替换为遍历逻辑（需提前安装jq工具：brew install jq）：

     # 收集所有非node_modules目录下的package.json脚本
     local scripts=()
     for pkg in $(find . -name package.json -type f | grep -v node_modules); do
       scripts+=($(jq -r '.scripts | keys[]' "$pkg" 2>/dev/null))
     done
     # 去重后生成补全候选
     COMPREPLY=( $(compgen -W "$(printf "%s\n" "${scripts[@]}" | sort -u)" -- "$cur") )
     # 注释掉原有的pkgjson读取和处理逻辑
     

3. 生效配置
   执行source /path/to/npm-completion-script或重启终端。

Zsh环境配置 #

情况1：使用Oh My Zsh的npm插件 #

1. 打开插件脚本：~/.oh-my-zsh/plugins/npm/npm.plugin.zsh
2. 找到_npm_run函数中获取脚本的部分，原逻辑类似：

   local prefix=$(npm prefix 2>/dev/null)
   local pkgjson="$prefix/package.json"
   

   • 改为仅显示当前目录脚本：

     local pkgjson="./package.json"
     

   • 改为显示所有子目录脚本（需安装jq）：

     local scripts=()
     for pkg in $(find . -name package.json -type f | grep -v node_modules); do
       scripts+=($(jq -r '.scripts | keys[]' "$pkg" 2>/dev/null))
     done
     scripts=(${(u)scripts}) # 去重
     compadd -- $scripts
     # 注释掉原有的pkgjson解析逻辑
     

情况2：系统自带zsh补全 #

补全脚本通常在/usr/share/zsh/site-functions/_npm，修改方式与上述一致，调整_npm_run中的package.json路径或遍历逻辑。

3. 生效配置
   执行source ~/.zshrc或重启终端。

注意事项 #

• 修改前建议备份原补全脚本，避免配置出错。
• 遍历所有子目录的方案可能在大型项目中导致补全延迟，按需选择。

内容的提问来源于stack exchange，提问作者Vilius