资讯专栏INFORMATION COLUMN

npm 脚本命令 学习笔记

LucasTwilight / 1073人阅读

摘要:脚本的退出码,也遵守脚本规则。比如,这个脚本命令,也有和钩子。简写是的简写是的简写是的简写是的简写执行顺序的内部变量通过前缀,脚本可以拿到里面的字段如果是脚本,可以用前缀取值脚本还可以通过前缀,拿到的配置变量,即命令返回的值。

什么是 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的原理??

</>复制代码

  1. 每当执行npm run,就会自动新建一个 Shell,在这个 Shell 里面执行指定的脚本命令。
    因此,只要是 Shell(一般是 Bash)可以运行的命令,就可以写在 npm 脚本里面。

  2. 比较特别的是,npm run新建的这个 Shell,会将当前目录的node_modules/.bin子目录加入PATH变量,执行结束后,再将PATH变量恢复原样。这意味着,当前目录的node_modules/.bin子目录里面的所有脚本,都可以直接用脚本名调用,而不必加上路径。

  3. 由于 npm 脚本的唯一要求就是可以在 Shell 执行,因此它不一定是 Node 脚本,任何可执行文件都可以写在里面。npm 脚本的退出码,也遵守 Shell 脚本规则。如果退出码不是0npm 就认为这个脚本执行失败。

通配符&转义

同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

</>复制代码

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

默认的钩子

</>复制代码

  1. prepublish,postpublish
  2. preinstall,postinstall
  3. preuninstall,postuninstall
  4. preversion,postversion
  5. pretest,posttest
  6. prestop,poststop
  7. prestart,poststart
  8. prerestart,postrestart

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. }

</>复制代码

  1. 注意,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"
常用脚本示例

</>复制代码

  1. // 删除目录
  2. "clean": "rimraf dist/*",
  3. // 本地搭建一个 HTTP 服务
  4. "serve": "http-server -p 9090 dist/",
  5. // 打开浏览器
  6. "open:dev": "opener http://localhost:9090",
  7. // 实时刷新
  8. "livereload": "live-reload --port 9091 dist/",
  9. // 构建 HTML 文件
  10. "build:html": "jade index.jade > dist/index.html",
  11. // 只要 CSS 文件有变动,就重新执行构建
  12. "watch:css": "watch "npm run build:css" assets/styles/",
  13. // 只要 HTML 文件有变动,就重新执行构建
  14. "watch:html": "watch "npm run build:html" assets/html",
  15. // 部署到 Amazon S3
  16. "deploy:prod": "s3-cli sync ./dist/ s3://example-com/prod-site/",
  17. // 构建 favicon
  18. "build:favicon": "node scripts/favicon.js",

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/86874.html

相关文章

  • webpack入门学习手记(二)

    摘要:例如现在的入门学习手记系列。收到粉丝留言和打赏的喜悦。安装上一篇入门学习手记一,主要是介绍了的核心概念,是整个学习过程的基础知识。新生成的类似如下入门学习手记因为生成的内容过多,我直接省略掉了。 showImg(https://segmentfault.com/img/bVbk5Nd?w=1150&h=599); 本人微信公众号:前端修炼之路,欢迎关注。 最近开始想要维护一个个人的公众...

    Joyven 评论0 收藏0
  • Laravel学习笔记三-前端工作流

    摘要:本节将学习是如何利用形成一套完整的前端工作流模式的。你也可以使用下面命令来强制安装所有模块,不管该模块之前是否安装过由于国内墙的原因,使用安装会非常缓慢,慢到想切,不过还好,我们可以使用淘宝提供的国内镜像进行下载。 本节将学习 Laravel 是如何利用 Sass, NPM, Gulp形成一套完整的前端工作流模式的。 一、句法强大的样式表Sass Sass 是一种可用于编写CSS的语言...

    liuchengxu 评论0 收藏0
  • 前端学习路线

    摘要:具体来说,包管理器就是可以通过命令行,帮助你把外部库和插件放到你的项目里面并在之后进行版本升级,这样就不用手工复制和更新库。现在有的包管理器主要是和。 一、基础 1、学习HTML基础 HTML给你的网页赋予了结构。它就像是人的骨架那样让你保持站立。首先你需要去学习语法以及它必须提供的一切。你的学习应该聚焦在下面这些东西上: 学习HTML基础,了解如何编写语义HTML 理解如何把网页分...

    FullStackDeveloper 评论0 收藏0
  • 前端学习路线

    摘要:具体来说,包管理器就是可以通过命令行,帮助你把外部库和插件放到你的项目里面并在之后进行版本升级,这样就不用手工复制和更新库。现在有的包管理器主要是和。 一、基础 1、学习HTML基础 HTML给你的网页赋予了结构。它就像是人的骨架那样让你保持站立。首先你需要去学习语法以及它必须提供的一切。你的学习应该聚焦在下面这些东西上: 学习HTML基础,了解如何编写语义HTML 理解如何把网页分...

    20171112 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<