什么是 npm 脚本?

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

  1. {
  2. // ...
  3. "scripts": {
  4. "build": "node build.js"
  5. }
  6. }

如何执行是 npm 脚本?

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

不知道有什么 npm 脚本??

  1. #查看当前项目的所有 npm 脚本命令
  2. #(其实也可以在package.json的看scripts对象里有什么属性)
  3. 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

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

传参

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

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

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

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

默认脚本

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

  1. "start": "node server.js"
  2. "install": "node-gyp rebuild"

钩子

npm 脚本有pre和post两个钩子

例子

  1. # package.json
  2. "prebuild": "echo I run before the build script",
  3. "build": "cross-env NODE_ENV=production webpack",
  4. "postbuild": "echo I run after the build script",
  5. # 命令行
  6. $ npm run build
  7. # 等同于执行
  8. $ npm run prebuild && npm run build && npm run postbuild

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

默认的钩子

  1. prepublishpostpublish
  2. preinstallpostinstall
  3. preuninstallpostuninstall
  4. preversionpostversion
  5. pretestposttest
  6. prestoppoststop
  7. prestartpoststart
  8. prerestartpostrestart

npm_lifecycle_event变量 (返回当前正在运行的脚本名称,pretest、test、posttest)

  1. #利用这个变量,在同一个脚本文件里面,为不同的npm scripts命令编写代码
  2. const TARGET = process.env.npm_lifecycle_event;
  3. if (TARGET === 'test') {
  4. console.log(`Running the test task!`);
  5. }
  6. if (TARGET === 'pretest') {
  7. console.log(`Running the pretest task!`);
  8. }
  9. if (TARGET === 'posttest') {
  10. console.log(`Running the posttest task!`);
  11. }

注意,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_前缀取值)

  1. // package.json
  2. {
  3. "name": "foo",
  4. "version": "1.2.5",
  5. "config" : { "port" : "8080" },
  6. "scripts": {
  7. "view": "node view.js",
  8. "start" : "node server.js"
  9. }
  10. }
  11. // view.js
  12. console.log(process.env.npm_package_name); // foo
  13. console.log(process.env.npm_package_version_view); // node view.js

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

  1. "view": "echo $npm_config_tag",

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

  1. $ npm config set foo:port 80

列出所有环境变量

  1. "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",

npm脚本探析的更多相关文章

  1. 浏览器环境下Javascript脚本加载与执行探析之DOMContentLoaded

    在”浏览器环境下Javascript脚本加载与执行探析“系列文章的前几篇,分别针对浏览器环境下JavaScript加载与执行相关的知识点或者属性进行了探究,感兴趣的同学可以先行阅读前几篇文章,了解相关 ...

  2. 浏览器环境下JavaScript脚本加载与执行探析之动态脚本与Ajax脚本注入

    在<浏览器环境下JavaScript脚本加载与执行探析之defer与async特性>中,我们研究了延迟脚本(defer)和异步脚本(async)的执行时机.浏览器支持情况.浏览器bug以及 ...

  3. 浏览器环境下JavaScript脚本加载与执行探析之defer与async特性

    defer和async特性相信是很多JavaScript开发者"熟悉而又不熟悉"的两个特性,从字面上来看,二者的功能很好理解,分别是"延迟脚本"和"异 ...

  4. javaScript系列 [02]-javaScript对象探析

    [02]-javaScript对象探析 题记:多年前,以非常偶然的方式关注了微信公众号“面向对象”,本以为这个公众号主要以分享面向对象编程的干货为主,不料其乃实实在在的猿圈相亲平台.通过查看公开资料, ...

  5. 中文分词工具探析(二):Jieba

    1. 前言 Jieba是由fxsjy大神开源的一款中文分词工具,一款属于工业界的分词工具--模型易用简单.代码清晰可读,推荐有志学习NLP或Python的读一下源码.与采用分词模型Bigram + H ...

  6. 中文分词工具探析(一):ICTCLAS (NLPIR)

    1. 前言 ICTCLAS是张华平在2000年推出的中文分词系统,于2009年更名为NLPIR.ICTCLAS是中文分词界元老级工具了,作者开放出了free版本的源代码(1.0整理版本在此). 作者在 ...

  7. [译]为什么我要离开gulp和grunt转投npm脚本的怀抱

    原文链接:https://medium.freecodecamp.com/why-i-left-gulp-and-grunt-for-npm-scripts-3d6853dd22b8#.n7m1855 ...

  8. 深入探析koa之中间件流程控制篇

    koa被认为是第二代web后端开发框架,相比于前代express而言,其最大的特色无疑就是解决了回调金字塔的问题,让异步的写法更加的简洁.在使用koa的过程中,其实一直比较好奇koa内部的实现机理.最 ...

  9. Emmet 语法探析

    Emmet 语法探析 Emmet(Zen Coding)是一个能大幅度提高前端开发效率的一个工具. 大多数编辑器都支持Snippet,即存储和重用一些代码块.但是前提是:你必须先定义 这些代码块. E ...

随机推荐

  1. 17秋 软件工程 团队第五次作业 Alpha Scrum6

    17秋 软件工程 团队第五次作业 Alpha Scrum6 今日完成的任务 世强:APP内通知消息发送; 港晨:APP前端登陆界面编写: 树民:Web后端数据库访问模块代码实现: 伟航:Web后端Re ...

  2. Oracle11g链接提示未“在本地计算机注册“OraOLEDB.Oracle”解决方法

    当 用,Provider=OraOLEDB.Oracle方式访问ORACLE11g数据库.出现 未在本地计算机注册“OraOLEDB.Oracle”提供程序提示.解决方案如下: 客户端环境:Win7 ...

  3. 控件_CheckBox(多选按钮)

    import android.os.Bundle; import android.app.Activity; import android.widget.CheckBox; import androi ...

  4. hdu3400(三分套三分)

    题意:平面上两条线段 AB,CD. A到B的速度v1,C到D的速度v2,其它地方的速度V3. 求A到D的最短时间. 解法:三分嵌套三分.首先假设AB上的点确定后.确定CD的点的确定应该是符合三分性质的 ...

  5. ERROR 1045 (28000): Access denied for user 'ODBC'@'localhost' (using password: NO) ERROR 1045 (28000): Access denied for user 'ODBC'@'localhost' (using password: YES)

    windows下,以上两个错误的解决方法 工具/原料   windows 8 MySql 方法/步骤     找到配置文件my.ini  ,然后将其打开,可以选择用记事本打开   打开后,搜索mysq ...

  6. canvas.toDataURL 画布导出图片

    <html> <meta http-equiv="X-UA-Compatible" content="chrome=1"> <he ...

  7. data函数参数

    date(format,timestamp); 参数 描述 format 必需.规定输出日期字符串的格式.可使用下列字符: d - 一个月中的第几天(从 01 到 31) D - 星期几的文本表示(用 ...

  8. PHP开发小技巧②—实现二维数组根据key进行排序

    在PHP中内置了很多对数组进行处理的函数,有很多时候我们直接使用其内置函数就能达到我们的需求,得到我们所想要的结果:但是,有的时候我们却不能通过使用内置函数实现我们的要求,这就需要我们自己去编写算法来 ...

  9. 转载 SpringMVC详解(二)------详细架构

    目录 1.SpringMVC 详细介绍 2.SpringMVC 处理请求流程 3.配置前端控制器 4.配置处理器适配器 5.编写 Handler 5.配置处理器映射器 6.配置视图解析器 7.Disp ...

  10. MongoDB可视化工具--Robo 3T 使用教程

    MongoDB可视化工具--Robo 3T 使用教程 1. 到官网下载Robo 3T,网址如: https://robomongo.org/download. 2. 下载安装成功后,打开后点击左上角的 ...