分析vue-cli@2.9.3 搭建的webpack项目工程
前言
已經(jīng)有很多分析Vue-cli搭建工程的文章,為什么自己還要寫一遍呢。學(xué)習(xí)就好比是座大山,人們沿著不同的路登山,分享著自己看到的風(fēng)景。你不一定能看到別人看到的風(fēng)景,體會(huì)到別人的心情。只有自己去登山,才能看到不一樣的風(fēng)景,體會(huì)才更加深刻。項(xiàng)目放在筆者的github上,分析vue-cli@2.9.3 搭建的webpack項(xiàng)目工程。方便大家克隆下載,或者在線查看。同時(shí)也求個(gè)star ^_^,也是對(duì)筆者的一種鼓勵(lì)和支持。
正文從這里開始~
使用vue-cli初始化webpack工程
// # 安裝 npm install -g vue-cli // 安裝完后vue命令就可以使用了。實(shí)際上是全局注冊(cè)了vue、vue-init、vue-list幾個(gè)命令// # ubuntu 系統(tǒng)下 // [vue-cli@2.9.3] link /usr/local/bin/vue@ -> /usr/local/lib/node_modules/vue-cli/bin/vue // [vue-cli@2.9.3] link /usr/local/bin/vue-init@ -> /usr/local/lib/node_modules/vue-cli/bin/vue-init // [vue-cli@2.9.3] link /usr/local/bin/vue-list@ -> /usr/local/lib/node_modules/vue-cli/bin/vue-listvue list // 可以發(fā)現(xiàn)有browserify、browserify-simple、pwa、simple、webpack、webpack-simple幾種模板可選,這里選用webpack。// # 使用 vue init vue init <template-name> <project-name>// # 例子 vue init webpack analyse-vue-cli更多vue-cli如何工作的可以查看這篇文章vue-cli是如何工作的,或者分析Vue-cli源碼查看這篇走進(jìn)Vue-cli源碼,自己動(dòng)手搭建前端腳手架工具,再或者直接查看vue-cli github倉庫源碼
如果對(duì)webpack還不是很了解,可以查看webpack官方文檔中的概念,雖然是最新版本的,但概念都是差不多的。
package.json
分析一個(gè)項(xiàng)目,一般從package.json的命令入口scripts開始。
"scripts": {// dev webpack-dev-server --inline 模式 --progress 顯示進(jìn)度 --config 指定配置文件(默認(rèn)是webpack.config.js)"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js","start": "npm run dev",// jest測(cè)試"unit": "jest --config test/unit/jest.conf.js --coverage",// e2e測(cè)試"e2e": "node test/e2e/runner.js",// 運(yùn)行jest測(cè)試和e2e測(cè)試"test": "npm run unit && npm run e2e",// eslint --ext 指定擴(kuò)展名和相應(yīng)的文件"lint": "eslint --ext .js,.vue src test/unit test/e2e/specs",// node 執(zhí)行build/build.js文件"build": "node build/build.js" },Npm Script 底層實(shí)現(xiàn)原理是通過調(diào)用 Shell 去運(yùn)行腳本命令。npm run start等同于運(yùn)行npm run dev。
Npm Script 還有一個(gè)重要的功能是能運(yùn)行安裝到項(xiàng)目目錄里的 node_modules 里的可執(zhí)行模塊。
例如在通過命令npm i -D webpack-dev-server將webpack-dev-server安裝到項(xiàng)目后,是無法直接在項(xiàng)目根目錄下通過命令 webpack-dev-server 去執(zhí)行 webpack-dev-server 構(gòu)建的,而是要通過命令 ./node_modules/.bin/webpack-dev-server 去執(zhí)行。
Npm Script 能方便的解決這個(gè)問題,只需要在 scripts 字段里定義一個(gè)任務(wù),例如:
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js"Npm Script 會(huì)先去項(xiàng)目目錄下的 node_modules 中尋找有沒有可執(zhí)行的 webpack-dev-server 文件,如果有就使用本地的,如果沒有就使用全局的。 所以現(xiàn)在執(zhí)行 webpack-dev-server 啟動(dòng)服務(wù)時(shí)只需要通過執(zhí)行 npm run dev 去實(shí)現(xiàn)。
再來看下 npm run devwebpack-dev-server 其實(shí)是一個(gè)node.js的應(yīng)用程序,它是通過JavaScript開發(fā)的。在命令行執(zhí)行npm run dev命令等同于執(zhí)行node ./node_modules/webpack-dev-server/bin/webpack-dev-server.js --inline --progress --config build/webpack.dev.conf.js。你可以試試。
更多package.json的配置項(xiàng),可以查看阮一峰老師的文章 package.json文件
npm run dev指定了build/webpack.dev.conf.js配置去啟動(dòng)服務(wù),那么我們來看下這個(gè)文件做了什么。
build/webpack.dev.conf.js webpack開發(fā)環(huán)境配置
這個(gè)文件主要做了以下幾件事情:
1、引入各種依賴,同時(shí)也引入了config文件夾下的變量和配置,和一個(gè)工具函數(shù)build/utils.js,
2、合并build/webpack.base.conf.js配置文件,
3、配置開發(fā)環(huán)境一些devServer,plugin等配置,
4、最后導(dǎo)出了一個(gè)Promise,根據(jù)配置的端口,尋找可用的端口來啟動(dòng)服務(wù)。
具體可以看build/webpack.dev.conf.js這個(gè)文件注釋。
'use strict' // 引入工具函數(shù) const utils = require('./utils') // 引入webpack const webpack = require('webpack') // 引入config/index.js配置 const config = require('../config') // 合并webpack配置 const merge = require('webpack-merge') const path = require('path') // 基本配置 const baseWebpackConfig = require('./webpack.base.conf') // 拷貝插件 const CopyWebpackPlugin = require('copy-webpack-plugin') // 生成html的插件 const HtmlWebpackPlugin = require('html-webpack-plugin') // 友好提示的插件 https://github.com/geowarin/friendly-errors-webpack-plugin const FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin') // 查找可用端口 // github倉庫 https://github.com/indexzero/node-portfinder const portfinder = require('portfinder')// process模塊用來與當(dāng)前進(jìn)程互動(dòng),可以通過全局變量process訪問,不必使用require命令加載。它是一個(gè)EventEmitter對(duì)象的實(shí)例。// 后面有些process模塊用到的,所以這里統(tǒng)一列舉下。 // 更多查看這篇阮一峰的這篇文章 http://javascript.ruanyifeng.com/nodejs/process.html// process對(duì)象提供一系列屬性,用于返回系統(tǒng)信息。 // process.pid:當(dāng)前進(jìn)程的進(jìn)程號(hào)。 // process.version:Node的版本,比如v0.10.18。 // process.platform:當(dāng)前系統(tǒng)平臺(tái),比如Linux。 // process.title:默認(rèn)值為“node”,可以自定義該值。 // process.argv:當(dāng)前進(jìn)程的命令行參數(shù)數(shù)組。 // process.env:指向當(dāng)前shell的環(huán)境變量,比如process.env.HOME。 // process.execPath:運(yùn)行當(dāng)前進(jìn)程的可執(zhí)行文件的絕對(duì)路徑。 // process.stdout:指向標(biāo)準(zhǔn)輸出。 // process.stdin:指向標(biāo)準(zhǔn)輸入。 // process.stderr:指向標(biāo)準(zhǔn)錯(cuò)誤。// process對(duì)象提供以下方法: // process.exit():退出當(dāng)前進(jìn)程。 // process.cwd():返回運(yùn)行當(dāng)前腳本的工作目錄的路徑。_ // process.chdir():改變工作目錄。 // process.nextTick():將一個(gè)回調(diào)函數(shù)放在下次事件循環(huán)的頂部。// host const HOST = process.env.HOST // 端口 const PORT = process.env.PORT && Number(process.env.PORT)// 合并基本的webpack配置 const devWebpackConfig = merge(baseWebpackConfig, {module: {// cssSourceMap這里配置的是truerules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap, usePostCSS: true })},// cheap-module-eval-source-map is faster for development// 在開發(fā)環(huán)境是cheap-module-eval-source-map選項(xiàng)更快// 這里配置的是cheap-module-eval-source-map// 更多可以查看中文文檔:https://webpack.docschina.org/configuration/devtool/#devtool// 英文 https://webpack.js.org/configuration/devtool/#developmentdevtool: config.dev.devtool,// these devServer options should be customized in /config/index.jsdevServer: {// 配置在客戶端的日志等級(jí),這會(huì)影響到你在瀏覽器開發(fā)者工具控制臺(tái)里看到的日志內(nèi)容。// clientLogLevel 是枚舉類型,可取如下之一的值 none | error | warning | info。// 默認(rèn)為 info 級(jí)別,即輸出所有類型的日志,設(shè)置成 none 可以不輸出任何日志。clientLogLevel: 'warning',// historyApiFallback boolean object 用于方便的開發(fā)使用了 HTML5 History API 的單頁應(yīng)用。// 可以簡(jiǎn)單true 或者 任意的 404 響應(yīng)可以提供為 index.html 頁面。historyApiFallback: {rewrites: [// config.dev.assetsPublicPath 這里是 /{ from: /.*/, to: path.posix.join(config.dev.assetsPublicPath, 'index.html') },],},// 開啟熱更新hot: true,// contentBase 配置 DevServer HTTP 服務(wù)器的文件根目錄。// 默認(rèn)情況下為當(dāng)前執(zhí)行目錄,通常是項(xiàng)目根目錄,所有一般情況下你不必設(shè)置它,除非你有額外的文件需要被 DevServer 服務(wù)。contentBase: false, // since we use CopyWebpackPlugin.// compress 配置是否啟用 gzip 壓縮。boolean 為類型,默認(rèn)為 false。compress: true,// host// 例如你想要局域網(wǎng)中的其它設(shè)備訪問你本地的服務(wù),可以在啟動(dòng) DevServer 時(shí)帶上 --host 0.0.0.0// 或者直接設(shè)置為 0.0.0.0// 這里配置的是localhosthost: HOST || config.dev.host,// 端口號(hào) 這里配置的是8080port: PORT || config.dev.port,// 打開瀏覽器,這里配置是不打開falseopen: config.dev.autoOpenBrowser,// 是否在瀏覽器以遮罩形式顯示報(bào)錯(cuò)信息 這里配置的是trueoverlay: config.dev.errorOverlay? { warnings: false, errors: true }: false,// 這里配置的是 /publicPath: config.dev.assetsPublicPath,// 代理 這里配置的是空{(diào)},有需要可以自行配置proxy: config.dev.proxyTable,// 啟用 quiet 后,除了初始啟動(dòng)信息之外的任何內(nèi)容都不會(huì)被打印到控制臺(tái)。這也意味著來自 webpack 的錯(cuò)誤或警告在控制臺(tái)不可見。// 開啟后一般非常干凈只有類似的提示 Your application is running here: http://localhost:8080quiet: true, // necessary for FriendlyErrorsPlugin// webpack-dev-middleware// watch: false,// 啟用 Watch 模式。這意味著在初始構(gòu)建之后,webpack 將繼續(xù)監(jiān)聽任何已解析文件的更改。Watch 模式默認(rèn)關(guān)閉。// webpack-dev-server 和 webpack-dev-middleware 里 Watch 模式默認(rèn)開啟。// Watch 模式的選項(xiàng)watchOptions: {// 或者指定毫秒為單位進(jìn)行輪詢。// 這里配置為falsepoll: config.dev.poll,}// 更多查看中文文檔:https://webpack.docschina.org/configuration/watch/#src/components/Sidebar/Sidebar.jsx},plugins: [// 定義為開發(fā)環(huán)境new webpack.DefinePlugin({// 這里是 { NODE_ENV: '"development"' }'process.env': require('../config/dev.env')}),// 熱更新插件new webpack.HotModuleReplacementPlugin(),// 熱更新時(shí)顯示具體的模塊路徑new webpack.NamedModulesPlugin(), // HMR shows correct file names in console on update.// 在編譯出現(xiàn)錯(cuò)誤時(shí),使用 NoEmitOnErrorsPlugin 來跳過輸出階段。new webpack.NoEmitOnErrorsPlugin(),// github倉庫 https://github.com/ampedandwired/html-webpack-pluginnew HtmlWebpackPlugin({filename: 'index.html',template: 'index.html',// inject 默認(rèn)值 true,script標(biāo)簽位于html文件的 body 底部// body 通true, header, script 標(biāo)簽位于 head 標(biāo)簽內(nèi)// false 不插入生成的 js 文件,只是單純的生成一個(gè) html 文件inject: true}),// copy custom static assets// 把static資源復(fù)制到相應(yīng)目錄。new CopyWebpackPlugin([{// 這里是 staticfrom: path.resolve(__dirname, '../static'),// 這里是 staticto: config.dev.assetsSubDirectory,// 忽略.開頭的文件。比如這里的.gitkeep,這個(gè)文件是指空文件夾也提交到gitignore: ['.*']}])] }) // 導(dǎo)出一個(gè)promise module.exports = new Promise((resolve, reject) => {// process.env.PORT 可以在命令行指定端口號(hào),比如PORT=2000 npm run dev,那訪問就是http://localhost:2000// config.dev.port 這里配置是 8080portfinder.basePort = process.env.PORT || config.dev.port// 以配置的端口為基準(zhǔn),尋找可用的端口,比如:如果8080占用,那就8081,以此類推// github倉庫 https://github.com/indexzero/node-portfinderportfinder.getPort((err, port) => {if (err) {reject(err)} else {// publish the new Port, necessary for e2e testsprocess.env.PORT = port// add port to devServer configdevWebpackConfig.devServer.port = port// Add FriendlyErrorsPlugindevWebpackConfig.plugins.push(new FriendlyErrorsPlugin({compilationSuccessInfo: {messages: [`Your application is running here: http://${devWebpackConfig.devServer.host}:${port}`],},// notifyOnErrors 這里配置是 true// onErrors 是一個(gè)函數(shù),出錯(cuò)輸出錯(cuò)誤信息,系統(tǒng)原生的通知onErrors: config.dev.notifyOnErrors? utils.createNotifierCallback(): undefined}))resolve(devWebpackConfig)}}) })build/utils.js 工具函數(shù)
上文build/webpack.dev.conf.js提到引入了build/utils.js工具函數(shù)。
該文件主要寫了以下幾個(gè)工具函數(shù):
1、assetsPath返回輸出路徑,
2、cssLoaders返回相應(yīng)的css-loader配置,
3、styleLoaders返回相應(yīng)的處理樣式的配置,
4、createNotifierCallback創(chuàng)建啟動(dòng)服務(wù)時(shí)出錯(cuò)時(shí)提示信息回調(diào)。
具體配置可以看該文件注釋:
'use strict' const path = require('path') // 引入配置文件config/index.js const config = require('../config') // 提取css的插件 const ExtractTextPlugin = require('extract-text-webpack-plugin') // 引入package.json配置 const packageConfig = require('../package.json') // 返回路徑 exports.assetsPath = function (_path) {const assetsSubDirectory = process.env.NODE_ENV === 'production'// 二級(jí)目錄 這里是 static? config.build.assetsSubDirectory// 二級(jí)目錄 這里是 static: config.dev.assetsSubDirectory// 生成跨平臺(tái)兼容的路徑// 更多查看Node API鏈接:https://nodejs.org/api/path.html#path_path_posixreturn path.posix.join(assetsSubDirectory, _path) }exports.cssLoaders = function (options) {// 作為參數(shù)傳遞進(jìn)來的options對(duì)象// {// // sourceMap這里是true// sourceMap: true,// // 是否提取css到單獨(dú)的css文件// extract: true,// // 是否使用postcss// usePostCSS: true// }options = options || {}const cssLoader = {loader: 'css-loader',options: {sourceMap: options.sourceMap}}const postcssLoader = {loader: 'postcss-loader',options: {sourceMap: options.sourceMap}}// generate loader string to be used with extract text plugin// 創(chuàng)建對(duì)應(yīng)的loader配置function generateLoaders (loader, loaderOptions) {// 是否使用usePostCSS,來決定是否采用postcssLoaderconst loaders = options.usePostCSS ? [cssLoader, postcssLoader] : [cssLoader]if (loader) {loaders.push({loader: loader + '-loader',// 合并 loaderOptions 生成optionsoptions: Object.assign({}, loaderOptions, {sourceMap: options.sourceMap})})}// Extract CSS when that option is specified// (which is the case during production build)if (options.extract) {// 如果提取使用ExtractTextPlugin插件提取// 更多配置 看插件中文文檔:https://webpack.docschina.org/plugins/extract-text-webpack-plugin/return ExtractTextPlugin.extract({// 指需要什么樣的loader去編譯文件// loader 被用于將資源轉(zhuǎn)換成一個(gè) CSS 導(dǎo)出模塊 (必填)use: loaders,// loader(例如 'style-loader')應(yīng)用于當(dāng) CSS 沒有被提取(也就是一個(gè)額外的 chunk,當(dāng) allChunks: false)fallback: 'vue-style-loader'})} else {return ['vue-style-loader'].concat(loaders)}}// https://vue-loader.vuejs.org/en/configurations/extract-css.htmlreturn {css: generateLoaders(),postcss: generateLoaders(),less: generateLoaders('less'),// sass indentedSyntax 語法縮進(jìn),類似下方格式// #main// color: blue// font-size: 0.3emsass: generateLoaders('sass', { indentedSyntax: true }),scss: generateLoaders('sass'),stylus: generateLoaders('stylus'),styl: generateLoaders('stylus')} }// Generate loaders for standalone style files (outside of .vue) // 最終會(huì)返回webpack css相關(guān)的配置 exports.styleLoaders = function (options) {// {// // sourceMap這里是true// sourceMap: true,// // 是否提取css到單獨(dú)的css文件// extract: true,// // 是否使用postcss// usePostCSS: true// }const output = []const loaders = exports.cssLoaders(options)for (const extension in loaders) {const loader = loaders[extension]output.push({test: new RegExp('\\.' + extension + '$'),use: loader})}return output }// npm run dev 出錯(cuò)時(shí), FriendlyErrorsPlugin插件 配置 onErrors輸出錯(cuò)誤信息 exports.createNotifierCallback = () => {// 'node-notifier'是一個(gè)跨平臺(tái)系統(tǒng)通知的頁面,當(dāng)遇到錯(cuò)誤時(shí),它能用系統(tǒng)原生的推送方式給你推送信息const notifier = require('node-notifier')return (severity, errors) => {if (severity !== 'error') returnconst error = errors[0]const filename = error.file && error.file.split('!').pop()notifier.notify({title: packageConfig.name,message: severity + ': ' + error.name,subtitle: filename || '',icon: path.join(__dirname, 'logo.png')})} }build/webpack.base.conf.js webpack基本配置文件
上文build/webpack.dev.conf.js提到引入了build/webpack.base.conf.js這個(gè)webpack基本配置文件。
這個(gè)文件主要做了以下幾件事情:
1、引入各種插件、配置等,其中引入了build/vue-loader.conf.js相關(guān)配置,
2、創(chuàng)建eslint規(guī)則配置,默認(rèn)啟用,
3、導(dǎo)出webpack配置對(duì)象,其中包含context,入口entry,輸出output,resolve,module下的rules(處理對(duì)應(yīng)文件的規(guī)則),和node相關(guān)的配置等。
具體可以看這個(gè)文件注釋:
// 使用嚴(yán)格模式,更多嚴(yán)格模式可以查看 // [阮一峰老師的es標(biāo)準(zhǔn)入門](http://es6.ruanyifeng.com/?search=%E4%B8%A5%E6%A0%BC%E6%A8%A1%E5%BC%8F&x=0&y=0#docs/function#%E4%B8%A5%E6%A0%BC%E6%A8%A1%E5%BC%8F) 'use strict' const path = require('path') // 引入工具函數(shù) const utils = require('./utils') // 引入配置文件,也就是config/index.js文件 const config = require('../config') // 引入vue-loader的配置文件 const vueLoaderConfig = require('./vue-loader.conf') // 定義獲取絕對(duì)路徑函數(shù) function resolve (dir) {return path.join(__dirname, '..', dir) } // 創(chuàng)建eslint配置 const createLintingRule = () => ({test: /\.(js|vue)$/,loader: 'eslint-loader',// 執(zhí)行順序,前置,還有一個(gè)選項(xiàng)是post是后置// 把 eslint-loader 的執(zhí)行順序放到最前面,防止其它 Loader 把處理后的代碼交給 eslint-loader 去檢查enforce: 'pre',// 包含文件夾include: [resolve('src'), resolve('test')],options: {// 使用友好的eslint提示插件formatter: require('eslint-friendly-formatter'),// eslint報(bào)錯(cuò)提示是否顯示以遮罩形式顯示在瀏覽器中// 這里showEslintErrorsInOverlay配置是falseemitWarning: !config.dev.showEslintErrorsInOverlay} })module.exports = {// 運(yùn)行環(huán)境的上下文,就是實(shí)際的目錄,也就是項(xiàng)目根目錄context: path.resolve(__dirname, '../'),// 入口entry: {app: './src/main.js'},// 輸出output: {// 路徑 這里是根目錄下的distpath: config.build.assetsRoot,// 文件名filename: '[name].js',publicPath: process.env.NODE_ENV === 'production'// 這里是 /,但要上傳到github pages等會(huì)路徑不對(duì),需要修改為./? config.build.assetsPublicPath// 這里配置是 /: config.dev.assetsPublicPath},// Webpack 在啟動(dòng)后會(huì)從配置的入口模塊出發(fā)找出所有依賴的模塊,Resolve 配置 Webpack 如何尋找模塊所對(duì)應(yīng)的文件。resolve: {// 配置了這個(gè),對(duì)應(yīng)的擴(kuò)展名可以省略extensions: ['.js', '.vue', '.json'],alias: {// 給定對(duì)象的鍵后的末尾添加 $,以表示精準(zhǔn)匹配 node_modules/vue/dist/vue.esm.js// 引用 import Vue from 'vue'就是引入的這個(gè)文件最后export default Vue 導(dǎo)出的Vue;// 所以這句可以以任意大寫字母命名 比如:import V from 'vue''vue$': 'vue/dist/vue.esm.js',// src別名 比如 :引入import HelloWorld from '@/components/HelloWorld''@': resolve('src'),}},// 定義一些文件的轉(zhuǎn)換規(guī)則module: {rules: [// 是否使用eslint 這里配置是true...(config.dev.useEslint ? [createLintingRule()] : []),{test: /\.vue$/,// vue-loader中文文檔:https://vue-loader-v14.vuejs.org/zh-cn/loader: 'vue-loader',options: vueLoaderConfig},{// js文件使用babel-loader轉(zhuǎn)換test: /\.js$/,loader: 'babel-loader',include: [resolve('src'), resolve('test'), resolve('node_modules/webpack-dev-server/client')]},{// 圖片文件使用url-loader轉(zhuǎn)換test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,loader: 'url-loader',options: {// 限制大小10000B(bytes)以內(nèi),轉(zhuǎn)成base64編碼的dataURL字符串limit: 10000,// 輸出路徑 img/名稱.7位hash.擴(kuò)展名name: utils.assetsPath('img/[name].[hash:7].[ext]')}},{// 視頻文件使用url-loader轉(zhuǎn)換test: /\.(mp4|webm|ogg|mp3|wav|flac|aac)(\?.*)?$/,loader: 'url-loader',options: {limit: 10000,name: utils.assetsPath('media/[name].[hash:7].[ext]')}},{test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,loader: 'url-loader',options: {limit: 10000,name: utils.assetsPath('fonts/[name].[hash:7].[ext]')}}]},// 這里的node是一個(gè)對(duì)象,其中每個(gè)屬性都是 Node.js 全局變量或模塊的名稱,每個(gè) value 是以下其中之一// empty 提供空對(duì)象。// false 什么都不提供。// 更多查看 中文文檔:https://webpack.docschina.org/configuration/node/node: {// prevent webpack from injecting useless setImmediate polyfill because Vue// source contains it (although only uses it if it's native).// 防止webpack注入一些polyfill 因?yàn)閂ue已經(jīng)包含了這些。setImmediate: false,// prevent webpack from injecting mocks to Node native modules// that does not make sense for the clientdgram: 'empty',fs: 'empty',net: 'empty',tls: 'empty',child_process: 'empty'} }build/vue-loader.conf.js vue-loader配置文件
上文build/webpack.dev.conf.js提到引入了build/vue-loader.conf.js。
這個(gè)文件主要導(dǎo)出了一份Vue-loader的配置,
主要有:loaders,cssSourceMap,cacheBusting,transformToRequire。
具體看該文件注釋:
'use strict' const utils = require('./utils') const config = require('../config') const isProduction = process.env.NODE_ENV === 'production' const sourceMapEnabled = isProduction// 這里是true? config.build.productionSourceMap// 這里是true: config.dev.cssSourceMap // 更多配置 可以查看vue-loader中文文檔:https://vue-loader-v14.vuejs.org/zh-cn/ module.exports = {// cssLoaders 生成相應(yīng)loader配置,具體看utils文件中的cssLoaderloaders: utils.cssLoaders({// 是否開啟sourceMap,便于調(diào)試sourceMap: sourceMapEnabled,// 是否提取vue單文件的cssextract: isProduction}),// 是否開啟cssSourceMap,便于調(diào)試cssSourceMap: sourceMapEnabled,// 這里是true// 緩存破壞,進(jìn)行sourceMap debug時(shí),設(shè)置成false很有幫助。cacheBusting: config.dev.cacheBusting,// vue單文件中,在模板中的圖片等資源引用轉(zhuǎn)成require的形式。以便目標(biāo)資源可以由 webpack 處理。transformToRequire: {video: ['src', 'poster'],source: 'src',img: 'src',// 默認(rèn)配置會(huì)轉(zhuǎn)換 <img> 標(biāo)簽上的 src 屬性和 SVG 的 <image> 標(biāo)簽上的 xlink:href 屬性。image: 'xlink:href'} }看完了這些文件相應(yīng)配置,開發(fā)環(huán)境的相關(guān)配置就串起來了。
其中config/文件夾下的配置,筆者都已經(jīng)注釋在build/文件夾下的對(duì)應(yīng)的文件中,所以就不單獨(dú)說明了。
那回過頭來看,package.json的scripts中的npm run build配置,node build/build.js,其實(shí)就是用node去執(zhí)行build/build.js文件。
build/build.js npm run build 指定執(zhí)行的文件
這個(gè)文件主要做了以下幾件事情:
1、引入build/check-versions文件,檢查node和npm的版本,
2、引入相關(guān)插件和配置,其中引入了webpack生產(chǎn)環(huán)境的配置build/webpack.prod.conf.js,
3、先控制臺(tái)輸出loading,刪除dist目錄下的文件,開始構(gòu)建,構(gòu)建失敗和構(gòu)建成功都給出相應(yīng)的提示信息。
具體可以查看相應(yīng)的注釋:
'use strict' // 檢查node npm的版本 require('./check-versions')()process.env.NODE_ENV = 'production' // 命令行中的loading const ora = require('ora') // 刪除文件或文件夾 const rm = require('rimraf') // 路徑相關(guān) const path = require('path') // 控制臺(tái)輸入樣式 chalk 更多查看:https://github.com/chalk/chalk const chalk = require('chalk') // 引入webpack const webpack = require('webpack') // 引入config/index.js const config = require('../config') // 引入 生產(chǎn)環(huán)境webpack配置 const webpackConfig = require('./webpack.prod.conf')// 控制臺(tái)輸入開始構(gòu)建loading const spinner = ora('building for production...') spinner.start()// 刪除原有構(gòu)建輸出的目錄文件 這里是dist 和 static rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => {// 如果出錯(cuò),拋出錯(cuò)誤if (err) throw errwebpack(webpackConfig, (err, stats) => {// 關(guān)閉 控制臺(tái)輸入開始構(gòu)建loadingspinner.stop()// 如果出錯(cuò),拋出錯(cuò)誤if (err) throw errprocess.stdout.write(stats.toString({colors: true,modules: false,children: false, // If you are using ts-loader, setting this to true will make TypeScript errors show up during build.chunks: false,chunkModules: false}) + '\n\n')// 如果有錯(cuò),控制臺(tái)輸出構(gòu)建失敗if (stats.hasErrors()) {console.log(chalk.red(' Build failed with errors.\n'))process.exit(1)}// 控制臺(tái)輸出構(gòu)建成功相關(guān)信息console.log(chalk.cyan(' Build complete.\n'))console.log(chalk.yellow(' Tip: built files are meant to be served over an HTTP server.\n' +' Opening index.html over file:// won\'t work.\n'))}) })build/check-versions 檢查node和npm版本
上文提到build/check-versions 檢查node和npm版本,
這個(gè)文件主要引入了一些插件和配置,最后導(dǎo)出一個(gè)函數(shù),版本不符合預(yù)期就輸出警告。
具體查看這個(gè)配置文件注釋:
'use strict' // 控制臺(tái)輸入樣式 chalk 更多查看:https://github.com/chalk/chalk const chalk = require('chalk') // 語義化控制版本的插件 更多查看:https://github.com/npm/node-semver const semver = require('semver') // package.json配置 const packageConfig = require('../package.json') // shell 腳本 Unix shell commands for Node.js 更多查看:https://github.com/shelljs/shelljs const shell = require('shelljs')function exec (cmd) {return require('child_process').execSync(cmd).toString().trim() }const versionRequirements = [{name: 'node',currentVersion: semver.clean(process.version),// 這里配置是"node": ">= 6.0.0",versionRequirement: packageConfig.engines.node} ] // 需要使用npm if (shell.which('npm')) {versionRequirements.push({name: 'npm',currentVersion: exec('npm --version'),// 這里配置是"npm": ">= 3.0.0"versionRequirement: packageConfig.engines.npm}) } // 導(dǎo)出一個(gè)檢查版本的函數(shù) module.exports = function () {const warnings = []for (let i = 0; i < versionRequirements.length; i++) {const mod = versionRequirements[i]// 當(dāng)前版本不大于所需版本if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) {warnings.push(mod.name + ': ' +chalk.red(mod.currentVersion) + ' should be ' +chalk.green(mod.versionRequirement))}}// 如果有警告,全部輸出到控制臺(tái)if (warnings.length) {console.log('')console.log(chalk.yellow('To use this template, you must update following to modules:'))console.log()for (let i = 0; i < warnings.length; i++) {const warning = warnings[i]console.log(' ' + warning)}console.log()process.exit(1)} }build/webpack.prod.conf.js webpack生產(chǎn)環(huán)境配置
上文build/build.js提到,引入了這個(gè)配置文件。
這個(gè)文件主要做了以下幾件事情:
1、引入一些插件和配置,其中引入了build/webpack.base.conf.js webpack基本配置文件,
2、用DefinePlugin定義環(huán)境,
3、合并基本配置,定義自己的配置webpackConfig,配置了一些modules下的rules,devtools配置,output輸出配置,一些處理js、提取css、壓縮css、輸出html插件、提取公共代碼等的
plugins,
4、如果啟用gzip,再使用相應(yīng)的插件處理,
5、如果啟用了分析打包后的插件,則用webpack-bundle-analyzer,
6、最后導(dǎo)出這份配置。
具體可以查看這個(gè)文件配置注釋:
'use strict' // 引入node路徑相關(guān) const path = require('path') // 引入utils工具函數(shù) const utils = require('./utils') // 引入webpack const webpack = require('webpack') // 引入config/index.js配置文件 const config = require('../config') // 合并webpack配置的插件 const merge = require('webpack-merge') // 基本的webpack配置 const baseWebpackConfig = require('./webpack.base.conf') // 拷貝文件和文件夾的插件 const CopyWebpackPlugin = require('copy-webpack-plugin') // 壓縮處理HTML的插件 const HtmlWebpackPlugin = require('html-webpack-plugin') const ExtractTextPlugin = require('extract-text-webpack-plugin') // 壓縮處理css的插件 const OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin') // 壓縮處理js的插件 const UglifyJsPlugin = require('uglifyjs-webpack-plugin')// 用DefinePlugin定義環(huán)境 const env = process.env.NODE_ENV === 'testing'// 這里是 { NODE_ENV: '"testing"' }? require('../config/test.env')// 這里是 { NODE_ENV: '"production"' }: require('../config/prod.env') // 合并基本webpack配置 const webpackConfig = merge(baseWebpackConfig, {module: {// 通過styleLoaders函數(shù)生成樣式的一些規(guī)則rules: utils.styleLoaders({// sourceMap這里是truesourceMap: config.build.productionSourceMap,// 是否提取css到單獨(dú)的css文件extract: true,// 是否使用postcssusePostCSS: true})},// 配置使用sourceMap true 這里是 #source-mapdevtool: config.build.productionSourceMap ? config.build.devtool : false,output: {// 這里是根目錄下的distpath: config.build.assetsRoot,// 文件名稱 chunkhashfilename: utils.assetsPath('js/[name].[chunkhash].js'),// chunks名稱 chunkhashchunkFilename: utils.assetsPath('js/[id].[chunkhash].js')},plugins: [// http://vuejs.github.io/vue-loader/en/workflow/production.html// 定義具體是什么環(huán)境new webpack.DefinePlugin({'process.env': env}),// 壓縮js插件new UglifyJsPlugin({uglifyOptions: {compress: {// 警告warnings: false// 構(gòu)建后的文件 常用的配置還有這些// 去除console.log 默認(rèn)為false。 傳入true會(huì)丟棄對(duì)console函數(shù)的調(diào)用。// drop_console: true,// 去除debugger// drop_debugger: true,// 默認(rèn)為null. 你可以傳入一個(gè)名稱的數(shù)組,而UglifyJs將會(huì)假定那些函數(shù)不會(huì)產(chǎn)生副作用。// pure_funcs: [ 'console.log', 'console.log.apply' ],}},// 是否開啟sourceMap 這里是truesourceMap: config.build.productionSourceMap,// 平行處理(同時(shí)處理)加快速度parallel: true}),// extract css into its own file// 提取css到單獨(dú)的css文件new ExtractTextPlugin({// 提取到相應(yīng)的文件名 使用內(nèi)容hash contenthashfilename: utils.assetsPath('css/[name].[contenthash].css'),// Setting the following option to `false` will not extract CSS from codesplit chunks.// Their CSS will instead be inserted dynamically with style-loader when the codesplit chunk has been loaded by webpack.// It's currently set to `true` because we are seeing that sourcemaps are included in the codesplit bundle as well when it's `false`,// increasing file size: https://github.com/vuejs-templates/webpack/issues/1110// allChunks 默認(rèn)是false,true指提取所有chunks包括動(dòng)態(tài)引入的組件。allChunks: true,}),// Compress extracted CSS. We are using this plugin so that possible// duplicated CSS from different components can be deduped.new OptimizeCSSPlugin({// 這里配置是truecssProcessorOptions: config.build.productionSourceMap? { safe: true, map: { inline: false } }: { safe: true }}),// generate dist index.html with correct asset hash for caching.// you can customize output by editing /index.html// see https://github.com/ampedandwired/html-webpack-pluginnew HtmlWebpackPlugin({// 輸出html名稱filename: process.env.NODE_ENV === 'testing'? 'index.html'// 這里是 根目錄下的dist/index.html: config.build.index,// 使用哪個(gè)模板template: 'index.html',// inject 默認(rèn)值 true,script標(biāo)簽位于html文件的 body 底部// body 通true, header, script 標(biāo)簽位于 head 標(biāo)簽內(nèi)// false 不插入生成的 js 文件,只是單純的生成一個(gè) html 文件inject: true,// 壓縮minify: {// 刪除注釋removeComments: true,// 刪除空格和換行collapseWhitespace: true,// 刪除html標(biāo)簽中屬性的雙引號(hào)removeAttributeQuotes: true// 更多配置查看html-minifier插件// more options:// https://github.com/kangax/html-minifier#options-quick-reference},// necessary to consistently work with multiple chunks via CommonsChunkPlugin// 在chunk被插入到html之前,你可以控制它們的排序。允許的值 ‘none’ | ‘a(chǎn)uto’ | ‘dependency’ | {function} 默認(rèn)為‘a(chǎn)uto’.// dependency 依賴(從屬)chunksSortMode: 'dependency'}),// keep module.id stable when vendor modules does not change// 根據(jù)代碼內(nèi)容生成普通模塊的id,確保源碼不變,moduleID不變。new webpack.HashedModuleIdsPlugin(),// enable scope hoisting// 開啟作用域提升 webpack3新的特性,作用是讓代碼文件更小、運(yùn)行的更快new webpack.optimize.ModuleConcatenationPlugin(),// split vendor js into its own file// 提取公共代碼new webpack.optimize.CommonsChunkPlugin({name: 'vendor',minChunks (module) {// any required modules inside node_modules are extracted to vendorreturn (module.resource &&/\.js$/.test(module.resource) &&module.resource.indexOf(path.join(__dirname, '../node_modules')) === 0)}}),// extract webpack runtime and module manifest to its own file in order to// prevent vendor hash from being updated whenever app bundle is updated// 提取公共代碼new webpack.optimize.CommonsChunkPlugin({// 把公共的部分放到 manifest 中name: 'manifest',// 傳入 `Infinity` 會(huì)馬上生成 公共chunk,但里面沒有模塊。minChunks: Infinity}),// This instance extracts shared chunks from code splitted chunks and bundles them// in a separate chunk, similar to the vendor chunk// see: https://webpack.js.org/plugins/commons-chunk-plugin/#extra-async-commons-chunk// 提取動(dòng)態(tài)組件new webpack.optimize.CommonsChunkPlugin({name: 'app',// 如果設(shè)置為 `true`,一個(gè)異步的 公共chunk 會(huì)作為 `options.name` 的子模塊,和 `options.chunks` 的兄弟模塊被創(chuàng)建。// 它會(huì)與 `options.chunks` 并行被加載。可以通過提供想要的字符串,而不是 `true` 來對(duì)輸出的文件進(jìn)行更換名稱。async: 'vendor-async',// 如果設(shè)置為 `true`,所有 公共chunk 的子模塊都會(huì)被選擇children: true,// 最小3個(gè),包含3,chunk的時(shí)候提取minChunks: 3}),// copy custom static assets// 把static資源復(fù)制到相應(yīng)目錄。new CopyWebpackPlugin([{from: path.resolve(__dirname, '../static'),// 這里配置是staticto: config.build.assetsSubDirectory,// 忽略.開頭的文件。比如這里的.gitkeep,這個(gè)文件是指空文件夾也提交到gitignore: ['.*']}])] }) // 如果開始gzip壓縮,使用compression-webpack-plugin插件處理。這里配置是false // 需要使用是需要安裝 npm i compression-webpack-plugin -D if (config.build.productionGzip) {const CompressionWebpackPlugin = require('compression-webpack-plugin')webpackConfig.plugins.push(new CompressionWebpackPlugin({// asset: 目標(biāo)資源名稱。 [file] 會(huì)被替換成原始資源。// [path] 會(huì)被替換成原始資源的路徑, [query] 會(huì)被替換成查詢字符串。默認(rèn)值是 "[path].gz[query]"。asset: '[path].gz[query]',// algorithm: 可以是 function(buf, callback) 或者字符串。對(duì)于字符串來說依照 zlib 的算法(或者 zopfli 的算法)。默認(rèn)值是 "gzip"。algorithm: 'gzip',// test: 所有匹配該正則的資源都會(huì)被處理。默認(rèn)值是全部資源。// config.build.productionGzipExtensions 這里是['js', 'css']test: new RegExp('\\.(' +config.build.productionGzipExtensions.join('|') +')$'),// threshold: 只有大小大于該值的資源會(huì)被處理。單位是 bytes。默認(rèn)值是 0。threshold: 10240,// minRatio: 只有壓縮率小于這個(gè)值的資源才會(huì)被處理。默認(rèn)值是 0.8。minRatio: 0.8})) }// 輸出分析的插件 運(yùn)行npm run build --report // config.build.bundleAnalyzerReport這里是 process.env.npm_config_report // build結(jié)束后會(huì)自定打開 http://127.0.0.1:8888 鏈接 if (config.build.bundleAnalyzerReport) {// 更多查看鏈接地址:https://www.npmjs.com/package/webpack-bundle-analyzerconst BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPluginwebpackConfig.plugins.push(new BundleAnalyzerPlugin()) } // 當(dāng)然也可以用官方提供的網(wǎng)站 http://webpack.github.io/analyse/#home // 運(yùn)行類似 webpack --profile --json > stats.json 命令 // 把生成的構(gòu)建信息stats.json上傳即可// 最終導(dǎo)出 webpackConfig module.exports = webpackConfig至此,我們就分析完了package.json中的npm run dev和npm run build兩個(gè)命令。測(cè)試相關(guān)的類似就略過吧。
npm run lint,.eslintrc.js中的配置不多,更多可以查看eslint英文文檔或eslint中文官網(wǎng),所以也略過吧。不過提一下,把eslint整合到git工作流。可以安裝husky,npm i husky -S。安裝后,配置package.json的scripts中,配置precommit,具體如下:
"scripts": {"lint": "eslint --ext .js,.vue src test/unit test/e2e/specs","precommit": "npm run lint", },配置好后,每次git commit -m提交會(huì)檢查代碼是否通過eslint校驗(yàn),如果沒有校驗(yàn)通過則提交失敗。還可以配置prepush。husky不斷在更新,現(xiàn)在可能與原先的配置不太相同了,具體查看husky github倉庫。原理就是git-hooks,pre-commit的鉤子。對(duì)shell腳本熟悉的同學(xué)也可以自己寫一份pre-commit。復(fù)制到項(xiàng)目的.git/hooks/pre-commit中。不需要依賴husky包。我司就是用的shell腳本。
最后提一下.babelrc文件中的配置。
.babelrc babel相關(guān)配置
配置了一些轉(zhuǎn)碼規(guī)則。這里附上兩個(gè)鏈接:babel英文官網(wǎng)和babel的中文官網(wǎng)。
具體看文件中的配置注釋:
{// presets指明轉(zhuǎn)碼的規(guī)則"presets": [// env項(xiàng)是借助插件babel-preset-env,下面這個(gè)配置說的是babel對(duì)es6,es7,es8進(jìn)行轉(zhuǎn)碼,并且設(shè)置amd,commonjs這樣的模塊化文件,不進(jìn)行轉(zhuǎn)碼["env", {"modules": false,"targets": {"browsers": ["> 1%", "last 2 versions", "not ie <= 8"]}}],"stage-2"],// plugins 屬性告訴 Babel 要使用哪些插件,插件可以控制如何轉(zhuǎn)換代碼。// transform-vue-jsx 表明可以在項(xiàng)目中使用jsx語法,會(huì)使用這個(gè)插件轉(zhuǎn)換"plugins": ["transform-vue-jsx", "transform-runtime"],// 在特定的環(huán)境中所執(zhí)行的轉(zhuǎn)碼規(guī)則,當(dāng)環(huán)境變量是下面的test就會(huì)覆蓋上面的設(shè)置"env": {// test 是提前設(shè)置的環(huán)境變量,如果沒有設(shè)置BABEL_ENV則使用NODE_ENV,如果都沒有設(shè)置默認(rèn)就是development"test": {"presets": ["env", "stage-2"],"plugins": ["transform-vue-jsx", "transform-es2015-modules-commonjs", "dynamic-import-node"]}} }文件中presets中有配置env和stage-2,可能不知道是什么。這里引用深入淺出webpack書中,第三章,3-1使用ES6語言 小節(jié)的一段,解釋一下。
presets 屬性告訴 Babel 要轉(zhuǎn)換的源碼使用了哪些新的語法特性,一個(gè) Presets 對(duì)一組新語法特性提供支持,多個(gè) Presets 可以疊加。 Presets 其實(shí)是一組 Plugins 的集合,每一個(gè) Plugin 完成一個(gè)新語法的轉(zhuǎn)換工作。Presets 是按照 ECMAScript 草案來組織的,通常可以分為以下三大類(書中就是說三大類,我發(fā)現(xiàn)就兩點(diǎn)~~~):1、已經(jīng)被寫入 ECMAScript 標(biāo)準(zhǔn)里的特性,由于之前每年都有新特性被加入到標(biāo)準(zhǔn)里,所以又可細(xì)分為:
es2015 包含在2015里加入的新特性;
es2016 包含在2016里加入的新特性;
es2017 包含在2017里加入的新特性;
es2017 包含在2017里加入的新特性;
env 包含當(dāng)前所有 ECMAScript 標(biāo)準(zhǔn)里的最新特性。
2、被社區(qū)提出來的但還未被寫入 ECMAScript 標(biāo)準(zhǔn)里特性,這其中又分為以下四種:
stage0 只是一個(gè)美好激進(jìn)的想法,有 Babel 插件實(shí)現(xiàn)了對(duì)這些特性的支持,但是不確定是否會(huì)被定為標(biāo)準(zhǔn);
stage1 值得被納入標(biāo)準(zhǔn)的特性;
stage2 該特性規(guī)范已經(jīng)被起草,將會(huì)被納入標(biāo)準(zhǔn)里;
stage3 該特性規(guī)范已經(jīng)定稿,各大瀏覽器廠商和 `` 社區(qū)開始著手實(shí)現(xiàn);
stage4 在接下來的一年將會(huì)加入到標(biāo)準(zhǔn)里去。
至此,就算相對(duì)完整的分析完了Vue-cli(版本v2.9.3)搭建的webpack項(xiàng)目工程。希望對(duì)大家有所幫助。
項(xiàng)目放在筆者的github上,分析vue-cli@2.9.3 搭建的webpack項(xiàng)目工程。方便大家克隆下載,或者在線查看。同時(shí)也求個(gè)star ^_^,也是對(duì)筆者的一種鼓勵(lì)和支持。
筆者知識(shí)能力有限,文章有什么不妥之處,歡迎指出~
小結(jié)
1、分析這些,逐行注釋,還是需要一些時(shí)間的。其中有些不是很明白的地方,及時(shí)查閱相應(yīng)的官方文檔和插件文檔(建議看英文文檔和最新的文檔),不過文檔沒寫明白的地方,可以多搜索一些別人的博客文章,相對(duì)比較清晰明了。
2、前端發(fā)展太快,這個(gè)Vue-cli@2.9.3 webpack版本還是v3.x,webpack現(xiàn)在官方版本已經(jīng)是v4.12.0,相信不久后,Vue-cli也將發(fā)布支持webpack v4.x的版本,v3.0.0已經(jīng)是beta.16了。
3、后續(xù)有余力,可能會(huì)繼續(xù)分析新版的vue-cli構(gòu)建的webpack項(xiàng)目工程。
關(guān)于
作者:常以軒轅Rowboat若川為名混跡于江湖。前端路上 | PPT愛好者 | 所知甚少,唯善學(xué)。
個(gè)人博客
segmentfault前端視野專欄,開通了前端視野專欄,歡迎關(guān)注
掘金專欄,歡迎關(guān)注
知乎前端視野專欄,開通了前端視野專欄,歡迎關(guān)注
github,歡迎follow~
總結(jié)
以上是生活随笔為你收集整理的分析vue-cli@2.9.3 搭建的webpack项目工程的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Elasticsearch根据条件进行删
- 下一篇: CentOS7 minimal 没有n