题言:
相信很多vue新手,都像我一样,只是知道可以用vue-cli直接生成一个vue项目的架构,并不明白,他究竟是怎么运行的,现在我们一起来研究一下。。。
一、安装vue-cli,相信你既然会用到vue-cli,自然node环境是OK的,直接命令行下安装
npm install -g vue-cli
二、使用vue-cli创建vue项目
用法: vue init <template-name> <project-name>
template-name:
. webpack
. webpack-simple // 一个简单webpack+vue-loader的模板,不包含其他功能。
. browserify // 一个全面的Browserify+vueify 的模板,功能包括热加载,linting,单元检测。
. browserify-simple // 一个简单Browserify+vueify的模板,不包含其他功能。
. pwa // 基于webpack模板的vue-cli的PWA模板
. simple // 一个最简单的单页应用模板
常用的就是webpack了,模板之间的不同,自己体验
示例:
vue init webpack my-project
执行指令后,会让用户输入几个基本的选项,如图所示
需要注意的是项目的名称不能大写,不然会报错。
- Project name :项目名称 ,如果不需要更改直接回车就可以了。注意:这里不能使用大写。
- Project description:项目描述,默认为A Vue.js project,直接回车,不用编写。
- Author:作者,如果你有配置git,他会读取.ssh文件中的user。
- Install vue-router? 是否安装vue的路由插件,Y代表安装,N无需安装,下面的命令也是一样的。
- Use ESLint to lint your code? 是否用ESLint来限制你的代码错误和风格
- setup unit tests with Karma + Mocha? 是否需要安装单元测试工具Karma+Mocha。
- Setup e2e tests with Nightwatch?是否安装e2e来进行用户行为模拟测试。
- Should we run npm install for you after the project has been created?(recommended)npm
询问你使用npm安装还是yarn安装包依赖,我这里选择的是npm,yarn更快更好,使用yarn之前确保你的电脑已经安装yarn。
根据提示,待模板加载完成之后,执行下面两条命令1
2
3cd my-project
npm run dev // dev代表下图框选的内容
出现如图,就是编译成功了,英文稍微好点,就能读懂
这时候,鼠标放到 http://localhost:8080 会提示用“Alt+点击”即可访问;
出现如图,就成功创建了项目;
三、文件目录结构
本文主要分析开发(dev)和构建(build)两个过程涉及到的文件,故下面文件结构仅列出相应的内容。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31|-- build // 项目构建(webpack)相关代码
| |-- build.js // 生产环境构建代码
| |-- check-version.js // 检查node、npm等版本
| |-- utils.js // 构建工具相关
| |-- vue-loader.conf.js // webpack loader配置
| |-- webpack.base.conf.js // webpack基础配置
| |-- webpack.dev.conf.js // webpack开发环境配置,构建开发本地服务器
| |-- webpack.prod.conf.js // webpack生产环境配置
|-- config // 项目开发环境配置
| |-- dev.env.js // 开发环境变量
| |-- index.js // 项目一些配置变量
| |-- prod.env.js // 生产环境变量
| |-- test.env.js // 测试脚本的配置
|-- src // 源码目录
| |-- components // vue所有组件
| |-- router // vue的路由管理
| |-- App.vue // 页面入口文件
| |-- main.js // 程序入口文件,加载各种公共组件
|-- static // 静态文件,比如一些图片,json数据等
|-- test // 测试文件
| |-- e2e // e2e 测试
| |-- unit // 单元测试
|-- .babelrc // ES6语法编译配置
|-- .editorconfig // 定义代码格式
|-- .eslintignore // eslint检测代码忽略的文件(夹)
|-- .eslintrc.js // 定义eslint的plugins,extends,rules
|-- .gitignore // git上传需要忽略的文件格式
|-- .postcsssrc // postcss配置文件
|-- README.md // 项目说明,markdown文档
|-- index.html // 访问的页面
|-- package.json // 项目基本信息,包依赖信息等
如图所示:
下边是具体文件的具体分析
1. package.json文件
package.json文件是项目的配置文件,定义了项目的基本信息以及项目的相关包依赖,npm运行命令等
scripts 里定义的是一些比较长的命令,用node去执行一段命令,比如
npm run dev
其实就是执行
webpack-dev-server --inline --progress --config build/webpack.dev.conf.js
这句话的意思是利用 webpack-dev-server 读取 webpack.dev.conf.js 信息并启动一个本地服务器。
2. dependencies VS devDependencies
简单的来说1
2dependencies 是运行时依赖(生产环境) npm install --save **(package name)
devDependencies 是开发时的依赖(开发环境) npm install --save-dev **(package name)
3. 基础配置文件 webpack.base.conf.js
基础的 webpack 配置文件主要根据模式定义了入口出口,以及处理 vue, babel等的各种模块,是最为基础的部分。其他模式的配置文件以此为基础通过 webpack-merge 合并。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108'use strict'
const path = require('path')
const utils = require('./utils')
const config = require('../config')
const vueLoaderConfig = require('./vue-loader.conf')
// 获取绝对路径
function resolve (dir) {
return path.join(__dirname, '..', dir)
}
<!-- 定义一下代码检测的规则 -->
const createLintingRule = () => ({
test: /\.(js|vue)$/,
loader: 'eslint-loader',
enforce: 'pre',
include: [resolve('src'), resolve('test')],
options: {
formatter: require('eslint-friendly-formatter'),
emitWarning: !config.dev.showEslintErrorsInOverlay
}
})
module.exports = {
// 基础上下文
context: path.resolve(__dirname, '../'),
// webpack的入口文件
entry: {
app: './src/main.js'
},
// webpack的输出文件
output: {
path: config.build.assetsRoot,
filename: '[name].js',
publicPath: process.env.NODE_ENV === 'production'
? config.build.assetsPublicPath
: config.dev.assetsPublicPath
},
/**
* 当webpack试图去加载模块的时候,它默认是查找以 .js 结尾的文件的,
* 它并不知道 .vue 结尾的文件是什么鬼玩意儿,
* 所以我们要在配置文件中告诉webpack,
* 遇到 .vue 结尾的也要去加载,
* 添加 resolve 配置项,如下:
*/
resolve: {
extensions: ['.js', '.vue', '.json'],
alias: { // 创建别名
'vue$': 'vue/dist/vue.esm.js',
'@': resolve('src'), // 如 '@/components/HelloWorld'
}
},
// 不同类型模块的处理规则 就是用不同的loader处理不同的文件
module: {
rules: [
...(config.dev.useEslint ? [createLintingRule()] : []),
{// 对所有.vue文件使用vue-loader进行编译
test: /\.vue$/,
loader: 'vue-loader',
options: vueLoaderConfig
},
{// 对src和test文件夹下的.js文件使用babel-loader将es6+的代码转成es5
test: /\.js$/,
loader: 'babel-loader',
include: [resolve('src'), resolve('test'), resolve('node_modules/webpack-dev-server/client')]
},
{// 对图片资源文件使用url-loader
test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
loader: 'url-loader',
options: {
// 小于10K的图片转成base64编码的dataURL字符串写到代码中
limit: 10000,
// 其他的图片转移到静态资源文件夹
name: utils.assetsPath('img/[name].[hash:7].[ext]')
}
},
{// 对多媒体资源文件使用url-loader
test: /\.(mp4|webm|ogg|mp3|wav|flac|aac)(\?.*)?$/,
loader: 'url-loader',
options: {
// 小于10K的资源转成base64编码的dataURL字符串写到代码中
limit: 10000,
// 其他的资源转移到静态资源文件夹
name: utils.assetsPath('media/[name].[hash:7].[ext]')
}
},
{// 对字体资源文件使用url-loader
test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
loader: 'url-loader',
options: {
limit: 10000,
name: utils.assetsPath('fonts/[name].[hash:7].[ext]') // hash:7 代表 7 位数的 hash
}
}
]
},
node: {
// prevent webpack from injecting useless setImmediate polyfill because Vue
// source contains it (although only uses it if it's native).
setImmediate: false,
// prevent webpack from injecting mocks to Node native modules
// that does not make sense for the client
dgram: 'empty',
fs: 'empty',
net: 'empty',
tls: 'empty',
child_process: 'empty'
}
}
4. 开发环境配置文件 webpack.dev.conf.js
1 | 'use strict' |
5. 生产模式配置文件 webpack.prod.conf.js
1 | 'use strict' |
6. build.js 编译入口
1 | 'use strict' |
7. 实用代码段 utils.js
1 | 'use strict' |
8. babel配置文件.babelrc
1 | { //设定转码规则 |
9 .编码规范.editorconfig (自定义)
1 | root = true |
10 .src/app.vue文件解读
1 | <template> |
<template></template> 标签包裹的内容:这是模板的HTMLDom结构
<script></script> 标签包括的js内容:你可以在这里写一些页面的js的逻辑代码。
<style></style> 标签包裹的css内容:页面需要的CSS样式。
11. src/router/index.js 路由文件
1 | import Vue from 'vue' |
12. eslint的相关配置(按照AirBnb的规则检测);
网上看了张挺有意思的图:
vue-cli项目图:
写在最后: 关于配置文件的注释都写在代码里了,可以单独Copy出来看,有什么好的想法或者建议,可以加我微信,欢迎交流……
参考文章: