文件命名规则.mdc 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. # 文件命名规则
  2. ## 文件命名规范
  3. ### 组件文件命名
  4. 1. **UI组件文件**
  5. - 使用小写字母加连字符(kebab-case)
  6. - 例如:`button.tsx`, `card.tsx`, `mode-toggle.tsx`
  7. - 文件名应简洁明了,表达组件的功能
  8. 2. **页面组件文件**
  9. - 使用大驼峰命名法(PascalCase)
  10. - 例如:`HelloWorld.tsx`, `App.tsx`
  11. 3. **布局组件**
  12. - 使用小写字母加连字符(kebab-case)
  13. - 放置在 `layout` 目录下
  14. - 例如:`mode-toggle.tsx`
  15. ### 非组件文件命名
  16. 1. **工具函数文件**
  17. - 使用小写字母加连字符(kebab-case)
  18. - 放置在 `lib` 目录下
  19. - 例如:`utils.ts`
  20. 2. **钩子文件**
  21. - 使用 `use-` 前缀加小写字母和连字符(kebab-case)
  22. - 放置在 `hooks` 目录下
  23. - 例如:`use-mobile.ts`
  24. 3. **状态管理文件**
  25. - 使用小写字母加连字符(kebab-case)
  26. - 放置在 `store` 目录下
  27. - 例如:`counter-store.ts`, `theme-store.ts`
  28. 4. **类型定义文件**
  29. - 使用小写字母加连字符(kebab-case)
  30. - 放置在 `types` 目录下
  31. - 例如:`components.ts`, `index.ts`
  32. ### 目录命名
  33. 1. 所有目录使用小写字母命名
  34. 2. 目录名使用单数形式表示类别,如 `store`
  35. 3. 目录结构应遵循项目介绍中的规范