npm 脚本

摘自 阮一峰网站

基础使用

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

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

命令行下使用npm run命令，就可以执行定义的脚本

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

原理

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

比较特别的是，npm run新建的这个 Shell，会将当前目录的node_modules/.bin子目录加入PATH变量，执行结束后，再将PATH变量恢复原样。即当前目录的node_modules/.bin子目录里面的所有脚本，都可以直接用脚本名调用，而不必加上路径

比如项目依赖里有 vite，则可以直接写

"dev": "vite"

而不用写

"dev": "./node_modules/.bin/vite"

通配符

*表示任意文件名，**表示任意一层子目录

"clean:js": "rimraf *.js"
"clean:alljs": "rimraf **/*.js"

传参

使用 -- 标明

"dev": "vite --port 3000"

执行顺序

如果是并行执行（即同时的平行执行），可以使用&符号

如果是继发执行（即只有前一个任务成功，才执行下一个任务），可以使用&&符号

# 并行
$ npm run script1.js & npm run script2.js

# 前一个任务成功，才执行下一个任务
$ npm run script1.js && npm run script2.js

钩子

有pre和post两个钩子。pre最先执行，post会最后执行

比如有以下脚本

"prebuild": "echo I run before the build script",
"build": "vite build",
"postbuild": "echo I run after the build script"

执行npm run build的时候，会自动按照下面的顺序执行

npm run prebuild && npm run build && npm run postbuild

简写

以下四个常用的 npm 脚本有简写形式

• npm start是npm run start的简写
• npm stop是npm run stop的简写
• npm test是npm run test的简写
• npm restart是npm run stop && npm run restart && npm run start的简写

变量

通过npm_package_前缀，npm 脚本可以拿到package.json里面的字段

比如，下面是一个package.json

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

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

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

npm_package_前缀也支持嵌套的package.json字段

{
	"repository": {
        "type": "git"
    }
}

// test.js
console.log(process.env.npm_package_repository_type); // git

如果是 Bash 脚本，可以用$npm_package取到值

{
  "name": "foo", 
  "scripts": {
    "test": "echo $npm_package_name"
  }
}

package.json里面的config对象，可以被环境变量覆盖

{
    "config": {
        "port": 8080
    },
    "scripts": {
        "test": "node test.js"
    }
}

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

$ npm config set foo:port 80