文件目录规范

简介: 规范、整洁的文件目录,让人心情愉悦的同时,还能降低维护的难度,增加项目的可读性。

【前言】

规范、整洁的文件目录,让人心情愉悦的同时,还能降低维护的难度,增加项目的可读性。

由于其可复制性,由此总结出一套适用于前端的文件目录模板。

先来一张大体的目录格式:

目录-1.png

【取名规则】

名称遵循语义化

  1. 组件名需使用大驼峰,例如:PlanSelect
  2. 文件夹、文件按中划线拼接,例如:order-form

【具体拆分】

接口存放:api
子文件按菜单、模块区分

文件目录-1.png

静态资源:assets
分为fonts字体、images图片、style样式表;
images、style下子文件按菜单、模块区分。

文件目录-2.png

全局组件:components
分为business、common子目录;
business存放通用业务组件,子文件名B开头;
common存放通用非业务组件,子文件名C开头。

文件目录-3.png

项目插件:plugins
分为axios、lib等;
axios存放ajax相关配置;
lib存放第三方库、sdk等。

文件目录-4.png

项目路由、状态管理:router、store
router、store的modules下子文件以菜单、模块区分

文件目录-5.png

项目工具包:utils
分为enum、mixin、object、tools;
enum存放通用枚举;
mixin存放通用的拓展;
object存放通用的封装对象;
tools存放全局通用方法。

文件目录-6.png

菜单文件页:page
首层分为components、modules、page、style、utils、index.vue;
components存放当前菜单包含的组件;
modules存放菜单的模块,非页面、非组件(弹窗、表单、区块等等);
page放当前菜单下的二级菜单,子文件夹取自子页面名;
style存放菜单下可复用的样式;
utils结构与前面结构相同,不同在于存放的是本菜单下的枚举、拓展、对象、方法,而非全局性的;
index.vue是当前一级菜单的界面。

文件目录-7.png

Ps: 做到这些,就会使项目看起来更加清晰、简洁。

相关文章
|
移动开发 缓存 JavaScript
2021最新阿里代码规范(前端篇)
2021最新阿里代码规范(前端篇)
56604 11
2021最新阿里代码规范(前端篇)
vw、px、vh 和 rem应用场景以及区别
【4月更文挑战第2天】 vw、px、vh 和 rem应用场景以及区别
1439 10
|
Web App开发 自然语言处理 Java
Elasticsearch简介及安装
Elasticsearch简介及安装
473 0
|
12月前
|
存储 监控 安全
前端框架的数据驱动方式如何保证数据的安全性?
总之,前端框架的数据驱动方式需要综合运用多种手段来保证数据的安全性。从传输、存储、访问控制到防范攻击等各个方面进行全面考虑和实施,以确保用户数据的安全可靠。同时,不断加强安全管理和技术创新,以应对不断变化的安全挑战。
410 60
|
10月前
|
存储 边缘计算 网络协议
StarTower RIP 技术:重塑智能终端算力生态
在智能终端普及的今天,StarTower 的资源交互证明(RIP)技术通过算力打包、存储和调度,重塑了智能终端算力生态。虚拟化技术和容器化管理统一并优化了算力资源,分布式存储与微隔离技术保障数据安全,SDN 和边缘计算卸载提升了算力交互效率。这一创新为高效利用和共享算力开辟了新道路,引领智能化新时代。
352 70
|
小程序 Linux 区块链
Python PyInstaller 打包成 Win、Mac 应用程序(app / exe)
Python PyInstaller 打包成 Win、Mac 应用程序(app / exe)
886 0
|
JavaScript 前端开发 编译器
将 CommonJS 模块转换为 ES6 模块
【10月更文挑战第11天】 将 CommonJS 模块转换为 ES6 模块有三种主要方法:手动修改代码、使用工具(如 Babel)自动转换和逐步迁移。手动修改涉及导出和导入方式的转换,确保名称和结构一致;使用工具可自动化这一过程;逐步迁移适用于大型项目,先在新模块中使用 ES6 语法,再逐步替换旧模块。转换过程中需注意兼容性、代码逻辑调整和充分测试。
747 58
|
安全 前端开发 中间件
中间件在API跨域资源共享(CORS)
【6月更文挑战第16天】
321 7
|
自动驾驶 安全 物联网
2G、3G、4G与5G技术:主要区别详解
2G、3G、4G与5G技术:主要区别详解
7140 14
|
IDE API 开发工具
什么是 pep 8
【8月更文挑战第29天】
1618 4