入口
從package.json
能夠看到開發和生產環境的入口。javascript
"scripts": { "dev": "node build/dev-server.js", "build": "node build/build.js" }
開發環境
開發環境的入口文件是 build/dev-server.js。css
dev-server.js
該文件中,使用express做爲後端框架,結合一些關於webpack的中間件,搭建了一個開發環境。html
// 配置文件 var config = require('../config') // 若是 Node 的環境沒法判斷當前是 dev / product 環境 // 使用 config.dev.env.NODE_ENV 做爲當前的環境 if (!process.env.NODE_ENV) { process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV) } // 能夠強制打開瀏覽器並跳轉到指定 url 的插件 // https://github.com/sindresorhus/opn var opn = require('opn') // node自帶的文件路徑工具 var path = require('path') // express框架 var express = require('express') var webpack = require('webpack') // 測試環境,使用的配置與生產環境的配置同樣 // 非測試環境,即爲開發環境,由於此文件只有測試環境和開發環境使用 var proxyMiddleware = require('http-proxy-middleware') var webpackConfig = process.env.NODE_ENV === 'testing' // 生產環境配置文件 ? require('./webpack.prod.conf') // 開發環境配置文件 : require('./webpack.dev.conf') // 端口號爲命令行輸入的PORT參數或者配置文件中的默認值 var port = process.env.PORT || config.dev.port // 配置文件中 是否自動打開瀏覽器 var autoOpenBrowser = !!config.dev.autoOpenBrowser // 配置文件中 http代理配置 // https://github.com/chimurai/http-proxy-middleware var proxyTable = config.dev.proxyTable // 啓動 express 服務 var app = express() // 啓動 webpack 編譯 var compiler = webpack(webpackConfig) // 能夠將編譯後的文件暫存到內存中的插件 // https://github.com/webpack/webpack-dev-middleware var devMiddleware = require('webpack-dev-middleware')(compiler, { // 公共路徑,與webpack的publicPath同樣 publicPath: webpackConfig.output.publicPath, // 不打印 quiet: true }) // Hot-reload 熱重載插件 // https://github.com/glenjamin/webpack-hot-middleware var hotMiddleware = require('webpack-hot-middleware')(compiler, { log: () => {} }) // 當tml-webpack-plugin template更改以後,強制刷新瀏覽器 compiler.plugin('compilation', function (compilation) { compilation.plugin('html-webpack-plugin-after-emit', function (data, cb) { hotMiddleware.publish({ action: 'reload' }) cb() }) }) // 將 proxyTable 中的請求配置掛在到啓動的 express 服務上 Object.keys(proxyTable).forEach(function (context) { var options = proxyTable[context] // 若是options的數據類型爲string,則表示只設置了url, // 因此須要將url設置爲對象中的 target的值 if (typeof options === 'string') { options = { target: options } } app.use(proxyMiddleware(options.filter || context, options)) }) // 使用 connect-history-api-fallback 匹配資源 // 若是不匹配就能夠重定向到指定地址 // https://github.com/bripkens/connect-history-api-fallback app.use(require('connect-history-api-fallback')()) // 將暫存到內存中的 webpack 編譯後的文件掛在到 express 服務上 app.use(devMiddleware) // 將 Hot-reload 掛在到 express 服務上 app.use(hotMiddleware) // 拼接 static 文件夾的靜態資源路徑 var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory) // 靜態文件服務 app.use(staticPath, express.static('./static')) var uri = 'http://localhost:' + port // 編譯成功後打印網址信息 devMiddleware.waitUntilValid(function () { console.log('> Listening at ' + uri + '\n') }) module.exports = app.listen(port, function (err) { if (err) { console.log(err) return } // 若是配置了自動打開瀏覽器,且不是測試環境,則自動打開瀏覽器並跳到咱們的開發地址 if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') { opn(uri) } })
webpack.dev.conf.js
dev-server.js
中使用了webpack.dev.conf.js
文件,該文件是開發環境中webpack的配置入口。vue
// 工具函數集合 var utils = require('./utils') var webpack = require('webpack') // 配置文件 var config = require('../config') // webpack 配置合併插件 var merge = require('webpack-merge') // webpac基本配置 var baseWebpackConfig = require('./webpack.base.conf') // 自動生成 html 而且注入到 .html 文件中的插件 // https://github.com/ampedandwired/html-webpack-plugin var HtmlWebpackPlugin = require('html-webpack-plugin') // webpack錯誤信息提示插件 // https://github.com/geowarin/friendly-errors-webpack-plugin var FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin') // 將 Hol-reload 熱重載的客戶端代碼添加到 webpack.base.conf 的 對應 entry 中,一塊兒打包 Object.keys(baseWebpackConfig.entry).forEach(function(name) { baseWebpackConfig.entry[name] = ['./build/dev-client'].concat(baseWebpackConfig.entry[name]) }) module.exports = merge(baseWebpackConfig, { module: { // styleLoaders rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap }) }, // 最新的配置爲 cheap-module-eval-source-map,雖然 cheap-module-eval-source-map更快,但它的定位不許確 // 因此,換成 eval-source-map devtool: '#eval-source-map', plugins: [ // definePlugin 接收字符串插入到代碼當中, 因此你須要的話能夠寫上 JS 的字符串 // 此處,插入適當的環境 // https://webpack.js.org/plugins/define-plugin/ new webpack.DefinePlugin({ 'process.env': config.dev.env }), // HotModule 插件在頁面進行變動的時候只會重繪對應的頁面模塊,不會重繪整個 html 文件 // https://github.com/glenjamin/webpack-hot-middleware#installation--usage new webpack.HotModuleReplacementPlugin(), new webpack.NoEmitOnErrorsPlugin(), // 將 index.html 做爲入口,注入 html 代碼後生成 index.html文件 // https://github.com/ampedandwired/html-webpack-plugin new HtmlWebpackPlugin({ filename: 'index.html', template: 'index.html', inject: true }), // webpack錯誤信息提示插件 new FriendlyErrorsPlugin() ] })
webpack.base.conf.js
在webpack.dev.conf.js
中出現webpack.base.conf.js
,這個文件是開發環境和生產環境,甚至測試環境,這些環境的公共webpack配置。能夠說,這個文件至關重要。java
// node自帶的文件路徑工具 var path = require('path') // 工具函數集合 var utils = require('./utils') // 配置文件 var config = require('../config') // 工具函數集合 var vueLoaderConfig = require('./vue-loader.conf') /** * 得到絕對路徑 * @method resolve * @param {String} dir 相對於本文件的路徑 * @return {String} 絕對路徑 */ function resolve(dir) { return path.join(__dirname, '..', dir) } module.exports = { entry: { app: './src/main.js' }, output: { // 編譯輸出的靜態資源根路徑 path: config.build.assetsRoot, // 編譯輸出的文件名 filename: '[name].js', // 正式發佈環境下編譯輸出的上線路徑的根路徑 publicPath: process.env.NODE_ENV === 'production' ? config.build.assetsPublicPath : config.dev.assetsPublicPath }, resolve: { // 自動補全的擴展名 extensions: ['.js', '.vue', '.json'], // 路徑別名 alias: { // 例如 import Vue from 'vue',會自動到 'vue/dist/vue.common.js'中尋找 'vue$': 'vue/dist/vue.esm.js', '@': resolve('src'), } }, module: { rules: [{ // 審查 js 和 vue 文件 // https://github.com/MoOx/eslint-loader test: /\.(js|vue)$/, loader: 'eslint-loader', // 表示預先處理 enforce: "pre", include: [resolve('src'), resolve('test')], options: { formatter: require('eslint-friendly-formatter') } }, { // 處理 vue文件 // https://github.com/vuejs/vue-loader test: /\.vue$/, loader: 'vue-loader', options: vueLoaderConfig }, { // 編譯 js // https://github.com/babel/babel-loader test: /\.js$/, loader: 'babel-loader', include: [resolve('src'), resolve('test')] }, { // 處理圖片文件 // https://github.com/webpack-contrib/url-loader test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, loader: 'url-loader', query: { limit: 10000, name: utils.assetsPath('img/[name].[hash:7].[ext]') } }, { // 處理字體文件 test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/, loader: 'url-loader', query: { limit: 10000, name: utils.assetsPath('fonts/[name].[hash:7].[ext]') } } ] } }
config/index.js
該文件在不少文件中都用到,是主要的配置文件,包含靜態文件的路徑、是否開啓sourceMap等。其中,分爲兩個部分dev
(開發環境的配置)和build
(生產環境的配置)。node
// 詳情見文檔:https://vuejs-templates.github.io/webpack/env.html var path = require('path') module.exports = { // production 生產環境 build: { // 構建環境 env: require('./prod.env'), // 構建輸出的index.html文件 index: path.resolve(__dirname, '../dist/index.html'), // 構建輸出的靜態資源路徑 assetsRoot: path.resolve(__dirname, '../dist'), // 構建輸出的二級目錄 assetsSubDirectory: 'static', // 構建發佈的根目錄,可配置爲資源服務器域名或 CDN 域名 assetsPublicPath: '/', // 是否開啓 cssSourceMap productionSourceMap: true, // Gzip off by default as many popular static hosts such as // Surge or Netlify already gzip all static assets for you. // Before setting to `true`, make sure to: // npm install --save-dev compression-webpack-plugin // 默認關閉 gzip,由於不少流行的靜態資源主機,例如 Surge、Netlify,已經爲全部靜態資源開啓gzip productionGzip: false, // 須要使用 gzip 壓縮的文件擴展名 productionGzipExtensions: ['js', 'css'], // Run the build command with an extra argument to // View the bundle analyzer report after build finishes: // `npm run build --report` // Set to `true` or `false` to always turn it on or off // 運行「build」命令行時,加上一個參數,能夠在構建完成後參看包分析報告 // true爲開啓,false爲關閉 bundleAnalyzerReport: process.env.npm_config_report }, // dev 開發環境 dev: { // 構建環境 env: require('./dev.env'), // 端口號 port: 3333, // 是否自動打開瀏覽器 autoOpenBrowser: true, assetsSubDirectory: 'static', // 編譯發佈的根目錄,可配置爲資源服務器域名或 CDN 域名 assetsPublicPath: '/', // proxyTable 代理的接口(可跨域) // 使用方法:https://vuejs-templates.github.io/webpack/proxy.html proxyTable: {}, // CSS Sourcemaps off by default because relative paths are "buggy" // with this option, according to the CSS-Loader README // (https://github.com/webpack/css-loader#sourcemaps) // In our experience, they generally work as expected, // just be aware of this issue when enabling this option. // 默認狀況下,關閉 CSS Sourcemaps,由於使用相對路徑會報錯。 // CSS-Loader README:https://github.com/webpack/css-loader#sourcemaps cssSourceMap: false } }
utils.js
utils.js
也是一個被使用頻率的文件,這個文件包含了三個工具函數:webpack
-
生成靜態資源的路徑git
-
生成 ExtractTextPlugin對象或loader字符串github
-
生成 style-loader的配置web
// node自帶的文件路徑工具 var path = require('path') // 配置文件 var config = require('../config') // 提取css的插件 // https://github.com/webpack-contrib/extract-text-webpack-plugin var ExtractTextPlugin = require('extract-text-webpack-plugin') /** * 生成靜態資源的路徑 * @method assertsPath * @param {String} _path 相對於靜態資源文件夾的文件路徑 * @return {String} 靜態資源完整路徑 */ exports.assetsPath = function (_path) { var assetsSubDirectory = process.env.NODE_ENV === 'production' ? config.build.assetsSubDirectory : config.dev.assetsSubDirectory // path.posix.join與path.join同樣,不過老是以 posix 兼容的方式交互 return path.posix.join(assetsSubDirectory, _path) } /** * 生成處理css的loaders配置 * @method cssLoaders * @param {Object} options 生成配置 * option = { * // 是否開啓 sourceMap * sourceMap: true, * // 是否提取css * extract: true * } * @return {Object} 處理css的loaders配置對象 */ exports.cssLoaders = function (options) { options = options || {} var cssLoader = { loader: 'css-loader', options: { minimize: process.env.NODE_ENV === 'production', sourceMap: options.sourceMap } } /** * 生成 ExtractTextPlugin對象或loader字符串 * @method generateLoaders * @param {Array} loaders loader名稱數組 * @return {String|Object} ExtractTextPlugin對象或loader字符串 */ function generateLoaders (loader, loaderOptions) { var loaders = [cssLoader] if (loader) { loaders.push({ // 例如,sass?indentedSyntax // 在?號前加上「-loader」 loader: loader + '-loader', options: Object.assign({}, loaderOptions, { sourceMap: options.sourceMap }) }) } // extract爲true時,提取css // 生產環境中,默認爲true if (options.extract) { return ExtractTextPlugin.extract({ use: loaders, fallback: 'vue-style-loader' }) } else { return ['vue-style-loader'].concat(loaders) } } // http://vuejs.github.io/vue-loader/en/configurations/extract-css.html return { css: generateLoaders(), postcss: generateLoaders(), less: generateLoaders('less'), sass: generateLoaders('sass', { indentedSyntax: true }), scss: generateLoaders('sass'), stylus: generateLoaders('stylus'), styl: generateLoaders('stylus') } } /** * 生成 style-loader的配置 * style-loader文檔:https://github.com/webpack/style-loader * @method styleLoaders * @param {Object} options 生成配置 * option = { * // 是否開啓 sourceMap * sourceMap: true, * // 是否提取css * extract: true * } * @return {Array} style-loader的配置 */ exports.styleLoaders = function (options) { var output = [] var loaders = exports.cssLoaders(options) for (var extension in loaders) { var loader = loaders[extension] output.push({ test: new RegExp('\\.' + extension + '$'), use: loader }) } return output }
生產環境
開發環境的入口文件是build/build.js
。
build.js
該文件,爲構建打包文件,會將源碼進行構建(編譯、壓縮等)後打包。
// 設置當前環境爲生產環境 process.env.NODE_ENV = 'production' // loading 插件 // https://github.com/sindresorhus/ora var ora = require('ora') // 能夠在 node 中執行`rm -rf`的工具 // https://github.com/isaacs/rimraf var rm = require('rimraf') // node自帶的文件路徑工具 var path = require('path') // 在終端輸出帶顏色的文字 // https://github.com/chalk/chalk var chalk = require('chalk') var webpack = require('webpack') // 配置文件 var config = require('../config') var webpackConfig = require('./webpack.prod.conf') // 在終端顯示loading效果,並輸出提示 var spinner = ora('building for production...') spinner.start() // 刪除這個文件夾 (遞歸刪除) rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => { if (err) throw err // 構建 webpack(webpackConfig, function (err, stats) { // 構建成功 // 中止 loading動畫 spinner.stop() if (err) throw err process.stdout.write(stats.toString({ colors: true, modules: false, children: false, chunks: false, chunkModules: false }) + '\n\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' )) }) })
webpack.prod.conf
該文件,爲生產環境中webpack的配置入口。同時,它也依賴於前面提到的webpack.base.conf.js
、utils.js
和config/index.js
。
// node自帶的文件路徑工具 var path = require('path') // 工具函數集合 var utils = require('./utils') var webpack = require('webpack') // 配置文件 var config = require('../config') // webpack 配置合併插件 var merge = require('webpack-merge') // webpack 基本配置 var baseWebpackConfig = require('./webpack.base.conf') // webpack 複製文件和文件夾的插件 // https://github.com/kevlened/copy-webpack-plugin var CopyWebpackPlugin = require('copy-webpack-plugin') // 自動生成 html 而且注入到 .html 文件中的插件 // https://github.com/ampedandwired/html-webpack-plugin var HtmlWebpackPlugin = require('html-webpack-plugin') // 提取css的插件 // https://github.com/webpack-contrib/extract-text-webpack-plugin var ExtractTextPlugin = require('extract-text-webpack-plugin') // webpack 優化壓縮和優化 css 的插件 // https://github.com/NMFR/optimize-css-assets-webpack-plugin var OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin')