npm scripts介绍
前言
Node开发离不开npm,而脚本功能是npm最强大和最常用的功能之一
什么是npm 脚本
npm允许在package.json文件中,使用scripts字段定义的脚本命令
{
// ...
"scripts": {
"build": "node build.js"
}
}
上面代码是package.json文件一个片段，里面的scripts字段是一个对象。它的每一个属性，对应一段脚本。比如，build命令对应的脚本是node build.js。
这些定义在package.json里面的脚本，就称为npm脚本。它的优点很多
- 项目的相关脚本，可以集中在一个地方
- 不同项目的脚本命令，只要功能相同，就可以有同样的对外接口。用户不需要知道你怎么测试你的项目，只要运行`npm run dev`即可
- 可以利用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"
scripts中配置的mocha哪里来的?
通过npm 启动脚本,会默认把node_modules/.bin加入到PATH环境变量中。
node_modules/.bin/mocha 是哪来的？
当某个模块配置了bin时，就会在被安装的时候，自动阮链进去了
{
"name": "mocha",
"bin": {
"mocha": "./bin/mocha"
}
}
image.png
npm 和npx有什么区别
npx主要用于命令行的寻址等辅助功能,npm是管理依赖的
npx主要是解决的问题是调用项目内部安装的模块。
比如我们安装了mocha
npm i mocha -D
一般来说调用mocha,只能在项目脚本和package.json的scripts字段里面，如果想在命令行下调用，必须向想下面一样使用
./node-modules/.bin/mocha --version
npx就是解决这样的问题的。让项目内部安装的模块使用起来更方便
npx mocha --version
npx的原理很简单，就是在运行的时候，会到node_modules/.bin路径和环境变量$PATH里面，检查命令是否存在。
由于npx会检查环境变量$PAHT,所以系统命令也可以调用。
npx ls
// 等同于ls
npm 脚本#!/usr/bin/env node
-
#!
这个符号通常在linux系统的第一行开头出现，用于指明这个脚本文件的解释程序。npm脚本第一行增加这个程序#!/usr/bin/env node为了指定使用node执行脚本文件。 -
/usr/bin/env
不同用户的不同脚本教师器安装的不同的目录下，系统如何知道哪里去寻找你的解释程序呢？/usr/bin/env就是告诉系统在PATH目录下查找。所以配置#!/usr/bin/env node,就是解决不同用户node路径不同的问题，就是解决了不同用户node路径不同的问题，可以让系统动态的去查找node来执行你的脚本。
通配符
由于npm脚本就是shell脚本，因为可使用shell通配符
`lint`:'jshint */.js'
`lint`:'jshint **/*/.js'
传参
向npm脚本传入参数，需要使用--标明。下面是eslint内置的代码风格自动修复模式。圪塔传入--fix的参数
{
lint:js:fix": "npm run lint:js -- --fix"
}
执行顺序
如果npm脚本里面需要执行，那么需要明确他们执行顺序
- 并行执行使用
$符号
npm run script1.js & npm run script2.js
- 如果是串行执行使用
&&符号
npm run script1.js && npm run script2.js
钩子
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提供了一个npm_lifecycle_event,返回当时正在运行的脚本名称，比如pretest,test,posttest等。所以可以利用这个变量。在同一脚本文件中，对不同的npm scripts命令编写代码。
const TARGET = process.env.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!`);
}
变量
- npm_package_
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
如果在Bash脚本中,可以使用$npm_pacjage_name和$npm_package_version取到这两个值
- config对象
{
"name" : "foo",
"config" : { "port" : "8080" },
"scripts" : { "start" : "node server.js" }
}
上面代码中，npm_package_config_port变量返回的是8080。这个值可以用下面的方法覆盖。
npm config set foo:port 80
