前端组件开发规范
基础技术栈为vue
脚手架为vue-cli3
脚本语言JAVAScript采用ECMAScript 6.0以及以下语法
编码规范参考code编写
本篇文章依据官方推荐方案分为几个优先级来依据遵循:
优先级 A：必要的
这些规则会帮你规避错误，所以学习并接受它们带来的全部代价吧。这里面可能存在例外，但应该非常少，且只有你同时精通 JavaScript 和 Vue 才可以这样做。
组件名为多个单词
组件名应该始终是多个单词的，根组件App以及
这样做可以避免跟现有的以及未来的 HTML 元素相冲突，因为所有的 HTML 元素名称都是单个单词的。
反例
Vue.component('todo', {
// ...
})
export default {
name: 'Todo',
// ...
}好例子
Vue.component('todo-item', {
// ...
})
export default {
name: 'TodoItem',
// ...
}
组件数据
组件的data必须是一个函数。
当在组件中使用data属性的时候 (除了new Vue外的任何地方)，它的值必须是返回一个对象的函数。
反例
Vue.component('some-comp', {
data: {
foo: 'bar'
}
})export default {
data: {
foo: 'bar'
}
}好例子
Vue.component('some-comp', {
data: function () {
return {
foo: 'bar'
}
}
})// In a .vue file
export default {
data () {
return {
foo: 'bar'
}
}
}// 在一个 Vue 的根实例上直接使用对象是可以的，
// 因为只存在一个这样的实例。
new Vue({
data: {
foo: 'bar'
}
})Prop 定义
Prop 定义应该尽量详细。
在你提交的代码中，prop 的定义应该尽量详细，至少需要指定其类型。
详解
反例
// 这样做只有开发原型系统时可以接受
props: ['status']好例子
props: {
status: String
}// 更好的做法！
props: {
status: {
type: String,
required: true,
validator: function (value) {
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value) !== -1
}
}
}为v-for设置键值
总是用key配合v-for。
在组件上_总是_必须用key配合v-for，以便维护内部组件及其子树的状态。甚至在元素上维护可预测的行为，比如动画中的对象固化 (object constancy)，也是一种好的做法。
反例子
-
{{ todo.text }}
好例子
-
{{ todo.text }}
避免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 }}
好例子
-
{{ user.name }}
-
{{ user.name }}
为组件样式设置作用域
对于应用来说，顶级App组件和布局组件中的样式可以是全局的，但是其它所有组件都应该是有作用域的。
这条规则只和单文件组件有关。你_不一定_要使用scopedattribute。设置作用域也可以通过CSS Modules，那是一个基于 class 的类似BEM的策略，当然你也可以使用其它的库或约定。
不管怎样，对于组件库，我们应该更倾向于选用基于 class 的策略而不是scopedattribute。
这让覆写内部样式更容易：使用了常人可理解的 class 名称且没有太高的选择器优先级，而且不太会导致冲突。
详解
反例
好例子
优先级 B 的规则：强烈推荐 (增强可读性)
组件文件
只要有能够拼接文件的构建系统，就把每个组件单独分成文件。
当你需要编辑一个组件或查阅一个组件的用法时，可以更快速的找到它。
反例
Vue.component('TodoList', {
// ...
})
Vue.component('TodoItem', {
// ...
})好例子
components/
|- TodoList.js
|- TodoItem.jscomponents/
|- TodoList.vue
|- TodoItem.vue单文件组件文件的大小写
单文件组件的文件名应该要么始终是单词大写开头 (PascalCase)，要么始终是横线连接 (kebab-case)。
单词大写开头对于代码编辑器的自动补全最为友好，因为这使得我们在 JS(X) 和模板中引用组件的方式尽可能的一致。然而，混用文件命名方式有的时候会导致大小写不敏感的文件系统的问题，这也是横线连接命名同样完全可取的原因。
反例
components/
|- mycomponent.vuecomponents/
|- myComponent.vue好例子
components/
|- MyComponent.vuecomponents/
|- my-component.vue基础组件名
应用特定样式和约定的基础组件 (也就是展示类的、无逻辑的或无状态的组件) 应该全部以一个特定的前缀开头，比如Base、App或V。
详解
反例
components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue好例子
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vuecomponents/
|- AppButton.vue
|- AppTable.vue
|- AppIcon.vuecomponents/
|- VButton.vue
|- VTable.vue
|- VIcon.vue单例组件名
只应该拥有单个活跃实例的组件应该以The前缀命名，以示其唯一性。
这不意味着组件只可用于一个单页面，而是_每个页面_只使用一次。这些组件永远不接受任何 prop，因为它们是为你的应用定制的，而不是它们在你的应用中的上下文。如果你发现有必要添加 prop，那就表明这实际上是一个可复用的组件，_只是目前_在每个页面里只使用一次。
反例
components/
|- Heading.vue
|- MySidebar.vue好例子
components/
|- TheHeading.vue
|- TheSidebar.vue紧密耦合的组件名
和父组件紧密耦合的子组件应该以父组件名作为前缀命名。
如果一个组件只在某个父组件的场景下有意义，这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件，所以这样做可以把相关联的文件排在一起。
详解
反例
components/
|- TodoList.vue
|- TodoItem.vue
|- TodoButton.vuecomponents/
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue好例子
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vuecomponents/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue组件名中的单词顺序
组件名应该以高级别的 (通常是一般化描述的) 单词开头，以描述性的修饰词结尾。
详解
反例
components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue
|- LaunchOnStartupCheckbox.vue
|- RunSearchButton.vue
|- SearchInput.vue
|- TermsCheckbox.vue好例子
components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingsCheckboxLaunchOnStartup.vue自闭合组件
在单文件组件、字符串模板和JSX中没有内容的组件应该是自闭合的——但在 DOM 模板里永远不要这样做。
自闭合组件表示它们不仅没有内容，而且刻意没有内容。其不同之处就好像书上的一页白纸对比贴有“本页有意留白”标签的白纸。而且没有了额外的闭合标签，你的代码也更简洁。
不幸的是，HTML 并不支持自闭合的自定义元素——只有官方的“空”元素。所以上述策略仅适用于进入 DOM 之前 Vue 的模板编译器能够触达的地方，然后再产出符合 DOM 规范的 HTML。
反例
好例子
模板中的组件名大小写
对于绝大多数项目来说，在单文件组件和字符串模板中组件名应该总是 PascalCase 的——但是在 DOM 模板中总是 kebab-case 的。
PascalCase 相比 kebab-case 有一些优势：
- 编辑器可以在模板里自动补全组件名，因为 PascalCase 同样适用于 JavaScript。
-
- 如果你在模板中使用任何非 Vue 的自定义元素，比如一个 Web Component，PascalCase 确保了你的 Vue 组件在视觉上仍然是易识别的。
不幸的是，由于 HTML 是大小写不敏感的，在 DOM 模板中必须仍使用 kebab-case。
还请注意，如果你已经是 kebab-case 的重度用户，那么与 HTML 保持一致的命名约定且在多个项目中保持相同的大小写规则就可能比上述优势更为重要了。在这些情况下，在所有的地方都使用 kebab-case 同样是可以接受的。
反例
好例子
或者
JS/JSX 中的组件名大小写
JS/JSX中的组件名应该始终是 PascalCase 的，尽管在较为简单的应用中只使用Vue.component进行全局组件注册时，可以使用 kebab-case 字符串。
详解
反例
Vue.component('myComponent', {
// ...
})import myComponent from './MyComponent.vue'export default {
name: 'myComponent',
// ...
}export default {
name: 'my-component',
// ...
}好例子
Vue.component('MyComponent', {
// ...
})Vue.component('my-component', {
// ...
})import MyComponent from './MyComponent.vue'export default {
name: 'MyComponent',
// ...
}完整单词的组件名
组件名应该倾向于完整单词而不是缩写。
编辑器中的自动补全已经让书写长命名的代价非常之低了，而其带来的明确性却是非常宝贵的。不常用的缩写尤其应该避免。
反例
components/
|- SdSettings.vue
|- UProfOpts.vue好例子
components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vueProp 名大小写
在声明 prop 的时候，其命名应该始终使用 camelCase，而在模板和JSX中应该始终使用 kebab-case。
我们单纯的遵循每个语言的约定。在 JavaScript 中更自然的是 camelCase。而在 HTML 中则是 kebab-case。
反例
props: {
'greeting-text': String
}好例子
props: {
greetingText: String
}多个 attribute 的元素
多个 attribute 的元素应该分多行撰写，每个 attribute 一行。
在 JavaScript 中，用多行分隔对象的多个属性是很常见的最佳实践，因为这样更易读。模板和JSX值得我们做相同的考虑。
反例
好例子
模板中简单的表达式
组件模板应该只包含简单的表达式，复杂的表达式则应该重构为计算属性或方法。
复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的_是什么_，而非_如何_计算那个值。而且计算属性和方法使得代码可以重用。
反例
{{
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
}
}带引号的 attribute 值
非空 HTML attribute 值应该始终带引号 (单引号或双引号，选你 JS 里不用的那个)。
在 HTML 中不带空格的 attribute 值是可以没有引号的，但这鼓励了大家在特征值里_不写_空格，导致可读性变差。
反例
好例子
指令缩写
指令缩写 (用:表示v-bind:、用@表示v-on:和用#表示v-slot:) 应该要么都用要么都不用。
反例
Here might be a page title
Here's some contact info
好例子
Here might be a page title
Here's some contact info
Here might be a page title
Here's some contact info