npm 剧本敕令 进修笔记

2024年1月7日 144次阅读 来源: 幸运儿

什么是 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",
    原文作者：幸运儿
    原文地址: https://segmentfault.com/a/1190000008634604
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞