npm stripts 使用指南
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-runner、npm-run-all、redrun。
六、默认值
一般来说,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!`); }
注意,prepublish这个钩子不仅会在npm publish命令之前运行,还会在npm install(不带任何参数)命令之前运行。这种行为很容易让用户感到困惑,所以 npm 4 引入了一个新的钩子prepare,行为等同于prepublish,而从 npm 5 开始,prepublish将只在npm publish命令之前运行。
八、简写形式
四个常用的 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。
{"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",
十一、参考链接
- How to Use npm as a Build Tool, by Keith Cirkel
- Awesome npm scripts, by Ryan Zimmerman
原文链接:http://www.ruanyifeng.com/blog/2016/10/npm_scripts.html
转载于:https://www.cnblogs.com/duhuo/p/4482338.html
npm stripts 使用指南相关推荐
- webpack源码阅读——npm脚本运行webpack与命令行输入webpack的区别
原文地址:webpack源码阅读--npm脚本执行webpack与命令行输入webpack执行的区别 如有错误,欢迎指正! webpack是目前被大家广为使用的模块打包器.从命令行输入webpack或 ...
- ESLint的NPM账户遭黑客攻击,可能窃取用户NPM访问令牌
7月12日,黑客攻击了ESLint维护者的NPM帐户,并将带有病毒的eslint-scope和eslint-config-eslint软件包发布到NPM注册表中.带有恶意病毒的软件包在安装时,计算机会 ...
- npm package.json文件解读
每个Nodejs项目的根目录下面,一般都会有一个package.json文件.该文件可以由npm init生成,定义了项目所需要的各种模块,以及项目的配置信息(比如名称.版本.许可证等元数据). pa ...
- npm 包管理器_导演电影解释了节点软件包管理器(NPM)
npm 包管理器 by Kevin Kononenko 凯文·科诺年科(Kevin Kononenko) If you understand the general way that Hollywoo ...
- 前端架构设计第一课 CI环境npm/Yarn
开篇词 像架构师一样思考,突破技术成长瓶颈 透过工程基建,架构有迹可循.你好,我是侯策(LucasHC),目前任职于某互联网独角兽公司,带领 6 条业务线前端团队,负责架构设计和核心开发.工程方案调研 ...
- 2018 年了,你还是只会 npm install 吗
nodejs 社区乃至 Web 前端工程化领域发展到今天,作为 node 自带的包管理工具的 npm 已经成为每个前端开发者必备的工具.但是现实状况是,我们很多人对这个nodejs基础设施的使用和了解 ...
- 2018 年了,你还是只会 npm install 吗?
转载自:https://www.sohu.com/a/226831801_505818 nodejs 社区乃至 Web 前端工程化领域发展到今天,作为 node 自带的包管理工具的 npm 已经成为每 ...
- 如何打造规范的开源项目workflow
前言 一般开源项目正常的开发流程是: 初始阶段 创建仓库 git clone repository 到本地 添加修改代码 提交commit message push到 github 仓库 迭代阶段 切 ...
- vue-cli2.0创建项目步骤
Vue是近两年来比较火的一个前端框架(渐进式框架吧),与reactjs和angularjs三国鼎立,我不是职业前端,做过Vue,了解了一下React,听说过Angluar.我只能这么说,我来晚了,没经 ...
- 怎样开发一个 Node.js 命令行工具包
大家好,我是若川.最近组织了源码共读活动,感兴趣的可以点此加我微信 ruochuan12 参与,每周大家一起学习200行左右的源码,共同进步.同时极力推荐订阅我写的<学习源码整体架构系列> ...
最新文章
- python如何跨模块调用变量_Python跨模块用户定义的全局变量:在其他模块运行时调用它们的问题...
- Spring学习笔记之一----基于XML的Spring IOC配置
- redis 配置文件示例
- java gui 线程_如何在java中将消息从工作线程传递给GUI
- python语言有什么作用_python“ with”语句的用途是什么?
- 网络编程:TCP实现文件上传
- C++新特性探究(十二):static_assert(提前判误)
- 20180601 -1
- git 回滚到某个commit_Git 整理 v1.0 | Git 操作整理进阶篇
- java if 并列_Java 并列if语句,一个判断失败后,后面的if就不执行了,为什么啊?...
- 一起来学习BERT常见的几个变体
- 拓端tecdat|R语言分位数回归预测筛选有上升潜力的股票
- 友善的小精灵 Casper
- Codeforces Round #512 (Div. 2, based on Technocup 2019 Elimination Ro A. In Search of an Easy Proble
- sqlite3数据存储最多存储多少条数据?达到上限如何处理?_把 14 亿人拉到一个微信群,如何实现?...
- Android 小工具--圆形图片
- gnuplot下载及基本使用
- 2022 精心整理的 C语言/C++ 语言学习宝藏,值得收藏~
- 如何在局域网中查看其他电脑上的文件
- Html和Xml中注释符
热门文章
- 《SilverLight2快速入门》之Hello SilverLight
- 使用 java -jar命令启动jar包时报不支持的jdk版本异常
- 地铁沉降观测数据分析之巧用VBA编程处理
- [C语言]排序问题--我的解答
- Mac MySQL重置Root密码
- [2018.10.11 T3] 欠钱
- BZOJ3994[SDOI2015] 约数个数和
- java使用redis的demo,Javaredisdemo
- 柱状图多维条形图vue_使用D3.js+Vue实现一个简单的柱形图
- dhcp 续约review报文_DHCP工作原理( DHCP地址续约和释放)