npx

今天看react安装环境中有一句 npx create-react-app my-app,没有见过npx,查了查资料 聊以记录;

npx 是 npm v5.2.0 引入的一条命令,目的是为了提升开发者使用包内提供命令行工具的体验。

避免全局安装模块

eg:使用create-react-app创建项目

老方法:

1
2
npm install -g create-react-app
create-react-app my-app

npx 方法:

1
2
3
4
5
npx create-react-app my-app

//也可以指定版本
npx uglify-js@3.1.0 main.js -o ./dist/main.js

这条命令会临时安装create-react-app包,命令完成后会删掉,不会出现在global中。

支持运行远程仓库中的可执行文件

1
2
3
4
5
执行 Gist 代码
npx https://gist.github.com/zkat/4bc19503fe9e9309e2bfaa2c58074d32

//执行可执行文件
npx github:picco/cowsay hello

注意,远程代码必须是一个模块,即必须包含package.json和入口脚本。

使用http-server开启一个服务

1
npx http-server //第一次有点慢

指定node版本来运行 npm scripts

1
npx -p node@8 npm run build

调用项目安装的模块

npx 想要解决的主要问题,就是调用项目内部安装的模块。比如,项目内部安装了webpack。

举例来说,之前我们可能会写这样的命令:

1
2
3
npm i -D webpack
./node_modules/.bin/webpack -v
// webpack -v

bash版

1
2
3
npm i -D webpack
`npm bin`/webpack -v

npx

1
2
npm i -D webpack
npx webpack -v

也就是说 npx 会自动查找当前依赖包中的可执行文件,如果找不到,就会去 PATH 里找。如果依然找不到,就会帮你安装!

–no-install 参数和–ignore-existing 参数

如果想让 npx 强制使用本地模块,不下载远程模块,可以使用–no-install参数。如果本地不存在该模块,就会报错。

1
2
npx --no-install http-server

反过来,如果忽略本地的同名模块,强制安装使用远程模块,可以使用–ignore-existing参数。比如,本地已经全局安装了create-react-app,但还是想使用远程模块,就用这个参数。

1
npx --ignore-existing create-react-app my-react-app

使用不同版本的node

利用 npx 可以下载模块这个特点,可以指定某个版本的 Node 运行脚本。它的窍门就是使用 npm 的 node 模块。

1
2
$ npx node@0.12.8 -v
v0.12.8

上面命令会使用 0.12.8 版本的 Node 执行脚本。原理是从 npm 下载这个版本的 node,使用后再删掉。

某些场景下,这个方法用来切换 Node 版本,要比 nvm 那样的版本管理器方便一些。

-p参数

-p 参数用于指定 npx 所要安装的模块,所以上一节的命令可以写成下面这样。

1
2
npx -p node@0.12.8 node -v 
v0.12.8

上面命令先指定安装node@0.12.8,然后再执行node -v命令。

-p参数对于需要安装多个模块的场景很有用。

-c参数

如果 npx 安装多个模块,默认情况下,所执行的命令之中,只有第一个可执行项会使用 npx 安装的模块,后面的可执行项还是会交给 Shell 解释。

1
2
3
npx -p lolcatjs -p cowsay 'cowsay hello | lolcatjs'
# 报错

上面代码中,cowsay hello | lolcatjs执行时会报错,原因是第一项cowsay由 npx 解释,而第二项命令localcatjs由 Shell 解释,但是lolcatjs并没有全局安装,所以报错。

-c参数可以将所有命令都用 npx 解释。有了它,下面代码就可以正常执行了。

1
2
npx -p lolcatjs -p cowsay -c 'cowsay hello | lolcatjs'

-c参数的另一个作用,是将环境变量带入所要执行的命令。举例来说,npm 提供当前项目的一些环境变量,可以用下面的命令查看。

1
npm run env | grep npm_

-c参数可以把这些 npm 的环境变量带入 npx 命令。

1
npx -c 'echo "$npm_package_name"'

上面代码会输出当前项目的项目名。