SuperAPI AI 工具集

typescript-source-organization

编程与开发

查看项目

更新于 10-16 06:48

技能介绍

用途:在具体任务中应用 TypeScript Style Guide 的源码组织约定,用于按功能组织代码、就近放置文件、规划单体仓库各应用结构,并审查或解释相关约定。

主要能力与规则:每个应用或包按功能分组文件与文件夹,代码尽量就近放置,较深的目录嵌套不算问题。导入路径可用相对路径(以 ./ 或 ../ 开头)或绝对路径(如 @common/utils)。同一功能内彼此“接近”的文件应使用相对导入,便于整体移动时无需改动;其余情况使用绝对导入。所有导入应由工具(如 prettier-plugin-sort-imports、eslint-plugin-import 等)自动排序。示例:避免 import { bar, foo } from '../../../../../../distant-folder';,改用 import { locationApi } from '@api/locationApi';。

项目结构示例:前端单体仓库中 modules 负责各页面及其自定义功能(组件、hooks、工具函数),common 存放真正跨应用使用的实现,应谨慎使用;同一组件被多个页面使用时移入 common。使用基于文件系统的路由框架(如 Next.js)时,pages 仅作路由、定义路由,不放业务逻辑。后端项目同样按功能分组,模块内包含 model、controller、route、service、validation、test 与 index 等文件。

工作方式:先检查消费仓库现有结构、框架约定与配置;仓库显式约定优先于本指南;只应用、审查或解释与任务相关的指导;当组织方式取决于项目规模、框架或团队约定时,说明重要权衡。

限制:导入排序在有配置时交由格式化与 lint 工具负责;不因该技能启用而重组无关文件。具体命令与安装方式暂未提供。