IT序号网

npm脚本探析知识解答

lxf 2021年05月25日 编程语言 157 0

什么是 npm 脚本?

在package.json文件里面,使用scripts字段定义的脚本命令

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

如何执行是 npm 脚本?

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

不知道有什么 npm 脚本??

#查看当前项目的所有 npm 脚本命令 
#(其实也可以在package.json的看scripts对象里有什么属性) npm run

npm的原理??

每当执行npm run,就会自动新建一个 Shell,在这个 Shell 里面执行指定的脚本命令。
因此,只要是 Shell(一般是 Bash)可以运行的命令,就可以写在 npm 脚本里面。

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

由于 npm 脚本的唯一要求就是可以在 Shell 执行,因此它不一定是 Node 脚本,任何可执行文件都可以写在里面。npm 脚本的退出码,也遵守 Shell 脚本规则。如果退出码不是0,npm 就认为这个脚本执行失败。

通配符&转义

同shell

// *表示任意文件名,**表示任意一层子目录 
"lint": "jshint *.js" 
"lint": "jshint **/*.js" // 将通配符传入原始命令,防止被 Shell 转义,要将星号转义 "test": "tap test/\*.js"

传参

向 npm 脚本传入参数,要使用--标明

# package.json 
"deploy": "gulp deploy", 
# 命令行 
$ npm run deploy -- --test

一个命令执行多个任务??

#并行执行(即同时的平行执行),使用&符号 
$ npm run serve & npm run dev 
#继发执行(即只有前一个任务成功,才执行下一个任务),使用&&符号 
$ npm run build && npm run deploy

默认脚本

不用定义,就可以直接使用(前提是项目根目录下有server.js脚本和rebuild文件)

"start": "node server.js", 
"install": "node-gyp rebuild"

钩子

npm 脚本有pre和post两个钩子

例子

# package.json 
"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

自定义的脚本命令也可以加上pre和post钩子。比如,myscript这个脚本命令,也有premyscript和postmyscript钩子。不过,双重的pre和post无效,比如prepretest和postposttest是无效的。

默认的钩子

prepublish,postpublish 
preinstall,postinstall 
preuninstall,postuninstall 
preversion,postversion 
pretest,posttest 
prestop,poststop 
prestart,poststart 
prerestart,postrestart

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!`); }

注意,prepublish这个钩子不仅会在npm publish命令之前运行,还会在npm install(不带任何参数)命令之前运行。这种行为很容易让用户感到困惑,所以 npm 4 引入了一个新的钩子prepare,行为等同于prepublish,而从 npm 5 开始,prepublish将只在npm publish命令之前运行。

简写

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

执行顺序
1 prerestart
2 prestop
3 stop
4 poststop
5 restart
6 prestart
7 start
8 poststart
9 postrestart

npm 的内部变量

通过npm_package_前缀,npm 脚本可以拿到package.json里面的字段
(如果是 Bash 脚本,可以用$npm_package_前缀取值)

// package.json 
{ 
  "name": "foo",  
  "version": "1.2.5", "config" : { "port" : "8080" }, "scripts": { "view": "node view.js", "start" : "node server.js" } } // view.js console.log(process.env.npm_package_name); // foo console.log(process.env.npm_package_version_view); // node view.js

npm 脚本还可以通过npm_config_前缀,拿到 npm 的配置变量,即npm config get xxx命令返回的值。
比如,当前模块的发行标签,可以通过npm_config_tag取到。

"view": "echo $npm_config_tag",

注意 package.json里面的config对象,可以被环境变量覆盖。

$ npm config set foo:port 80

列出所有环境变量

"env": "env"

 

常用脚本示例

// 删除目录
"clean": "rimraf dist/*",

// 本地搭建一个 HTTP 服务
"serve": "http-server -p 9090 dist/",

// 打开浏览器
"open:dev": "opener http://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",


发布评论
IT序号网

微信公众号号:IT虾米 (左侧二维码扫一扫)欢迎添加!

项目开发之package.json知识解答
你是第一个吃螃蟹的人
发表评论

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。