vue项目开发规范总结

时间 2019-11-08

标签 vue 项目开发规范总结繁體版

原文原文链接

强制执行的：

文件名要为多个单词，且语义明确，同时要为大写驼峰javascript

组件名应该始终是多个单词的，根组件 App 以及、之类的 Vue 内置组件除外。css

反例：html
```
Vue.component('todo', {
  // ...
})
复制代码
```
好例：vue
```
export default {
  name: 'TodoItem',
  // ...
}
复制代码
```

组件数据data必须为一个函数java

反例：ide

export default {
  data: {
    foo: 'bar'
  }
}
复制代码

好例：函数

export default {
  data () {
    return {
      foo: 'bar'
    }
  }
}
复制代码

props的定义必定要详尽，例如类型、必填项、默认值、校验规则布局

反例：ui

props: ['status']
复制代码

好例：this

props: {
  status: {
    type: String,
    required: true,
    validator: function (value) {
      return [
        'syncing',
        'synced',
        'version-conflict',
        'error'
      ].indexOf(value) !== -1
    }
  }
}
复制代码

v-for设置key值

反例：

<ul>
  <li v-for="todo in todos">
    {{ todo.text }}
  </li>
</ul>
复制代码

好例：

<ul>
  <li v-for="todo in todos" :key="todo.id" >
    {{ todo.text }}
  </li>
</ul>
复制代码

避免v-if和v-for用一块儿

**永远不要把 v-if 和 v-for 同时用在同一个元素上。**当 Vue 处理指令时，v-for 比 v-if 具备更高的优先级。

反例：

<ul>
  <li v-for="user in users" v-if="user.isActive" :key="user.id" >
    {{ user.name }}
  </li>
</ul>
复制代码

好例：

<ul v-if="shouldShowUsers">
  <li v-for="user in users" :key="user.id" >
    {{ user.name }}
  </li>
</ul>
复制代码

为组件样式设置做用域

对于应用来讲，顶级 App 组件和布局组件中的样式能够是全局的，可是其它全部组件都应该是有做用域的。

反例：

<template>
  <button class="btn btn-close">X</button>
</template>

<style> .btn-close { background-color: red; } </style>
复制代码

好例：

<template>
  <button class="button button-close">X</button>
</template>

<!-- 使用 `scoped` 特性 -->
<style scoped> .button { border: none; border-radius: 2px; } .button-close { background-color: red; } </style>
复制代码

使用私有属性名

反例：

var myGreatMixin = {
  // ...
  methods: {
    update: function () {
      // ...
    }
  }
}
复制代码

好例：

var myGreatMixin = {
  // ...
  methods: {
   	$_update: function () {
      // ...
    }
  }
}
复制代码

推荐执行的

基础文件名

应用特定样式和约定的基础组件 (也就是展现类的、无逻辑的或无状态的组件) 应该所有以一个特定的前缀开头，好比 Base、App 或 V。

反例：
```
components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue
复制代码
```
好例：
```
components/
|- BaseButton.vue
|- AppTable.vue
|- VIcon.vue
复制代码
```
单例组件名

只应该拥有单个活跃实例的组件应该以 The 前缀命名，以示其惟一性。

反例：
```
components/
|- Heading.vue
|- MySidebar.vue
复制代码
```
好例：
```
components/
|- TheHeading.vue
|- TheSidebar.vue
复制代码
```

自闭合组件

在单文件组件、字符串模板和 JSX 中没有内容的组件应该是自闭合的——但在 DOM 模板里永远不要这样作。

反例：

<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent></MyComponent>
<!-- 在 DOM 模板中 -->
<my-component/>
复制代码

好例：

<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>
复制代码

模板中组件名大小写

对于绝大多数项目来讲，在单文件组件和字符串模板中组件名应该老是 PascalCase 的——可是在 DOM 模板中老是 kebab-case 的。

反例：

<!-- 在单文件组件和字符串模板中 -->
<mycomponent/>
<!-- 在单文件组件和字符串模板中 -->
<myComponent/>
<!-- 在 DOM 模板中 -->
<MyComponent></MyComponent>
复制代码

好例：

<!-- 在单文件组件和字符串模板中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>
或者
<!-- 在全部地方 -->
<my-component></my-component>
复制代码

模板中简单的表达式

组件模板应该只包含简单的表达式，复杂的表达式则应该重构为计算属性或方法。

反例：

{{
  fullName.split(' ').map(function (word) {
    return word[0].toUpperCase() + word.slice(1)
  }).join(' ')
}}
复制代码

好例：

<!-- 在模板中 -->
{{ normalizedFullName }}

// 复杂表达式已经移入一个计算属性
computed: {
  normalizedFullName: function () {
    return this.fullName.split(' ').map(function (word) {
      return word[0].toUpperCase() + word.slice(1)
    }).join(' ')
  }
}
复制代码

简单的计算属性

应该把复杂计算属性分割为尽量多的更简单的属性。

反例：

computed: {
  price: function () {
    var basePrice = this.manufactureCost / (1 - this.profitMargin)
    return (
      basePrice -
      basePrice * (this.discountPercent || 0)
    )
  }
}
复制代码

好例：

computed: {
  basePrice: function () {
    return this.manufactureCost / (1 - this.profitMargin)
  },
  discount: function () {
    return this.basePrice * (this.discountPercent || 0)
  },
  finalPrice: function () {
    return this.basePrice - this.discount
  }
}
复制代码

带引号的特性值

非空 HTML 特性值应该始终带引号 (单引号或双引号，选你 JS 里不用的那个)。

反例：

<input type=text>
<AppSidebar :style={width:sidebarWidth+'px'}>
复制代码

好例：

<input type="text">
<AppSidebar :style="{ width: sidebarWidth + 'px' }">
复制代码

指令缩写

指令缩写 (用 : 表示 v-bind: 、用 @ 表示 v-on: 和用 # 表示 v-slot:) 应该要么都用要么都不用。

反例：

<input v-bind:value="newTodoText" :placeholder="newTodoInstructions" >
<input v-on:input="onInput" @focus="onFocus" >
<template v-slot:header>
  <h1>Here might be a page title</h1> 
</template>

<template #footer>
  <p>Here's some contact info</p>
</template>
复制代码

好例：

<input :value="newTodoText" :placeholder="newTodoInstructions" >
<input v-bind:value="newTodoText" v-bind:placeholder="newTodoInstructions" >
<input @input="onInput" @focus="onFocus" >
<input v-on:input="onInput" v-on:focus="onFocus" >
复制代码