這篇文章主要介紹了npm中scripts怎么用,具有一定借鑒價(jià)值,感興趣的朋友可以參考下,希望大家閱讀完這篇文章之后大有收獲,下面讓小編帶著大家一起了解一下。
網(wǎng)頁設(shè)計(jì)是網(wǎng)站建設(shè)的前奏,好的網(wǎng)頁設(shè)計(jì)更深度的剖析產(chǎn)品和設(shè)計(jì)風(fēng)格定位,結(jié)合最新的網(wǎng)頁設(shè)計(jì)流行趨勢(shì),與WVI應(yīng)用標(biāo)準(zhǔn),設(shè)計(jì)出具企業(yè)表現(xiàn)力,大器而深穩(wěn)的網(wǎng)站界面設(shè)。成都創(chuàng)新互聯(lián)成立于2013年,是成都網(wǎng)站建設(shè)公司:提供企業(yè)網(wǎng)站設(shè)計(jì),品牌網(wǎng)站設(shè)計(jì),營銷型企業(yè)網(wǎng)站建設(shè)方案,響應(yīng)式網(wǎng)站設(shè)計(jì),微信平臺(tái)小程序開發(fā),專業(yè)建站公司做網(wǎng)站。
Node 開發(fā)離不開 npm,而腳本功能是 npm 最強(qiáng)大、最常用的功能之一。
本文介紹如何使用 npm 腳本(npm scripts)。
一、什么是 npm 腳本?
npm 允許在package.json文件里面,使用scripts字段定義腳本命令。
{ // ... "scripts": { "build": "node build.js" } }
上面代碼是package.json文件的一個(gè)片段,里面的scripts字段是一個(gè)對(duì)象。它的每一個(gè)屬性,對(duì)應(yīng)一段腳本。比如,build命令對(duì)應(yīng)的腳本是node build.js。
命令行下使用npm run命令,就可以執(zhí)行這段腳本。
$ npm run build # 等同于執(zhí)行 $ node build.js
這些定義在package.json里面的腳本,就稱為 npm 腳本。它的優(yōu)點(diǎn)很多。
項(xiàng)目的相關(guān)腳本,可以集中在一個(gè)地方。
不同項(xiàng)目的腳本命令,只要功能相同,就可以有同樣的對(duì)外接口。用戶不需要知道怎么測試你的項(xiàng)目,只要運(yùn)行npm run test即可。
可以利用 npm 提供的很多輔助功能。
查看當(dāng)前項(xiàng)目的所有 npm 腳本命令,可以使用不帶任何參數(shù)的npm run命令。
$ npm run
二、原理
npm 腳本的原理非常簡單。每當(dāng)執(zhí)行npm run,就會(huì)自動(dòng)新建一個(gè) Shell,在這個(gè) Shell 里面執(zhí)行指定的腳本命令。因此,只要是 Shell(一般是 Bash)可以運(yùn)行的命令,就可以寫在 npm 腳本里面。
比較特別的是,npm run新建的這個(gè) Shell,會(huì)將當(dāng)前目錄的node_modules/.bin子目錄加入PATH變量,執(zhí)行結(jié)束后,再將PATH變量恢復(fù)原樣。
這意味著,當(dāng)前目錄的node_modules/.bin子目錄里面的所有腳本,都可以直接用腳本名調(diào)用,而不必加上路徑。比如,當(dāng)前項(xiàng)目的依賴?yán)锩嬗?Mocha,只要直接寫mocha test就可以了。
"test": "mocha test"
而不用寫成下面這樣。
"test": "./node_modules/.bin/mocha test"
由于 npm 腳本的唯一要求就是可以在 Shell 執(zhí)行,因此它不一定是 Node 腳本,任何可執(zhí)行文件都可以寫在里面。
npm 腳本的退出碼,也遵守 Shell 腳本規(guī)則。如果退出碼不是0,npm 就認(rèn)為這個(gè)腳本執(zhí)行失敗。
三、通配符
由于 npm 腳本就是 Shell 腳本,因?yàn)榭梢允褂?Shell 通配符。
"lint": "jshint *.js" "lint": "jshint **/*.js"
上面代碼中,*表示任意文件名,**表示任意一層子目錄。
如果要將通配符傳入原始命令,防止被 Shell 轉(zhuǎn)義,要將星號(hào)轉(zhuǎn)義。
"test": "tap test/\*.js"
四、傳參
向 npm 腳本傳入?yún)?shù),要使用--標(biāo)明。
"lint": "jshint **.js"
向上面的npm run lint命令傳入?yún)?shù),必須寫成下面這樣。
$ npm run lint -- --reporter checkstyle > checkstyle.xml
也可以在package.json里面再封裝一個(gè)命令。
"lint": "jshint **.js", "lint:checkstyle": "npm run lint -- --reporter checkstyle > checkstyle.xml"
五、執(zhí)行順序
如果 npm 腳本里面需要執(zhí)行多個(gè)任務(wù),那么需要明確它們的執(zhí)行順序。
如果是并行執(zhí)行(即同時(shí)的平行執(zhí)行),可以使用&符號(hào)。
$ npm run script1.js & npm run script2.js
如果是繼發(fā)執(zhí)行(即只有前一個(gè)任務(wù)成功,才執(zhí)行下一個(gè)任務(wù)),可以使用&&符號(hào)。
$ npm run script1.js && npm run script2.js
這兩個(gè)符號(hào)是 Bash 的功能。此外,還可以使用 node 的任務(wù)管理模塊:script-runner、npm-run-all、redrun。
六、默認(rèn)值
一般來說,npm 腳本由用戶提供。但是,npm 對(duì)兩個(gè)腳本提供了默認(rèn)值。也就是說,這兩個(gè)腳本不用定義,就可以直接使用。
"start": "node server.js", "install": "node-gyp rebuild"
上面代碼中,npm run start的默認(rèn)值是node server.js,前提是項(xiàng)目根目錄下有server.js這個(gè)腳本;npm run install的默認(rèn)值是node-gyp rebuild,前提是項(xiàng)目根目錄下有binding.gyp文件。
七、鉤子
npm 腳本有pre和post兩個(gè)鉤子。舉例來說,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"
用戶執(zhí)行npm run build的時(shí)候,會(huì)自動(dòng)按照下面的順序執(zhí)行。
npm run prebuild && npm run build && npm run postbuild
因此,可以在這兩個(gè)鉤子里面,完成一些準(zhǔn)備工作和清理工作。下面是一個(gè)例子。
"clean": "rimraf ./dist && mkdir dist", "prebuild": "npm run clean", "build": "cross-env NODE_ENV=production webpack"
npm 默認(rèn)提供下面這些鉤子。
prepublish,postpublish
preinstall,postinstall
preuninstall,postuninstall
preversion,postversion
pretest,posttest
prestop,poststop
prestart,poststart
prerestart,postrestart
自定義的腳本命令也可以加上pre和post鉤子。比如,myscript這個(gè)腳本命令,也有premyscript和postmyscript鉤子。不過,雙重的pre和post無效,比如prepretest和postposttest是無效的。
npm 提供一個(gè)npm_lifecycle_event變量,返回當(dāng)前正在運(yùn)行的腳本名稱,比如pretest、test、posttest等等。所以,可以利用這個(gè)變量,在同一個(gè)腳本文件里面,為不同的npm scripts命令編寫代碼。請(qǐng)看下面的例子。
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這個(gè)鉤子不僅會(huì)在npm publish命令之前運(yùn)行,還會(huì)在npm install(不帶任何參數(shù))命令之前運(yùn)行。這種行為很容易讓用戶感到困惑,所以 npm 4 引入了一個(gè)新的鉤子prepare,行為等同于prepublish,而從 npm 5 開始,prepublish將只在npm publish命令之前運(yùn)行。
八、簡寫形式
四個(gè)常用的 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是一個(gè)復(fù)合命令,實(shí)際上會(huì)執(zhí)行三個(gè)腳本命令:stop、restart、start。具體的執(zhí)行順序如下。
prerestart
prestop
stop
poststop
restart
prestart
start
poststart
postrestart
九、變量
npm 腳本有一個(gè)非常強(qiáng)大的功能,就是可以使用 npm 的內(nèi)部變量。
首先,通過npm_package_前綴,npm 腳本可以拿到package.json里面的字段。比如,下面是一個(gè)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
上面代碼中,我們通過環(huán)境變量process.env對(duì)象,拿到package.json的字段值。如果是 Bash 腳本,可以用$npm_package_name和$npm_package_version取到這兩個(gè)值。
npm_package_前綴也支持嵌套的package.json字段。
"repository": { "type": "git", "url": "xxx" }, scripts: { "view": "echo $npm_package_repository_type" }
上面代碼中,repository字段的type屬性,可以通過npm_package_repository_type取到。
下面是另外一個(gè)例子。
"scripts": { "install": "foo.js" }
上面代碼中,npm_package_scripts_install變量的值等于foo.js。
然后,npm 腳本還可以通過npm_config_前綴,拿到 npm 的配置變量,即npm config get xxx命令返回的值。比如,當(dāng)前模塊的發(fā)行標(biāo)簽,可以通過npm_config_tag取到。
"view": "echo $npm_config_tag",
注意,package.json里面的config對(duì)象,可以被環(huán)境變量覆蓋。
{ "name" : "foo", "config" : { "port" : "8080" }, "scripts" : { "start" : "node server.js" } }
上面代碼中,npm_package_config_port變量返回的是8080。這個(gè)值可以用下面的方法覆蓋。
$ npm config set foo:port 80
最后,env命令可以列出所有環(huán)境變量。
"env": "env"
十、常用腳本示例
// 刪除目錄 "clean": "rimraf dist/*", // 本地搭建一個(gè) HTTP 服務(wù) "serve": "http-server -p 9090 dist/", // 打開瀏覽器 "open:dev": "opener http://localhost:9090", // 實(shí)時(shí)刷新 "livereload": "live-reload --port 9091 dist/", // 構(gòu)建 HTML 文件 "build:html": "jade index.jade > dist/index.html", // 只要 CSS 文件有變動(dòng),就重新執(zhí)行構(gòu)建 "watch:css": "watch 'npm run build:css' assets/styles/", // 只要 HTML 文件有變動(dòng),就重新執(zhí)行構(gòu)建 "watch:html": "watch 'npm run build:html' assets/html", // 部署到 Amazon S3 "deploy:prod": "s3-cli sync ./dist/ s3://example-com/prod-site/", // 構(gòu)建 favicon "build:favicon": "node scripts/favicon.js",
感謝你能夠認(rèn)真閱讀完這篇文章,希望小編分享的“npm中scripts怎么用”這篇文章對(duì)大家有幫助,同時(shí)也希望大家多多支持創(chuàng)新互聯(lián),關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道,更多相關(guān)知識(shí)等著你來學(xué)習(xí)!
當(dāng)前題目:npm中scripts怎么用
網(wǎng)頁網(wǎng)址:http://jinyejixie.com/article44/pgeoee.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站導(dǎo)航、網(wǎng)站排名、外貿(mào)建站、軟件開發(fā)、網(wǎng)站策劃、商城網(wǎng)站
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場,如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來源: 創(chuàng)新互聯(lián)