📦 Workspace Guardian — 工作区守护者

文件创建与目录组织规则

核心价值

• 节省 token：减少重复搜索定位的时间
• 节约时间：不再花时间找文件
• 降低管理成本：产出物有序不混乱

何时生效

当用户没有明确指定路径时，此规则强制生效。

文件命名规范

基本原则

• 使用有意义的英文名称
• 使用小写字母和数字
• 使用连字符 - 分隔单词
• 避免使用缩写
• 避免使用中文

具体规则

# ✅ 正确
user-service.ts
auth-middleware.js
database-config.yml
# ❌ 错误
UserService.ts        # 使用了大写
auth_middleware.js    # 使用了下划线
数据库配置.yml        # 使用了中文

文件类型命名

目录结构规范

根目录结构

src/                  # 源代码
tests/                # 测试代码
docs/                 # 文档和资源
scripts/              # 脚本工具
config/               # 配置文件

源代码目录

src/
├── components/       # UI 组件
├── services/         # 业务服务
├── utils/            # 工具函数
├── types/            # 类型定义
├── constants/        # 常量定义
├── hooks/            # 自定义 Hooks
├── pages/            # 页面组件
└── layouts/          # 布局组件

测试目录

tests/
├── unit/             # 单元测试
├── integration/      # 集成测试
└── e2e/              # 端到端测试

代码组织原则

• 单一职责：每个文件只包含一个主要概念
• 就近原则：相关文件放在一起
• 层次清晰：目录结构反映代码层次
• 命名一致：同类型文件使用相同命名模式

路径使用示例

// ✅ 正确 - 使用 src 作为根目录
import { UserService } from '@/services/user.service';
import { Header } from '@/components/header.component';
// ❌ 错误 - 使用绝对路径或中文路径
import { UserService } from '/Users/zhangsan/project/src/services/user.service';
import { Header } from './组件/头部.tsx';

配置文件位置

总结

Workspace Guardian 规则确保项目结构清晰、一致、可维护， 让所有团队成员都能快速找到所需文件，提高开发效率。