一步步教你利用webpack如何搭一個(gè)vue腳手架(超詳細(xì)講解和注釋)
Vue作為前端三大框架之一截至到目前在github上以收獲44,873顆星,足以說明其以悄然成為主流。16年10月Vue發(fā)布了2.x版本,經(jīng)過了一段時(shí)間的摸索和看官方的教程和api,才了解到2.0版本在1.0版本的基礎(chǔ)上做了好多調(diào)整,廢棄了好多api。
本文將詳細(xì)介紹關(guān)于利用webpack搭一個(gè)vue腳手架的相關(guān)內(nèi)容,分享出來供大家參考學(xué)習(xí),下面話不多說了,來一起看看詳細(xì)的介紹吧。
一.適用人群
1.對webpack知識(shí)有一定了解但不熟悉的同學(xué).
2.女同學(xué)?。?!(233333....)
二.目的
在自己對webpack有進(jìn)一步了解的同時(shí),也希望能幫到一些剛接觸webpack的同學(xué).
腳手架已放上github,不想聽我啰嗦的同學(xué)可以直接去download或clone下來看哦.
腳手架里都有詳細(xì)注釋!
源碼:https://github.com/webfansplz/xc-cli.git (本地下載)
覺得有幫助到你的同學(xué)給個(gè)star哈,也算是對我的一種支持!
三.腳手架結(jié)構(gòu)
├── build 構(gòu)建服務(wù)和webpack配置 |—— build.js webpack打包服務(wù) |—— webpack.base.conf.js webpack基本通用配置 |—— webpack.dev.conf.js webpack開發(fā)環(huán)境配置 |—— webpack.prod.conf.js webpack生產(chǎn)環(huán)境配置 ├── config 構(gòu)建項(xiàng)目不同環(huán)境的配置 ├── public 項(xiàng)目打包文件存放目錄 ├── index.html 項(xiàng)目入口文件 ├── package.json 項(xiàng)目配置文件 ├── static 靜態(tài)資源 ├── .babelrc babel配置文件 ├── .gitignore git忽略文件 ├── postcss.config.js postcss配置文件 ├── src 項(xiàng)目目錄 |—— page 頁面組件目錄 |—— router vue路由配置 |—— store vuex配置 |—— App.vue vue實(shí)例入口 |—— main.js 項(xiàng)目構(gòu)建入口
四.配置npm scripts
4.1 生成package.json文件,配置npm scripts.
4.1.1 使用 npm init 命令,生成一個(gè)package.json文件!
npm init
4.1.2 全局安裝webpack和webpack-dev-server
npm install webpack webpack-dev-server -g
4.1.3 在項(xiàng)目目錄下安裝webpack和webpack-dev-server
npm install webpack webpack-dev-server -D
4.1.4 進(jìn)入package.json配置npm scripts命令
"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在本地進(jìn)行開發(fā),
scripts.dev命令解讀:
通過webpack-dev-server命令 啟動(dòng)build文件夾下webpack.dev.conf.js。
也可以通過npm run build 打包項(xiàng)目文件進(jìn)行線上部署.
scripts.build命令解讀:
通過node命令構(gòu)建build文件夾下的build.js。
命令的配置可以根據(jù)自己腳手架的配置文件位置和名稱不同修改哦!
五.構(gòu)建腳手架目錄
同學(xué)們可以通過自己的習(xí)慣和喜愛搭建自己的腳手架目錄,下面講解以上面腳手架結(jié)構(gòu)為準(zhǔn)!
六.構(gòu)建config/config.js
6.1 該文件主要用來配置構(gòu)建開發(fā)環(huán)境和生產(chǎn)環(huán)境差異化的參數(shù).
6.2
const _path = require("path"); const ExtractTextPlugin = require("extract-text-webpack-plugin"); //vue-loader基本配置 const baseVueLoaderConf = { //引入postcss插件 postcss: { config: { path: _path.resolve("../") } }, //轉(zhuǎn)為require調(diào)用,讓webpack處理目標(biāo)資源! transformToRequire: { video: "src", source: "src", img: "src", image: "xlink:href" } }; //vue-loader 開發(fā)環(huán)境配置 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 生產(chǎn)環(huán)境配置 const buildVueLoaderConf = Object.assign({}, baseVueLoaderConf, { //loaders loaders: ExtractTextPlugin.extract({ use: ["css-loader", "postcss-loader", "less-loader"], fallback: "vue-style-loader" }), cssSourceMap: false }); //開發(fā)/生產(chǎn)環(huán)境 配置參數(shù)! 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" } };
七.構(gòu)建build/webpack.base.conf.js
7.1 此文件主要是webpack開發(fā)環(huán)境和生成環(huán)境的通用配置.
7.2
"use strict"; //引入node path路徑模塊 const path = require("path"); //引入webpack生產(chǎn)環(huán)境配置參數(shù) const prodConfig = require("../config").build; //拼接路徑 function resolve(track) { return path.join(__dirname, "..", track); } //資源路徑 function assetsPath(_path) { return path.join(prodConfig.staticPath, _path); } //webpack 基本設(shè)置 module.exports = { //項(xiàng)目入口文件->webpack從此處開始構(gòu)建! entry: path.resolve(__dirname, "../src/main.js"), //配置模塊如何被解析 resolve: { //自動(dòng)解析文件擴(kuò)展名(補(bǔ)全文件后綴)(從左->右) // 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' // 鍵后加上$,表示精準(zhǔn)匹配! vue$: "vue/dist/vue.esm.js", "@": resolve("src"), utils: resolve("src/utils"), components: resolve("src/components"), public: resolve("public") } }, module: { //處理模塊的規(guī)則(可在此處使用不同的loader來處理模塊!) rules: [ //使用babel-loader來處理src下面的所有js文件,具體babel配置在.babelrc,主要是用來轉(zhuǎn)義es6 { test: /\.js$/, use: { loader: "babel-loader" }, include: resolve("src") }, //使用url-loader(file-loader的一個(gè)再封裝)對引入的圖片進(jìn)行編碼,此處可將小于8192字節(jié)(8kb)的圖片轉(zhuǎn)為DataURL(base64), //大于limit字節(jié)的會(huì)調(diào)用file-loader進(jìn)行處理! //圖片一般發(fā)布后都是長緩存,故此處文件名加入hash做版本區(qū)分! { test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, loader: "url-loader", options: { limit: 8192, name: assetsPath("img/[name].[hash:8].[ext]") } } ] } };
八.構(gòu)建 build/webpack.dev.conf.js
8.1 該文件主要用于構(gòu)建開發(fā)環(huán)境
8.2
"use strict"; //引入node path路徑模塊 const path = require("path"); //引入webpack const webpack = require("webpack"); //引入webpack開發(fā)環(huán)境配置參數(shù) const devConfig = require("../config").dev; //引入webpack基本配置 const baseConf = require("./webpack.base.conf"); //一個(gè)webpack配置合并模塊,可簡單的理解為與Object.assign()功能類似! const merge = require("webpack-merge"); //一個(gè)創(chuàng)建html入口文件的webpack插件! const HtmlWebpackPlugin = require("html-webpack-plugin"); //一個(gè)編譯提示的webpack插件! const FriendlyErrorsPlugin = require("friendly-errors-webpack-plugin"); //發(fā)送系統(tǒng)通知的一個(gè)node模塊! const notifier = require("node-notifier"); //將webpack基本配置與開發(fā)環(huán)境配置合并! const devConf = merge(baseConf, { //項(xiàng)目出口,webpack-dev-server 生成的包并沒有寫入硬盤,而是放在內(nèi)存中! output: { //文件名 filename: "[name].js", //html引用資源路徑,在dev-server中,引用的是內(nèi)存中文件! publicPath: devConfig.publicPath }, //生成sourceMaps(方便調(diào)試) devtool: devConfig.devtoolType, // //啟動(dòng)一個(gè)express服務(wù)器,使我們可以在本地進(jìn)行開發(fā)?。?! devServer: { //HMR控制臺(tái)log等級 clientLogLevel: "warning", // 熱加載 hot: true, //自動(dòng)刷新 inline: true, //自動(dòng)打開瀏覽器 open: true, //在開發(fā)單頁應(yīng)用時(shí)非常有用,它依賴于HTML5 history API,如果設(shè)置為true,所有的跳轉(zhuǎn)將指向index.html historyApiFallback: true, //主機(jī)名 host: devConfig.host, //端口號(hào) port: devConfig.port, //配置反向代理解決跨域 proxy: devConfig.proxyTable, //為你的代碼進(jìn)行壓縮。加快開發(fā)流程和優(yōu)化的作用 compress: true, // 在瀏覽器上全屏顯示編譯的errors或warnings。 overlay: { errors: true, warnings: false }, // 終端輸出的只有初始啟動(dòng)信息。 webpack 的警告和錯(cuò)誤是不輸出到終端的 quiet: true }, module: { //處理模塊的規(guī)則(可在此處使用不同的loader來處理模塊!) rules: [ //使用vue-loader處理以vue結(jié)尾的文件! { test: /\.vue$/, loader: "vue-loader", options: devConfig.vueloaderConf }, //使用vue-style-loader!css-loader!postcss-loader處理以css結(jié)尾的文件! { 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結(jié)尾的文件! { 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(), //編譯出錯(cuò)時(shí),該插件可跳過輸出,確保輸出資源不會(huì)包含錯(cuò)誤! // 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}` ] }, //編譯出錯(cuò)! onErrors: function(severity, errors) { if (severity !== "error") { return; } const error = errors[0]; const filename = error.file.split("!").pop(); //編譯出錯(cuò)時(shí),右下角彈出錯(cuò)誤提示! notifier.notify({ title: "xc-cli", message: severity + ": " + error.name, subtitle: filename || "", icon: path.join(__dirname, "xc-cli.png") }); } }) ] }); module.exports = devConf;
8.3 通過創(chuàng)建以上文件,并下載相應(yīng)的依賴和創(chuàng)建項(xiàng)目入口,我們就可以通過npm run dev在本地開發(fā)vue項(xiàng)目啦?。?!
九.創(chuàng)建 build/webpack.prod.conf.js
9.1 此文件主要用于構(gòu)建生產(chǎn)環(huán)境的配置.
9.2
"use strict"; //引入node path路徑模塊 const path = require("path"); //引入webpack const webpack = require("webpack"); //一個(gè)webpack配置合并模塊,可簡單的理解為與Object.assign()功能類似! const merge = require("webpack-merge"); //引入webpack生產(chǎn)環(huán)境配置參數(shù) const prodConfig = require("../config").build; //引入webpack基本配置 const baseConf = require("./webpack.base.conf"); //一個(gè)創(chuàng)建html入口文件的webpack插件! const HtmlWebpackPlugin = require("html-webpack-plugin"); //一個(gè)抽離出css的webpack插件! const ExtractTextPlugin = require("extract-text-webpack-plugin"); //一個(gè)壓縮css的webpack插件! const OptimizeCSSPlugin = require("optimize-css-assets-webpack-plugin"); //一個(gè)拷貝文件的webpack插件! const CopyWebpackPlugin = require("copy-webpack-plugin"); //資源路徑 function assetsPath(_path) { return path.join(prodConfig.staticPath, _path); } //將webpack基本配置與生產(chǎn)環(huán)境配置合并! const prodConf = merge(baseConf, { //項(xiàng)目出口配置 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(方便調(diào)試) devtool: prodConfig.devtoolType, module: { //處理模塊的規(guī)則(可在此處使用不同的loader來處理模塊!) rules: [ //使用vue-loader處理以vue結(jié)尾的文件! { 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: [ //每個(gè)chunk頭部添加hey,xc-cli! new webpack.BannerPlugin("hey,xc-cli"), //壓縮js new webpack.optimize.UglifyJsPlugin({ parallel: true, compress: { warnings: false } }), //分離入口引用的css,不內(nèi)嵌到j(luò)s bundle中! new ExtractTextPlugin({ filename: assetsPath("css/[name].[contenthash].css"), allChunks: false }), //壓縮css new OptimizeCSSPlugin(), //根據(jù)模塊相對路徑生成四位數(shù)hash值作為模塊id new webpack.HashedModuleIdsPlugin(), //作用域提升,提升代碼在瀏覽器執(zhí)行速度 new webpack.optimize.ModuleConcatenationPlugin(), //抽離公共模塊,合成一個(gè)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, // (創(chuàng)建一個(gè)異步 公共chunk) minChunks: 3 // (在提取之前需要至少三個(gè)子 chunk 共享這個(gè)模塊) }), //將整個(gè)文件復(fù)制到構(gòu)建輸出指定目錄下 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, //去除屬性引號(hào) removeAttributeQuotes: true }, //根據(jù)依賴引入chunk chunksSortMode: "dependency" }) ] }); module.exports = prodConf;
十. 創(chuàng)建 build/build.js
10.1 此文件是項(xiàng)目打包服務(wù),用來構(gòu)建一個(gè)全量壓縮包
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(); //構(gòu)建全量壓縮包! 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" ) ); }); });
10.3 創(chuàng)建好以上文件 我們就可以通過npm run build來打包我們的項(xiàng)目文件并部署上線啦。
十一.大功告成!
通過以上步驟,一個(gè)spa版的vue腳手架就大功告成啦!
如果對一些細(xì)節(jié)不懂的可以留言或者上我的github查看
地址:https://github.com/webfansplz/xc-cli.git (本地下載)
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
相關(guān)文章
Vue父子組建的簡單通信之控制開關(guān)Switch的實(shí)現(xiàn)
這篇文章主要介紹了Vue父子組建的簡單通信之控制開關(guān)Switch的實(shí)現(xiàn),小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-06-06el-table?樹形數(shù)據(jù)?tree-props?多層級使用避坑
本文主要介紹了el-table?樹形數(shù)據(jù)?tree-props?多層級使用避坑,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-08-08vue實(shí)現(xiàn)同一個(gè)頁面可以有多個(gè)router-view的方法
今天小編就為大家分享一篇vue實(shí)現(xiàn)同一個(gè)頁面可以有多個(gè)router-view的方法,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-09-09詳解Vue Elementui中的Tag與頁面其它元素相互交互的兩三事
這篇文章主要介紹了詳解Vue Elementui中的Tag與頁面其它元素相互交互的兩三事,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-09-09Vue3使用transition實(shí)現(xiàn)組件切換的過渡效果
<Transition> 是一個(gè)內(nèi)置組件,這意味著它在任意別的組件中都可以被使用,無需注冊,它可以將進(jìn)入和離開動(dòng)畫應(yīng)用到通過默認(rèn)插槽傳遞給它的元素或組件上,本文介紹了Vue3使用transition實(shí)現(xiàn)組件切換的過渡效果,需要的朋友可以參考下2024-09-09vue中axios的get請求和post請求的傳參方式、攔截器示例代碼
Post是向服務(wù)器提交數(shù)據(jù)的一種請求,get是向服務(wù)器發(fā)索取數(shù)據(jù)的一種請求,post在真正接受數(shù)據(jù)之前會(huì)先將請求頭發(fā)送給服務(wù)器進(jìn)行確認(rèn),然后才真正發(fā)送數(shù)據(jù),本文給大家介紹vue中axios的get請求和post請求的傳參方式、攔截器示例代碼,感興趣的朋友一起看看吧2023-10-10Vue中使用vue-i18插件實(shí)現(xiàn)多語言切換功能
在基于vue-cli項(xiàng)目開發(fā)過程中,多語言切換功能可使用vue-i18插件,這篇文章分步驟給大家介紹了Vue中使用vue-i18插件實(shí)現(xiàn)多語言切換功能,感興趣的朋友一起看看吧2018-04-04