npm scripts 使用指南

171 阅读3分钟

Node 开发离不开 npm,而脚本功能是 npm 最强大、最常用的功能之一。

本文介绍如何使用 npm 脚本(npm scripts)。

一、什么是 npm 脚本?

npm 允许在package.json文件里面,使用scripts字段定义脚本命令。

{
 // ...
   "scripts": {
     "build": "node build.js"
   }
 }

上面代码是package.json文件的一个片段,里面的scripts字段是一个对象。它的每一个属性,对应一段脚本。比如,build命令对应的脚本是node build.js

命令行下使用npm run命令,就可以执行这段脚本。

$ npm run build
// 等同于执行
$ node build.js

这些定义在package.json里面的脚本,就称为 npm 脚本。它的优点很多。

  1. 项目的相关脚本,可以集中放在一个地方
  2. 不同项目的脚本命令,只要功能相同,就可以有同样的对外接口。用户不需要知道怎么测试你的项目,只要运行npm run test即可。
  3. 可以利用 npm 提供的很多辅助功能。

查看当前项目的所有 npm 脚本命令,可以使用不带任何参数的npm run命令。

二、原理

npm 脚本的原理非常简单。每当执行npm run,就会自动新建一个 Shell,在这个 Shell 里面执行指定的脚本命令。因此,只要是 Shell(一般是 Bash)可以运行的命令,就可以写在 npm 脚本里面。

比较特别的是,npm run新建的这个 Shell,会将当前目录的node_modules/.bin子目录加入PATH变量,执行结束后,再将PATH变量恢复原样。

这意味着,当前目录的node_modules/.bin子目录里面的所有脚本,都可以直接用脚本名调用,而不必加上路径。比如,当前项目的依赖里面有 Mocha,只要直接写mocha test就可以了。

"test": "mocha test"
// 而不用加上路径写成下面这种
 "test": "./node_modules/.bin/mocha test"

由于 npm 脚本的唯一要求就是可以在 Shell 执行,因此它不一定是 Node 脚本,任何可执行文件都可以写在里面。

npm 脚本的退出码,也遵守 Shell 脚本规则。如果退出码不是0,npm 就认为这个脚本执行失败。

三、传参

向 npm 脚本传入参数,要使用--标明。

 "dev": "vue-cli-service serve",

向上面的npm run dev命令传入参数,必须写成下面这样。

npm run dev --test

也可以在package.json里面再封装一个命令。

{
   "scripts": {
     "dev": "vue-cli-service serve",
     "overseas": "npm run dev --test",
   }
 }

vue.config.js文件中可以通过 process.env.npm_config_test 来判断参数是否为:test;如果是test返回true;否则返回false或者undefined

四、默认值及简写

  1. 一般来说,npm 脚本由用户提供。但是,npm 对两个脚本提供了默认值。也就是说,这两个脚本不用定义,就可以直接使用。
"start": "node server.js""install": "node-gyp rebuild"

上面代码中,npm run start的默认值是node server.js,前提是项目根目录下有server.js这个脚本;npm run install的默认值是node-gyp rebuild,前提是项目根目录下有binding.gyp文件;npm install或者npm i 在 scripts 中没有定义,但是可以直接使用,npm提供的默认值。

  1. 常用的 npm 脚本有简写形式。
npm start 是 npm run start
npm stop 是 npm run stop
npm test 是 npm run test

五、变量

npm 脚本有一个非常强大的功能,就是可以使用 npm 的内部变量。

首先,通过npm_package_前缀,npm 脚本可以拿到package.json里面的字段。比如,下面是一个package.json

 {
   "name": "foo", 
   "version": "1.2.5",
   "scripts": {
     "view": "node view.js"
   }
 }

那么,变量npm_package_name返回foo,变量npm_package_version返回1.2.5

console.log(process.env.npm_package_name); // foo
console.log(process.env.npm_package_version); // 1.2.5

npm 脚本还可以通过npm_config_前缀,拿到 npm 的配置变量,即npm config get xxx命令返回的值。比如,当前模块的发行标签,可以通过npm_config_tag取到。

 "view": "echo $npm_config_tag",

注意,package.json里面的config对象,可以被环境变量覆盖。

{
  "name" : "foo",
  "config" : { "port" : "8080" },
  "scripts" : { "start" : "node server.js" }
}

上面代码中,npm_package_config_port变量返回的是8080。这个值可以用下面的方法覆盖。

$ npm config set foo:port 80

也可以在scripts中设置port

{
  "name" : "foo",
  "scripts" : { 
      "start" : "node server.js",
      "dev": "set DUBBO_HEALTHCHECK_SKIP=true && egg-bin --port=7011 dev", // egg中
  }
}

最后,env命令可以列出所有环境变量。

"env": "env"