寧波芯賽云——vue項(xiàng)目規(guī)范(管理臺)

一稀颁、 文件/文件夾命名規(guī)范

1. src/Views

  • 以一級菜單或模塊分文件夾:權(quán)限管理、會員管理
  • 文件夾為大駝峰命名:PermissionManagement俊戳、Login
  • 各個模塊下頁面以頁面path大駝峰命名:MemberList.vue竣付、MenuManagement.vue
  • 不要用index.vue文件,除非該菜單下包含三級路由:列表詳情需要單獨(dú)頁面鉴象,可以把列表和詳情頁都放在三級菜單忙菠,index.vue作為router-view容器
  • 模塊下的靜態(tài)數(shù)據(jù)、類型定義纺弊、脫耦方法牛欢、復(fù)雜方法、數(shù)據(jù)處理方法等可提取的一切都放到對應(yīng)模塊下的js中淆游,以功能創(chuàng)建文件:const.ts傍睹、func.ts、types.ts
  • 模塊下組件提取到component文件夾下犹菱,頁面組件非必要不提取拾稳,必要條件:單獨(dú)功能點(diǎn)(上下文耦合極低)、復(fù)用(覆蓋超過80%)

2. src/components

  • 組件本身使用大駝峰命名
  • 0耦合組件直接放在basic文件夾下:任何項(xiàng)目都可以用 Icon.vue
  • 本項(xiàng)目組件按照組件類型分文件夾:2種表格/table/DefaultTable.vue和/table/ColorTable.vue腊脱、/modal/DefaultDialog.vue

3.其他

  • 任何文件命名都要規(guī)范访得,最少做到望文知義

二、src/styles/提取規(guī)范

  • 提取的樣式一般不涉及業(yè)務(wù)
  • 提取的顆粒度做到最小
  • 提取的樣式class以功能命名:m-top-16(mt-16)陕凹,text-aline-center(ta-center)
  • 提取的樣式的值必須是項(xiàng)目中常用的:例如padding和margin一般ui設(shè)計(jì)的時(shí)候都是有規(guī)范的悍抑,例如8px鳄炉、16px、24px或者10px搜骡、20px拂盯、30px之類的,例如flex定義為1的情景记靡,特殊場景在vue文件內(nèi)自定義
  • ui框架需要統(tǒng)一樣式覆蓋的情景(官方方案滿足不了)磕仅,樣式覆蓋外層一定要帶上業(yè)務(wù)class,避免影響到其他同事的頁面簸呈,需要覆蓋的頁面直接附上class即可
  • 業(yè)務(wù)樣式不需要提取榕订,復(fù)用性高的話就要考慮為什么不提取組件了
  • class都是以小寫中劃線命名,別和我說什么方便復(fù)制
  • 補(bǔ)充一點(diǎn):通用class以功能命名蜕便,那么業(yè)務(wù)class就一定是以業(yè)務(wù)來命名:user-block劫恒、username、user-age轿腺,2種命名不要弄混了

三两嘴、src/components/提取規(guī)范

  • 組件比較復(fù)雜或和業(yè)務(wù)關(guān)聯(lián)性比較強(qiáng)的時(shí)候,可以對組件本身進(jìn)行拆分
  • 組件的不同情景盡量使用slot族壳,不要使用if-else
  • 組件的樣式盡量不使用公共class憔辫,而是再組件內(nèi)部消化(方便其他項(xiàng)目單獨(dú)使用)

四、src/utils/仿荆、src/const/贰您、src/hooks/提取規(guī)范

  • utils 為全局工具類,里面是全局的方法:request.ts拢操、dateFormate.ts锦亦、auth.ts
  • const為項(xiàng)目常量,一般是鍵值對令境、固定的數(shù)據(jù)列表等杠园,最好按照業(yè)務(wù)模塊文件區(qū)分
  • hooks前提必須先明白什么是hook,然后再進(jìn)行提取舔庶,理論上hook對業(yè)務(wù)是極低耦合的:每個頁面都要記錄用戶行為抛蚁,那么點(diǎn)擊上報(bào)這就是一個hook
  • 當(dāng)然要utils干凈一點(diǎn),可以有一個單獨(dú)的func文件夾惕橙,用來放公共方法

五瞧甩、其他規(guī)范(參考)

http://www.reibang.com/p/85e93d2ce8f6
https://gitee.com/webxingjie/document/blob/master/前端開發(fā)規(guī)范.md


未完待續(xù)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市吕漂,隨后出現(xiàn)的幾起案子亲配,更是在濱河造成了極大的恐慌尘应,老刑警劉巖惶凝,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件吼虎,死亡現(xiàn)場離奇詭異,居然都是意外死亡苍鲜,警方通過查閱死者的電腦和手機(jī)思灰,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來混滔,“玉大人洒疚,你說我怎么就攤上這事∨饔欤” “怎么了油湖?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵,是天一觀的道長领跛。 經(jīng)常有香客問我乏德,道長,這世上最難降的妖魔是什么吠昭? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任喊括,我火速辦了婚禮,結(jié)果婚禮上矢棚,老公的妹妹穿的比我還像新娘郑什。我一直安慰自己,他們只是感情好蒲肋,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布蘑拯。 她就那樣靜靜地躺著,像睡著了一般兜粘。 火紅的嫁衣襯著肌膚如雪强胰。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天妹沙,我揣著相機(jī)與錄音偶洋,去河邊找鬼。 笑死距糖,一個胖子當(dāng)著我的面吹牛玄窝,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播悍引,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼恩脂,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了趣斤?” 一聲冷哼從身側(cè)響起俩块,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后玉凯,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體势腮,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年漫仆,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了捎拯。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡盲厌,死狀恐怖署照,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情吗浩,我是刑警寧澤建芙,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站懂扼,受9級特大地震影響岁钓,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜微王,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一屡限、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧炕倘,春花似錦钧大、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至涨醋,卻和暖如春瓜饥,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背浴骂。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工乓土, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人溯警。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓趣苏,卻偏偏與公主長得像,于是被迫代替她去往敵國和親梯轻。 傳聞我的和親對象是個殘疾皇子食磕,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評論 2 355

推薦閱讀更多精彩內(nèi)容