0脚手架的webpack,配置文件分析

作者: 韦德国际1946国际网址  发布:2019-06-15

前言

前言
作为 Vue 的使用者我们对此 vue-cli 都很谙习,然则对它的 webpack 配置大家可能关怀啥少,后天大家为大家带来 vue-cli#2.0 的 webpack 配置解析
vue-cli 的简要介绍、安装大家不在这里赘述,对它还不熟知的同班能够从来访问 vue-cli 查看
目录结构

在从零上学vue之大致练习——创设单页面项目中,笔者对vue脚手架的架构做了一个很简短的分析。
在这篇小说中,将会深深学习vue架议和webpack和服务端的安顿难题。
驷不及舌参照了合法文书档案0脚手架的webpack,配置文件分析。,这里对官方文书档案进行了认证以及翻译。

vue-cli脚手架中 webpack 目录

作为 Vue 的使用者大家对此 vue-cli 都很熟谙,但是对它的 webpack 配置大家或然关心啥少,明天我们为大家带来 vue-cli#2.0 的 webpack 配置分析

├── README.md
├── build
│   ├── build.js
│   ├── check-versions.js
│   ├── dev-client.js
│   ├── dev-server.js
│   ├── utils.js
│   ├── webpack.base.conf.js
│   ├── webpack.dev.conf.js
│   └── webpack.prod.conf.js
├── config
│   ├── dev.env.js
│   ├── index.js
│   └── prod.env.js
├── index.html
├── package.json
├── src
│   ├── App.vue
│   ├── assets
│   │   └── logo.png
│   ├── components
│   │   └── Hello.vue
│   └── main.js
└── static

1.品类架构

图片 1

附上官方图

.|-- build                                                              // 项目营造(webpack)相关代码

vue-cli 的简单介绍、安装大家不在这里赘述,对它还不掌握的同学能够直接待上访问 vue-cli 查看

当我们实施 npm run dev / npm run build 时运维的是 node build/dev-server.js 或 node build/build.js

build/

存款和储蓄了开支服务器的布置(node)、生成webpack配置文件,平时情形下无需改换那个文件,除非需求团结定制Webpack loaders,在这种气象下能够看/webpack.base.conf.js

|  |-- build.js                                                       // 生产条件创设代码

目录结构

dev-server.js
让我们先从 build/dev-server.js 动手

config/index.js

那是首要的布局文件,提供最常用的创设配置接口。

|  |-- check-version.js                                         / 检查node、npm等版本

.
├── README.md
├── build
│  ├── build.js
│  ├── check-versions.js
│  ├── dev-client.js
│  ├── dev-server.js
│  ├── utils.js
│  ├── webpack.base.conf.js
│  ├── webpack.dev.conf.js
│  └── webpack.prod.conf.js
├── config
│  ├── dev.env.js
│  ├── index.js
│  └── prod.env.js
├── index.html
├── package.json
├── src
│  ├── App.vue
│  ├── assets
│  │  └── logo.png
│  ├── components
│  │  └── Hello.vue
│  └── main.js
└── static
// 检查 Node 和 npm 版本
require('./check-versions')()

// 获取 config/index.js 的默认配置
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)

// 使用 NodeJS 自带的文件路径工具
var path = require('path')

// 使用 express
var express = require('express')

// 使用 webpack
var webpack = require('webpack')

// 一个可以强制打开浏览器并跳转到指定 url 的插件
var opn = require('opn')

// 使用 proxyTable
var proxyMiddleware = require('http-proxy-middleware')

// 使用 dev 环境的 webpack 配置
var webpackConfig = require('./webpack.dev.conf')

// default port where dev server listens for incoming traffic

// 如果没有指定运行端口,使用 config.dev.port 作为运行端口
var port = process.env.PORT || config.dev.port

// Define HTTP proxies to your custom API backend
// https://github.com/chimurai/http-proxy-middleware

// 使用 config.dev.proxyTable 的配置作为 proxyTable 的代理配置
var proxyTable = config.dev.proxyTable

// 使用 express 启动一个服务
var app = express()

// 启动 webpack 进行编译
var compiler = webpack(webpackConfig)

// 启动 webpack-dev-middleware,将 编译后的文件暂存到内存中
var devMiddleware = require('webpack-dev-middleware')(compiler, {
  publicPath: webpackConfig.output.publicPath,
  stats: {
    colors: true,
    chunks: false
  }
})

// 启动 webpack-hot-middleware,也就是我们常说的 Hot-reload
var hotMiddleware = require('webpack-hot-middleware')(compiler)
// force page reload when html-webpack-plugin template changes
compiler.plugin('compilation', function (compilation) {
  compilation.plugin('html-webpack-plugin-after-emit', function (data, cb) {
    hotMiddleware.publish({ action: 'reload' })
    cb()
  })
})

// proxy api requests
// 将 proxyTable 中的请求配置挂在到启动的 express 服务上
Object.keys(proxyTable).forEach(function (context) {
  var options = proxyTable[context]
  if (typeof options === 'string') {
    options = { target: options }
  }
  app.use(proxyMiddleware(context, options))
})

// handle fallback for HTML5 history API
// 使用 connect-history-api-fallback 匹配资源,如果不匹配就可以重定向到指定地址
app.use(require('connect-history-api-fallback')())

// serve webpack bundle output
// 将暂存到内存中的 webpack 编译后的文件挂在到 express 服务上
app.use(devMiddleware)

// enable hot-reload and state-preserving
// compilation error display
// 将 Hot-reload 挂在到 express 服务上
app.use(hotMiddleware)

// serve pure static assets
// 拼接 static 文件夹的静态资源路径
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
// 为静态资源提供响应服务
app.use(staticPath, express.static('./static'))

// 让我们这个 express 服务监听 port 的请求,并且将此服务作为 dev-server.js 的接口暴露
module.exports = app.listen(port, function (err) {
  if (err) {
    console.log(err)
    return
  }
  var uri = 'http://localhost:'   port
  console.log('Listening at '   uri   'n')

  // when env is testing, don't need open it
  // 如果不是测试环境,自动打开浏览器并跳到我们的开发地址
  if (process.env.NODE_ENV !== 'testing') {
    opn(uri)
  }
})

src/

此地是项目代码首要囤积的地方,这里的构造目录首要在于开垦者。

|  |-- dev-client.js                                                 // 热重载相关

本篇作品的基本点关怀点在

webpack.dev.conf.js
恰恰大家在 dev-server.js 中用到了 webpack.dev.conf.js 和 index.js,我们先来看一下 webpack.dev.conf.js

static/

本条款录是用来存款和储蓄静态能源,放在这里的文件不会被webpack打包。他们会被维持原状地复制到webpack营造出来的对应一样目录下。

|  |-- dev-server.js                                               // 创设地面服务器

build - 编写翻译职务的代码

// 同样的使用了 config/index.js
var config = require('../config') 

// 使用 webpack
var webpack = require('webpack') 

// 使用 webpack 配置合并插件
var merge = require('webpack-merge') 

// 使用一些小工具
var utils = require('./utils') 

// 加载 webpack.base.conf
var baseWebpackConfig = require('./webpack.base.conf') 

// 使用 html-webpack-plugin 插件,这个插件可以帮我们自动生成 html 并且注入到 .html 文件中
var HtmlWebpackPlugin = require('html-webpack-plugin') 

// add hot-reload related code to entry chunks
// 将 Hol-reload 相对路径添加到 webpack.base.conf 的 对应 entry 前
Object.keys(baseWebpackConfig.entry).forEach(function (name) {
  baseWebpackConfig.entry[name] = ['./build/dev-client'].concat(baseWebpackConfig.entry[name])
})

// 将我们 webpack.dev.conf.js 的配置和 webpack.base.conf.js 的配置合并
module.exports = merge(baseWebpackConfig, {
  module: {
    // 使用 styleLoaders
    loaders: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap })
  },
  // eval-source-map is faster for development
  // 使用 #eval-source-map 模式作为开发工具,此配置可参考 DDFE 往期文章详细了解
  devtool: '#eval-source-map',
  plugins: [

    // definePlugin 接收字符串插入到代码当中, 所以你需要的话可以写上 JS 的字符串
    new webpack.DefinePlugin({
      'process.env': config.dev.env
    }),
    // https://github.com/glenjamin/webpack-hot-middleware#installation--usage
    new webpack.optimize.OccurenceOrderPlugin(),

    // HotModule 插件在页面进行变更的时候只会重回对应的页面模块,不会重绘整个 html 文件
    new webpack.HotModuleReplacementPlugin(),

    // 使用了 NoErrorsPlugin 后页面中的报错不会阻塞,但是会在编译结束后报错
    new webpack.NoErrorsPlugin(),
    // https://github.com/ampedandwired/html-webpack-plugin

    // 将 index.html 作为入口,注入 html 代码后生成 index.html文件
    new HtmlWebpackPlugin({
      filename: 'index.html',
      template: 'index.html',
      inject: true
    })
  ]
})
webpack.base.conf.js
我们看到在 webpack.dev.conf.js 中又引入了 webpack.base.conf.js, 它看起来很重要的样子,所以我们只能在下一章来看看 config/index.js 了 (摊手)

// 使用 NodeJS 自带的文件路径插件
var path = require('path') 

// 引入 config/index.js
var config = require('../config') 

// 引入一些小工具
var utils = require('./utils') 

// 拼接我们的工作区路径为一个绝对路径
var projectRoot = path.resolve(__dirname, '../') 

// 将 NodeJS 环境作为我们的编译环境
var env = process.env.NODE_ENV

// check env & config/index.js to decide weither to enable CSS Sourcemaps for the
// various preprocessor loaders added to vue-loader at the end of this file

// 是否在 dev 环境下开启 cssSourceMap ,在 config/index.js 中可配置
var cssSourceMapDev = (env === 'development' && config.dev.cssSourceMap)

// 是否在 production 环境下开启 cssSourceMap ,在 config/index.js 中可配置
var cssSourceMapProd = (env === 'production' && config.build.productionSourceMap)

// 最终是否使用 cssSourceMap
var useCssSourceMap = cssSourceMapDev || cssSourceMapProd

module.exports = {
  entry: {
      // 编译文件入口
    app: './src/main.js' 
  },
  output: {
      // 编译输出的根路径
    path: config.build.assetsRoot, 
    // 正式发布环境下编译输出的发布路径
    publicPath: process.env.NODE_ENV === 'production' ? config.build.assetsPublicPath : config.dev.assetsPublicPath, 
    // 编译输出的文件名
    filename: '[name].js' 
  },
  resolve: {
    // 自动补全的扩展名
    extensions: ['', '.js', '.vue'],
    // 不进行自动补全或处理的文件或者文件夹
    fallback: [path.join(__dirname, '../node_modules')],
    alias: {
    // 默认路径代理,例如 import Vue from 'vue',会自动到 'vue/dist/vue.common.js'中寻找
      'vue': 'vue/dist/vue.common.js',
      'src': path.resolve(__dirname, '../src'),
      'assets': path.resolve(__dirname, '../src/assets'),
      'components': path.resolve(__dirname, '../src/components')
    }
  },
  resolveLoader: {
    fallback: [path.join(__dirname, '../node_modules')]
  },
  module: {
    preLoaders: [
      // 预处理的文件及使用的 loader
      {
        test: /.vue$/,
        loader: 'eslint',
        include: projectRoot,
        exclude: /node_modules/
      },
      {
        test: /.js$/,
        loader: 'eslint',
        include: projectRoot,
        exclude: /node_modules/
      }
    ],
    loaders: [
      // 需要处理的文件及使用的 loader
      {
        test: /.vue$/,
        loader: 'vue'
      },
      {
        test: /.js$/,
        loader: 'babel',
        include: projectRoot,
        exclude: /node_modules/
      },
      {
        test: /.json$/,
        loader: 'json'
      },
      {
        test: /.(png|jpe?g|gif|svg)(?.*)?$/,
        loader: 'url',
        query: {
          limit: 10000,
          name: utils.assetsPath('img/[name].[hash:7].[ext]')
        }
      },
      {
        test: /.(woff2?|eot|ttf|otf)(?.*)?$/,
        loader: 'url',
        query: {
          limit: 10000,
          name: utils.assetsPath('fonts/[name].[hash:7].[ext]')
        }
      }
    ]
  },
  eslint: {
    // eslint 代码检查配置工具
    formatter: require('eslint-friendly-formatter')
  },
  vue: {
    // .vue 文件配置 loader 及工具 (autoprefixer)
    loaders: utils.cssLoaders({ sourceMap: useCssSourceMap }),
    postcss: [
      require('autoprefixer')({
        browsers: ['last 2 versions']
      })
    ]
  }
}

test/unit

富含单元测试相关文件。

|  |-- utils.js                                                         // 营造筑工程具相关

config - webpack 的布局文件

config/index.js
好不轻巧深入分析完了 webpack.base.conf.js,来让大家看一下 config/index.js

test/e2e

含有e2e测试相关文件。

|  |-- webpack.base.conf.js                                 // webpack基础配置

package.json - 项目的主干信息

index.js 中有 dev 和 production 三种意况的陈设

index.html

那是单页面项指标模版index.html,在支付营造进程中,webpack会生成assets能源,对应的U途达L会自动插入至这么些模板中并渲染。

|  |-- webpack.dev.conf.js                                  // webpack开垦条件陈设

本文由韦德国际1946发布于韦德国际1946国际网址,转载请注明出处:0脚手架的webpack,配置文件分析

关键词: 日记本 Web前端入门 it 从零学习vue