codeguard-solidity

Solidity Codeguard Gate

Goal: turn "looks fine" into repeatable tool evidence, and honestly distinguish pass, fail, unverifiable, and planned.

Start in 30 seconds

1. At the repository root, confirm that 无专用标记文件 or the target file exists.
2. Probe tools:solhint --version。
3. Read-only check first:solhint '**/*.sol'。
4. Classify results as: code violations, missing configuration, missing tools, tool internal errors.
5. Only perform on safely fixable items:prettier --plugin=prettier-plugin-solidity --write。
6. Re-run lint, and run the project's existing test/build gates.

You can directly propose:

• "Check this Solidity project, don't modify anything yet, and give me the lint failure classification."
• "Only fix Solidity formatting issues, list semantic issues first."
• "Verify Solidity lint, test, and build evidence before committing."

Capability boundaries

✅ Good at handling

1. Based on .sol and project markers, identify the Solidity workspace.
2. Run solhint '**/*.sol' and preserve exit codes, scope, and tool versions.
3. Distinguish formatting, static rules, configuration, dependency, and environment failures.
4. Use prettier --plugin=prettier-plugin-solidity --write 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 project constraints.
2. Must be executed 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 problems.
4. Do not claim "checks passed" when tools or configuration are missing.

When to use

• The user requests checking or fixing Solidity code standards.
• AI modified .sol, and pre-commit verification is needed.
• CI has failures related to solhint '**/*.sol' .
• Need to determine whether an issue can be auto-fixed 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.
• When the user only asks to explain one 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 log 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.3)
File extension	.sol
Project marker	No dedicated marker file
Integration configuration	Subject to the repository's existing configuration
Tool preparation	npm install -g solhint prettier prettier-plugin-solidity
Probe command	使用命令查找与项目配置检查
lint	solhint '**/*.sol'
format/fix	prettier --plugin=prettier-plugin-solidity --write
Project-level gate	solhint '**/*.sol'

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 to 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. Repository configuration takes precedence over this skill's examples; if the two conflict, report the differences first.

Step 3: Probe tools and versions

Run 对应工具 --version. Missing tools, incompatible versions, or failure to load configuration are all recorded as "unable to verify", not as passed.

Step 4: Run read-only checks

Run solhint '**/*.sol', 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	Allow the formatter, 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 the prerequisites
Environment	command not found, version conflicts	Report installation/version requirements, do not silently install
Tool internal error	crash, timeout, parser exception	Preserve the original evidence, narrow down the reproduction scope

Step 6: Controlled fixes

Prefer to run prettier --plugin=prettier-plugin-solidity --write. 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 "passed" 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 a fix, the original command that triggered the failure must be re-run.
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 fabrication allowed: Tools that were not run, configurations that were not seen, and platforms that were not verified must be explicitly labeled.

Output template

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

Gotchas

1. Missing tools are not a pass — you must output UNVERIFIED and a clear way to prepare.
2. formatter is not linter — all-green formatting cannot override static rules or compilation errors.
3. Root directory determines the result — running in the wrong module may cause missed checks or loading 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 — you must not arbitrarily scan or modify third-party content across the entire repository.

Domain pitfalls and fixes

1. Domain pitfall — Solhint is a style/static check; it does not replace Slither, Foundry tests, or contract audits.

When information is insufficient

Do not just say "please provide more information." First provide 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 you conclude the code is fine? No. The status must be UNVERIFIED。

Q2: Can you automatically add ignore or suppression? No. An 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, first exclude generated/vendor content, then explain to the user.

Q5: How can you avoid changing too much at once? First fix in batches by failure category and file; after 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 CI's version, environment variables, operating system, and command scope.

Load resources on demand

• When encountering exit codes, failure classifications, 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 all of them at once.