Vue开发结构语法规范
1.结构化规范
├── index.html 入口页面
├── build 构建脚本目录
│ ├── build-server.js 运行本地构建服务器，可以访问构后的页面
│ ├── build.js 生产环境构建脚本
│ ├── dev-client.js 开发服务器热重载脚本，主要用来实现开发阶段的页面自动
│ ├── dev-server.js 运行本地开发服务器
│ ├── utils.js 构建相关工具方法
│ ├── webpack.base.conf.js wabpack基础配置
│ ├── webpack.dev.conf.js wabpack开发环境配置
│ └── webpack.prod.conf.js wabpack生产环境配置
├── config 项目配置
│ ├── dev.env.js 开发环境变量
│ ├── index.js 项目配置文件
│ ├── prod.env.js 生产环境变量
│ └── test.env.js 测试环境变量
├── mock mock数据目录
│ └── hello.js
├── package.json npm包配置文件，里面定义了项目的npm脚本，依赖包等信息
├── src 项目源码目录
│ ├── main.js 入口js文件
│ ├── App.vue 根组件
│ ├── components 公共组件目录
│ │ └── title.vue
│ ├── assets 资源目录，这里的资源会被wabpack构建
│ │ ├── css 公共样式文件目录
│ │ ├── js 公共js文件目录
│ │ └── img 图片存放目录
│ ├── routes 前端路由
│ │ └── index.js
│ ├── store 应用级数据（state）
│ │ └── index.js
│ └── views 页面目录
│ ├── hello.vue
│ └── notfound.vue
├── static 纯静态资源，不会被wabpack构建。
│── .gitignore.js 提交代码时候需要配置的忽略提交的代码目录
│── README.md 展示项目基本用法功能的说明性文件
2.vue文件方法声明顺序
- components
- props
- data
- created
- mounted
- activited
- update
- beforeRouteUpdate
- metods
- filter
- computed
- watch
3、强制要求
- 组件名为多个单词
组件名应该始终是多个单词的，根组件 App 除外。
// 反例：
export default {
name: 'Todo',
// ...
}
// 正例
export default {
name: 'TodoItem',
// ...
}
- 组件数据
组件的 data 必须是一个函数。
当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方)，它的值必须是返回一个对象的函数。
// 正例
// In a .vue file
export default {
data () {
return {
foo: 'bar'
}
}
}
// 在一个 Vue 的根实例上直接使用对象是可以的，
// 因为只存在一个这样的实例。
new Vue({
data: {
foo: 'bar'
}
})
// 反例
export default {
data: {
foo: 'bar'
}
}
- Prop定义
Prop 定义应该尽量详细。
在你提交的代码中，prop 的定义应该尽量详细，至少需要指定其类型。
// 正例
props: {
status: String
}
// 更好的做法！
props: {
status: {
type: String,
required: true,
validator: function (value) {
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value) !== -1
}
}
}
// 反例
// 这样做只有开发原型系统时可以接受
props: ['status']
- 为v-for设置键值
总是用 key 配合 v-for。
在组件上总是必须用 key 配合 v-for，以便维护内部组件及其子树的状态。甚至在元素上维护可预测的行为，比如动画中的对象固化 (object constancy)，也是一种好的做法。
// 正例
-
{{ todo.text }}
// 反例
-
{{ todo.text }}
5.避免 v-if 和 v-for 用在一起
永远不要把 v-if 和 v-for 同时用在同一个元素上。
一般我们在两种常见的情况下会倾向于这样做：
为了过滤一个列表中的项目 (比如 v-for=“user in users” v-if=“user.isActive”)。在这种情形下，请将 users 替换为一个计算属性 (比如 activeUsers)，让其返回过滤后的列表。
为了避免渲染本应该被隐藏的列表 (比如v-for=“user in users” v-if=“shouldShowUsers”)。这种情形下，请将 v-if 移动至容器元素上 (比如 ul, ol)。
// 正例
-
{{ user.name }}
// 反例
-
{{ user.name }}
4、强烈推荐（增强可读性）
- 组件文件
只要有能够拼接文件的构建系统，就把每个组件单独分成文件。
当你需要编辑一个组件或查阅一个组件的用法时，可以更快速的找到它。
// 正例
components/
|- TodoList.vue
|- TodoItem.vue
// 反例
Vue.component('TodoList', {
// ...
})
Vue.component('TodoItem', {
// ...
})
- 单文件组件文件的大小写
单文件组件的文件名应该要么始终是单词大写开头 (PascalCase)
// 正例
components/
|- MyComponent.vue
// 反例
components/
|- myComponent.vue
|- mycomponent.vue
- 基础组件名
应用特定样式和约定的基础组件 (也就是展示类的、无逻辑的或无状态的组件) 应该全部以一个特定的前缀开头，比如 Base、App 或 V。
// 正例
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue
// 反例
components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue
- 紧密耦合的组件名
和父组件紧密耦合的子组件应该以父组件名作为前缀命名。
如果一个组件只在某个父组件的场景下有意义，这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件，所以这样做可以把相关联的文件排在一起。
// 正例
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
components/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue
// 反例
components/
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue
- 模板中的组件名大小写
总是 PascalCase 的
// 正例
- 完整单词的组件名
组件名应该倾向于完整单词而不是缩写。
// 正例
components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue
// 反例
components/
|- SdSettings.vue
|- UProfOpts.vue
- 多个特性的元素
多个特性的元素应该分多行撰写，每个特性一行。
// 正例
)
- 带引号的特性值
非空 HTML 特性值应该始终带引号 (单引号或双引号，选你 JS 里不用的那个)。
在 HTML 中不带空格的特性值是可以没有引号的，但这样做常常导致带空格的特征值被回避，导致其可读性变差。
// 正例
// 反例
指令缩写
都用指令缩写 (用 : 表示 v-bind: 和用 @ 表示 v-on:)
// 正例
// 反例
5、推荐单文件组件元素的顺序
- 单文件组件的顶级元素的顺序
单文件组件应该总是让 、
// 正例
...
6、谨慎使用 (有潜在危险的模式)
- 没有在 v-if/v-if-else/v-else 中使用 key
如果一组 v-if + v-else 的元素类型相同，最好使用 key (比如两个
// 正例
错误：{{ error }}
{{ results }}
// 反例
错误：{{ error }}
{{ results }}
- scoped 中的元素选择器
元素选择器应该避免在 scoped 中出现。
在 scoped 样式中，类选择器比元素选择器更好，因为大量使用元素选择器是很慢的。
// 正例
// 反例
- 隐性的父子组件通信
应该优先通过 prop 和事件进行父子组件之间的通信，而不是 this.$parent 或改变 prop。
// 正例
Vue.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
template: `
`
})
// 反例
Vue.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
methods: {
removeTodo () {
var vm = this
vm.$parent.todos = vm.$parent.todos.filter(function (todo) {
return todo.id !== vm.todo.id
})
}
},
template: `
{{ todo.text }}
`
})