主页»NodeJS»npm scripts 运用指南

npm scripts 运用指南

来历:ruanyifeng 发布时刻:2016-10-17 阅览次数:

Node 开发离不开 npm,而脚本功用是 npm 最强壮、最常用的功用之一。

本文介绍怎样运用 npm 脚本(npm scripts)。

一、什么是 npm 脚本?

npm 答应在package.json文件里边,运用scripts字段界说脚本指令。

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

上面代码是package.json文件的一个片段,里边的scripts字段是一个目标。它的每一个特点,对应一段脚本。比方,build指令对应的脚本是node build.js。

指令行下运用npm run指令,就能够履行这段脚本。

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

这些界说在package.json里边的脚本,就称为 npm 脚本。它的长处许多。

  • 项目的相关脚本,能够会集在一个当地。
  • 不同项目的脚本指令,只需功用相同,就能够有相同的对外接口。用户不需求知道怎样测验你的项目,只需运转npm run test即可。
  • 能够运用 npm 供给的许多辅佐功用。

检查当时项目的一切 npm 脚本指令,能够运用不带任何参数的npm run指令。

$ npm run

二、原理

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 就以为这个脚本履行失利。

三、通配符

由于 npm 脚本便是 Shell 脚本,由于能够运用 Shell 通配符。

"lint": "jshint *.js"
"lint": "jshint **/*.js"

上面代码中,*表明恣意文件名,**表明恣意一层子目录。

假如要将通配符传入原始指令,避免被 Shell 转义,要将星号转义。

"test": "tap test/\*.js"

四、传参

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

"lint": "jshint **.js"

向上面的npm run lint指令传入参数,有必要写成下面这样。

$ npm run lint --  --reporter checkstyle > checkstyle.xml

也能够在package.json里边再封装一个指令。

"lint": "jshint **.js",
"lint:checkstyle": "npm run lint -- --reporter checkstyle > checkstyle.xml"

五、履行次序

假如 npm 脚本里边需求履行多个使命,那么需求清晰它们的履行次序。

假如是并行履行(即一起的平行履行),能够运用&符号。

$ npm run script1.js & npm run script2.js

假如是继发履行(即只需前一个使命成功,才履行下一个使命),能够运用&&符号。

$ npm run script1.js && npm run script2.js

这两个符号是 Bash 的功用。此外,还能够运用 node 的使命办理模块:script-runnernpm-run-allredrun

六、默许值

一般来说,npm 脚本由用户供给。可是,npm 对两个脚本供给了默许值。也便是说,这两个脚本不必界说,就能够直接运用。

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

上面代码中,npm run start的默许值是node server.js,条件是项目根目录下有server.js这个脚本;npm run install的默许值是node-gyp rebuild,条件是项目根目录下有binding.gyp文件。

七、钩子

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 = 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 脚本有简写方式。

  • 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。详细的履行次序如下。

  1. prerestart
  2. prestop
  3. stop
  4. poststop
  5. restart
  6. prestart
  7. start
  8. poststart
  9. postrestart

九、变量

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.log(process.env.npm_package_name); // foo
console.log(process.env.npm_package_version); // 1.2.5

上面代码中,咱们经过环境变量process.env目标,拿到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"

十、常用脚本示例

// 删去目录
"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",

十一、参阅链接

QQ群:凯发娱乐官网官方群(515171538),验证音讯:10000
微信群:加小编微信 849023636 邀请您参加,验证音讯:10000
提示:更多精彩内容重视微信大众号:全栈开发者中心(fsder-com)
npm
网友谈论(共0条谈论) 正在载入谈论......
沉着谈论文明上网,回绝歹意咒骂 宣布谈论 / 共0条谈论
登录会员中心