npm脚本命令npm run script的使用

 

 

npm 可以在项目package.json里面自定义脚本命令

package.json文件

{
  "script":{
    "dev": "webpack -w"
  }
}

package.json文件中的字段script的每一个属性都是一个自定义的脚本命令。

在命令行中可以通过执行npm run dev来执行这段脚本。

执行原理

使用npm run script执行脚本的时候都会创建一个shell，然后在shell中执行指定的脚本。

这个shell会将当前项目的可执行依赖目录（即node_modules/.bin）添加到环境变量path中，当执行之后之后再恢复原样。就是说脚本命令中的依赖名会直接找到node_modules/.bin下面的对应脚本，而不需要加上路径。

执行顺序

一个npm脚本可以执行多个任务，这些任务之间可以指定不同的执行顺序。

'&' 并行执行顺序，同时执行
"dev":"node test.js & webpack"

'&&'继发顺序，执行前面之后才可以执行后面
"dev":"node test.js && webpack"

顺序钩子

npm脚本自带两个顺序钩子，'pre' 和 'post'

"predev":"node test_one.js",
"dev":"node test_two.js",
"postdev":"node test_three.js"

当执行 npm run dev 的时候默认就会执行

npm run predev && npm run dev && npm run postdev

获取当前正在运行的脚本名称

npm 提供一个npm_lifecycle_event变量，返回当前正在运行的脚本名称，可以配合顺序钩子使用

npm run dev


const target = process.env.npm_lifecycle_event;

if(target === 'predev'){
  console.log('the process is predev')  
}
if(target === 'dev'){
  console.log('the process is dev')
}
if(target === 'postdev'){
  console.log('this process is postdev')
}

四个可以简写的脚本执行命令

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

使用package.json内部变量

通过npm_package_前缀，npm脚本可以拿到npm的内部变量

package.json:
{
  "name":"zzpzds",
  "script":"node test.js"
}

test.js:
console.log(process.env.npm_package_name) //zzpzds