vue-cli3脚手架文件详解
前言
vue-cli是构建vue单页应用的脚手架,输入一串指定的命令行从而自动生成vue.js+webpack的项目模板。这其中webpack发挥了很大的作用,它使得我们的代码模块化,引入一些插件帮我们完善功能可以将文件打包压缩,图片转base64等。后期对项目的配置使得我们对于脚手架自动生成的代码的理解更为重要。
主体结构
├─.git
├─node_modules
├─public
│ ├─favicon.ico
│ ├─index.html
├─src
│ ├─assets
│ ├─components
│ ├─App.vue
│ ├─main.js
├─.gitignore
├─babel.config.js
├─package.json
├─package-lock.json
└─README.md.git文件
git忽略的文件,远程push时不会上传
node_modules文件夹
存放的是npm加载的项目依赖模块 ,以后要添加依赖也是放在这个里面
public文件夹
跟src里的assets文件夹一样,都是放置静态文件。public放不会改动的文件,这里面的内容可以使引用的,不是由自己编写的内容。基本不会改动的内容(如index.html入口页面)
src文件夹
我们开发的代码都存放在src目录下,根据需要我们通常会再建一些文件夹。比如新建pages文件夹,用来存放页面。components文件夹存放组件;api或request文件夹,来封装请求的参数和方法;router文件夹,一般存放路由文件;store文件夹,使用vuex来作为vue的状态管理工具,我也常叫它作前端的数据库等。
①.assets文件:assets放可能会变动的文件(自己写的js文件等等可能需要改动的文件),脚手架自动会放入一个图片在里面作为初始页面的logo。平常我们使用的时候会在里面建立js,css,img,fonts等文件夹,作为静态资源调用
②.components文件夹:用来存放组件,合理地使用组件可以高效地实现复用等功能,从而更好地开发项目。一般情况下比如创建头部组件的时候,我们会新建一个header的文件夹,然后再新建一个header.vue的文件
③.router文件夹:该文件夹下有一个叫index.js文件,用于实现页面的路由跳转。
④.App.vue:作为我们的主组件,可通过使用<router-view/>开放入口让其他的页面组件得以显示。
⑤.main.js:作为我们的入口文件,主要作用是初始化vue实例并使用需要的插件,小型项目省略router时可放在该处
package.json文件
项目作为一个大家庭,每个文件都各司其职。package.json来制定名单,需要哪些npm包来参与到项目中来,npm install命令根据这个配置文件增减来管理本地的安装包。
{
//从name到private都是package的配置信息,也就是我们在脚手架搭建中输入的项目描述
"name": "shop",//项目名称:不能以.(点)或者_(下划线)开头,不能包含大写字母,具有明确的的含义与现有项目名字不重复
"version": "1.0.0",//项目版本号:遵循"大版本.次要版本.小版本"
"description": "A Vue.js project",//项目描述
"author": "qietuniu",//作者名字
"private": true,//是否私有
//scripts中的子项即是我们在控制台运行的脚本的缩写
"scripts": {
//①webpack-dev-server:启动了http服务器,实现实时编译;
//inline模式会在webpack.config.js入口配置中新增webpack-dev-server/client?http://localhost:8080/的入口,使得我们访问路径为localhost:8080/index.html(相应的还有另外一种模式Iframe);
//progress:显示打包的进度
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
"start": "npm run dev",//与npm run dev相同,直接运行开发环境
"build": "node build/build.js"//使用node运行build文件
},
//②dependencies(项目依赖库):在安装时使用--save则写入到dependencies
"dependencies": {
"vue": "^2.5.2",//vue.js
"vue-router": "^3.0.1"//vue的路由插件
},
//和devDependencies(开发依赖库):在安装时使用--save-dev将写入到devDependencies
"devDependencies": {
"autoprefixer": "^7.1.2",//autoprefixer作为postcss插件用来解析CSS补充前缀,例如 display: flex会补充为display:-webkit-box;display: -webkit-flex;display: -ms-flexbox;display: flex。
//babel:以下几个babel开头的都是针对es6解析的插件。用最新标准编写的 JavaScript 代码向下编译成可以在今天随处可用的版本
"babel-core": "^6.22.1",//babel的核心,把 js 代码分析成 ast ,方便各个插件分析语法进行相应的处理。
"babel-helper-vue-jsx-merge-props": "^2.0.3",//预制babel-template函数,提供给vue,jsx等使用
"babel-loader": "^7.1.1",//使项目运行使用Babel和webpack来传输js文件,使用babel-core提供的api进行转译
"babel-plugin-syntax-jsx": "^6.18.0",//支持jsx
"babel-plugin-transform-runtime": "^6.22.0",//避免编译输出中的重复,直接编译到build环境中
"babel-plugin-transform-vue-jsx": "^3.5.0",//babel转译过程中使用到的插件,避免重复
"babel-preset-env": "^1.3.2",//转为es5,transform阶段使用到的插件之一
"babel-preset-stage-2": "^6.22.0",//ECMAScript第二阶段的规范
"chalk": "^2.0.1",//用来在命令行输出不同颜色文字
"copy-webpack-plugin": "^4.0.1",//拷贝资源和文件
"css-loader": "^0.28.0",//webpack先用css-loader加载器去解析后缀为css的文件,再使用style-loader生成一个内容为最终解析完的css代码的style标签,放到head标签里
"extract-text-webpack-plugin": "^3.0.0",//将一个以上的包里面的文本提取到单独文件中
"file-loader": "^1.1.4",//③打包压缩文件,与url-loader用法类似
"friendly-errors-webpack-plugin": "^1.6.1",//识别某些类别的WebPACK错误和清理,聚合和优先排序,以提供更好的开发经验
"html-webpack-plugin": "^2.30.1",//简化了HTML文件的创建,引入了外部资源,创建html的入口文件,可通过此项进行多页面的配置
"node-notifier": "^5.1.2",//支持使用node发送跨平台的本地通知
"optimize-css-assets-webpack-plugin": "^3.2.0",//压缩提取出的css,并解决ExtractTextPlugin分离出的js重复问题(多个文件引入同一css文件)
"ora": "^1.2.0",//加载(loading)的插件
"portfinder": "^1.0.13",//查看进程端口
"postcss-import": "^11.0.0",//可以消耗本地文件、节点模块或web_modules
"postcss-loader": "^2.0.8",//用来兼容css的插件
"postcss-url": "^7.2.1",//URL上重新定位、内联或复制
"rimraf": "^2.6.0",//节点的UNIX命令RM—RF,强制删除文件或者目录的命令
"semver": "^5.3.0",//用来对特定的版本号做判断的
"shelljs": "^0.7.6",//使用它来消除shell脚本在UNIX上的依赖性,同时仍然保留其熟悉和强大的命令,即可执行Unix系统命令
"uglifyjs-webpack-plugin": "^1.1.1",//压缩js文件
"url-loader": "^0.5.8",//压缩文件,可将图片转化为base64
"vue-loader": "^13.3.0",//VUE单文件组件的WebPACK加载器
"vue-style-loader": "^3.0.1",//类似于样式加载程序,您可以在CSS加载器之后将其链接,以将CSS动态地注入到文档中作为样式标签
"vue-template-compiler": "^2.5.2",//这个包可以用来预编译VUE模板到渲染函数,以避免运行时编译开销和CSP限制
"webpack": "^3.6.0",//打包工具
"webpack-bundle-analyzer": "^2.9.0",//可视化webpack输出文件的大小
"webpack-dev-server": "^2.9.1",//提供一个提供实时重载的开发服务器
"webpack-merge": "^4.1.0"//它将数组和合并对象创建一个新对象。如果遇到函数,它将执行它们,通过算法运行结果,然后再次将返回的值封装在函数中
},
//engines是引擎,指定node和npm版本
"engines": {
"node": ">= 6.0.0",
"npm": ">= 3.0.0"
},
//限制了浏览器或者客户端需要什么版本才可运行
"browserslist": [
"> 1%",
"last 2 versions",
"not ie <= 8"
]
}
其他文件
① .gitignore:忽略git提交的一个文件,配置之后提交时将不会加载忽略的文件
② package.lock.json:锁定安装时的包的版本号,并且需要上传到git,以保证其他人在npm install时大家的依赖能保证一致
③ README.md:可此填写项目介绍
vue.config.js文件
有需要自行建立并配置的文件
devServer本地代理
例:
module.exports = {
configureWebpack: {
// other webpack options to merge in ...
},
devServer: {
public: 'localhost:8081',
hot: true, // 开启热模块替换也就是热更新
// hotOnly: true, // 不刷新页面,只做热更新
disableHostCheck: true,
open: true // 配置自动启动浏览器
}
};
更多devServer配置:
devServer: {
open: true, // 构建完成自动打开浏览器
openPage: '' // 打开指定页面路径
compress: true, // 开启gzip压缩
port: 8083, // 端口号
host: '0.0.0.0', // ip地址, 局域网访问,
hot: false, // 热模块更新作用
inline: false, // 关闭热更新
https: false, // 开启https代理
proxy: { // 配置多个代理
'/admin': { // 匹配接口前缀, 如: 请求为axios.post('/admin/user/userInfo'),
target: 'https://test.dasheng0609.com:19004', // 接口请求地址, 就是将"/admin"替换成target值
changeOrigin: true, // 开启代理, 在本地创建一个虚拟服务端
secure: false,
pathRewrite: { // 重写路径
'^/admin': '' // 正则匹配 "/admin"前缀, 替换为""空, 如果需要修改为其他的, 可以在这里修改
}
}
}
}vue-cli2和vue-cli对比
1.vue-cli3的设计原则是"0配置",移除了配置文件根目录下的一些配置文件:build、config等
2.vue-cli3提供了 vue ui 命令,提供了可视化配置,更加人性化
3.移除了static文件夹,新增了public文件夹,并且将index.html移动到public中。
标签:无