Code Style of Vue

There are only two hard things in Computer Science: cache invalidation and naming things.

-- Phil Karlton

There are only two hard problems in distributed systems: 2. Exactly-once delivery 1. Guaranteed order of messages 2. Exactly-once delivery

-- Mathias Verraes

Official


A https://cn.vuejs.org/v2/style-guide/#Prop-定义-必要

-- wen

A https://cn.vuejs.org/v2/style-guide/#为-v-for-设置键值-必要

-- wen

A https://cn.vuejs.org/v2/style-guide/#为组件样式设置作用域-必要

-- xuan

A https://cn.vuejs.org/v2/style-guide/#私有属性名-必要

插件、混入等扩展中始终为自定义的私有属性使用 $_ 前缀。并附带一个命名空间以回避和其它作者的冲突 (比如 $yourPluginName)。

-- kang
-- xuan
-- tong

B https://cn.vuejs.org/v2/style-guide/#自闭合组件-强烈推荐

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

DOM模板 误区?
https://vuejsdevelopers.com/2017/09/17/vue-js-avoid-dom-templates/
https://cn.vuejs.org/v2/guide/components.html#DOM-模板解析注意事项

-- wen

B https://cn.vuejs.org/v2/style-guide/#简单的计算属性-强烈推荐

-- xuan
-- tong

B https://cn.vuejs.org/v2/style-guide/#模板中简单的表达式-强烈推荐

-- xuan

B https://cn.vuejs.org/v2/style-guide/#基础组件名-强烈推荐

-- xuan

B https://cn.vuejs.org/v2/style-guide/#单例组件名-强烈推荐

-- tong

B https://cn.vuejs.org/v2/style-guide/#紧密耦合的组件名-强烈推荐

-- tong

B https://cn.vuejs.org/v2/style-guide/#组件名中的单词顺序-强烈推荐

-- tong

B https://cn.vuejs.org/v2/style-guide/#完整单词的组件名-强烈推荐

-- tong

B https://cn.vuejs.org/v2/style-guide/#JS-JSX-中的组件名大小写-强烈推荐

JS/JSX 中的组件名应该始终是 PascalCase 的,尽管在较为简单的应用中只使用 Vue.component 进行全局组件注册时,可以使用 kebab-case 字符串。

  • 组件的name选项的格式统一为kebab-case,而且每个组件必须要有一个name选项 -- kang
  • 单词大写开头 -- tong

C https://cn.vuejs.org/v2/style-guide/#组件-实例的选项的顺序-推荐

-- kang
-- tong

C https://cn.vuejs.org/v2/style-guide/#元素特性的顺序-推荐

-- kang
-- tong

C https://cn.vuejs.org/v2/style-guide/#单文件组件的顶级元素的顺序-推荐

.vue单文件中各个模块的顺序是:<template>、<script>、<style>、<custom>(官方)-- kang
-- tong

C https://cn.vuejs.org/v2/style-guide/#组件-实例选项中的空行-推荐

组件/实例选项中国空行(template标签内支持, script标签内不支持,我也不知道为什么,视觉习惯吧) -- tong

D https://cn.vuejs.org/v2/style-guide/#scoped-中的元素选择器-谨慎使用

-- kang
-- tong


image.png

D https://cn.vuejs.org/v2/style-guide/#没有在-v-if-v-if-else-v-else-中使用-key-谨慎使用

-- wen
不支持? -- tong

补充


v-once的使用

https://cn.vuejs.org/v2/api/#v-once

多个属性换行写

<a a=’1’ 
   b=’2’
   c=’3’></a>

所有双括号内首尾留空格

 {{ a, b }}

class 疑问

:class=[ ‘a’, { ‘b’: c } ]还是 class=”a” :class=”{ ‘b’: c }”

每一个属性后面要不要都加空行?

样式名字要不要出一份常用的样式名字模板? 如根元素我喜欢用class=”XXX-container” 后面一个容器用class=”XXX-wrap”

一些统一的方法名字需要统一还是根据功能不同起名字?如对于所有的组件内的click事件,我倾向于@click=”action” 父组件@action=”XXX”

结尾逗号是否要全部统一启用?

{ a: 123, }

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Trailing_commas
(注意JSON不允许trailing commas)
es8

类选择器命名规范 -- tong

services 提取url, 展开参数

image.png

Boolean variables, or functions that return a boolean value, should start with “is,” “has” or “should.”

isFish = true  
isCat = false  
hasScales = true 
hasFur = false 
canSwim = true  
wasEgg = true 
eatAble = true

匿名函数与debug

named callback

const funWithName = () => { console.log('I'm happy I have a name.'); }
document.addEventListen('scroll', function onScroll(e) { ... });
function onSuccess() { ... }
doSomeAsyncOp.then(onSuccess)
doSomeAsyncOp.then(function onSuccess() { ... })
// doSomeAsyncOp.then(res => { ... })

// onXXXError
// onXXXSuccess
// onXXXFinish
// beXXXforeSend

arrow-parens "always"

(a) => { ... }

https://eslint.org/docs/rules/arrow-parens

arrow-body-style "always"

https://eslint.org/docs/rules/arrow-body-style

code split 粒度

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

推荐阅读更多精彩内容

  • 前些日子从@张鑫旭微博处得一份推荐(Front-end-tutorial),号称最全的资源教程-前端涉及的所有知识...
    谷子多阅读 4,137评论 0 44
  • Rancher安装 Rancher是一个开源的容器管理平台,帮助构建企业私有容器服务,相当于KVM里的Openst...
    adeng2016阅读 1,791评论 1 2
  • 孰能无过,过而能改,善莫大焉。 犯错,每个人都曾有过。那么,对于一个犯过错的人,是否应该一辈子都不去原谅ta,不给...
    車心阅读 636评论 0 0