深入理解npm脚本

最新推荐文章于 2025-05-09 07:30:00 发布

LoveyL0201

最新推荐文章于 2025-05-09 07:30:00 发布

阅读量1.2k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： npm 文章标签： npm

本文链接：https://blog.youkuaiyun.com/chen_junfeng/article/details/110450230

npm 专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍了npm脚本的概念，包括如何在package.json中定义脚本，执行原理，npm start的作用，脚本的并行与继发执行，以及如何使用内部变量和通配符。此外，还提到了npm脚本中可以访问package.json的字段和npm配置变量，并指出环境变量可以覆盖package.json的config对象。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

npm脚本

什么是npm脚本？

npm 允许在 package.json 文件里面，使用 scripts 字段定义脚本命令；
```
{
  "scripts": {
    "build": "node build.js"
  }
}
```
在package.json文件中有一个scripts对象，这里面可以书写我们想要执行的脚本，比如如果想执行 node build.js，我们只需要在终端中输入：
```
$ npm run build
//这样等同于我们执行了
$ node build.js
```
查看当前scirpts对象中的全部脚本

直接执行终端的命令即可，不需要添加任何参数
```
$ npm run
```
原理

每当我们执行了 npm run 命令时，此时那么终端就会执行一个新的终端命令。
```
{ 
  "name" : "foo", 
  "dependencies" : { 
    "bar" : "0.1.x" 
  }, 
  "scripts": { 
    "start" : "bar ./test" 
  } 
}
```
官方文档：

如果我们执行脚本需要依赖其他的包，那么在我们执行 npm start 时，脚本会将所依赖包的环境变量 path 添加到我们所执行脚本的路径中，所以当你执行了 npm start 时，相当于会将node_modules/.bin 目录添加到我们的./test路径之前：

个人理解：

只要全局和开发环境中有就可以不用写路径，可以直接使用模块的脚本名，如果该模块不存在，即在全局和开发环境中找不到这个模块，那么一定会报错，这时候可以检查是否安装了该模块。
```
"scripts": { 
    "start" : "bar node_modules/.bin/test" 
  } 
```
npm start

它运行 package.json 中的 scripts 对象中的“start”属性中指定的任意命令。如果在“scripts”对象上没有指定“start”属性，它将运行node server.js。
```
$ npm run start 
$ npm start //简写
```

简写

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 的简写

脚本的执行顺序
```
"scripts": {
  "script1": "node script1.js",
  "script2": "node script2.js"
}
```
并行执行 ( 两个脚本同时执行，执行完成的先后顺序不确定)
```
$ npm run script1.js & npm run script2.js
```
继发执行（只有第一个脚本执行成功之后，第二个脚本才会执行）
```
$ npm run script1.js && npm run script2.js
```

变量

npm 脚本可以使用内部变量

可以通过npm_package_ 前缀，拿到package.json 文件里的字段

{
  "name": "foo", 
  "version": "1.2.5",
   "repository": {
    "type": "git",
    "url": "xxx"
  },
  "scripts": {
    "view": "node view.js"
  }
}

View.js

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

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

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

“env”: “env”

通配符

由于 npm 脚本就是 Shell 脚本，因为可以使用 Shell 通配符。
```
"lint": "jshint *.js"
"lint": "jshint **/*.js"
```
上面代码中，*表示任意文件名，**表示任意一层子目录。

如果要将通配符传入原始命令，防止被 Shell 转义，要将星号转义。
```
"test": "tap test/\*.js"
```
参考文献：

阮一峰-npm scripts 使用指南

npm官方文档