Skip to main content

工程结构说明

实际的目录里有测试相关的文件,这里忽略它们 ( jest.config.js 等关键字)

📁 my-app
├─ 📁 public
│ │─ 📁 @
│ │ ├─ 📁 assets // 资源文件存放目录,比如图片,音视频文件,字体文件等。
│ │ └─ index.html // 应用启动入口 html 模板
├─ 📁 src
│ │─ 📁 api
│ │ ├─ 📁 interceptors // http 拦截器 目录
│ │ ├─ 📁 mock // http 拦截器 目录
│ │ │ ├─📁 mock // http 拦截器 目录
│ │ │ │ └─ 📁 data // mock 数据配置 目录
│ │ │ └─ server.ts // mock 启动配置
│ │ ├─ 📁 models // 数据模型定义 目录
│ │ ├─ 📁 utils // 常用工具函数 目录
│ │ │ ├─📁 await-wrap.ts // await 函数扩展 函数
│ │ │ ├─📁 query-parse.ts // query 参数格式化 函数
│ │ │ ├─📁 resolve-context.ts // 后台返回数据格式化 函数
│ │ │ ├─📁 validation.ts // 常见校验函数
│ │ │ └─📁 validators.ts // 自定义表单校验器
│ │ ├─📁 http-client.ts // http 请求方法封装
│ │ ├─📁 data-result.ts // http 后台返回值数据结构定义
│ │ └─ ...
│ │─ 📁 assets // 资源文件存放目录,比如图片,音视频文件,字体文件等。
│ │─ 📁 components // 项目级别公共组建目录
│ │─ 📁 composables // 项目级别公共组合api目录
│ │─ 📁 filter // 项目级别过滤器 目录
│ │─ 📁 layouts // 项目级别通用布局 目录
│ │─ 📁 router // 路由配置文件 目录
│ │─ 📁 store // 状态管理 目录
│ │─ 📁 styles // 公共样式 目录
│ │ └─ variables.less // 主题样式参数定义文件
│ │─ 📁 views // 业务组件 目录
│ │ └─ ...
│ │─ app.vue // 根组件
│ │─ main.scss // 样式代码
│ │─ main.ts // 应用启动入口 ts 代码
│ │─ shims-vue.d.ts // vue-cli初始化ts项目生成的shims-vue.d.ts 类型定义文件
│ │─ tools // 第三方工具库 目录
├─ .babelrc.json // babel 配置文件
├─ .editorconfig // 编辑器格式化配置文件
├─ .env // 环境变量配置
├─ .env.devlopment // 环境变量配置
├─ .env.production // 环境变量配置
├─ .env.test // 环境变量配置
├─ .eslintrc.js // eslint 配置文件
├─ .gitignore // git忽略配置
├─ .gitlab-ci.yml // git CICD 配置
├─ .npmrc // npm 配置文件ß
├─ .prettierignore // 代码格式化文件忽略配置
├─ .prettierrc // 代码格式化配置
├─ .prettierrc.js // 代码格式化配置
├─ .stylelintrc.js // stylelint 格式化配置文件
├─ CHANGELOG.md // 变更说明文件
├─ Jenkinsfile // Jenkins配置
├─ jest.config.js // 自动化测试 配置
├─ package.json // 编辑器格式化配置文件
├─ README.md // 项目介绍文件,可以写配置环境和启动项目步骤
├─ sonar-project.properties // SonarQube配置
├─ tsconfig.json // ts 通用配置
├─ vue.config.js // Vue CLI 配置
└─ ...