codeguard-powershell

PowerShell Codeguard Gate

Goal: turn "looks fine" into repeatable tool evidence, and honestly distinguish between pass, fail, unable to verify, and planned.

Start in 30 Seconds

1. At the repository root, confirm that 无专用标记文件 or the target file exists.
2. Probe the tool:pwsh --version。
3. Read-only check first:pwsh -NoProfile -Command 'Invoke-ScriptAnalyzer -Path . -Severity Error'。
4. Classify results into: code violations, missing configuration, missing tools, tool internal errors.
5. Only perform safely fixable items:pwsh -NoProfile -Command Invoke-Formatter。
6. Re-run lint, and run the project's existing test/build gates.

You can directly ask:

• "Check this PowerShell project, don't modify anything yet, and give me a classification of lint failures."
• "Only fix PowerShell formatting issues, and list semantic issues first."
• "Before committing, verify PowerShell lint, test, and build evidence."

Capability Boundaries

✅ Good At

1. Based on .ps1, .psm1 and project markers to identify the PowerShell workspace.
2. Run pwsh -NoProfile -Command 'Invoke-ScriptAnalyzer -Path . -Severity Error' and preserve exit codes, scope, and tool version.
3. Distinguish between formatting, static rules, configuration, dependency, and environment failures.
4. Use pwsh -NoProfile -Command Invoke-Formatter to handle reversible issues and re-scan.
5. Report local results and CI/build/test evidence in layers.

⚠️ Requires Conditions

1. The target tool must already be installed and its version compatible with the project constraints.
2. It must be run from the correct repository or module root directory.
3. If the project has custom configuration, the committed configuration prevails.
4. Whether generated code, vendor, and cache directories are scanned must follow repository rules.

❌ Not Applicable

1. Do not treat formatter passing as compilation, testing, or security audit passing.
2. Do not silently install tools, upgrade dependencies, or modify team rules.
3. Do not use suppress/ignore/raising thresholds to hide real issues.
4. Do not claim "checks passed" when tools or configuration are missing.

When to Use

• The user asks to check or fix PowerShell code style.
• AI has modified .ps1, .psm1, and pre-commit verification is needed.
• CI shows failures related to pwsh -NoProfile -Command 'Invoke-ScriptAnalyzer -Path . -Severity Error' .
• It is necessary to determine whether an issue can be fixed automatically or must be handled manually.

When Not to Use

• If the main task is learning language syntax, framework design, or business modeling, use the corresponding language professional skill instead.
• If the main task is dependency vulnerabilities, security audits, or license governance, use a dedicated security skill.
• If the user only asks to explain a single error and there is no project context, first do a local explanation and do not claim the repository is all green.

Data and Security

This skill does not collect, upload, send, or store user code or credentials. By default, it only reads local repository configuration and runs local tools; it does not install dependencies over the network and does not record tokens, passwords, or private source code. Before any automatic fix, check the diff first; destructive or large-scale changes must be explicitly confirmed by the user.

Execution Contract

Project	Current facts
Status	stable(since Codeguard V0.5)
File extensions	.ps1, .psm1
Project marker	No dedicated marker file
Integration configuration	Based on the repository's existing configuration
Tool preparation	Install-Module PSScriptAnalyzer
Probe command	使用命令查找与项目配置检查
lint	pwsh -NoProfile -Command 'Invoke-ScriptAnalyzer -Path . -Severity Error'
format/fix	pwsh -NoProfile -Command Invoke-Formatter
Project-level gate	pwsh -NoProfile -Command 'Invoke-ScriptAnalyzer -Path . -Severity Error'

Standard Workflow

Step 1: Determine the real scope

Confirm the repository root, module roots, generated directories, vendor directories, and user-specified files. For multi-module projects, first list the modules that will be scanned; do not guess based on the current directory.

Step 2: Read the project contract

Read the actual commands in the repository's existing configuration and CI. The repository configuration takes precedence over the examples in this skill; if the two conflict, report the differences first.

Step 3: Probe tools and versions

Run 对应工具 --version. If a tool is missing, the version is incompatible, or the configuration cannot be loaded, record it as "unable to verify", not as a pass.

Step 4: Run read-only checks

Run pwsh -NoProfile -Command 'Invoke-ScriptAnalyzer -Path . -Severity Error', and record the command, working directory, exit code, tool version, and the first actionable error.

Step 5: Failure classification

Type	Typical signal	Handling
Formatting	Indentation, whitespace, import order	Formatter allowed, then check the diff
Static rules	unused, complexity, naming, dangerous APIs	Minimal semantic fixes, no bulk guessing
Configuration	parser/config/schema not found	Fix the integration or report the preconditions
Environment	command not found, version conflict	Report installation/version requirements, do not install silently
Tool internal error	crash, timeout, parser exception	Preserve the raw evidence and narrow the reproduction scope

Step 6: Controlled fixes

Prefer running pwsh -NoProfile -Command Invoke-Formatter. Only handle issues that are certain and reversible; dependency upgrades, rule exemptions, generated files, and business semantic changes must be explained separately.

Step 7: Verification loop

Re-run the same lint command, then run the project's existing tests and build. Only write "pass" when the command, scope, and exit code are all clear; otherwise write "not run" or "unable to verify".

Rules

1. Re-verify with the same command: after fixing, you must re-run the original command that triggered the failure.
2. Layered evidence: report lint, format, compile, test, and security separately.
3. Minimal changes: do not refactor along the way, and do not expand style fixes into business rewrites.
4. Configuration first: do not override the project's existing ignore, dialect, target, or version constraints.
5. No making things up: tools not run, configurations not seen, and platforms not verified must be clearly marked.

Output template

PowerShell Codeguard 结果
- 范围：<仓库/模块/文件>
- 工具：<名称与版本>
- 命令：<实际命令>
- 状态：PASS / FAIL / UNVERIFIED / PLANNED
- 发现：<按格式/规则/配置/环境分类>
- 修改：<文件与原因；无修改写 none>
- 复验：<命令、退出码>
- 未验证：<测试/构建/平台差异>

Gotchas

1. A missing tool is not a pass — you must output UNVERIFIED and a clear preparation method.
2. A formatter is not a linter — all-green formatting cannot cover static rules or compilation errors.
3. The root directory determines the result — Running in the wrong module may miss detections or load the wrong configuration.
4. Placeholders are not literal arguments — {file} must be replaced with real, authorized paths.
5. Auto-fix may expand the diff — after fixing, review the diff first, then run the regression gate.
6. Generated and vendor directories require an explicit policy — do not arbitrarily scan or modify third-party content across the whole repository.

Domain Pitfalls and Fixes

1. Domain Pitfall — Windows PowerShell and PowerShell 7 have different rules/modules; confirm the target runtime first.

When Information Is Insufficient

Do not just say "please provide more information." First give a safe read-only inspection plan, and list the specific items that still need confirmation:

1. Repository/module root directory;
2. Target tool and version;
3. Project configuration files;
4. The authoritative command in CI;
5. Whether auto-fix is allowed.

FAQ

Q1: If the tool is not installed, can we conclude the code is fine? No. The status must be UNVERIFIED。

Q2: Can ignores or suppressions be added automatically? No. Exemptions are allowed only when the user explicitly accepts them and the reason is documented.

Q3: Why does it still fail after formatting? The formatter only covers formatting; static rules, configuration, compilation, and tests still need to be handled separately.

Q4: Should generated code be scanned? By default, follow the repository configuration; if there are no rules, exclude generated/vendor first, then explain to the user.

Q5: How can I avoid making too many changes at once? First fix in batches by failure category and file; re-run the original command and review the diff after each batch.

Q6: If it passes locally, can I say CI will pass? No. You also need to align CI's version, environment variables, operating system, and command scope.

Load Resources on Demand

• When encountering exit codes, failure classification, or exemption decisions, read references/rules/gate-rules.md。
• When you need to verify this language's registry, toolchain, and project configuration, read references/tooling/toolchain.md。
• When you need copyable task examples, read by scenario examples/, no need to load everything at once.