【精选】package.json scripts 脚本使用指南 |
您所在的位置：网站首页 › js脚本运行缺少对象 › 【精选】package.json scripts 脚本使用指南 |
|
package.json scripts 脚本使用指南
Node 开发离不开 npm，而脚本功能是 npm 最强大、最常用的功能之一。本文介绍如何使用 npm 脚本（npm scripts）。 一、package.json scripts 脚本是什么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，postpublishpreinstall，postinstallpreuninstall，postuninstallpreversion，postversionpretest，posttestprestop，poststopprestart，poststartprerestart，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。具体的执行顺序如下。 prerestartprestopstoppoststoprestartprestartstartpoststartpostrestart 九、变量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": "rm -rf dist && mkdir dist", "example": "export DEBUG=table* && babel-node ./example/example.js", "test": "export DEBUG=table && babel-node ./test/test.js", "build": "./node_modules/.bin/babel src --out-dir dist", // 可以简写成下面的形式 "build": "babel src --out-dir dist", "build:pkg": "babel bin --out-dir dist/bin --copy-files", "prepublishOnly": "npm run clean && npm run build", // 配置环境变量 "start": "export DEBUG=table* && node scripts/start.js", "build": "node ./scripts/build.js", "test": "node scripts/test.js --env=jsdom", "pub:es": "npm run clean && export BABEL_ENV=production && babel src --out-dir es --copy-files", "pub:lib": "npm run clean && export BABEL_ENV=node && babel src --out-dir lib --copy-files", "pub:um": "npm run clean:dist && export RABEL_ENV=production && webpack --config ./config/webpack.config.pub.js", "pub:optimized": "rm es/setting.js es/i18n.js es/index.local.js && rm lib.settings.js lib/i18n.js lib/index.local.js", "prepublishOnly": "npm run pub:lib && npm run pub:es && npm run pub:umd && npm run pub:optimized" // 本地搭建一个 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", 十一、Michael 总结 npm run test 相当于直接使用 nodeJS 运行脚本（node test.js node scripts/test.js）既然是 nodeJS，那么可以运行 bash 类似的操作使用 npm run 查看当前项目中支持的脚本；npm 可以直接运行 node_mobules/.bin 下面的命令（不需要重新设置环境变量）例如直接使用 mocha jest babel 等支持通配符：** 表示任意目录 * 表示任意文件名；文件名和文件路径需要转义支持参数：使用 – 表示传参 npm run lint --repoeter or npm install --no-audit支持执行顺序：两条命令之间，如果是并行的命令，使用 & 分割；两条命令之间，如果具有先后次序，使用 && 分割 rm -rf dist & rm -rf bin or rm -rf dist && mkdir dist && babel src --out-dir dist默认脚本：npm start - npm install 对应 node setver.js node-gyp rebuild 如果已经有脚本就执行钩子函数：执行一个命令同时执行的函数：npm run publish 实际上执行 npm run prepublish && npm run publish && npm run postpublish 前处理阶段可以进行编译；结束阶段可以清理环境，删除编译后的内容简写形式：npm start npm stop (省略run)获取 package.json 中的变量 process.env 对象可以获取（版本号和名称，或者需要传入的其他变量）参考阮一峰老师的博客 |
今日新闻 |
推荐新闻 |
| CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |