1.必要的编码规范
1.1. 组件名为多个单词
[强制] 组件名应该始终是多个单词的,根组件 App 以及 、 之类的 Vue 内置组件除外。
示例:
/* good */
Vue.component('todo-item', {
// ...
})
/* bad */
Vue.component('todo', {
// ...
})
1.2. 组件数据必须是函数
[强制] 当在组件中使用 data property 的时候 (除了 new Vue 外的任何地方),它的值必须是返回一个对象的函数。
示例:
/* good */
Vue.component('some-comp', {
data: function () {
return {
foo: 'bar'
}
}
})
/* bad */
Vue.component('some-comp', {
data: {
foo: 'bar'
}
})
1.3. Prop 定义应该尽量详细
[强制] 在你提交的代码中,prop 的定义应该尽量详细,至少需要指定其类型。
示例:
/* good */
props: {
status: {
type: String,
required: true,
validator: function (value) {
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value) !== -1
}
}
}
/* bad */
props: ['status']
1.4. 用 key 配合 v-for
[强制] 在组件上总是必须用 key 配合 v-for,以便维护内部组件及其子树的状态。甚至在元素上维护可预测的行为,比如动画中的对象固化 (object constancy),也是一种好的做法。
示例:
/* good */
<ul>
<li
v-for="todo in todos"
:key="todo.id"
>
{
{ todo.text }}
</li>
</ul>}
/* bad */
<ul>
<li v-for="todo in todos">
{
{ todo.text }}
</li>
</ul>
1.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)。
示例:
/* good */
<ul>
<li
v-for="user in activeUsers"
:key="user.id"
>
{
{ user.name }}
</li>
</ul>
/* bad */
<ul>
<li
v-for="user in users"
v-if="user.isActive"
:key="user.id"
>
{
{ user.name }}
</li>
</ul>
1.6. 为组件样式设置作用域
[强制] 对于应用来说,顶级 App 组件和布局组件中的样式可以是全局的,但是其它所有组件都应该是有作用域的。
示例:
/* good */
<style scoped>
.button {
border: none;
border-radius: 2px;
}
.button-close {
background-color: red;
}
</style>
/* bad */
<style>
.btn-close {
background-color: red;
}
</style>
1.7. 私有 property 名
[强制] 使用模块作用域保持不允许外部访问的函数的私有性。如果无法做到这一点,就始终为插件、混入等不考虑作为对外公共 API 的自定义私有 property 使用 $_ 前缀。并附带一个命名空间以回避和其它作者的冲突 (比如 $yourPluginName)。
示例:
/* good */
var myGreatMixin = {
// ...
methods: {
$_myGreatMixin_update: function () {
// ...
}
}
/* bad */
var myGreatMixin = {
// ...
methods: {
update: function () {
// ...
}
}
2. 强烈推荐使用规范
2.1. 组件文件
[提示] 只要有能够拼接文件的构建系统,就把每个组件单独分成文件。
示例:
/* good */
components/
|- TodoList.js
|- TodoItem.js
2.2. 单文件组件文件名
[提示] 单文件组件的文件名应该要么始终是单词大写开头 (PascalCase)
示例:
/* good */
components/
|- MyComponent.vue
/* bad */
components/
|- myComponent.vue
2.3. 基础组件文件名
[提示] 应用特定样式和约定的基础组件 (也就是展示类的、无逻辑的或无状态的组件) 应该全部以一个特定的前缀开头,比如 Base、App 或 V。
示例:
/* good */
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue
/* bad */
components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue
2.4. 单例组件文件名
[提示] 只应该拥有单个活跃实例的组件应该以 The 前缀命名,以示其唯一性。
这不意味着组件只可用于一个单页面,而是每个页面只使用一次。这些组件永远不接受任何 prop,因为它们是为你的应用定制的,而不是它们在你的应用中的上下文。如果你发现有必要添加 prop,那就表明这实际上是一个可复用的组件,只是目前在每个页面里只使用一次。
示例:
/* good */
components/
|- TheHeading.vue
|- TheSidebar.vue
/* bad */
components/
|- Heading.vue
|- MySidebar.vue
2.5. 紧密耦合的组件文件名
[提示] 和父组件紧密耦合的子组件应该以父组件名作为前缀命名。
如果一个组件只在某个父组件的场景下有意义,这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件,所以这样做可以把相关联的文件排在一起。
示例:
/* good */
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
/* bad */
components/
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue
2.6. 组件名中的单词顺序
[提示] 组件名应该以高级别的 (通常是一般化描述的) 单词开头,以描述性的修饰词结尾。
示例:
/* good */
components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingsCheckboxLaunchOnStartup.vue
/* bad */
components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue
|- LaunchOnStartupCheckbox.vue
|- RunSearchButton.vue
|- SearchInput.vue
|- TermsCheckbox.vue
2.7. 自闭合组件
[提示] 在单文件组件、字符串模板和 JSX 中没有内容的组件应该是自闭合的——但在 DOM 模板里永远不要这样做。
自闭合组件表示它们不仅没有内容,而且刻意没有内容。其不同之处就好像书上的一页白纸对比贴有“本页有意留白”标签的白纸。而且没有了额外的闭合标签,你的代码也更简洁。
示例:
/* good */
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>
/* bad */
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent></MyComponent>
<!-- 在 DOM 模板中 -->
<my-component/>
2.8. 组件名大小写
[提示] 对于绝大多数项目来说,在单文件组件和字符串模板中组件名应该总是 PascalCase 的——但是在 DOM 模板中总是 kebab-case 的。组件名应该倾向于完整单词而不是缩写。
示例:
/* good */
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>
/* bad */
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent></MyComponent>
<!-- 在 DOM 模板中 -->
<my-component/>
2.9. prop名大小写
[提示] 在声明 prop 的时候,其命名应该始终使用 camelCase,而在模板和 JSX 中应该始终使用 kebab-case。我们单纯的遵循每个语言的约定。在 JavaScript 中更自然的是 camelCase。而在 HTML 中则是 kebab-case。
示例:
/* good */
props: {
greetingText: String
}
<WelcomeMessage greeting-text="hi"/>
/* bad */
props: {
'greeting-text': String
}
<WelcomeMessage greetingText="hi"/>
2.10. 多个 attribute 的元素
[提示] 多个 attribute 的元素应该分多行撰写,每个 attribute 一行。
示例:
/* good */
<img
src="https://vuejs.org/images/logo.png"
alt="Vue Logo"
>
/* bad */
<img src="https://vuejs.org/images/logo.png" alt="Vue Logo">
2.11. 模板中简单的表达式
[提示] 组件模板应该只包含简单的表达式,复杂的表达式则应该重构为计算属性或方法。
示例:
/* good */
<!-- 在模板中 -->
{
{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性
computed: {
normalizedFullName: function () {
return this.fullName.split(' ').map(function (word) {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}
}
/* bad */
{
{
fullName.split(' ').map(function (word) {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}}
2.12. 简单的计算属性
[提示] 应该把复杂计算属性分割为尽可能多的更简单的 property。
示例:
/* good */
computed: {
basePrice: function () {
return this.manufactureCost / (1 - this.profitMargin)
},
discount: function () {
return this.basePrice * (this.discountPercent || 0)
},
finalPrice: function () {
return this.basePrice - this.discount
}
}
/* bad */
computed: {
price: function () {
var basePrice = this.manufactureCost / (1 - this.profitMargin)
return (
basePrice -
basePrice * (this.discountPercent || 0)
)
}
}
2.13. 指令简写风格尽量统一
[提示] 指令缩写 (用 : 表示 v-bind:、用 @ 表示 v-on: 和用 # 表示 v-slot:) 应该要么都用要么都不用。
示例:
/* good */
<input
:value="newTodoText"
:placeholder="newTodoInstructions"
>
/* bad */
<input
v-bind:value="newTodoText"
:placeholder="newTodoInstructions"
>