用途
angularjs-health-audit 是一个针对 AngularJS(Angular 1.x)项目的项目健康审计技能。它通过一套模块化、可顺序执行的规则,对既有 AngularJS 代码库进行系统性体检,并生成统一的 Markdown 审计报告。
主要能力
- 全面项目审计:评估 AngularJS 项目健康的多个方面,包括技术栈、模块/组件架构、服务与数据流、测试、构建与资源管线、代码质量、文档等。
- 基于证据的分析:要求基于仓库中实际存在的证据进行分析,不虚构数据、不做假设;证据缺失时报告为 “Unknown”。
- 模块化规则执行:协调 13 条专用分析规则的顺序执行,每条规则可独立运行,其输出汇入最终报告。
- 评分计算:计算各分段得分(0–100)以及加权总分。
- 技术风险评估:识别技术风险、技术债以及迁移风险指标(如框架生命周期终止、Bower 弃用)。
- 报告整合:将来自多条分析规则的发现综合为统一的 Markdown 报告。
- AngularJS 最佳实践评估:考察
.component()/controllerAs 与重度$scope控制器的对比、指令设计、.factory/.service分层、$http/拦截器、$rootScope使用纪律、digest-cycle/$watch卫生、ng-repeat的track by、$sce.trustAsHtml,以及可安全压缩的依赖注入(DI)。 - 遗留前端架构理解:理解模块组织、按功能与按类型分文件夹,以及 Bower/Grunt/gulp 资源管线。
使用方式
执行流程按步骤顺序进行,并采用基于波次(Wave)的并行执行策略:
- Wave 0(顺序,强制):Step 0 环境搭建。使用 nvm 对齐项目的 Node.js 版本(强制,失败即停止),安装 npm 开发工具链以及(若存在 bower.json)Bower 组件,并生成 Karma/Jasmine 覆盖率。
- Wave 1(并行):Step 1 仓库盘点 + Step 2 核心配置文件分析。
- Wave 2(并行):Step 3 构建与资源管线 + Step 4 测试基础设施 + Step 5 代码质量与 Linter + Step 8 AI Harness 与采用度分析。
- Wave 3(并行):Step 6 服务与数据流分析 + Step 7 文档与运维。
- Wave 4(顺序):Step 9 生成最终报告 + Step 10 导出最终报告。报告保存至
./reports/<YYYY-MM-DD>-<project>-angularjs-health-audit.md。
执行纪律要求:不得跳过、合并或缩写任何步骤;执行每个步骤前先完整阅读其引用的 .md 文件并遵循其指令;每完成一步输出 “STEP N COMPLETED: [简要结果摘要]”;不得用摘要代替执行引用文件。强制步骤失败时立即停止并给出解决步骤;非关键问题可带警告继续。
报告包含:总体评分的高层摘要、含全部 9 个分段得分的一览记分卡、9 个详细分段(技术栈、架构、状态管理、测试、代码质量、性能、文档与运维、CI/CD、AI Harness 与采用度)、附加指标、风险与机会(5–8 条,含 AngularJS EOL/Bower 弃用迁移风险)、建议(6–10 条优先级行动)、证据索引附录以及评分方法附录。
适用场景
适用于对既有的 AngularJS(Angular 1.x)代码库进行技术健康评估,涵盖技术栈、架构、服务与数据流、测试、构建管线、代码质量、文档和 AI Harness 采用度等维度,并输出可分享的 Markdown 报告。安全分析需另行运行独立的安全审计(/somnio:security-audit)。
限制
- 明确针对 AngularJS(Angular 1.x),不适用于其它前端框架。
- 仅聚焦技术层面,明确不提供运营/治理类建议(如不推荐 CODEOWNERS、SECURITY.md,不推荐 runbook、部署流程、监控等运维文档)。
- 要求基于仓库证据,无法证明的内容必须标注为 “Unknown”。
- 强制步骤(如 nvm 配置)失败时执行会停止。
- 报告评分依据 references/report-generator.md 中的权重与方法;其余具体收费、价格、平台等信息暂未提供。