宁波芯赛云——vue项目规范(管理台)

一、 文件/文件夹命名规范

1. src/Views

  • 以一级菜单或模块分文件夹:权限管理、会员管理
  • 文件夹为大驼峰命名:PermissionManagement、Login
  • 各个模块下页面以页面path大驼峰命名:MemberList.vue、MenuManagement.vue
  • 不要用index.vue文件,除非该菜单下包含三级路由:列表详情需要单独页面,可以把列表和详情页都放在三级菜单,index.vue作为router-view容器
  • 模块下的静态数据、类型定义、脱耦方法、复杂方法、数据处理方法等可提取的一切都放到对应模块下的js中,以功能创建文件:const.ts、func.ts、types.ts
  • 模块下组件提取到component文件夹下,页面组件非必要不提取,必要条件:单独功能点(上下文耦合极低)、复用(覆盖超过80%)

2. src/components

  • 组件本身使用大驼峰命名
  • 0耦合组件直接放在basic文件夹下:任何项目都可以用 Icon.vue
  • 本项目组件按照组件类型分文件夹:2种表格/table/DefaultTable.vue和/table/ColorTable.vue、/modal/DefaultDialog.vue

3.其他

  • 任何文件命名都要规范,最少做到望文知义

二、src/styles/提取规范

  • 提取的样式一般不涉及业务
  • 提取的颗粒度做到最小
  • 提取的样式class以功能命名:m-top-16(mt-16),text-aline-center(ta-center)
  • 提取的样式的值必须是项目中常用的:例如padding和margin一般ui设计的时候都是有规范的,例如8px、16px、24px或者10px、20px、30px之类的,例如flex定义为1的情景,特殊场景在vue文件内自定义
  • ui框架需要统一样式覆盖的情景(官方方案满足不了),样式覆盖外层一定要带上业务class,避免影响到其他同事的页面,需要覆盖的页面直接附上class即可
  • 业务样式不需要提取,复用性高的话就要考虑为什么不提取组件了
  • class都是以小写中划线命名,别和我说什么方便复制
  • 补充一点:通用class以功能命名,那么业务class就一定是以业务来命名:user-block、username、user-age,2种命名不要弄混了

三、src/components/提取规范

  • 组件比较复杂或和业务关联性比较强的时候,可以对组件本身进行拆分
  • 组件的不同情景尽量使用slot,不要使用if-else
  • 组件的样式尽量不使用公共class,而是再组件内部消化(方便其他项目单独使用)

四、src/utils/、src/const/、src/hooks/提取规范

  • utils 为全局工具类,里面是全局的方法:request.ts、dateFormate.ts、auth.ts
  • const为项目常量,一般是键值对、固定的数据列表等,最好按照业务模块文件区分
  • hooks前提必须先明白什么是hook,然后再进行提取,理论上hook对业务是极低耦合的:每个页面都要记录用户行为,那么点击上报这就是一个hook
  • 当然要utils干净一点,可以有一个单独的func文件夹,用来放公共方法

五、其他规范(参考)

https://www.jianshu.com/p/85e93d2ce8f6
https://gitee.com/webxingjie/document/blob/master/前端开发规范.md


未完待续

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

推荐阅读更多精彩内容