vue-cli 3.0 特性速讀

phoebeCodeSpace發表於2018-04-19
Vue

我的個人blog : 原文連結

最近的開發專案中使用了vue-cli 3.0，使用體驗可以說非常棒了，模板更加制定化，配置更加簡潔。以下總結下應用過程中的一些經驗。

新建專案

# 安裝
npm install -g @vue/cli

# 新建專案
vue create my-project

# 專案啟動
npm run serve

# 打包
npm run build
複製程式碼

打包後的檔案，對引用資源注入了預載入（preload/prefetch），啟用 PWA 外掛時注入 manifest/icon 連結，並且引入(inlines) webpack runtime / chunk manifest 清單已獲得最佳效能。

功能配置

功能選擇

功能選擇

3.0 版本包括預設預設配置 和 使用者自定義配置，在使用者自定義配置之後，會詢問是否儲存當前的配置功能為將來的專案配置的預設值，這樣下次可直接使用不需要再次配置。

自定義功能配置包括以下功能：

  • TypeScript
  • Progressive Web App (PWA) Support
  • Router
  • Vuex
  • CSS Pre-processors
  • Linter / Formatter
  • Unit Testing
  • E2E Testing

可以根據專案大小和功能體驗配置不同的功能，空格鍵 選中/反選，按a鍵 全選/全不選，按i鍵反選已選擇項， 上下鍵 上下移動選擇。

功能細節配置

功能配置

在選擇功能後，會詢問更細節的配置，

  • TypeScript：
    • 是否使用class風格的元件語法：Use class-style component syntax?
    • 是否使用babel做轉義：Use Babel alongside TypeScript for auto-detected polyfills?
  • CSS Pre-processors：
    • 選擇CSS 預處理型別：Pick a CSS pre-processor
  • Linter / Formatter
    • 選擇Linter / Formatter規範型別：Pick a linter / formatter config
    • 選擇lint方式，儲存時檢查/提交時檢查：Pick additional lint features
  • Testing
    • 選擇Unit測試方式
    • 選擇E2E測試方式
  • 選擇 Babel, PostCSS, ESLint 等自定義配置的存放位置 Where do you prefer placing config for Babel, PostCSS, ESLint, etc.?

vue.config.js 自定義配置

vue.config.js完整預設配置

module.exports = {
  // 基本路徑
  baseUrl: '/',
  // 輸出檔案目錄
  outputDir: 'dist',
  // eslint-loader 是否在儲存的時候檢查
  lintOnSave: true,
  // use the full build with in-browser compiler?
  // https://vuejs.org/v2/guide/installation.html#Runtime-Compiler-vs-Runtime-only
  compiler: false,
  // webpack配置
  // see https://github.com/vuejs/vue-cli/blob/dev/docs/webpack.md
  chainWebpack: () => {},
  configureWebpack: () => {},
  // vue-loader 配置項
  // https://vue-loader.vuejs.org/en/options.html
  vueLoader: {},
  // 生產環境是否生成 sourceMap 檔案
  productionSourceMap: true,
  // css相關配置
  css: {
    // 是否使用css分離外掛 ExtractTextPlugin
    extract: true,
    // 開啟 CSS source maps?
    sourceMap: false,
    // css預設器配置項
    loaderOptions: {},
    // 啟用 CSS modules for all css / pre-processor files.
    modules: false
  },
  // use thread-loader for babel & TS in production build
  // enabled by default if the machine has more than 1 cores
  parallel: require('os').cpus().length > 1,
  // 是否啟用dll
  // See https://github.com/vuejs/vue-cli/blob/dev/docs/cli-service.md#dll-mode
  dll: false,
  // PWA 外掛相關配置
  // see https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-pwa
  pwa: {},
  // webpack-dev-server 相關配置
  devServer: {
    open: process.platform === 'darwin',
    host: '0.0.0.0',
    port: 8080,
    https: false,
    hotOnly: false,
    proxy: null, // 設定代理
    before: app => {}
  },
  // 第三方外掛配置
  pluginOptions: {
    // ...
  }
}
複製程式碼

設定代理

# string
module.exports = {
  devServer: {
    proxy: '<url>'
  }
}

# Object
module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: '<url>',
        ws: true,
        changeOrigin: true
      },
      '/foo': {
        target: '<other_url>'
      }
    }
  }
}
複製程式碼

啟用dll

啟用dll後，我們的動態庫檔案每次打包生成的vendor的[chunkhash]值就會一樣，其值可以是 true/false,也可以制定特定的程式碼庫。

module.exports = {
  dll: true
}

module.exports = {
  dll: [
    'dep-a',
    'dep-b/some/nested/file.js'
  ]
}
複製程式碼

靜態資源路徑

  • 相對路徑

    • 靜態資源路徑以 @ 開頭代表 <projectRoot>/src
    • 靜態資源路徑以 ~ 開頭，可以引入node modules內的資源

  • public資料夾裡的靜態資源引用

      # 在 public/index.html中引用靜態資源
  <%= webpackConfig.output.publicPath %>
  <link rel="shortcut icon" href="<%= webpackConfig.output.publicPath %>favicon.ico">

  # vue templates中，需要在data中定義baseUrl
  <template>
    <img :src="`${baseUrl}my-image.png`">
  </template>
  <script>
    data () {
      return {
        baseUrl: process.env.BASE_URL
      }
    }
  </script>
複製程式碼

webpack配置修改

用 webpack-chain 修改webpack相關配置，強烈建議先熟悉webpack-chain和vue-cli 原始碼，以便更好地理解這個選項的配置項。

  • 對模組處理配置
// vue.config.js
module.exports = {
  chainWebpack: config => {
    config.module
      .rule('js')
        .include
          .add(/some-module-to-transpile/)  // 要處理的模組
  }
}
複製程式碼
  • 修改webpack Loader配置
// vue.config.js
module.exports = {
  chainWebpack: config => {
    config.module
      .rule('scss')
      .use('sass-loader')
      .tap(options =>
        merge(options, {
          includePaths: [path.resolve(__dirname, 'node_modules')],
        })
      )
  }
}
複製程式碼
  • 修改webpack Plugin配置
// vue.config.js
module.exports = {
  chainWebpack: config => {
    config
      .plugin('html')
      .tap(args => {
        return [/* new args to pass to html-webpack-plugin's constructor */]
      })
  }
}
複製程式碼

eg: 在本次專案較小，只對uglifyjs進行了少量的修改，後期如果還有配置上優化會繼續新增。

chainWebpack: config => {
    if (process.env.NODE_ENV === 'production') { 
        config
            .plugin('uglify')
            .tap(([options]) =>{
                // 去除 console.log
                return [Object.assign(options, {
                    uglifyOptions: { compress: {
                        drop_console : true,
                        pure_funcs: ['console.log']
                    }}
                })]
            })
    }
}
複製程式碼

全域性變數的設定

在專案根目錄建立以下專案：

.env                # 在所有環節中執行
.env.local          # 在所有環境中執行，git會ignored
.env.[mode]         # 只在特定環境執行( [mode] 可以是 "development", "production" or "test" )
.env.[mode].local   # 在特定環境執行, git會ignored


.env.development    # 只在生產環境執行
.env.production     # 只在開發環境執行
複製程式碼

在檔案裡配置鍵值對：

# 鍵名須以VUE_APP開頭
VUE_APP_SECRET=secret
複製程式碼

在專案中訪問：

console.log(process.env.VUE_APP_SECRET)
複製程式碼

這樣專案中的 process.env.VUE_APP_SECRET 就會被 secret 所替代。

vue-cli 3 就專案效能而言已經相當友好了，私有制定性也特別強，各種配置也特別貼心，可以根據專案大小和特性制定私有預設，對前期專案搭建而言效率極大提升了。

填坑

  1. 執行 npm run serve 提示錯誤： error: You must pass the "decoratorsLegacy": true option to @babel/preset-stage-2
# 解決辦法1： 在package.json中指定@babel/preset-stage-2版本
"devDependencies": {
  "@babel/preset-stage-2": "7.0.0-beta.44",
  ...
}

# 解決辦法2： 修改.babelrc
{
  "presets": [
    ["@babel/preset-env", {
      "targets": {
        "browsers": [
          "> 5%",
          "last 2 versions",
          "not ie <= 8"
        ]
      },
      "modules": false,
      "exclude": [
        "transform-regenerator"
      ]
    }],
    ["@babel/preset-stage-2", {
      "useBuiltIns": true,
      "decoratorsLegacy": true
    }]
  ],
  "plugins": [
  ]
}
複製程式碼

相關文章