Vue-cli解析

前言

这段时间,算是空出手来写几篇文章了。由于很久都没有时间整理现在所用的东西了,所以,接下来会慢慢整理出一些文档来记录前段时间的工作和生活。

正文

首先,我们来说一下安装的东西吧!处于有头有尾的目的,还是几句话草草了事。步骤如下:

安装vue-cli

以webpack模版安装目录

这样之后,我们就可以使用IDE打开目录了。

此处注明我的vue-cli的版本2.9.2,以免之后改版之后,误导读者。

之后,附上自己的目录截图,并没有做改动,如图:

'use strict'

constpath=require('path')

constutils=require('./utils')

constconfig=require('../config')

constvueLoaderConfig=require('./vue-loader.conf')

分别是:

path路径

这个模块可以看nodejs官网的介绍,其实,就是一个文件路径的获取和设置等模块,学习node的时候,我们往往会看到这个模块被大量运用。

path模块提供了用于处理文件和目录路径的使用工具

utils.js

我们可以到其中去看一下代码,其实光从名字上我们可以推断出,它可能是为整个脚手架提供方法的。我们可以先来看一下头部引用的资源文件:

constpath=require('path')

constconfig=require('../config')

constExtractTextPlugin=require('extract-text-webpack-plugin')

constpackageConfig=require('../package.json')

同样的,它也引用了path模块和config目录中的index.js文件,之后的话是一个npm包——extract-text-webpack-plugin。这个包的话,是用来分离css和js的内容的。后续我们可以详细了解一下。同时,它还引用的package.json文件,这是一个json文件,加载过来之后,会变成一个对象。

所以,我们需要从它的头部依赖开始说起:

path模块我们之前提到过,这里就不细说。我们可以来分析一下config目录下的index.js文件。

index.js

这个文件中,其实有十分充足的代码注释,我们也可以来深入探究一下。

从代码中,我们可以看到通过module.exports导出了一个对象,其中包含两个设置dev和build。

在dev中,设置了一些配置,代码如下:

modules.exports={dev:{//PathsassetsSubDirectory:'static', assetsPublicPath:'/', proxyTable:{},//Various Dev Server settingshost:'localhost',//can be overwritten by process.env.HOSTport:8080,//can be overwritten by process.env.PORT, if port is in use, a free one will be determinedautoOpenBrowser:false, errorOverlay:true, notifyOnErrors:true, poll:false,//https://webpack.js.org/configuration/dev-server/#devserver-watchoptions-//Use Eslint Loader?//If true, your code will be linted during bundling and//linting errors and warnings will be shown in the console.useEslint:true,//If true, eslint errors and warnings will also be shown in the error overlay//in the browser.showEslintErrorsInOverlay:false,/*** Source Maps*///https://webpack.js.org/configuration/devtool/#developmentdevtool:'eval-source-map',//If you have problems debugging vue-files in devtools,//set this to false - it *may* help//https://vue-loader.vuejs.org/en/options.html#cachebustingcacheBusting:true,//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.cssSourceMap:false, } }

通过它的注释,我们可以理解它在dev中配置了静态路径、本地服务器配置项、Eslint、Source Maps等参数。如果我们需要在开发中,改动静态资源文件、服务器端口等设置,可以在这个文件中进行修改。

下面还有一个build的对象,它是在vue本地服务器启动时,打包的一些配置, 代码如下:

build:{//Template for index.htmlindex:path.resolve(__dirname,'../dist/index.html'),//PathsassetsRoot:path.resolve(__dirname,'../dist'), assetsSubDirectory:'static', assetsPublicPath:'/',/*** Source Maps*/productionSourceMap:true,//https://webpack.js.org/configuration/devtool/#productiondevtool:'#source-map',//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-pluginproductionGzip:false, 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 offbundleAnalyzerReport:process.env.npm_config_report}

其中包括模版文件的修改,打包完目录之后的一些路径设置,gzip压缩等。明白了这些字段的意思之后,就可以在之后的开发中,主动根据项目需求,改动目录内容。

聊完config下的index.js文件,回到utils.js文件中,我们可以来看几个其中的方法,来分析它们分别起到了什么作用。

assetsPath方法

接受一个_path参数

返回static目录位置拼接的路径。

它根据nodejs的proccess.env.NODE_ENV变量,来判断当前运行的环境。返回不同环境下面的不同static目录位置拼接给定的_path参数。

cssLoaders方法

接受一个options参数,参数还有的属性:sourceMap、usePostCSS。

同时,这里用到了我们之前提到的extract-text-webpack-plugin插件,来分离出js中的css代码,然后分别进行打包。同时,它返回一个对象,其中包含了css预编译器(less、sass、stylus)loader生成方法等。如果你的文档明确只需要一门css语言,那么可以稍微清楚一些语言,同时可以减少npm包的大小(毕竟这是一个令人烦躁的东西)。

styleLoaders方法

接受的options对象和上面的方法一致。该方法只是根据cssLoaders中的方法配置,生成不同loaders。然后将其返回。

createNotifierCallback方法

此处调用了一个模块,可以在GitHub上找到,它是一个原生的操作系统上发送通知的nodeJS模块。用于返回脚手架错误的函数

一共这么四个函数方法,在utils中被定义到。

这个文件中的代码非常的少,我们可以直接贴上代码,然后来分析,其中的作用。代码如下:

'use strict'

constutils=require('./utils')

constconfig=require('../config')

constisProduction=process.env.NODE_ENV==='production'

constsourceMapEnabled=isProduction?config.build.productionSourceMap:config.dev.cssSourceMap

module.exports={ loaders:utils.cssLoaders({ sourceMap:sourceMapEnabled, extract:isProduction }), cssSourceMap:sourceMapEnabled, cacheBusting:config.dev.cacheBusting, transformToRequire:{ video:['src','poster'], source:'src', img:'src', image:'xlink:href'}}

其中,主要就是根据NODE_ENV这个变量,然后分析是否是生产环境,然后将根据不同的环境来加载,不同的环境,来判断是否开启了sourceMap的功能。方便之后在cssLoaders中加上sourceMap功能。然后判断是否设置了cacheBusting属性,它指的是缓存破坏,特别是进行sourceMap debug时,设置成false是非常有帮助的。最后就是一个转化请求的内容,video、source、img、image等的属性进行配置。

具体的还是需要去了解vue-loader这个webpack的loader加载器。

其实的两个方法,其中一个是来合并path路径的,另一个是加载Eslint的rules的。

我们直接看后面那个函数,createLintingRule方法:

其中,加载了一个formatter,这个可以在终端中显示eslint的规则错误,方便开发者直接找到相应的位置,然后修改代码。

之后的一个对象,就是webpack的基础配置信息。我们可以逐一字段进行分析:

context => 运行环境的上下文,就是实际的目录

entry => 入口文件:src下的main.js文件

output => 输出内容,这内部的配置会根据不同的运行环境来进行变化

resolve => 其中的extensions字段,指定检测的文件后缀,同时alias是用于指定别名的。在引用文件路径中,如果有别名的符号,会被替换成指定的路径。

module => 配置了一些eslint、vue、js、图片资源、字体图标、文件等加载的loader。详细的可以去看webpack的官方网站。

node => 此处部分有注释,主要是阻止一些webpack的默认注入行为,因为在vue中,已经具备了这些功能。

这个文件中,引用了webapck-merge这npm包,它可以将两个配置对象,进行合并。代码如下:

constmerge=require('webpack-merge');

constdevWebpackConfig=merge(baseWebpackConfig, {

...

})

这样就合并了base中的webpack配置项。之后,我们可以来看一下dev环境中的新增了那些配置项,它们分别起到了什么作用?

首先,在module的rules中增加了cssSourceMap的功能

然后就是devtools,通过注释的英文翻译,可以知道cheap-module-eval-source-map使得开发更快。

之后,就是devSever的一些配置项了。其中包块客户端报错级别、端口、host等等

还有新增的plugins,我们可以来看一下实际新增的plugins(具体可以看webpack文档):

定义process.env

HotModuleReplacementPlugin: 模块热替换插件

NameModulesPlugin: 显示模块加载相对路径插件

NoEmitOnErrorsPlugin: 在编译出现错误时,使用 NoEmitOnErrorsPlugin 来跳过输出阶段。这样可以确保输出资源不会包含错误

HtmlWebpackPlugin: 使用插件生成一个指定的模版。

之后,还有一个函数,确保启动程序时,如果端口被占用时,会通过portfinder来发布新的端口,然后输出运行的host字符串。

新增了output的配置,我们可以看到它在output中新增了一些属性,将js打包成不同的块chunk,然后使用hash尾缀进行命名

添加了一些插件:

UglifJsPlugin: 这个是用来丑化js代码的

ExtractTextplugin: 这里新增了一些属性,在打包的css文件也增加了块和hash尾缀

OptimizeCssplugin: 这里是来优化css文件的,主要就是压缩css代码

HashedModuleIdsPlugin: 保证module的id值稳定

optimize: 这里是webpack一系列优化的措施,具体可以逐一查看官方文档

CopyWebPlugins: 自定义assets文件目录

如果没有进行gzip压缩,调用CompressionWebpackPlugin插件进行压缩

这样,我们的webpack配置文件内容基本上就全部看完了。或许,会有点蒙,还是看官方文档来的实在。

最后,还需要分析一个build.js文件。

build.js

这个文件是在打包的时候,会被用到的。

首先,文件的开头请求了check-version.js中的函数,然后确定了一下node和npm的版本。相对于较低版本的node和npm,在打包过程中,会产生警告。之后,设置环境参数,设置成生产环境,之后就是一系列打包的流程。

总结

本篇文章,主要总结了一下vue-cli生成的文件中,其中的一些配置参数和文件大致的作用。有不到位的地方,希望大家可以指正。同时希望我们共同进步,共勉。

如果你对我写的有疑问,可以评论,如我写的有错误,欢迎指正。你喜欢我的博客,请给我关注Star~呦github博客

  • 发表于:
  • 原文链接http://kuaibao.qq.com/s/20171226G05B8S00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。

扫码关注云+社区

领取腾讯云代金券