教你用webpack搭一個vue腳手架[超詳細講解和註釋！]

時間 2019-11-06

標籤 webpack 一個 vue 腳手架詳細講解註釋简体版

原文原文鏈接

1.適用人羣

1.對webpack知識有必定了解但不熟悉的同窗.
    
    2.女同窗！！！(233333....)
複製代碼

2.目的

在本身對webpack有進一步瞭解的同時,也但願能幫到一些剛接觸webpack的同窗.
複製代碼

腳手架已放上github,不想聽我囉嗦的同窗能夠直接去download或clone下來看哦.

腳手架裏都有詳細註釋！

複製代碼

傳送門css

以爲有幫助到你的同窗給個star哈,也算是對個人一種支持！html

3.腳手架結構

├── build                       構建服務和webpack配置
    |—— build.js                webpack打包服務
    |—— webpack.base.conf.js    webpack基本通用配置
    |—— webpack.dev.conf.js     webpack開發環境配置
    |—— webpack.prod.conf.js    webpack生產環境配置
├── config                      構建項目不一樣環境的配置
├── public                      項目打包文件存放目錄
├── index.html                  項目入口文件
├── package.json                項目配置文件
├── static       	            靜態資源
├── .babelrc                    babel配置文件
├── .gitignore                  git忽略文件
├── postcss.config.js           postcss配置文件
├── src                         項目目錄
    |—— page                    頁面組件目錄
    |—— router                  vue路由配置
    |—— store                   vuex配置
    |—— App.vue                 vue實例入口
    |—— main.js                 項目構建入口


複製代碼

4.配置npm scripts

4.1 生成package.json文件,配置npm scripts.vue

4.1.1 使用 npm init 命令,生成一個package.json文件!node

npm init
複製代碼

4.1.2 全局安裝webpack和webpack-dev-serverwebpack

npm install webpack webpack-dev-server -g
複製代碼

4.1.3 在項目目錄下安裝webpack和webpack-dev-servergit

npm install webpack webpack-dev-server -D
複製代碼

4.1.4 進入package.json配置npm scripts命令es6

"scripts": {
    "dev": "webpack-dev-server --config build/webpack.dev.conf.js",
    "start": "npm run dev",
    "build": "node build/build.js"
  }

  經過配置以上命令：
  咱們能夠經過npm start/npm run dev在本地進行開發,
  scripts.dev命令解讀:
  經過webpack-dev-server命令 啓動build文件夾下webpack.dev.conf.js。
  也能夠經過npm run build 打包項目文件進行線上部署.
  scripts.build命令解讀：
  經過node命令構建build文件夾下的build.js。
  命令的配置能夠根據本身腳手架的配置文件位置和名稱不一樣修改哦！
複製代碼

5.構建腳手架目錄

同窗們能夠經過本身的習慣和喜好搭建本身的腳手架目錄,下面講解以上面腳手架結構爲準！
複製代碼

6.構建config/config.js

6.1 該文件主要用來配置構建開發環境和生產環境差別化的參數. 6.2github

const _path = require("path");
const ExtractTextPlugin = require("extract-text-webpack-plugin");

//vue-loader基本配置
const baseVueLoaderConf = {
  //引入postcss插件
  postcss: {
    config: {
      path: _path.resolve("../")
    }
  },
  //轉爲require調用,讓webpack處理目標資源!
  transformToRequire: {
    video: "src",
    source: "src",
    img: "src",
    image: "xlink:href"
  }
};

//vue-loader 開發環境配置
const devVueLoaderConf = Object.assign({}, baseVueLoaderConf, {
  //loaders
  loaders: {
    css: ["vue-style-loader", "css-loader"],
    less: ["vue-style-loader", "css-loader", "postcss-loader", "less-loader"]
  },
  cssSourceMap: true
});

//vue-loader 生產環境配置
const buildVueLoaderConf = Object.assign({}, baseVueLoaderConf, {
  //loaders
  loaders: ExtractTextPlugin.extract({
    use: ["css-loader", "postcss-loader", "less-loader"],
    fallback: "vue-style-loader"
  }),
  cssSourceMap: false
});

//開發/生產環境 配置參數！
module.exports = {
  dev: {
    publicPath: "/",
    devtoolType: "cheap-module-eval-source-map",
    vueloaderConf: devVueLoaderConf,
    host: "localhost",
    port: "1234",
    proxyTable: {}
  },
  build: {
    publicPath: "/",
    devtoolType: "source-map",
    vueloaderConf: buildVueLoaderConf,
    staticPath: "static"
  }
};

複製代碼

7.構建build/webpack.base.conf.js

7.1 此文件主要是webpack開發環境和生成環境的通用配置.web

7.2vuex

"use strict";

//引入node path路徑模塊
const path = require("path");
//引入webpack生產環境配置參數
const prodConfig = require("../config").build;

//拼接路徑
function resolve(track) {
  return path.join(__dirname, "..", track);
}
//資源路徑
function assetsPath(_path) {
  return path.join(prodConfig.staticPath, _path);
}

//webpack 基本設置

module.exports = {
  //項目入口文件->webpack今後處開始構建！
  entry: path.resolve(__dirname, "../src/main.js"),
  //配置模塊如何被解析
  resolve: {
    //自動解析文件擴展名(補全文件後綴)(從左->右)
    // import hello from './hello'  （!hello.js? -> !hello.vue? -> !hello.json）
    extensions: [".js", ".vue", ".json"],
    //配置別名映射
    alias: {
      // import Vue from 'vue/dist/vue.esm.js'能夠寫成 import Vue from 'vue'
      // 鍵後加上$,表示精準匹配！
      vue$: "vue/dist/vue.esm.js",
      "@": resolve("src"),
      utils: resolve("src/utils"),
      components: resolve("src/components"),
      public: resolve("public")
    }
  },
  module: {
    //處理模塊的規則(可在此處使用不一樣的loader來處理模塊！)
    rules: [
      //使用babel-loader來處理src下面的全部js文件,具體babel配置在.babelrc,主要是用來轉義es6
      {
        test: /\.js$/,
        use: {
          loader: "babel-loader"
        },
        include: resolve("src")
      },
      //使用url-loader(file-loader的一個再封裝)對引入的圖片進行編碼,此處可將小於8192字節(8kb)的圖片轉爲DataURL(base64),
      //大於limit字節的會調用file-loader進行處理！
      //圖片通常發佈後都是長緩存,故此處文件名加入hash作版本區分!
      {
        test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
        loader: "url-loader",
        options: {
          limit: 8192,
          name: assetsPath("img/[name].[hash:8].[ext]")
        }
      }
    ]
  }
};

複製代碼

8.構建 build/webpack.dev.conf.js

8.1 該文件主要用於構建開發環境

8.2

"use strict";
//引入node path路徑模塊
const path = require("path");
//引入webpack
const webpack = require("webpack");
//引入webpack開發環境配置參數
const devConfig = require("../config").dev;
//引入webpack基本配置
const baseConf = require("./webpack.base.conf");
//一個webpack配置合併模塊,可簡單的理解爲與Object.assign()功能相似！
const merge = require("webpack-merge");
//一個建立html入口文件的webpack插件！
const HtmlWebpackPlugin = require("html-webpack-plugin");
//一個編譯提示的webpack插件！
const FriendlyErrorsPlugin = require("friendly-errors-webpack-plugin");
//發送系統通知的一個node模塊！
const notifier = require("node-notifier");
//將webpack基本配置與開發環境配置合併！
const devConf = merge(baseConf, {
  //項目出口,webpack-dev-server 生成的包並無寫入硬盤,而是放在內存中！
  output: {
    //文件名
    filename: "[name].js",
    //html引用資源路徑,在dev-server中,引用的是內存中文件！
    publicPath: devConfig.publicPath
  },
  //生成sourceMaps(方便調試)
  devtool: devConfig.devtoolType,
  //
  //啓動一個express服務器,使咱們能夠在本地進行開發！！！
  devServer: {
    //HMR控制檯log等級
    clientLogLevel: "warning",
    // 熱加載
    hot: true,
    //自動刷新
    inline: true,
    //自動打開瀏覽器
    open: true,
    //在開發單頁應用時很是有用，它依賴於HTML5 history API，若是設置爲true，全部的跳轉將指向index.html
    historyApiFallback: true,
    //主機名
    host: devConfig.host,
    //端口號
    port: devConfig.port,
    //配置反向代理解決跨域
    proxy: devConfig.proxyTable,
    //爲你的代碼進行壓縮。加快開發流程和優化的做用
    compress: true,
    // 在瀏覽器上全屏顯示編譯的errors或warnings。
    overlay: {
      errors: true,
      warnings: false
    },
    // 終端輸出的只有初始啓動信息。 webpack 的警告和錯誤是不輸出到終端的
    quiet: true
  },
  module: {
    //處理模塊的規則(可在此處使用不一樣的loader來處理模塊！)
    rules: [
      //使用vue-loader處理以vue結尾的文件！
      {
        test: /\.vue$/,
        loader: "vue-loader",
        options: devConfig.vueloaderConf
      },
      //使用vue-style-loader!css-loader!postcss-loader處理以css結尾的文件！
      {
        test: /\.css$/,
        use: [
          "vue-style-loader",
          {
            loader: "css-loader",
            options: {
              sourceMap: true
            }
          },
          {
            loader: "postcss-loader",
            options: {
              sourceMap: true
            }
          }
        ]
      },
      //使用vue-style-loader!css-loader!postcss-loader處理以less結尾的文件！
      {
        test: /\.less$/,
        use: [
          "vue-style-loader",
          {
            loader: "css-loader",
            options: {
              sourceMap: true
            }
          },
          {
            loader: "less-loader",
            options: {
              sourceMap: true
            }
          },
          {
            loader: "postcss-loader",
            options: {
              sourceMap: true
            }
          }
        ]
      }
    ]
  },
  plugins: [
    //開啓HMR(熱替換功能,替換更新部分,不重載頁面！)
    new webpack.HotModuleReplacementPlugin(),

    //顯示模塊相對路徑
    new webpack.NamedModulesPlugin(),

    //編譯出錯時,該插件可跳過輸出,確保輸出資源不會包含錯誤!
    // new webpack.NoEmitOnErrorsPlugin(),

    //配置html入口信息
    new HtmlWebpackPlugin({
      title: "hello,xc-cli!",
      filename: "index.html",
      template: "index.html",
      //js資源插入位置,true表示插入到body元素底部
      inject: true
    }),

    //編譯提示插件
    new FriendlyErrorsPlugin({
      //編譯成功提示！
      compilationSuccessInfo: {
        messages: [
          `Your application is running here: http://${devConfig.host}:${devConfig.port}`
        ]
      },
      //編譯出錯！
      onErrors: function(severity, errors) {
        if (severity !== "error") {
          return;
        }
        const error = errors[0];
        const filename = error.file.split("!").pop();
        //編譯出錯時,右下角彈出錯誤提示！
        notifier.notify({
          title: "xc-cli",
          message: severity + ": " + error.name,
          subtitle: filename || "",
          icon: path.join(__dirname, "xc-cli.png")
        });
      }
    })
  ]
});
module.exports = devConf;

複製代碼

8.3 經過建立以上文件,並下載相應的依賴和建立項目入口,咱們就能夠經過npm run dev在本地開發vue項目啦！！！

9.建立 build/webpack.prod.conf.js

9.1 此文件主要用於構建生產環境的配置. 9.2

"use strict";
//引入node path路徑模塊
const path = require("path");
//引入webpack
const webpack = require("webpack");
//一個webpack配置合併模塊,可簡單的理解爲與Object.assign()功能相似！
const merge = require("webpack-merge");
//引入webpack生產環境配置參數
const prodConfig = require("../config").build;
//引入webpack基本配置
const baseConf = require("./webpack.base.conf");
//一個建立html入口文件的webpack插件！
const HtmlWebpackPlugin = require("html-webpack-plugin");
//一個抽離出css的webpack插件！
const ExtractTextPlugin = require("extract-text-webpack-plugin");
//一個壓縮css的webpack插件！
const OptimizeCSSPlugin = require("optimize-css-assets-webpack-plugin");
//一個拷貝文件的webpack插件！
const CopyWebpackPlugin = require("copy-webpack-plugin");

//資源路徑
function assetsPath(_path) {
  return path.join(prodConfig.staticPath, _path);
}
//將webpack基本配置與生產環境配置合併！
const prodConf = merge(baseConf, {
  //項目出口配置
  output: {
    //Build後全部文件存放的位置
    path: path.resolve(__dirname, "../public"),
    //html引用資源路徑,可在此配置cdn引用地址！
    publicPath: prodConfig.publicPath,
    //文件名
    filename: assetsPath("js/[name].[chunkhash].js"),
    //用於打包require.ensure(代碼分割)方法中引入的模塊
    chunkFilename: assetsPath("js/[name].[chunkhash].js")
  },
  //生成sourceMaps(方便調試)
  devtool: prodConfig.devtoolType,
  module: {
    //處理模塊的規則(可在此處使用不一樣的loader來處理模塊！)
    rules: [
      //使用vue-loader處理以vue結尾的文件！
      {
        test: /\.vue$/,
        loader: "vue-loader",
        options: prodConfig.vueloaderConf
      },
      {
        test: /\.css$/,
        use: ExtractTextPlugin.extract({
          use: ["css-loader", "postcss-loader"],
          fallback: "vue-style-loader"
        })
      },
      {
        test: /\.less$/,
        use: ExtractTextPlugin.extract({
          use: ["css-loader", "less-loader", "postcss-loader"],
          fallback: "vue-style-loader"
        })
      }
    ]
  },
  plugins: [
    //每一個chunk頭部添加hey,xc-cli!
    new webpack.BannerPlugin("hey,xc-cli"),

    //壓縮js
    new webpack.optimize.UglifyJsPlugin({
      parallel: true,
      compress: {
        warnings: false
      }
    }),

    //分離入口引用的css,不內嵌到js bundle中!

    new ExtractTextPlugin({
      filename: assetsPath("css/[name].[contenthash].css"),
      allChunks: false
    }),

    //壓縮css
    new OptimizeCSSPlugin(),

    //根據模塊相對路徑生成四位數hash值做爲模塊id
    new webpack.HashedModuleIdsPlugin(),

    //做用域提高,提高代碼在瀏覽器執行速度
    new webpack.optimize.ModuleConcatenationPlugin(),

    //抽離公共模塊,合成一個chunk,在最開始加載一次,便緩存使用,用於提高速度!

    // 1. 第三方庫chunk
    new webpack.optimize.CommonsChunkPlugin({
      name: "vendor",
      minChunks: function(module) {
        //在node_modules的js文件!
        return (
          module.resource &&
          /\.js$/.test(module.resource) &&
          module.resource.indexOf(path.join(__dirname, "../node_modules")) === 0
        );
      }
    }),

    // 2. 緩存chunk
    new webpack.optimize.CommonsChunkPlugin({
      name: "manifest",
      minChunks: Infinity
    }),
    // 3.異步 公共chunk
    new webpack.optimize.CommonsChunkPlugin({
      name: "app",
      children: true,
      // (選擇全部被選 chunks 的子 chunks)
      async: true,
      // (建立一個異步 公共chunk)
      minChunks: 3
      // (在提取以前須要至少三個子 chunk 共享這個模塊)
    }),

    //將整個文件複製到構建輸出指定目錄下
    new CopyWebpackPlugin([
      {
        from: path.resolve(__dirname, "../static"),
        to: prodConfig.staticPath,
        ignore: [".*"]
      }
    ]),

    //生成html
    new HtmlWebpackPlugin({
      filename: path.resolve(__dirname, "../public/index.html"),
      template: "index.html",
      favicon: path.resolve(__dirname, "../favicon.ico"),
      //js資源插入位置,true表示插入到body元素底部
      inject: true,
      //壓縮配置
      minify: {
        //刪除Html註釋
        removeComments: true,
        //去除空格
        collapseWhitespace: true,
        //去除屬性引號
        removeAttributeQuotes: true
      },
      //根據依賴引入chunk
      chunksSortMode: "dependency"
    })
  ]
});
module.exports = prodConf;

複製代碼

#10. 建立 build/build.js 10.1 此文件是項目打包服務,用來構建一個全量壓縮包 10.2

"use strict";
//node for loading
const ora = require("ora");
// rm-rf for node
const rm = require("rimraf");
//console for node
const chalk = require("chalk");
//path for node
const path = require("path");
//webpack
const webpack = require("webpack");
//webpack production setting
const config = require("./webpack.prod.conf");
//指定刪除的文件
const rmFile = path.resolve(__dirname, "../public/static");
//build start loading
const spinner = ora("building for production...");
spinner.start();

//構建全量壓縮包！
rm(rmFile, function(err) {
  if (err) throw err;
  webpack(config, function(err, stats) {
    spinner.stop();
    if (err) throw err;
    process.stdout.write(
      stats.toString({
        colors: true,
        modules: false,
        children: false,
        chunks: false,
        chunkModules: false
      }) + "\n\n"
    );

    if (stats.hasErrors()) {
      console.log(chalk.red(" Build failed with errors.\n"));
      process.exit(1);
    }

    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"
      )
    );
  });
});

複製代碼