npm scripts

摘要:
Npm允许您使用包中的脚本字段定义脚本命令。json文件$Npmrunscript1.js&npmrunscript2.js如果是二次执行,则可以使用&&符号$Npmrunscript1.js&&npmrunscript2.js是默认值。一般来说,npm脚本是由用户提供的。“scripts”:{“install”:“foo.js”}在上述代码中,npm_package_scripts_安装变量的值等于foo.js然后,npm脚本还可以_ config_ Prefix获取npm的配置变量,即npmconfiggetxxx命令返回的值。例如,可以通过npm_config_Tag访问当前模块的发布标签。{“name”:“foo”,“config”:{“port”:“8080”},“scripts”:{“start”:“nodeserver.js”}}在上面的代码中,npm_package_config_port变量返回8080。

Node 开发离不开 npm,而脚本功能是 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
  • 查看当前项目的所有 npm 脚本命令,可以使用不带任何参数的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 脚本,因为可以使用 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

默认值

  • 一般来说,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 脚本有一个非常强大的功能,就是可以使用 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

常用脚本

// 删除目录
"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://www.ruanyifeng.com/blog/2016/10/npm_scripts.html

免责声明:文章转载自《npm scripts》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇[转] Oracle数据库维护常用SQL语句集合UNIX中CC编译器下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

NPM 配置文件修改

NPM 配置文件修改 几乎每一门语言都有配套的包管理器,比如 Ruby 有RubyGems,Go 有 go modules,npm 作为 node 的包管理器,你有想过全局安装的 node 包都放在硬盘里面的哪个地方?它有没有配置文件?node 包的缓存位置在哪里?node 的包管理工具是 npm,npm 的 配置文件是.npmrc 文件,您可以通过npm...

crosswalk 初步使用

这里简单的说下 crossWalk 的配置; 我在学习 crosswalk 的时候,看到一篇博客,他所记录的已经是很完整的教程了: 点击查看 本文就根据该博客和官网说明,进行部分修改,补充; 首先 crosswalk 的 minsdk 是14,如果兼容需要14一下的,那么就没法了; 基础引入: 和普通的一样; 1.1 在 /build.gradle 里的...

sql编程命名规范

< DOCTYPE html PUBLIC -WCDTD XHTML StrictEN httpwwwworgTRxhtmlDTDxhtml-strictdtd> 一、表名1、基础表(一般整个系统都要用到,三个子系统以上用到都算作基础表) ba开头,后面用英文单词,首字母大写,需要多个英文词的每个单词首字母大写 如baDepartment b...

实现自己的.NET Core配置Provider之Yaml

YAML是一种更适合人阅读的文件格式,很多大型的项目像Ruby on Rails都选择YAML作为配置文件的格式。如果项目的配置很少,用JSON或YAML没有多大差别。看看rails项目中的配置文件,如果用JSON写试试什么感受吧。 在《实现自己的.NET Core配置Provider之EF》中已经讲过配置的执行流程,这里不再复述,直接动手。 YamlCo...

(转)使用CruiseControl+SVN+ANT实现持续集成之二

1. 环境搭建1.1. 下载及目录介绍 从官方站点http://cruisecontrol.sourceforge.net/download.html下载一份最新的 CC 压缩包,最新的版本号为2.8.4 下载了cruisecontrol-bin-2.8.4.zip 直接解压到E盘下,文件结构如下图: apache-ant-1.7.0:CC中使用...

SAP Study Notes: BW Queriy-Variables(变量)

About Variable:1.Variable 是和InfoObject绑定的,可用于任何含有该IO的query中。2.Variable有以下几种类型:Characteristic:用于限制Char。 Text:用于在报表动态显示文本。 Hierarchy:用于限制Hierarchy。 Hieararchy Node:用于限制Hierarchy Nod...