Vue项目中的文件/文件夹命名规范
文件或文件夹的命名遵循以下原则:
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 { default as AppMain } from './AppMain'
export { default as Navbar } from './Navbar'
export { default as Sidebar } from './Sidebar'
看index.js中最后一行代码,不难发现,为什么components下的子文件夹要使用
PascalCase
命名:export { default as Sidebar } from './sidebar' // 使用kebab-case命名的文件夹 export { default as Sidebar } 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项目中的文件/文件夹命名规范相关推荐
- Vue项目中操作svg文件
Vue项目中使用svg 引入依赖 yarn add svg-sprite-loader -D [可选] yarn add svgo svgo-loader -D 依赖说明: svg-sprite-lo ...
- vue项目中的 env文件从何而来?什么是 process.env
start 在 vue 项目中,时常会遇到到这么一行代码 process.env 这东西是什么,怎么用? 今天一篇文章带你了解 process.env 1.使用场景 先别急,先看 vue 项目中的用法 ...
- vue-cli构建的vue项目中引入stylus文件
stylus是css预处理器.还有另外两种css预处理器语言详解:less.sass. 不懂的可以先看一下这篇文章:stylus预处理入门 在vue项目引入stylus css预处理器,可以让我们的c ...
- styl类型文件css,vue-cli构建的vue项目中引入stylus文件
stylus是css预处理器.还有另外两种css预处理器语言详解:less.sass. 不懂的可以先看一下这篇文章:stylus预处理入门 在vue项目引入stylus css预处理器,可以让我们的c ...
- vue项目中引入.xlsx文件
安装3个依赖包 $ npm install -S file-saver $ npm install -S xlsx $ npm install -D script-loader template部分 ...
- vue 项目中 下载保存文件(MP3)
前面解决了 a标down属性 down不下来的问题.今天来说一下遇到的下载mp3文件的需求.解决图片跨域 用到了canvas.那么mp3格式的文件,可以采用哪些方式down下来呢. 1---form ...
- Vue项目中使用svg文件
使用第三方插件vue-svg-icon npm i vue-svg-icon -D 在入口文件main.js引入 import Vue from from 'vue' import Icon from ...
- 如何在 vue 项目中引入 html 文件
这里以 vue-cli3 为例子,在pubilc目录下引入html就行了 如果需要查看的可用下面的方法 1 window.open(`/ssh-terminal-template/index.html ...
- VUE 项目中引入外部js文件(CND引入)
以VUE项目中引入echarts文件为例: 第一步在VUE项目中找到index.html文件 引入 :<script src="https://cdnjs.cloudflare.com ...
- Vue项目中750设计稿px自动转化成rem方法(小白一个,记录自己遇到的小白问题,大家勿怪)
一.首先下载 postcss-pxtorem 运行npm install postcss-pxtorem 完成下载之后,在package.json文件中添加这段代码 "postcss&quo ...
最新文章
- 关于simplemodal的动态加载
- php使用第三方登录
- 宁波大红鹰学院计算机毕设,网络文化对价值观的影响调查报告马克思主义基本原理概论》课程调查实践报告大学毕业设计.doc...
- 财务凭证过账增强 BAPI_ACC_DOCUMENT_POST
- 进程隐藏与进程保护(SSDT Hook 实现)(二)
- Python使用技巧
- 前端优化-vue-cli4安装webpack-bundle-analyzer分析包文件
- ubuntu中启动oracle数据库
- map key char*
- vue全局安装jquery,vue使用bootstrap框架,vue中封装websocket通讯,vue引入element-ui 组件库,引入highcharts图表插件
- Activiti5第十一弹,流程监听器与任务监听器
- 彭文华:详解数字化转型的破局之道(附直播视频)
- java去掉重复字符_Java实现去掉字符串重复字母的方法示例
- DDNS 通过阿里云API接口实现 DDNS 动态解析
- 企业大数据价值你只发掘了1%!
- 任务宿主阻止关机解决方案
- windows通过资源管理器访问服务器(samba服务),您需要权限来执行此操作
- 浮点型数据的输入和输出(C语言)
- 数据库Java项目:在线租房出租房屋系统(java+springboot+maven+mysql)
- 腾讯地图中轻松定义多边形
热门文章
- Deploy Apache Flink Natively on YARN/Kubernetes
- android可以root的版本,Android8.0以上系统ROOT时,Magisk框架替代SpuerSU
- python pickle反序列化漏洞_渗透测试 - 黑客技术 | 【技术分享】记CTF比赛中发现的Python反序列化漏洞_吾爱漏洞...
- 查看linux文件的日期格式,5个在Linux中管理文件类型和系统时间的有用命令
- java中怎么创建单列模式,java中的3种方式创建的单例模式
- mysql 存储过程 注入_MySQL数据库(六)-- SQL注入攻击、视图、事物、存储过程、流程控制...
- 用matlab给图像加水印,大神,在MATLAB中将图像水印插入音频文件可否给我个具体的步骤啊!很着急​...
- MySQL报错113_连接 MySQL 报错'NoneType' object has no attribute '__getitem__'
- 计算机专硕超过270分人数,从18调剂看19备考策略(附76所院校19招生简章)
- 帆软统计函数之统计有效性