PS：今天看到同事的接口和设计逻辑，我直接挠头。也感觉出了编码/命名规范真的很重要，所以顺便整理了一下前端开发的规范，自己也学习学习。（持续更新）
一、命名规范
1.项目文件命名
1.1项目名
全部采用小写方式， 以短横线分隔。例:my-project-name。
1.1.2 目录名
参照项目命名规则，有复数结构时，要采用复数命名法。例:docs、assets、components、directives、mixins、utils、views。
|- BuildScript // 流水线部署文件目录
|- docs // 项目的细化文档目录（可选）
|- nginx // 部署在容器上前端项目 nginx 代理文件目录
|- node_modules // 下载的依赖包
|- public // 静态页面目录
|- index.html // 项目入口
|- src // 源码目录
||- api // http 请求目录
||- assets // 静态资源目录，这里的资源会被wabpack构建
||- icon // icon 存放目录
||- img // 图片存放目录
||- js // 公共 js 文件目录
||- scss // 公共样式 scss 存放目录
||- frame.scss // 入口文件
||- global.scss // 公共样式
||- reset.scss // 重置样式
||- components // 组件
||- plugins // 插件
||- router // 路由
||- routes // 详细的路由拆分目录（可选）
||- index.js
||- store // 全局状态管理
||- utils // 工具存放目录
||- request.js // 公共请求工具
||- views // 页面存放目录
||- App.vue // 根组件
||- main.js // 入口文件
||- tests // 测试用例
|- .browserslistrc// 浏览器兼容配置文件
|- .editorconfig // 编辑器配置文件
|- static // 非组件静态资源
|- .eslintignore // eslint 忽略规则
|- .eslintrc.js // eslint 规则
|- .gitignore // git 忽略规则
|- babel.config.js // babel 规则
|- Dockerfile // Docker 部署文件
|- jest.config.js
|- package-lock.json
|- package.json // 依赖
|- README.md // 项目 README
|- vue.config.js // webpack 配置
1.1.3 图像文件名,HTML 文件名
全部采用小写方式， 优先选择单个单词命名，多个单词命名以下划线分隔。例: banner_sina.gif
1.1.4 CSS 文件名,JavaScript 文件名
全部采用小写方式， 优先选择单个单词命名，多个单词命名以短横线分隔。例:input-number.scss, account-model.js
1.2VUE组件命名
1.2.1 单文件组件名
文件扩展名为 .vue 的单文件组件应该始终是单词大写开头。例:
components/
|- MyComponent.vue
1.2.2 单例组件名
只拥有单个活跃实例的组件应该以 The 前缀命名，以示其唯一性。
这不意味着组件只可用于一个单页面，而是每个页面只使用一次。这些组件永远不接受任何 prop，因为它们是为你的应用定制的。如果你发现有必要添加 prop，那就表明这实际上是一个可复用的组件，只是目前在每个页面里只使用一次。
比如，头部和侧边栏组件几乎在每个页面都会使用，不接受 prop，该组件是专门为该应用所定制的。
components/
|- TheHeading.vue
1.2.3 基础组件名
应用特定样式和约定的基础组件(也就是展示类的、无逻辑的或无状态、不掺杂业务逻辑的组件) 应该全部以一个特定的前缀开头 —— Base。基础组件在一个页面内可使用多次，在不同页面内也可复用，是高可复用组件。
components/
|- BaseButton.vue
1.2.4业务组件
掺杂了复杂业务的组件（拥有自身 data、prop 的相关处理）即业务组件应该以 Custom 前缀命名。业务组件在一个页面内比如：某个页面内有一个卡片列表，而样式和逻辑跟业务紧密相关的卡片就是业务组件。
components/
|- CustomCard.vue
1.2.5 紧密耦合的组件名
和父组件紧密耦合的子组件应该以父组件名作为前缀命名。 因为编辑器通常会按字母顺序组织文件，所以这样做可以把相关联的文件排在一起。
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
1.2.6 组件名中单词顺序
组件名应该以高级别的 (通常是一般化描述的) 单词开头，以描述性的修饰词结尾。 因为编辑器通常会按字母顺序组织文件，所以现在组件之间的重要关系一目了然。如下组件主要是用于搜索和设置功能。
components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SettingsCheckboxTerms.vue
还有另一种多级目录的方式，把所有的搜索组件放到“search”目录，把所有的设置组件放到“settings”目录。我们只推荐在非常大型 (如有 100+ 个组件) 的应用下才考虑这么做，因为在多级目录间找来找去，要比在单个 components 目录下滚动查找要花费更多的精力。
1.2.7 完整单词的组件名
组件名应该倾向于完整单词而不是缩写。 编辑器中的自动补全已经让书写长命名的代价非常之低了，而其带来的明确性却是非常宝贵的。不常用的缩写尤其应该避免。
components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue
1.3 代码参数命名
1.3.1 name
组件名应该始终是多个单词，应该始终是 PascalCase 的。 根组件 App 以及 、 之类的 Vue 内置组件除外。这样做可以避免跟现有的以及未来的 HTML 元素相冲突，因为所有的 HTML 元素名称都是单个单词的。
export default {
name: 'ToDoList',
// ...
}
1.3.2 prop
在声明 prop 的时候，其命名应该始终使用 camelCase，而在模板和 JSX 中应该始终使用 kebab-case。我们单纯的遵循每个语言的约定，在 JavaScript 中更自然的是 camelCase。而在 HTML 中则是 kebab-case。
<WelcomeMessage greeting-text="hi"/>
export default {
name: 'MyComponent',
// ...
props: {
greetingText: {
type: String,
required: true,
validator: function (value) {
return ['syncing', 'synced',].indexOf(value) !== -1
}
}
}
}
1.3.3 router
Vue Router Path 命名采用 kebab-case 格式。 用 Snake（如：/user_info）或 camelCase（如：/userInfo)的单词会被当成一个单词，搜索引擎无法区分语义。
// bad
{
path: '/user_info', // user_info 当成一个单词
name: 'UserInfo',
component: UserInfo,
meta: {
title: ' - 用户',
desc: ''
}
},
// good
{
path: '/user-info', // 能解析成 user info
name: 'UserInfo',
component: UserInfo,
meta: {
title: ' - 用户',
desc: ''
}
},
1.3.4 模板中组件
对于绝大多数项目来说，在单文件组件和字符串模板中组件名应该总是 PascalCase 的，但是在 DOM 模板中总是 kebab-case 的。
