npx原理以及使用方法

1,741 阅读4分钟

什么是 npx

npm 是 node 的包管理器,那么 npx 是什么呢?

npx是一个由 Node.js 官方提供的用于快速执行 npm 包中的可执行文件的工具。(用来执行node_modules/bin/可执行文件),定义为 npm 包的执行者。

相比 npm,npx 会自动安装依赖包并执行某个命令。

  • 它可以帮助我们在不全局安装某些包的情况下,直接运行该包提供的命令行工具;
  • npx在执行时,检查本地项目中是否安装了对应的依赖,如果没有安装则会自动下载安装,并执行命令;
  • 如果本地已经存在该依赖,则直接执行命令;

原理

npx 在运行时,会到node_modules/.bin路径和环境变量$PATH里面,检查命令是否存在

举个例子,由于 npx 会检查环境变量$PATH,所以系统命令也可以调用

//等同于 ls
npx ls

注意,Bash 内置的命令不在$PATH里面,所以不能用。比如,cd是 Bash 命令,因此就不能用npx cd

用它的目的

npx是一个工具,npm v5.2.0引入的一条命令(npx),一个npm包执行器,旨在提高从npm注册表使用软件包的体验 ,npm使得它非常容易地安装和管理托管在注册表上的依赖项,加强用户的体验。

目的一:调用项目安装的模块

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

比如,项目内部安装了测试工具 Mocha

npm install -D mocha

一般来说,调用 Mocha ,只能在项目脚本和 package.jsonscripts字段里面, 如果想在命令行下调用,必须像下面这样:

// 项目的根目录下执行
$ node-modules/.bin/mocha --version

npx 就是想解决这个问题,让项目内部安装的模块用起来更方便,只要像下面这样调用就行了

npx mocha --version

目的二:避免全局安装模块

npx 不会像 npmyarn 一样将包下载到本地的 node_modules 目录中。相反,它会在执行命令时,在本地缓存中寻找并下载包,然后执行该包中的命令。这样可以避免在开发过程中在全局安装大量的包,同时也可以确保使用的是最新版本的包。

npx会在执行命令之前,将需要执行的包下载到一个临时目录中,并在执行完毕后删除该目录。这样可以避免在本地留下不必要的依赖包。如果需要保留依赖包,可以使用--no-cleanup选项来禁止删除下载的包。

npx 怎么用

Node 自带 npm 模块,所以可以直接使用 npx 命令。万一不能用,就要手动安装一下。

npm install -g npx

1、使用create-react-app创建一个react项目

传统方法:

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

npx 方法:

npx create-react-app my-app

这条命令会临时安装 create-react-app 包,命令完成后create-react-app 会删掉,不会出现在 global 中。下次再执行,还是会重新临时安装。

2、npx 支持运行远程仓库的可执行文件:

npx 还可以执行 GitHub 上面的模块源码

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

// 执行仓库代码
npx github:piuccio/cowsay hello

3、npx 可以指定node版本来运行npm scripts

npx -p node@8 npm run build

npx命令参数

1、--no-install 参数和--ignore-existing 参数

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

npx --no-install http-server

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

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

2、-p 参数

-p参数用于指定 npx 所要安装的模块,它可以指定某一个版本进行安装:

npx -p node@0.12.8 node -v 

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

3、-c 参数

作用一

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

npx -p lolcatjs -p cowsay 'cowsay hello | lolcatjs' //报错

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

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

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

作用二

-c参数的另一个作用,是将环境变量带入所要执行的命令。

举例来说,npm 提供当前项目的一些环境变量,可以用下面的命令查看。

npm run env | grep npm_

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

npx -c 'echo "$npm_package_name"'

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

npx 与npm的区别

  • npx侧重于执行这个包
  • npm侧重安装与卸载这个包。但npm可以通过scripts配置来达到npx的效果

参考链接

阮一峰网络日志:npx 使用教程