npm-run-path

中文文档
6.0.0发布于 2024/08/26MITTypeScriptES Module近 30 天下载 6.2亿

在PATH前面加上本地安装的二进制文件

中文使用文档
文档目录7 节
  1. 安装
  2. 用法
  3. API
  4. npmRunPath(选项?)
  5. npmRunPathEnv(选项?)
  6. 选项
  7. 相关

npm-run-path

让你的 路径 加上本地安装的二进制文件

在 NPM运行脚本 您可以按名称执行本地安装的二进制文件。这会在npm外部启用相同的功能。

安装

npm install npm-run-path

用法

import childProcess from 'node:child_process';
import {npmRunPath, npmRunPathEnv} from 'npm-run-path';

console.log(process.env.PATH);
//=> '/usr/local/bin'

console.log(npmRunPath());
//=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin'

// `foo` is a locally installed binary
childProcess.execFileSync('foo', {
    env: npmRunPathEnv()
});

API

npmRunPath(选项?)

options: Options
返回: string

返回扩增的PATH字符串。

npmRunPathEnv(选项?)

options: Options
返回: object

返回增广 process.env 对象。

选项

类型: object

慢性消耗病

类型: string | URL
默认值: process.cwd()

工作目录。

execPath

类型: string | URL
默认值: process.execPath

当前Node.js可执行文件的路径。

可以是绝对路径,也可以是相对路径 cwd 选项。

addExecPath

类型: boolean
默认值: true

是否推送当前Node.js可执行文件目录(execPath 选项)到PATH的前面。

preferLocal

类型: boolean
默认值: true

是否将本地安装的二进制文件目录推到PATH的前面。

路径

类型: string
默认值: PATH

要追加的PATH。

将其设置为空字符串以排除默认的PATH。

仅适用于 npmRunPath(),而不是 npmRunPathEnv()。

env

类型: object
默认值: process.env

接受环境变量的对象,如 process.env,并使用正确的方法修改PATH 关键路径. 如果要修改PATH以便在 child_process 选项。

仅适用于 npmRunPathEnv(),而不是 npmRunPath()。

版本与发布记录

npm-run-path 共发布 14 个版本,首次发布于 2015/12/29;过去 12 个月发布了 0 个版本。

版本发布日期距今
6.0.0latest2024/08/262 年前
5.3.02024/02/232 年前
5.2.02023/12/222 年前
5.1.02022/02/094 年前
5.0.12021/10/055 年前
5.0.02021/10/055 年前

关于 npm-run-path 的常见问题

npm-run-path 是什么?

在PATH前面加上本地安装的二进制文件

如何安装 npm-run-path?

在项目目录运行 npm install npm-run-path,或使用 pnpm add / yarn add / bun add。

npm-run-path 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

npm-run-path 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

npm-run-path 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

npm-run-path 可以商用吗?

npm-run-path 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

npm-run-path 的下载量有多少?

根据 npm 官方下载统计,npm-run-path 在 2026/10/04 – 2026/11/02 这 30 天内被下载 617,388,594 次,日均约 20,579,620 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

npm-run-path 还在维护吗?

最新版本 6.0.0 发布于 2024/08/26(2 年前);至今共发布 14 个版本,其中过去 12 个月发布了 0 个;首次发布于 2015/12/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。