- npm 从 5.2 版本开始,增加了 npx 命令
- Node 自带 npm 模块,所以可以直接使用 npx 命令
1 - 调用项目安装的模块
(这是 npx 想要解决的主要问题)
比如,项目内部安装了测试工具 Mocha:
$ npm install -D mocha
一般来说,调用 Mocha 只能在项目脚本和 package.json 的 script 字段里,如果想要在命令行下调用:
# 项目的根目录下执行
$ node-modules/.bin/mocha --version
这种情况就是 npx 要解决的问题,让项目内部安装的模块用起来更方便:
$ npx mocha --version
npx 的原理:在运行的时候,会到 node_modules/.bin 路径和环境变量 $PATH 里,检查命令是否存在。
由于 npx 会检查环境变量 $PATH,所以系统命令也可以调用:
# 等同于 ls
$ npx ls
注意,Bash 内置的命令不在 $PATH 里面,所以 npx 不可以调用 Bash 命令,因此不能使用 npx cd 。
2 - 避免全局安装模块
比如,npx 运行 create-react-app 这个模块,但不进行全局安装:
$ npx create-react-app my-app
npx 将 create-react-app 模块下载到一个临时文件,使用以后再删除。所以,若再次执行以上代码,create-react-app 会重新被下载。
下载全局模块时,npx 允许指定版本:
$ npx uglify-js@3.1.0 main.js -o ./dist/main.js
以上代码意思是指定使用 3.1.0 版本的 uglify-js 压缩脚本。
注意,只要 npx 后面的模块无法在本地发现,就会下载同名模块。比如,本地没有安装 http-server 模块,下面的命令会自动下载该模块,在当前目录启动一个 web 服务:
$ npx http-server
--no-install 参数和 --ignore-existing 参数
如果想让 npx 强制使用本地模块,不下载远程模块,可以使用 --no--install 参数。如果本低不存在该模块,就会报错。
$ npx --no-install http-server
如果想要忽略本地的同名模块,强制安装使用远程模块,可以使用 --ignore-existing 参数。比如,本地已经全局安装了 create-react-app,但是想要使用远程模块:
$ npx --ignore-existing create-react-app my-app
使用不同版本的 node
利用 npx 可以下载模块这个特点,可以指定某个版本的 Node 运行脚本:
$ npx node@0.12.8 -v
上面命令会使用 0.12.8 版本的 Node 执行脚本。原理是从 npm 下载这个版本的 node ,使用后再删除。
在某些场景下,这个方法可以用来切换 Node 版本,要比 nvm 那样的版本管理器方便一些。
(nvm 是???)
-p 参数
-p 参数用于指定 npx 所要安装的模块,所以上一节的命令可以写成这样:
$ npx -p node@0.12.8 node -v
上面命令先指定安装 node@0.12.8,然后再执行 node -v 命令。
-p 参数对于需要安装多个模块的场景很有用:
$ npx -p lolcat js -p cowsay [command]
-c 参数
如果 npx 安装多个模块,默认情况下,所执行的命令之中,只有第一个可执行项会使用 npx 安装的模块,后面的可执行项是会交给 Shell 解释。
$ npx -p lolcat js -p cowsay 'cowsay hello | lolcat js'
上面代码中,cowsay hello | lolcat js 执行时会报错,原因是第一项 cowsay 由 npx 解释,而第二行命令 lolcat js 由 Shell 解释,但是 lolcat js 并没有全局安装,所以报错。
-c 参数可以将所有命令都用 npx 解释:
$ npx -p lolcat js -p cowsay -c 'cowsay hello | lolcat js'
-c 参数的另一个作用,是将环境变量带入所要执行的命令。举例来说,npm 提供当前项目的一些环境变量,可以用下面的命令查看:
$ npm run env | grep npm_
-c 参数可以把这些 npm 的环境变量带入 npx 命令:
$ npx -c 'echo "$npm_package_name"'
上面代码会输出当前项目的项目名。
执行 GitHub 源码
npx 还可以执行 GitHub 上面的模块源码:
# 执行 Gist 代码
$ npx https://gist.github.com/zkat/4bc19503fe9e9309e2bfaa2c58074d32
# 执行仓库代码
$ npxx github:piuccio/cowsay hello
注意,远程代码必须是一个模块,即必须包含 package.json 和入口脚本。
(完)
参考 npx 使用教程 - 阮一峰网络日志