文件目录规范

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

【前言】

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

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

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

目录-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: 做到这些,就会使项目看起来更加清晰、简洁。

相关文章
vw、px、vh 和 rem应用场景以及区别
【4月更文挑战第2天】 vw、px、vh 和 rem应用场景以及区别
1579 10
阿里云商标注册申请官方入口(附商标自助申请流程)
阿里云商标分为商标智能注册申请、商标安心注册申请和商标顾问注册申请
33184 4
阿里云商标注册申请官方入口(附商标自助申请流程)
Echarts 热力图自定义开发
Echarts 热力图自定义开发
1935 0
|
Web App开发 自然语言处理 Java
Elasticsearch简介及安装
Elasticsearch简介及安装
602 0
|
SQL 关系型数据库 MySQL
【MySQL基础篇】多表查询(隐式/显式内连接、左/右外连接、自连接查询、联合查询、标量/列/行/表子查询)
本文详细介绍了MySQL中的多表查询,包括多表关系、隐式/显式内连接、左/右外连接、自连接查询、联合查询、标量/列/行/表子查询及其实现方式,一文全面读懂多表联查!
2515 2
【MySQL基础篇】多表查询(隐式/显式内连接、左/右外连接、自连接查询、联合查询、标量/列/行/表子查询)
|
小程序 Linux 区块链
Python PyInstaller 打包成 Win、Mac 应用程序(app / exe)
Python PyInstaller 打包成 Win、Mac 应用程序(app / exe)
1310 0
|
JavaScript 前端开发 编译器
将 CommonJS 模块转换为 ES6 模块
【10月更文挑战第11天】 将 CommonJS 模块转换为 ES6 模块有三种主要方法:手动修改代码、使用工具(如 Babel)自动转换和逐步迁移。手动修改涉及导出和导入方式的转换,确保名称和结构一致;使用工具可自动化这一过程;逐步迁移适用于大型项目,先在新模块中使用 ES6 语法,再逐步替换旧模块。转换过程中需注意兼容性、代码逻辑调整和充分测试。
938 58
|
前端开发 JavaScript 程序员
HarmonyOS NEXT开发-ArkTS五
本文介绍了ArkTS中的联合类型和枚举类型,讲解了定义与使用方法,并详细阐述了模块的导出与导入(包括静态导入、动态导入及HarmonyOS SDK的开放能力导入),帮助开发者更好地理解和应用这些特性。君志所向,一往无前!
342 0
HarmonyOS NEXT开发-ArkTS五
|
网络协议 Java Shell
java spring 项目若依框架启动失败,启动不了服务提示端口8080占用escription: Web server failed to start. Port 8080 was already in use. Action: Identify and stop the process that’s listening on port 8080 or configure this application to listen on another port-优雅草卓伊凡解决方案
java spring 项目若依框架启动失败,启动不了服务提示端口8080占用escription: Web server failed to start. Port 8080 was already in use. Action: Identify and stop the process that’s listening on port 8080 or configure this application to listen on another port-优雅草卓伊凡解决方案
1054 7
|
存储 Java 测试技术
阿里巴巴java开发手册
这篇文章是关于阿里巴巴Java开发手册的整理,内容包括编程规约、异常日志、单元测试、安全规约、MySQL数据库使用以及工程结构等方面的详细规范和建议,旨在帮助开发者编写更加规范、高效和安全的代码。