Skip to content
⚠️ This article was written in 2018. Some content may be outdated.

npm scripts 自動化工作流

很多人只用 npm scripts 跑 npm startnpm run build,其實它能做很多自動化的事情。

基礎

json
{
  "scripts": {
    "dev": "webpack-dev-server --mode development",
    "build": "webpack --mode production",
    "lint": "eslint src --ext .js,.vue",
    "test": "jest"
  }
}

運行:npm run devstarttest 可以省略 run)

串行與並行

json
{
  "scripts": {
    // 串行:&& 前一個失敗則停止
    "build": "npm run lint && npm run compile && npm run minify",

    // 並行:& 同時運行(Unix),或用 npm-run-all
    "dev": "npm run server & npm run watch",

    // 用 npm-run-all(跨平台)
    "dev": "npm-run-all --parallel server watch",
    "build": "npm-run-all lint compile minify"
  }
}
bash
npm install --save-dev npm-run-all

傳遞參數

bash
# -- 後面的參數傳給腳本
npm run build -- --watch
npm run lint -- --fix
json
{
  "scripts": {
    "lint": "eslint src",
    "lint:fix": "npm run lint -- --fix"
  }
}

生命週期鈎子

npm 提供 pre/post 鈎子:

json
{
  "scripts": {
    "prebuild": "npm run clean", // build 前自動執行
    "build": "webpack --mode production",
    "postbuild": "npm run zip-dist", // build 後自動執行

    "pretest": "npm run lint", // 測試前先檢查代碼
    "test": "jest"
  }
}

實用腳本集合

json
{
  "scripts": {
    // 清理構建目錄
    "clean": "rimraf dist",

    // 分析包大小
    "analyze": "webpack-bundle-analyzer stats.json",

    // 檢查依賴更新
    "deps:check": "ncu",
    "deps:update": "ncu -u && npm install",

    // 生成 changelog
    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",

    // 版本發佈
    "release:patch": "npm version patch && npm publish",
    "release:minor": "npm version minor && npm publish",

    // 啓動後自動打開瀏覽器
    "dev": "webpack-dev-server --open",

    // 格式化所有文件
    "format": "prettier --write \"src/**/*.{js,vue,css,scss}\"",

    // 全量檢查(CI 用)
    "ci": "npm run lint && npm run test && npm run build"
  }
}

環境變量

json
{
  "scripts": {
    // cross-env 跨平台設置環境變量
    "build:staging": "cross-env NODE_ENV=production VUE_APP_ENV=staging webpack",
    "build:prod": "cross-env NODE_ENV=production VUE_APP_ENV=production webpack"
  }
}
bash
npm install --save-dev cross-env rimraf

腳本里使用 node

直接在 scripts 裏寫 node 腳本:

json
{
  "scripts": {
    "gen-icons": "node scripts/generate-icons.js",
    "update-version": "node -e \"require('./scripts/bump-version')()\"",
    "check-size": "node -e \"const s = require('./dist/main.js').length; console.log('Size:', (s/1024).toFixed(1)+'KB')\""
  }
}

小結

  • pre/post 鈎子做自動化串聯
  • npm-run-all 處理並行/串行任務,跨平台
  • cross-env 跨平台設置環境變量
  • 把常用操作都寫成 script,文檔化並標準化團隊工作流

MIT Licensed