那些花儿，从零构建Vue工程(webpack4 Eslint git hooks...)

时间 2019-11-06

标签那些花儿构建 vue 工程 webpack4 webpack eslint git hooks 栏目 Git 繁體版

原文原文链接

从零搭建Vue开发环境：webpack4 + vue-loader + koa2 + babel-loader v8 + Babel v7 + eslint + git hooks + editorconfigcss

从2009到2019社会在不断进步技术也在不断进步咱们固然也不能落后

“不积跬步无以致千里，不积小流无以成江海”html

先开始webpack基本构建

建立一个工程目录 vue-structurevue

mkdir vue-structure && cd vue-structure
复制代码

安装webpack

npm i webpack webpack-cli -D
复制代码

建立build目录node

mkdir build
复制代码

在build目录里, 建立webpack.config.jswebpack

cd build && touch webpack.config.js
复制代码

建立入口文件 src/main.jsios

mkdir src

cd src && touch main.js
复制代码

main.jscss3

alert('hello world!')
复制代码

配置npm scriptsgit

// package.json 
  "scripts": {
    "build": "webpack --config build/webpack.config.js --progress --mode production"
  }
复制代码

配置devServer

npm i webpack-dev-server -D
复制代码

配置npm scriptsgithub

"scripts": {
    ...
    "dev": "webpack-dev-server --config build/webpack.config.js --progress --mode development"
  }
复制代码

html 插件web

npm i html-webpack-plugin -D
复制代码

webpack配置

// build/webpack.config.js

const path = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin')

const resolve = dir => path.join(__dirname, '..', dir)

module.exports = {
  entry: resolve('src/main.js'),
  output: {
    filename: '[name].[hash:5].js',
    path: resolve('dist')
  },
  devServer: {
    host: '0.0.0.0',
    port: 7000,
    open: true
  },
  plugins: [
    new HtmlWebpackPlugin({
      template: resolve('index.html')
    })
  ]
}

复制代码

运行webpack dev server

npm run dev
复制代码

浏览器自动打开 http://0.0.0.0:7000/

到这里webpack开发服务基本跑通了

配置babel v7

webpack 4.x | babel-loader 8.x | babel 7.x

npm i -D babel-loader @babel/core @babel/preset-env 
复制代码

babel plugin 支持动态import()

npm i @babel/plugin-syntax-dynamic-import -D
复制代码

配置webpack.config.js

module: {
    rules: [
      {
        test: /\.js$/,
        use: 'babel-loader',
        exclude: /node_modules/
      }
    ]
  }
复制代码

建立.babelrc文件

{
  "plugins": [
    "@babel/plugin-syntax-dynamic-import"
  ],
  "presets": [
    [
      "@babel/preset-env",
      {
        "modules": false
      }
    ]
  ]
}

复制代码

测试下ES6代码

test.js

// src/test.js
  export default () => alert('hello vue!')
复制代码

index.html

// src/index.html
  <body>
    <div id="app">请说say</div>
  </body>
复制代码

main.js

// src/main.js
 document.querySelector('#app').addEventListener('click', () => {
  import('./test.js').then(res => {
    res.default()
  })
})
复制代码

运行下dev

npm run dev
复制代码

点击页面div

ok 没问题

配置Vue Loader

Vue Loader 是什么？

Vue Loader 是一个 webpack 的 loader，它容许你以一种以单文件组件（*.vue文件）的格式撰写 Vue 组件：

建立App.vue根组件

<template>
  <div class="example">{{ msg }}</div>
</template>

<script>
export default {
  data () {
    return {
      msg: 'Hello Vue!'
    }
  }
}
</script>

<style>
.example {
  color: red;
}
</style>

复制代码

安装Vue

npm i vue
复制代码

src/main.js

import Vue from 'vue'
import App from './App.vue'

new Vue({
  render: h => h(App)
}).$mount('#app')
复制代码

修改index.html

<body>
  <div id="app"></div>
</body>
复制代码

运行dev

npm run dev
复制代码

结果报错了 webpack默认只能识别JavaScript文件，不能解析.vue文件（vue单文件组件是Vue独有的），因而做者提供了vue-loader。

Vue单文件组件

cn.vuejs.org/v2/guide/si…

配置vue-loader

npm i vue-loader vue-template-compiler
复制代码

vue-template-compiler (peer dependency) 是vue-loader的同版本依赖

webpack.config.js

// webpack.config.js
const VueLoaderPlugin = require('vue-loader/lib/plugin')

module.exports = {
  module: {
    rules: [
      // ... 其它规则
      {
        test: /\.vue$/,
        loader: 'vue-loader'
      }
    ]
  },
  plugins: [
    // 请确保引入这个插件！
    new VueLoaderPlugin()
  ]
}
复制代码

vue单文件组件中css 也须要css-loader解析

npm i css-loader -D
复制代码

配置webpack

// webpack.config.js
const VueLoaderPlugin = require('vue-loader/lib/plugin')

module.exports = {
  mode: 'development',
  module: {
    rules: [
      {
        test: /\.vue$/,
        loader: 'vue-loader'
      },
      // 它会应用到普通的 `.js` 文件
      // 以及 `.vue` 文件中的 `<script>` 块
      {
        test: /\.js$/,
        loader: 'babel-loader'
      },
      // 它会应用到普通的 `.css` 文件
      // 以及 `.vue` 文件中的 `<style>` 块
      {
        test: /\.css$/,
        use: [
          'vue-style-loader',
          'css-loader'
        ]
      }
    ]
  },
  plugins: [
    // 请确保引入这个插件来施展魔法
    new VueLoaderPlugin()
  ]
}
复制代码

此时运行npm run dev OK了，App.vue被成功挂载到页面

css预处理器配置

npm i stylus stylus-loader
复制代码

webpack.config.js

module: {
    rules: [
      {
        test: /\.styl(us)?$/,
        use: [
          'vue-style-loader',
          'css-loader',
          'stylus-loader'
        ]
      }
    ]
  }
复制代码

vue组件中使用

<style lang='stylus' scoped>
.example
  .title
    color: red
</style>
复制代码

postcss配置

postcss 提供了一个解析器，它可以将 CSS 解析成抽象语法树（AST）。

npm i -D postcss-loader
复制代码

autoprefixer（插件) 它能够解析CSS文件而且添加浏览器前缀到CSS内容里

npm i -D autoprefixer
复制代码

建立postcss.config.js

module.exports = {
  plugins: [
    require('autoprefixer')
  ]
}
复制代码

配置webpack

// webpack.config.js
  module: {
    rules: [
      ...
      {
        test: /\.css$/,
        use: [
          devMode ? 'vue-style-loader' : MiniCssExtractPlugin.loader,
          {
            loader: 'css-loader',
            options: {
              sourceMap: true
            }
          },
          {
            loader: 'postcss-loader',
            options: {
              sourceMap: true
            }
          }
        ]
      },
      {
        test: /\.styl(us)?$/,
        use: [
          devMode ? 'vue-style-loader' : MiniCssExtractPlugin.loader,
          {
            loader: 'css-loader',
            options: {
              sourceMap: true
            }
          },
          {
            loader: 'postcss-loader',
            options: {
              sourceMap: true
            }
          },
          {
            loader: 'stylus-loader',
            options: {
              sourceMap: true
            }
          }
        ]
      }
    ]
  }
复制代码

给App.vue添加css3样式

此时 npm run dev 能够看到自动添加了浏览器前缀

图片资源加载配置

url-loader

将图片资源转换成base64 URI

// webpack.config.js

module: {
  rules: [
    {
      test: /\.(png|svg|jpe?g)$/,
      loader: 'url-loader',
      options: {
        limit: 8192
      }
    }
  ]
}
复制代码

转换后图片地址变为了base64 URI

file-loader

加载图标字体

module: {
  rules: [
    {
      test: /\.(woff|woff2|eot|ttf|otf)$/,
      use: ['file-loader']
    }
  ]
}
复制代码

cross-env

设置命令运行时的环境变量以便在webpack配置文件中区分环境

npm i cross-env -D
复制代码

package.json

"scripts": {
    "build": "cross-env NODE_ENV=production webpack --config build/webpack.config.js --progress --mode production",
    "dev": "cross-env NODE_ENV=development webpack-dev-server --config build/webpack.config.js --progress --mode development"
  },
复制代码

css提取

webpack4

npm i mini-css-extract-plugin -D
复制代码

webpack.config.js

// 区分当前环境是 development 仍是 production
const devMode = process.env.NODE_ENV === 'development'

module: {
  rules: [
    {
      test: /\.css$/,
      use: [
        devMode ? 'vue-style-loader' : MiniCssExtractPlugin.loader,
        'css-loader'
      ]
    },
    {
      test: /\.styl(us)?$/,
      use: [
        devMode ? 'vue-style-loader' : MiniCssExtractPlugin.loader,
        'css-loader',
        'stylus-loader'
      ]
    }
  ]
},

plugins: [
  ...
  new MiniCssExtractPlugin({
    filename: '[name].css',
    chunkFilename: '[id].css'
  })
]
复制代码

开发环境下通常不开启css提取，要否则每次代码改动从新编译速度会慢。一般在生成环境下打包时才开启css提取。

此时npm run build, css被单独打包成一个css文件

清理dist目录

生产环境下为何要清理dist目录由于咱们的输出文件为了缓存再文件名拼接上hash值，只要文件有改动就会产生新的hash值，dist目录下每次都会新增一份输出文件但咱们只要编译后的最终的那个就能够了

npm run build 三次 dist目录以下

dist
├── app.bundle.0e380cea371d050137cd.js
├── app.bundle.259c34c1603489ef3572.js
├── app.bundle.e56abf8d6e5742c78c4b.js
├── index.html
└── style.css
复制代码

module.exports = {
    output: {
    filename: '[name].[hash:6].js',
    path: resolve('dist')
  },
}
复制代码

利用webpack插件清理

clean-webpack-plugin

npm i clean-webpack-plugin -D
复制代码

webpack配置

// build/webpack.config.js

const CleanWebpackPlugin = require('clean-webpack-plugin')

module.exports = {
  plugins: [
    new CleanWebpackPlugin(['dist'], {
      root: path.join(__dirname, '../')
    })
  ]
}
复制代码

而后运行npm run build 每次打包前就会把以前的dist目录清理下

第二种方式用rimraf命令清理dist目录

rimraf

The UNIX command rm -rf for node.

npm i rimraf -D
复制代码

修改package.json

"scripts": {
    "clean": "rimraf dist",
    "build": "npm run clean && cross-env NODE_ENV=production webpack --config build/webpack.config.js --progress --mode production",
}

复制代码

npm run build 也是ok的

.editorconfig

在不一样的编辑器和IDEs中为多个从事同一项目的开发人员保持一致的编码风格。

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
复制代码

editorconfig.org/

代码校验 (Linting)

安装eslint

npm i eslint eslint-plugin-vue -D
复制代码

eslint各类安装

npm i -D babel-eslint eslint-config-standard eslint-plugin-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-node
复制代码

建立.eslintrc文件

{
  root: true,
  env: {
    node: true
  },
  parserOptions: {
    parser: "babel-eslint",
    sourceMap: "module"
  },
  extends: [
    "plugin:vue/essential",
    "standard"
  ],
  rules: {}
}
复制代码

webpack中配置eslint

经过webpack实时编译，进行代码效验

npm i eslint-loader -D
复制代码

webpack.config.js

module: {
  rules: [
    {
      {
        enforce: 'pre',
        test: /\.(js|vue)$/,
        loader: 'eslint-loader',
        exclude: /node_modules/
      },
      ......
    }
  ]
}
复制代码

在src/main.js中定义一个未使用变量

let title = 'eslint'
复制代码

运行 npm run dev

eslint基本配置完了可是我想在控制台报错信息更友好些

eslint-friendly-formatter

一个简单的eslint格式设置工具/报告器，它使用高级文本和iterm2“点击打开文件”功能友好

安装

npm i -D eslint-friendly-formatter
复制代码

修改webpack配置

// build/webpack.config.js

module: {
  rules: [
    {
      {
        enforce: 'pre',
        test: /\.(js|vue)$/,
        loader: 'eslint-loader',
        exclude: /node_modules/,
        options: {
          formatter: require('eslint-friendly-formatter')
        }
      },
      ......
    }
  ]
}

复制代码

再次 npm run dev

此时命令行中报错信息更加友好显示rules详细规则

devServer.overlay

把编译错误，直接显示到浏览器页面上。

webpack.config.js

module.exports = {
  devServer: {
    overlay: {
      errors: true,
      warnings: true
    }
  }
}

复制代码

再次npm run dev 这样就能够直接在页面中看到错误信息了

package.json中配置eslint

"scripts": {
    "lint": "eslint --ext .js,.vue src"
  },
复制代码

经过npm 单独进行效验代码也能够

npm run lint
复制代码

eslint自动修复

Eslint检测出的问题如何自动修复

"scripts": {
    "lint": "eslint --ext .js,.vue src",
    "lint:fix": "eslint --fix --ext .js,.vue src"
  },
复制代码

npm run lint:fix
复制代码

会把你代码中一些常规错误进行自动修复

Git Hooks

Git 能在特定的重要动做发生时触发自定义脚本。相似于框架中的生命周期

git-scm.com/book/zh/v2/…

husky

npm install husky --save-dev
复制代码

www.npmjs.com/package/hus…

建立.huskyrc

// .huskyrc
{
  "hooks": {
    "pre-commit": "npm run lint"
  }
}
复制代码

package.json

"scripts": {
    "lint": "eslint --ext .js,.vue src"
  },
复制代码

当每次git commit时自动执行npm run lint效验

webpack代码分离

代码分离属于性能优化 (业务代码第三方代码 webpack运行时生成代码...)

webpack4中直接配置就能够

// build/webpack.config.js

module.exports = {
    optimization: {
    splitChunks: {
      // 默认将node_modules中依赖打包到venders.js
      chunks: 'all'
    },
    // 将webpack运行时生成代码打包到runtime.js
    runtimeChunk: true
  },
}
复制代码

此时 npm run build 会看到vendors.js 和 runtime.js

webpack4中 optimization选项更多配置请看官方文档

webpack.js.org/configurati…

目前完整配置文件

package.json

"scripts": {
    "clean": "rimraf dist",
    "build": "npm run clean && cross-env NODE_ENV=production webpack --config build/webpack.config.js --progress --mode production",
    "dev": "cross-env NODE_ENV=development webpack-dev-server --config build/webpack.config.js --progress --mode development",
    "lint": "eslint --ext .js,.vue src",
    "lint:fix": "eslint --fix --ext .js,.vue src"
  },
复制代码

build/webpack.config.js

const path = require('path')
const VueLoaderPlugin = require('vue-loader/lib/plugin')
const HtmlWebpackPlugin = require('html-webpack-plugin')
const MiniCssExtractPlugin = require('mini-css-extract-plugin')
const CleanWebpackPlugin = require('clean-webpack-plugin')

const resolve = dir => path.join(__dirname, '..', dir)

const devMode = process.env.NODE_ENV === 'development'

module.exports = {
  entry: resolve('src/main.js'),
  output: {
    filename: '[name].[hash:6].js',
    path: resolve('dist')
  },
  module: {
    rules: [
      {
        enforce: 'pre',
        test: /\.(js|vue)$/,
        loader: 'eslint-loader',
        exclude: /node_modules/,
        options: {
          formatter: require('eslint-friendly-formatter')
        }
      },
      {
        test: /\.vue$/,
        use: 'vue-loader',
        exclude: /node_modules/
      },
      {
        test: /\.js$/,
        use: 'babel-loader',
        exclude: /node_modules/
      },
      {
        test: /\.css$/,
        use: [
          devMode ? 'vue-style-loader' : MiniCssExtractPlugin.loader,
          {
            loader: 'css-loader',
            options: {
              sourceMap: true
            }
          },
          {
            loader: 'postcss-loader',
            options: {
              sourceMap: true
            }
          }
        ]
      },
      {
        test: /\.styl(us)?$/,
        use: [
          devMode ? 'vue-style-loader' : MiniCssExtractPlugin.loader,
          {
            loader: 'css-loader',
            options: {
              sourceMap: true
            }
          },
          {
            loader: 'postcss-loader',
            options: {
              sourceMap: true
            }
          },
          {
            loader: 'stylus-loader',
            options: {
              sourceMap: true
            }
          }
        ]
      },
      {
        test: /\.(png|svg|jpe?g)$/,
        loader: 'url-loader',
        options: {
          limit: 8192
        }
      },
      {
        test: /\.(woff|woff2|eot|ttf|otf)$/,
        use: ['file-loader']
      }
    ]
  },
  optimization: {
    splitChunks: {
      // 默认将node_modules中依赖打包到venders.js
      chunks: 'all'
    },
    // 将webpack运行时代码打包到runtime.js
    runtimeChunk: true
  },
  devServer: {
    host: '0.0.0.0',
    port: 7000,
    open: true,
    overlay: {
      warnings: true,
      errors: true
    }
  },
  plugins: [
    new VueLoaderPlugin(),
    new MiniCssExtractPlugin({
      filename: '[name].css',
      chunkFilename: '[id].css'
    }),
    new HtmlWebpackPlugin({
      template: resolve('index.html')
    })
    // new CleanWebpackPlugin(['dist'], {
    //   root: path.join(__dirname, '../')
    // })
  ]
}

复制代码

未完待续

webpack配置根据环境进行拆分(生产、开发)
动态连接库
vue路由集成代码组织
axios二次封装
api管理
Vue插件应用
Vuex Vue-Route集成

其余更多配置留到下一章

webpack配置源码地址

github.com/Lwenli1224/…

那些花儿，从零构建Vue工程(webpack4 Eslint git hooks...)

从2009到2019社会在不断进步 技术也在不断进步 咱们固然也不能落后

先开始webpack基本构建

安装webpack

配置devServer

配置babel v7

配置Vue Loader

Vue Loader 是什么？

配置vue-loader

配置webpack

css预处理器配置

postcss配置

图片资源加载配置

url-loader

file-loader

cross-env

css提取

清理dist目录

利用webpack插件清理

第二种方式 用rimraf命令 清理dist目录

.editorconfig

代码校验 (Linting)

webpack中配置eslint

eslint-friendly-formatter

devServer.overlay

package.json中配置eslint

eslint自动修复

Git Hooks

husky

webpack代码分离

目前完整配置文件

未完待续

webpack配置源码地址

每当到了夜晚时分 就是心里最安静的时候心无杂念。

从2009到2019社会在不断进步技术也在不断进步咱们固然也不能落后

配置vue-loader

配置webpack

第二种方式用rimraf命令清理dist目录

webpack中配置eslint

package.json中配置eslint

每当到了夜晚时分就是心里最安静的时候心无杂念。