vue规范

vue官方风格指南
ESLint官方网站

vue 2.x 常规项目目录

|— build       构建脚本目录 
    |— build.js      生产环境构建(编译打包)脚本 
    |— check-versions.js   版本验证工具 
    |— utils.js      构建相关工具方法
    |— vue-loader.conf.js   处理vue中的样式 
    |— webpack.base.conf.js   webpack基础配置 
    |— webpack.dev.conf.js   webpack开发环境配置 
    |— webapck.prod.conf.js   webpack生产环境配置
|— config     项目配置 
    |— dev.env.js   开发环境变量 
    |— index.js    主配置文件 
    |— prod.env.js   生产环境变量 
    |— test.env.js   测试环境变量
|— node_modules    依赖模块
|— mock      mock数据目录,用于本地数据模拟
|— src      源码目录 
    |— assets    资源目录,资源会被webpack构建     
    |— js    公共js文件目录     
    |— css    公共样式文件目录     
    |— images   图片存放目录 
    |— components   公共组件目录  
    |— api     接口模块
    |— utils   工具文件夹
    App.vue    根组件 
    main.js    入口js文件 
    |— routers    前端路由目录     
        index.js 
    |— views/pages     前端页面文件 
    |— store     应用级数据管理  
        |— index.js/store.js      组装模块并导出,统一管理导出
        |— state.js    单一状态树,定义应用数据结构及初始化状态  
        |— getters.js   获取state中的状态,仅单向获取数据,不做任何修改  
        |— actions.js   调用mutation方法对数据进行操作   
        |— types.js 存放vuex常用的变量  
        |— mutations.js   定义state数据的修改操作
|— static 纯静态资源,不会被webpack构建
|— test      测试
|— unit      单元测试
|— e2e       e2e测试
.babelrc     babel的配置文件
.editorconfig   编辑器的配置文件
.gitignore    git的忽略配置文件
.postcssrc.js   postcss的配置文件
index.html    html模板,入口页面
package.json    npm包配置文件,依赖包信息
vue.config.js  vue配置文件
README.md     项目介绍

规范

项目命名

  • 采用小写方式,短横线分隔,eg:project-name

文件夹命名

  • 采用小写方式,若为复数形式,则加s。 eg:imgsstyles

变量命名、函数命名

  • 使用es6风格编码,eg:定义变量用let,定义常量用const, 箭头函数等
  • 小驼峰式命名法,变量eg:myName ,方法eg: getList
  • 请求接口数据方法,可以用Data结尾,eg:getFormDatagetListData
  • 尽量在每个方法前都添加注释

组件命名

  • 单文件组件书写顺序为template,script,style
  • 大驼峰式命名法,2-3个单词组合,根组件App(与之区分)。eg:TodoListTodoItem。使用时为 <todo-list></todo-list>
  • 组件内部文件夹包含:子组件文件夹childs、样式文件style、静态资源文件resources。目录结构:
|-- demo   文件夹
    |-- resources
    |-- childs
    |-- style
    |-- Demo.vue

props 命名

命名使用小驼峰式命名法,使用时用-连接

样式类命名

  • 采用小写方式,短横线分隔,eg:xxx-xxx,和变量进行区分
  • 单个组件样式写在scoped
  • scoped中,尽量使用类选择器,少使用元素选择器
  • 尽量避免使用中文拼音,用语义话英文单词组合,做到见字知意
  • 字体粗细规定统一值,eg:normal/bold/bolder分别设置成400、600、800

注释

单行: //
多行: /** */

template style注释

对每个功能区做注释

图片命名

  • 列表图片,可按照列表索引命名
  • 图标图片,用项目名缩写-icon-

指令统一

规则:要么统一缩写,要么不统一。
缩写(:表示v-binid,@表示v-on):

<input v-bind:value="123" v-on:blur="handleInput" >

不缩写

<input :value="123" @blur="handleInput">

路由

路由对象至少需要三部分:pathnamecomponent
path: 使用大驼峰式命名法

// 统一使用AMD规范的require或者es6的import 引入路由文件
{
    path: "/RoutePath",
    component: ()=> import("")
    // component: ()=> require("")
    name: "路由名称"
}

vuex

  • mutations数据同步处理
  • actions数据异步处理
  • 组件提交同步处理数据 this.$store.commit("xxx",xxx)
  • 组件异步处理数据 this.$store.dispatch("xxx",xxx)

框架选择

pc: Element UI、iView
移动端:mint-ui、vant

css 预处理器

Less、Sass、Stylus
建议时用less,轻量,满足大部分场景。

web字体

可使用Font Awesome、 Iconfont代替图片

其他

  • 不同浏览器样式标准不用,造成浏览器样式差异,有些第三方ui也会对默认样式进行修改,要进行reset.css的引入。
  • 函数全局问题: 可使用that = this,解决this指向问题。
  • v-for要设置key值,避免与v-if连用,可使用v-show
  • 特殊状态下,可以设置ref,用this.$refs.xxx,操作dom。
  • 样式值为0时,省略单位;为0.开头小数时,可省略0。eg
padding: 0px;
opacity: 0.5;

// 可改为
padding: 0;
opacity: .5;
  • 对于一组固定的图片或图标,可以适当的根据情况使用雪碧图
  • 接口请求返回数据统一为:response
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,544评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,430评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,764评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,193评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,216评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,182评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,063评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,917评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,329评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,425评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,019评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2 353