吉安感知网项目-前端
edit | blame | history | raw

Repository Guidelines

项目结构与模块组织

  • applications/:可运行的 Web 应用(如 drone-command/mobile-web-view/task-work-order/)。
  • packages/:共享库(API、组件、常量、hooks、工具等)。
  • uniapps/:UniApp 相关应用(如 work-app/work-wx/)。
  • 资源文件通常放在各应用内,具体入口以各应用的 README.md 为准。

构建、测试与开发命令

在仓库根目录使用 pnpm
- pnpm install:安装工作区依赖。
- pnpm dev:并行启动所有工作区的开发服务。
- pnpm dev:drone-command:启动单个应用。
- pnpm dev:mobile-web-view:启动单个应用。
- pnpm dev:task-work-order:启动单个应用。
- pnpm dev:work-app:启动 UniApp H5 开发服务。
- pnpm dev:work-wx:启动 UniApp H5 开发服务。
- pnpm build:test:<app> / pnpm build:prod:<app>:构建指定应用,例如 pnpm build:prod:mobile-web-view

编码风格与命名规范

  • 使用 Prettier 统一格式化(.prettierrc.json)。
  • 使用 Tab 缩进(tabWidth: 2, useTabs: true),semi: falsesingleQuote: true
  • SCSS 使用 tabWidth: 4 且双引号。
  • 文件与目录保持 kebabCase,遵循现有应用与包的命名风格。

测试指南

  • 当前未配置测试框架(pnpm test 会直接退出)。
  • 若新增测试,请在对应应用 README.md 说明测试框架,并补充根目录脚本。

提交与合并请求规范

  • 提交历史使用简短的约定式主题(如 feat: ...)。
  • 建议使用 feat:fix:chore:refactor: 等前缀并保持简洁描述。
  • PR 需要包含:目的、影响的应用/包、UI 改动截图。
  • 可关联相关 issue 或工单。

环境与配置

  • Node.js >= 20,pnpm >= 9。
  • 优先使用根目录工作区脚本,除非必要不要在子目录直接运行脚本。