SuperAPI AI 工具集

powershell-code-review

编程与开发

查看项目

更新于 10-16 14:59

技能介绍

用途

PowerShell Code Review 是一个面向 PowerShell 脚本与模块的生产就绪性代码审查技能,主要服务于企业级(如 Fortune 100 环境)的 PowerShell 代码审计。它借助埃隆·马斯克的五步设计流程来消除冗余、简化逻辑并加固代码,且要求按顺序执行。

审查理念

五步流程依次为:

  1. 让需求不那么愚蠢——质疑每一项需求,谁签署的?为什么存在?
  2. 删除——最关键的一步,移除一切无法证明其存在必要的内容。
  3. 简化/优化——仅在删除之后进行,绝不优化本不该存在的东西。
  4. 加速周期时间——代码是否有利于更快迭代,还是制造瓶颈?
  5. 自动化——最后一步,绝不自动化应被删除的内容。

默认倾向于删除,要求代码证明其必须存在,而非假设它应该存在。

工作流程

  1. 接收代码:支持内联粘贴、文件路径引用或 GitHub URL。
  2. 应用五步流程:逐步质疑需求、删除、简化、加速、自动化。
  3. 分类问题:覆盖正确性与逻辑(缺陷、错误假设、数据流错误、Graph/API 调用准确性)、安全性(凭据、令牌、输入验证、注入风险、最小权限)、性能(冗余调用、N+1 模式、不必要的物化)、PowerShell 最佳实践(命名、[CmdletBinding()]、管道设计、错误处理)、跨平台(PowerShell Core 兼容性、操作系统特定隔离)、错误处理与日志(终止性 vs 非终止性、结构化错误、避免泛型 catch)、可维护性(SRP、DRY/KISS/YAGNI、无注释可读性、守卫子句)。
  4. 生成报告:输出 Markdown 报告,结构包括执行摘要、关键问题、建议删除、建议增强、可选改进、风险评估、附录:删除摘要。默认保存为 <ScriptName>-review.md,除非用户指定路径。

主要能力

  • 依据五步设计流程系统化审查 PowerShell 代码。
  • 覆盖多个审查类别,包括正确性、安全、性能、最佳实践、跨平台、错误处理与可维护性。
  • 提供 PowerShell 最佳实践快速参考,涵盖命名、函数、错误处理、输出、破坏性操作等。
  • 输出结构化 Markdown 审查报告。

使用方式

用户以三种方式之一提交 PowerShell 代码(内联粘贴、文件路径、GitHub URL),技能按五步流程逐一审查,然后分类问题并生成报告。报告默认保存为 <ScriptName>-review.md。

适用场景

适用于需要对 PowerShell 脚本或模块进行生产就绪性审计的场景,尤其是企业级环境中的代码质量、安全与性能审查。

限制

资料中未提供关于该技能的收费、价格、平台依赖或具体使用效果的信息;未说明其运行环境或集成方式。