codeguard-vbnet

Visual Basic .NET Codeguard Gate

Goal: turn "looks fine" into repeatable tool evidence, and honestly distinguish 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 tools:dotnet --version。
3. Read-only check first:dotnet format --verify-no-changes。
4. Classify results as: code violations, missing configuration, missing tools, tool internal errors.
5. Only perform safe-to-fix items:dotnet format。
6. Re-run lint, and run the project's existing test/build gates.

You can directly request:

• "Check this Visual Basic .NET project, do not modify anything for now, and give me a classification of the lint failures."
• "Only fix Visual Basic .NET formatting issues, list semantic issues first."
• "Verify Visual Basic .NET lint, test, and build evidence before committing."

Capability Boundaries

✅ Good At

1. Based on .vb and project markers, identify the Visual Basic .NET workspace.
2. Run dotnet format --verify-no-changes and retain exit codes, scope, and tool versions.
3. Distinguish formatting, static rules, configuration, dependency, and environment failures.
4. Use dotnet format to handle reversible issues and rescan.
5. Report local results in layers with CI/build/test evidence.

⚠️ Requires Conditions

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

❌ Out of Scope

1. Do not treat formatter passing as compilation, test, 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 problems.
4. Do not claim "check passed" when tools or configuration are missing.

When to Use

• The user requests checking or fixing Visual Basic .NET code style.
• AI modified .vb, and pre-commit verification is needed.
• CI shows failures related to dotnet format --verify-no-changes .
• Need 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 auditing, or license governance, use a dedicated security skill.
• If the user only asks to explain an error and there is no project context, provide a local explanation first and do not claim the repository is all green.

Data and Security

This skill does not collect, upload, send, or store user code and 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

Item	Current fact
Status	stable(since Codeguard V0.4)
File extensions	.vb
Project marker	No dedicated marker file
Integration configuration	*.sln, *.csproj, *.vbproj
Tool preparation	.NET SDK 6+
Detection command	使用命令查找与项目配置检查
lint	dotnet format --verify-no-changes
format/fix	dotnet format
Project-level gate	dotnet format --verify-no-changes

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 *.sln, *.csproj, *.vbproj and the actual commands in CI. Repository configuration takes precedence over the examples in this skill; if the two conflict, report the differences first.

Step 3: Detect tools and versions

Run 对应工具 --version. Missing tools, incompatible versions, or configurations that cannot be loaded are all recorded as "unable to verify," not as passed.

Step 4: Run read-only checks

Run dotnet format --verify-no-changes, recording 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 fix; no bulk guessing
Configuration	parser/config/schema not found	Fix the integration or report prerequisites
Environment	command not found, version conflict	Report installation/version requirements; do not install silently
Tool internal error	crash, timeout, parser exception	Preserve the original evidence and narrow the reproduction scope

Step 6: Controlled fixes

Prefer running dotnet format. 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. Write "passed" only 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 a style fix into a business rewrite.
4. Configuration takes precedence: Do not override the project's existing ignore, dialect, target, or version constraints.
5. No fabrication: Tools that were not run, configurations that were not seen, and platforms that were not verified must be explicitly marked.

Output template

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

Gotchas

1. Missing tools is not a pass — you must output UNVERIFIED and an explicit way to get ready.
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 checks or load the wrong configuration.
4. A placeholder is not a literal argument — {file} must be replaced with a real, authorized path.
5. Automatic fixes may expand the diff — after fixing, review the diff first, then run the regression gate.
6. Generated and vendor directories need an explicit policy — do not scan or modify third-party content across the whole repository at will.

Domain pitfalls and fixes

1. Domain pitfall — dotnet format needs to resolve a solution/project; when there are only scattered .vb files, you cannot declare a pass.

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. the repository/module root directory;
2. the target tool and version;
3. the project configuration file;
4. the authoritative command in CI;
5. whether automatic fixes are allowed.

FAQ

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

Q2: Can you automatically add ignore or suppression? No. Exemption is allowed only when the user explicitly accepts it and the reason is recorded.

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 is no rule, exclude generated/vendor first, then explain to the user.

Q5: How can you avoid changing too much at once? Fix in batches by failure category and file first; for each batch, rerun the original command and review the diff.

Q6: If it passes locally, can you say CI will pass? No. You also need to align the CI 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 check this language's registry, toolchain, and project configuration, read references/tooling/toolchain.md。
• When you need copyable task examples, read by scenario examples/; there is no need to load them all at once.