Static Code Analysis 是一个围绕静态代码分析实践组织的技能,目标是通过自动化工具在不运行代码的前提下分析源代码,尽早捕获缺陷、安全问题与风格违规。
用途 该技能用于在开发流程中引入静态代码分析能力,覆盖以下典型场景:执行编码规范、检测安全漏洞、预防缺陷、自动化代码审查、接入 CI/CD 流水线、配置 pre-commit 钩子以及辅助重构。
主要能力 技能以配置示例和参考指南的形式提供实现指导。快速开始部分给出一个最小可用的 ESLint 配置示例(.eslintrc.js),其中继承 eslint:recommended、plugin:@typescript-eslint/recommended 和 plugin:security/recommended,并启用 @typescript-eslint、security、import 插件。示例规则包括:no-console 设为 warn 并允许 error 与 warn;no-unused-vars 设为 error;prefer-const 设为 error;eqeqeq 设为 error 且 always;no-eval 设为 error;security/detect-object-injection 设为 warn;security/detect-non-literal-regexp 设为 warn;@typescript-eslint/no-explicit-any 设为 warn;@typescript-eslint/explicit-function-return-type 设为 error;import/order 设为 error 并配置 builtin、external、internal 等分组。
参考指南 技能在 references/ 目录中提供更详细的实现说明,涵盖以下主题:ESLint 配置、Python 代码检查(pylint + mypy)、pre-commit 钩子、SonarQube 集成、自定义 AST 分析、安全扫描。
使用方式 资料未提供具体的安装命令或调用步骤,仅给出配置示例与参考指南目录。实际使用时应结合项目语言与工具链,参考对应指南进行配置。
最佳实践 应做:在 CI/CD 中运行 linter;使用 pre-commit 钩子;配置 IDE 集成;逐步修复问题;记录自定义规则;在团队内共享配置;自动化安全扫描。 不应做:忽略所有警告;跳过 linter 设置;提交违反 lint 规则的代码;初期使用过于严格的规则;跳过安全扫描;无理由禁用规则。
适用场景与限制 适用于需要统一代码标准、提前发现安全与质量问题的团队与项目,尤其适合与 CI/CD 和提交钩子结合。限制方面,资料未说明支持的具体语言范围、工具版本要求、性能影响或收费信息,这些内容暂未提供。