SuperAPI AI 工具集

angular-style-guide

前端与建站

查看项目

更新于 10-16 08:48

技能介绍

用途:为 Angular 项目提供命名约定、文件结构与编码规范,适用于命名 Angular 文件、组织项目结构或遵循 Angular 风格指南时使用。优先级为 P0(关键)。

原则:单一职责,每个文件一个组件或服务,函数少于 75 行;文件少于 400 行,超出则重构;严格命名,采用 kebab-case 加类型后缀,如 hero-list.component.ts、auth.service.ts、user.pipe.ts、app.routes.ts。Barrel 文件 index.ts 仅用于公共 API,同一特性内不做深层 barrel 导入,直接导入;错误的 barrel 放置会破坏 tree-shaking。LIFT 原则:快速定位代码、按名称识别文件、结构尽量扁平、尽量 DRY。

命名标准:文件为 kebab-case.type.ts;类为 PascalCase 加类型后缀(HeroListComponent、AuthService);指令为 camelCase 选择器并带 app 前缀(如 appHighlight);管道为 camelCase 名称(如 truncate);服务为 PascalCase 加 Service 后缀(HeroService);接口不使用 I 前缀,不加 IUser/IHero,直接以名词命名,如 User、Hero。

文件夹结构:core 位于 src/app/core/,存放单例与全局状态;shared 位于 src/app/shared/,存放可复用 UI 与管道;features 位于 src/app/features/,按需懒加载,文件夹深度不超过 3 层,不得更深嵌套。

反模式:模板中不放逻辑,移到组件类或 computed() signal;不做深层嵌套,保持文件夹深度不超过 3 层;接口不加 I 前缀。

限制:当前资料未提供安装命令、许可、收费、平台支持与版本要求等信息。