详解npm脚本和package.json
npm是什么
npm是前端开发⼴泛使⽤的包管理⼯具，它让js开发者分享、复⽤代码更⽅便。可以重复的框架代码被称为包（package）或者模块(module),⼀个包可是是⼀个⽂件夹⾥放着⼏个⽂件夹，还有⼀个package.json⽂件。
1、什么是npm脚本
在创建node.js项⽬如⼀个vue项⽬，或⼀个react项⽬时，项⽬都会⽣成⼀个描述⽂件package.json 。
⽐如npm允许在package.json⽂件⾥⾯，使⽤scripts字段定义脚本命令。
{
//...
"scripts": {
"dev": "webpack-dev-server --inline --progress --config build/f.js",
"start": "npm run dev",
"e2e": "node test/e2e/runner.js",
"test": "npm run e2e",
"lint": "eslint --ext .js,.vue src test/e2e/specs",
"build": "node build/build.js"
},
}
上⾯代码是package.json⽂件的⼀个⽚段，⾥⾯的scripts字段是⼀个对象。它的每⼀个属性，对应⼀段脚本。⽐如，build 命令对应的脚本是node build.js 。
命令⾏下使⽤npm run 命令，就可以执⾏这段脚本。
$ npm run build
等同于执⾏：
$ node build/build.js
同理，上⾯的那段scripts中， npm run test 等同于 npm run e2e , 等同于 node test/e2e/runner.js
这些定义在package.json⾥⾯的脚本，就称为npm脚本。项⽬的相关脚本，可以集中在⼀个地⽅；不同项⽬的脚本命令，只要功能相同，就可以有同样的对外接⼝。⽐如⽤户不需要知道怎么测试你的项⽬，只要运⾏ npm run dev 即可
查看当前项⽬的所有npm脚本命令，可以使⽤不带任何参数的 npm run 命令。
$ npm run
2、npm原理
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 就认为这个脚本执⾏失败。
3、通配符
由于npm脚本就是shell脚本，因此可以使⽤shell通配符。
"lint": "jshint *.js"
"lint": "jshint **/*.js"
上⾯代码中，* 表⽰任意⽂件名，**表⽰任意⼀层⼦⽬录。如果要将通配符传⼊原始命令，防⽌被shell转义，要将*号转义。
"test": "tap test/\*.js"
4、传参
向npm脚本传⼊参数，要使⽤ -- 标明。
"lint": "jshint **.js"
向上⾯的 npm run lint 命令传⼊参数，必须写成下⾯这样。
怎么看项目是什么框架$ npm run lint -- --reporter checkstyle > l
也可以再package.json⾥⾯封装⼀个命令。
"lint": "jshint **.js",
"lint:checkstyle": "npm run lint -- --reporter checkstyle > l"
5、执⾏顺序
如果npm脚本⾥⾯需要执⾏多个任务，那么需要明确它们的执⾏顺序。如果是并⾏执⾏（即同时的平⾏执⾏），可以使⽤& 符号。
$ npm run script1.js & npm run script2.js
如果是继发执⾏（即只有前⼀个任务成功，才能执⾏下⼀个任务），可以使⽤ && 符号。
$ npm run script1.js && npm run script2.js
6、默认值
⼀般来说，npm脚本由⽤户提供。但是，npm对两个脚本提供了默认值。也就是说，这两个脚本不⽤定义，就可以直接使⽤。
"start": "node server.js"，
"install": "node-gyp rebuild"
上⾯代码中，npm run start 的默认值是 node server.js, 前提是项⽬根⽬录下有server.js这个脚本；npm run install 的默认值是node-gyp rebuild, 前提是项⽬根⽬录下有p⽂件。
7、钩⼦
npm脚本有pre何post两个钩⼦。举例来说，build脚本命令的钩⼦就是prebuild和postbuild。
"prebuild": "echo I run before the build script",
"build": "cross-env NODE_ENV=production webpack",
"postbuild": "echo I run after the build script"
⽤户执⾏npm run build的时候，会⾃动按照下⾯的顺序执⾏。
npm run prebuild && npm run build && npm run postbuild
因此，可以在这两个钩⼦⾥⾯，完成⼀些准备⼯作和清理⼯作。下⾯是⼀个例⼦：
"clean": "rimraf ./dist && mkdir dist",
"prebuild": "npm run clean",
"build": "cross-env NODE_ENV=production webpack"
npm默认提供下⾯的这些钩⼦：
prepublish，postpublish
preinstall，postinstall
preuninstall，postuninstall
preversion，postversion
pretest，posttest
prestop，poststop
prestart，poststart
prerestart，postrestart
⾃定义的脚本命令也可以加上pre和post钩⼦。⽐如，myscript这个脚本命令，也有premyscript和postmyscript钩⼦。不过，双重的pre和post⽆效，⽐如prepretest和postposttest是⽆效的。
npm提供⼀个npm_lifecycle_event变量，返回当前正在运⾏的脚本命令，⽐如pretest、test、posttest等等。所以，可以利⽤这个变量，在同⼀个脚本⽂件⾥⾯，为不同的npm scripts命令编写代码。请看下⾯的例⼦：
const TARGET = v.npm_lifecycle_event;
if (TARGET === 'test') {
console.log(`Running the test task!`);
}
if (TARGET === 'pretest') {
console.log(`Running the pretest task!`);
}
if (TARGET === 'posttest') {
console.log(`Running the posttest task!`);
}
注意，prepublish这个钩⼦不仅会在npm publish 命令之前运⾏，还会在npm install （不带任何参数）
命令之前运⾏。这种⾏为很容易让⽤户感到困惑，所以npm 4引⼊了⼀个新的钩⼦prepare, ⾏为等同于prepublish, ⽽从npm 5开始，prepublish 将只在npm publish命令之前运⾏。
8、简写形式
四个常⽤的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 start 、npm stop、npm restart都⽐较好理解，⽽npm restart 是⼀个复合命令，实际上会执⾏三个脚本命令：stop、restart、start 。具体的执⾏顺序如下：
prerestart prestop stop poststop restart prestart start poststart postrestart
9、变量
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 。
// view.js
console.v.npm_package_name); // foo
console.v.npm_package_version); // 1.2.5
上⾯代码中，我们通过环境变量v 对象，拿到package.json 的字段值。如果是bash脚本，可以
⽤$npm_package_name和$npm_package_version娶到这两个值。
npm_package_ 前缀也⽀持嵌套的package.json字段。
"repository": {
"type": "git",
"url": "xxx"
},
scripts: {
"view": "echo $npm_package_repository_type"
}
上⾯代码中，repository字段的type属性，可以通过 npm_package_repository_type取到。
下⾯是另外⼀个例⼦：
"scripts": {
"install": "foo.js"
}
上⾯代码中，npm_package_scripts_install变量的值等于foo.js 。
然后，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"
10、常⽤脚本⽰例
// 删除⽬录
"clean": "rimraf dist/*",
// 本地搭建⼀个 HTTP 服务
"serve": "http-server -p 9090 dist/",
/
/ 打开浏览器
"open:dev": "opener localhost:9090",
// 实时刷新
"livereload": "live-reload --port 9091 dist/",
// 构建 HTML ⽂件
"build:html": "jade index.jade > dist/index.html",
// 只要 CSS ⽂件有变动，就重新执⾏构建
"watch:css": "watch 'npm run build:css' assets/styles/",
// 只要 HTML ⽂件有变动，就重新执⾏构建
"watch:html": "watch 'npm run build:html' assets/html",
// 部署到 Amazon S3
"deploy:prod": "s3-cli sync ./dist/ s3://example-com/prod-site/",
// 构建 favicon
"build:favicon": "node scripts/favicon.js",
11、package.json其他配置项说明
对于dependencies和devDependencies的⼀些说明：
使⽤npm安装依赖时，如果使⽤--save安装的依赖，会被写到dependencies模块⾥⾯去；
⽽使⽤--save-dev安装的依赖，则会被写到devDependencies模块⾥⾯去；如果什么都不写，则默认安装到dependencies⾥⾯去。
⽐如我们使⽤的⼀些构建⼯具例如glup、webpack这些只在开发环境中才⽤到的包，则只需要写到devDependencies中即可。
对于两种环境的指定⽅式，则是通过配置⽂件中的 v.NODE_ENV = 'development' 或
12、package.json中的bin属性
package.json中的bin是命令名和本地⽂件的映射。如果是全局安装，则会把⽂件映射到全局的bin⾥⾯去，安装后，在任意地⽅打开终端使⽤命令⾏执⾏该⽂件；
如果是本地安装，则会把⽂件映射到本项⽬的./node_modules/.bin⽂件夹⾥⾯，安装后，在本⼯程⽬录⾥⾯使⽤命令⾏执⾏该⽂件。
举例说明：
新建⼀个⽂件夹，打开终端，进⼊该⽂件夹，通过命令 npm init -y 创建⼀个package.json⽂件。然后在package.json⽂件同级⽬录下新建⼀个index.js⽂件，加上测试数据。注意，index.js⽂件的头部必须有这个 #!/usr/bin/env node 节点。在package.json中增加bin属性，设置命令名和index.js的映射关系。在终端当前⽬录中进⾏全局安装： npm install -g 安装成功后，则在电脑任意⽂件夹打开终端，执⾏package.json中bin中设置的命令，都会执⾏对应的index.js中的代码。如下图
同时，我们打开全局的bin⽂件夹，可以发现bin下⾯的刚刚添加的全局命令 tan-temp-bin
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论