网络科技

    今日:238| 主题:244794
收藏本版
互联网、科技极客的综合动态。

[其他] npm scripts 使用指南

[复制链接]
容颜出现编译错误 发表于 2016-10-11 19:40:10
173 10

立即注册CoLaBug.com会员,免费获得投稿人的专业资料,享用更多功能,玩转个人品牌!

您需要 登录 才可以下载或查看,没有帐号?立即注册

x
Node 开发离不开 npm,而脚本功能是 npm 最强大、最常用的功能之一。
  本文介绍如何使用 npm 脚本(npm scripts)。
   
npm scripts 使用指南-1 (接口,开发,如何,项目,用户)

  一、什么是 npm 脚本?

   npm 允许在 package.json 文件里面,使用 scripts 字段定义脚本命令。
  [code]{
  // ...
  "scripts": {
    "build": "node build.js"
  }
}[/code]   上面代码是 package.json 文件的一个片段,里面的 scripts 字段是一个对象。它的每一个属性,对应一段脚本。比如, build 命令对应的脚本是 node build.js 。
   命令行下使用 npm run 命令,就可以执行这段脚本。
  [code]$ npm run build
# 等同于执行
$ node build.js[/code]   这些定义在 package.json 里面的脚本,就称为 npm 脚本。它的优点很多。
  
       
  • 项目的相关脚本,可以集中在一个地方。   
  • 不同项目的脚本命令,只要功能相同,就可以有同样的对外接口。用户不需要知道怎么测试你的项目,只要运行 npm run test 即可。   
  • 可以利用 npm 提供的很多辅助功能。  
   查看当前项目的所有 npm 脚本命令,可以使用不带任何参数的 npm run 命令。
  [code]$ npm run[/code]  二、原理

   npm 脚本的原理非常简单。每当执行 npm run ,就会自动新建一个 Shell,在这个 Shell 里面执行指定的脚本命令。因此,只要是 Shell(一般是 Bash)可以运行的命令,就可以写在 npm 脚本里面。
   比较特别的是, npm run 新建的这个 Shell,会将当前目录的 node_modules/.bin 子目录加入 PATH 变量,执行结束后,再将 PATH 变量恢复原样。
   这意味着,当前目录的 node_modules/.bin 子目录里面的所有脚本,都可以直接用脚本名调用,而不必加上路径。比如,当前项目的依赖里面有 Mocha,只要直接写 mocha test 就可以了。
  [code]"test": "mocha test"[/code]  而不用写成下面这样。
  [code]"test": "./node_modules/.bin/mocha test"[/code]  由于 npm 脚本的唯一要求就是可以在 Shell 执行,因此它不一定是 Node 脚本,任何可执行文件都可以写在里面。
   npm 脚本的退出码,也遵守 Shell 脚本规则。如果退出码不是 0 ,npm 就认为这个脚本执行失败。
  三、通配符

  由于 npm 脚本就是 Shell 脚本,因为可以使用 Shell 通配符。
  [code]"lint": "jshint *.js"
"lint": "jshint **/*.js"[/code]   上面代码中, * 表示任意文件名, ** 表示任意一层子目录。
  如果要将通配符传入原始命令,防止被 Shell 转义,要将星号转义。
  [code]"test": "tap test/\*.js"[/code]  四、传参

   向 npm 脚本传入参数,要使用 -- 标明。
  [code]"lint": "jshint **.js"[/code]   向上面的 npm run lint 命令传入参数,必须写成下面这样。
  [code]$ npm run lint --  --reporter checkstyle > checkstyle.xml[/code]   也可以在 package.json 里面再封装一个命令。
  [code]"lint": "jshint **.js",
"lint:checkstyle": "npm run lint -- --reporter checkstyle > checkstyle.xml"[/code]  五、执行顺序

  如果 npm 脚本里面需要执行多个任务,那么需要明确它们的执行顺序。
   如果是并行执行(即同时的平行执行),可以使用 & 符号。
  [code]$ npm run build
# 等同于执行
$ node build.js0[/code]   如果是继发执行(即只有前一个任务成功,才执行下一个任务),可以使用 && 符号。
  [code]$ npm run build
# 等同于执行
$ node build.js1[/code]   这两个符号是 Bash 的功能。此外,还可以使用 node 的任务管理模块: script-runner 、 npm-run-all 、 redrun 。
  六、默认值

  一般来说,npm 脚本由用户提供。但是,npm 对两个脚本提供了默认值。也就是说,这两个脚本不用定义,就可以直接使用。
  [code]$ npm run build
# 等同于执行
$ node build.js2[/code]   上面代码中, npm run start 的默认值是 node server.js ,前提是项目根目录下有 server.js 这个脚本; npm run install 的默认值是 node-gyp rebuild ,前提是项目根目录下有 binding.gyp 文件。
  七、钩子

   npm 脚本有 pre 和 post 两个钩子。举例来说, build 脚本命令的钩子就是 prebuild 和 postbuild 。
  [code]$ npm run build
# 等同于执行
$ node build.js3[/code]   用户执行 npm run build 的时候,会自动按照下面的顺序执行。
  [code]$ npm run build
# 等同于执行
$ node build.js4[/code]  因此,可以在这两个钩子里面,完成一些准备工作和清理工作。下面是一个例子。
  [code]$ npm run build
# 等同于执行
$ node build.js5[/code]  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 命令编写代码。请看下面的例子。
  [code]$ npm run build
# 等同于执行
$ node build.js6[/code]  八、简写形式

  四个常用的 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 。具体的执行顺序如下。
  
       
  • prerestart   
  • prestop   
  • stop   
  • poststop   
  • restart   
  • prestart   
  • start   
  • poststart   
  • postrestart  
  九、变量

  npm 脚本有一个非常强大的功能,就是可以使用 npm 的内部变量。
   首先,通过 npm_package_ 前缀,npm 脚本可以拿到 package.json 里面的字段。比如,下面是一个 package.json 。
  [code]$ npm run build
# 等同于执行
$ node build.js7[/code]   那么,变量 npm_package_name 返回 foo ,变量 npm_package_version 返回 1.2.5 。
  [code]$ npm run build
# 等同于执行
$ node build.js8[/code]   上面代码中,我们通过环境变量 process.env 对象,拿到 package.json 的字段值。如果是 Bash 脚本,可以用 $npm_package_name 和 $npm_package_version 取到这两个值。
   npm_package_ 前缀也支持嵌套的 package.json 字段。
  [code]$ npm run build
# 等同于执行
$ node build.js9[/code]   上面代码中, repository 字段的 type 属性,可以通过 npm_package_repository_type 取到。
  下面是另外一个例子。
  [code]$ npm run0[/code]   上面代码中, npm_package_scripts_install 变量的值等于 foo.js 。
   然后,npm 脚本还可以通过 npm_config_ 前缀,拿到 npm 的配置变量,即 npm config get xxx 命令返回的值。比如,当前模块的发行标签,可以通过 npm_config_tag 取到。
  [code]$ npm run1[/code]   注意, package.json 里面的 config 对象,可以被环境变量覆盖。
  [code]$ npm run2[/code]   上面代码中, npm_package_config_port 变量返回的是 8080 。这个值可以用下面的方法覆盖。
  [code]$ npm run3[/code]   最后, env 命令可以列出所有环境变量。
  [code]$ npm run4[/code]  十、常用脚本示例

  [code]$ npm run5[/code]  十一、参考链接

  
       
  • How to Use npm as a Build Tool , by Keith Cirkel   
  • Awesome npm scripts , by Ryan Zimmerman  
  (完)
友荐云推荐




上一篇:Avoid callbacks in Node.js with Bluebird promises
下一篇:“程序员萌”,一个被忽视的隐秘消费群体?
酷辣虫提示酷辣虫禁止发表任何与中华人民共和国法律有抵触的内容!所有内容由用户发布,并不代表酷辣虫的观点,酷辣虫无法对用户发布内容真实性提供任何的保证,请自行验证并承担风险与后果。如您有版权、违规等问题,请通过"联系我们"或"违规举报"告知我们处理。

clown 发表于 2016-10-11 21:09:12
我是clown,我是新手~~
回复 支持 反对

使用道具 举报

22222222222222 发表于 2016-10-11 21:30:55
22222222222222把冰桶抛向楼主
回复 支持 反对

使用道具 举报

bjwtr01 发表于 2016-10-11 21:31:04
锻炼身体,天天顶贴!
回复 支持 反对

使用道具 举报

yoda 发表于 2016-10-11 21:31:27
我就是路过,拿积分走人!!
回复 支持 反对

使用道具 举报

新之 发表于 2016-10-11 21:49:39
修养的艺术,其实就是说谎的艺术。  
回复 支持 反对

使用道具 举报

淡看残花飘零久 发表于 2016-10-11 21:49:39
我只是来看看的,这个世界还有太多的帖需要哥。哥祝楼主早日得到解答
回复 支持 反对

使用道具 举报

金大牙 发表于 2016-10-12 02:54:28
LZ帖子不给力,勉强给回复下吧
回复 支持 反对

使用道具 举报

雪瑶 发表于 2016-10-19 10:40:27
有的人,有一股,让人想一辈子跟他做陌生人的强大的气场。
回复 支持 反对

使用道具 举报

库子2 发表于 2016-10-19 17:23:58
围观 围观 沙发在哪里!!!
回复 支持 反对

使用道具 举报

*滑动验证:
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

我要投稿

推荐阅读

扫码访问 @iTTTTT瑞翔 的微博
回页顶回复上一篇下一篇回列表手机版
手机版/CoLaBug.com ( 粤ICP备05003221号 | 文网文[2010]257号 )|网站地图 酷辣虫

© 2001-2016 Comsenz Inc. Design: Dean. DiscuzFans.

返回顶部 返回列表