Vue项目中的文件/文件夹命名规范

网址:https://www.cnblogs.com/dongzhuangdian/p/9992542.html
文件或文件夹的命名遵循以下原则:

文件夹camelCase

单文件组件camelCase || kebab-case

变量camelCase || _隔开

template中的组件kebab-case

组件的name值camelCase

Vue 推荐文件夹、单文件组件、组件name值以PascalBase规则命名

index.js 或者 index.vue,统一使用小写字母开头的(kebab-case)命名规范

属于组件或类的,统一使用大写字母开头的(PascalCase)命名规范

其他非组件或类的,统一使用小写字母开头的(kebab-case)命名规范

1. Why?

文件夹命名: camelCase VS kebab-case

展开node_modules中的项目依赖,会发现,几乎所有的项目文件夹命名都是 kebab-case命名的,使用kebab-case命名的文件夹比camelCase命名的文件夹看起来更清晰

组件命名:kebab-case VS PascalCase

vue的官方的风格指南中关于组件文件名的推荐:

单文件组件文件的大小写强烈推荐

单文件组件的文件名应该要么始终是单词大写开头 (PascalCase),要么始终是横线连接 (kebab-case)。

单词大写开头对于代码编辑器的自动补全最为友好,因为这使得我们在 JS(X) 和模板中引用组件的方式尽可能的一致。然而,混用文件命名方式有的时候会导致大小写不敏感的文件系统的问题,这也是横线连接命名同样完全可取的原因。

2. 文件夹命名规范

属于components文件夹下的子文件夹,使用大写字母开头的PascalBase风格

全局通用的组件放在 /src/components下

其他业务页面中的组件,放在各自页面下的 ./components文件夹下

每个components文件夹下最多只有一层文件夹,且文件夹名称为组件的名称,文件夹下必须有index.vue或

index.js,其他.vue文件统一大写开头(Pascal case),components下的子文件夹名称统一大写开头(PascalCase)

其他文件夹统一使用kebab-case的风格

全局公共组件:/src/components示例

-[components]-[Breadcrumb]-index.vue-[Hamburger]-index.vue-[SvgIcon]-index.vue

业务页面内部封装的组件:以 /src/views/layout/components示例

-[src]-[views]-[layout]-[components]-[Sidebar]-index.vue-Item.vue-SidebarItem.vue-AppMain.vue-index.js-Navbar.vue`

index.js 中导出组件方式如下:

export{defaultasAppMain }from'./AppMain'export{defaultasNavbar }from'./Navbar'export{defaultasSidebar }from'./Sidebar'

看index.js中最后一行代码,不难发现,为什么components下的子文件夹要使用PascalCase命名:

export{defaultasSidebar }from'./sidebar'// 使用kebab-case命名的文件夹export{defaultasSidebar }from'./Sidebar'// 使用 PascalCase命名的文件夹

对于组件的导出/导入,我们一般都是使用大写字母开头的PascalCase风格,

以区别于.vue组件内部的其他camelCase声明的变量,

[Sidebar]作为【侧边栏组件】的一个整体被导出,文件夹的命名也采用PascalCase,

有利于index.js中export时的前后统一,避免很多情况下不注意区分大小写

3. 文件命名规范

3.1. *.js文件命名规范

属于类的.js文件,除index.js外,使用PascalBase风格

其他类型的.js文件,使用kebab-case风格

属于Api的,统一加上Api后缀

3.2. *.vue文件命名规范

除index.vue之外,其他.vue文件统一用PascalBase风格

3.3. *.less文件命名规范

统一使用kebab-case命名风格

Vue 推荐文件夹、单文件组件、组件name值以PascalBase规则命名

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 文件或文件夹的命名遵循以下原则:index.js 或者 index.vue,统一使用小写字母开头的(kebab-c...
    WHU_凌晨_Bin阅读 36,294评论 2 17
  • 目的 统一开发风格,使代码结构更加清晰明了。 前提条件 项目是用vue搭建的,前端vue打开项目是需要一个环境运行...
    风凌摆渡人阅读 543评论 1 4
  • 这里是官方的 Vue 特有代码的风格指南。如果在工程中使用 Vue,为了回避错误、小纠结和反模式,该指南是份不错的...
    youins阅读 6,003评论 0 5
  • title: 风格指南type: style-guide 这里是官方的 Vue 特有代码的风格指南。如果在工程中使...
    ChenyuMa阅读 1,227评论 1 1
  • 什么是组件? 组件 (Component) 是 Vue.js 最强大的功能之一。组件可以扩展 HTML 元素,封装...
    youins阅读 9,708评论 0 13

友情链接更多精彩内容