文件结构、命名优化;

IFLOW描述文件更新;
This commit is contained in:
yuantao
2025-09-28 16:34:48 +08:00
parent 2a4232b695
commit 931fa1afd3
6 changed files with 158 additions and 577 deletions

View File

@@ -13,10 +13,13 @@
```
.
├── api/ # 接口相关
├── api/ # 接口相关
│ ├── modules/ # 业务接口
│ └── request.js # 请求封装
├── common/ # 公共资源
│ ├── styles/ # 全局样式
│ │ ├── common.css # codefun原子类样式
│ │ └── base.scss # 全局样式变量
│ └── utils/ # 工具函数
├── components/ # 公共组件
├── uni_modules/ # uni-app 组件
@@ -24,6 +27,7 @@
│ └── luch-request/ # luch-request 网络请求库
├── uview-plus/ # uView-Plus 组件库
├── mixins/ # Vue 混入
├── store/ # 状态管理
├── pages/ # 主包页面
├── subPages/ # 分包页面
├── App.vue # 应用入口
@@ -31,6 +35,7 @@
├── pages.json # 页面配置
├── manifest.json # 应用配置
├── uni.scss # 全局样式变量
├── vite.config.js # Vite 编译配置
└── .env # 环境变量
```
@@ -60,11 +65,26 @@ npm install
## 样式
* 全局样式文件位于 `common/styles/` 目录下,包括 `common.css``normal.scss`
* 样式优先使用codefun原子类样式。
* 样式规范应遵循项目中已有的风格。
## JavaScript
* 严格遵循ES6规范。
* 遵循JavaScript函数式编程范式。
* 方法类函数应该使用 `function` 进行定义。
* 避免出现超过4个以上的 `ref`超过4个则使用 `reactive`
* 页面的生命周期按需进行导入,如(`import { onLoad } from '@dcloudio/uni-app'`)。
* 所有全局变量都集中放置于代码顶部。
* 所有变量都应该写有注释说明、类型说明。
* 所有的 `Promise` 方法使用 `async` `await` 写法,并进行容错处理。
* 所有的字符串拼接使用ES6的模板语法。
* JavaScript规范应遵循项目中已有的风格。
## 静态资源
* 所有静态资源需要使用环境变量 `VITE_ASSETSURL`
* 静态资源变量 `ASSETSURL` 已全局导入,可以在 `<template></template>` 中直接使用
* 所有静态资源URL应该使用 `ASSETSURL` 进行拼接,如:`${ASSETSURL}simple.png`
## 工具函数 (tool.js)
@@ -80,15 +100,19 @@ npm install
* 网络请求使用 `lib/luch-request` 库进行封装。
* 全局配置在 `api/request.js` 中定义包括基础URL、请求头、SSL验证等。
* 包含请求和响应拦截器,用于处理通用逻辑(如错误提示、鉴权等)。
* 各业务板块的接口都应存放在 `api/modules` 下,并将单个接口进行导出以便页面按需导入。
## 组件
* 项目集成了 `uView-Plus``z-paging` 两个组件库,组件均全局导入,可以直接使用。
* 项目集成了 `uView-Plus``z-paging` 两个组件库,组件均全局导入,可以直接使用。
* `uView-Plus` 组件的使用方式是 `u-icon``u-input``u-textarea`
* 自定义组件放在 `components/` 目录下。
* 全局组件放在 `components/` 目录下。
* 页面独立组件放在页面根目录下的 `components/`
* 每个组件应该附带 `README.MD` 文档。
* 组件编写应遵循项目中已有的风格。
## 页面
* 页面配置在 `pages.json` 中管理。
* 主包页面放在 `pages/` 目录下,分包页面放在 `subPages/` 目录下。
* 页面的生命周期按需进行导入,如(`import { onLoad } from '@dcloudio/uni-app'`)
* 注释、结构规范应遵循项目中已有的风格