codeguard-clojure

Clojure Codeguard Gate

Goal: turn "looks fine" into repeatable tool evidence, and honestly distinguish passed, failed, unable to verify, and planned.

30-second start

1. At the repository root, confirm that deps.edn`, `project.clj or the target file exists.
2. Probe tools:clj-kondo --version。
3. First do a read-only check:clj-kondo --lint src。
4. Classify results into: code violations, missing configuration, missing tools, tool internal errors.
5. Only perform on safely fixable items:cljstyle。
6. Rerun lint, and run the project's existing test/build gates.

You can directly ask:

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

Capability boundaries

✅ Good at handling

1. Identify the Clojure workspace based on .clj, .cljs, .cljc, .edn and project markers.
2. Run clj-kondo --lint src and preserve exit codes, scope, and tool versions.
3. Distinguish formatting, static rules, configuration, dependency, and environment failures.
4. Use cljstyle to handle reversible issues and rescan.
5. Report local results and CI/build/test evidence in layers.

⚠️ Conditions required

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 takes precedence.
4. Whether generated code, vendor, and cache directories are scanned must follow repository rules.

❌ Not applicable

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 "checks passed" when tools or configuration are missing.

When to use

• The user requests checking or fixing Clojure code standards.
• AI modified .clj, .cljs, .cljc, .edn, and pre-commit verification is needed.
• CI shows failures related to clj-kondo --lint src .
• You need to determine whether an issue can be fixed automatically or must be handled manually.

When not to use

• When the main task is learning language syntax, framework design, or business modeling, use the corresponding language professional skill instead.
• When 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, first provide 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, inspect 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.5)
File Extension	.clj, .cljs, .cljc, .edn
Project Marker	deps.edn, project.clj
Integration Configuration	Follow the repository's existing configuration
Tool Preparation	brew install clj-kondo cljstyle
Detection Command	使用命令查找与项目配置检查
lint	clj-kondo --lint src
format/fix	cljstyle
Project-level gate	clj-kondo --lint src

Standard Workflow

Step 1: Determine the Real Scope

Confirm the repository root, module root, 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: Detect Tools and Versions

Run 对应工具 --version. Missing tools, incompatible versions, or configurations that fail to load are all recorded as "unable to verify," not as passing.

Step 4: Run Read-Only Checks

Run clj-kondo --lint src, 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; check the diff afterward
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 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; narrow the reproduction scope

Step 6: Controlled Fixes

Prefer running cljstyle. 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. Evidence layering: 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 first: Do not override the project's existing ignore, dialect, target, or version constraints.
5. No fabrication: Tools not run, configurations not seen, and platforms not verified must be clearly marked.

Output Template

Clojure 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 up static rule 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. Automatic fixes 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 — The clj-kondo cache and classpath affect macro analysis; macro projects must provide an export configuration.

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 file;
4. The authoritative command in CI;
5. Whether automatic fixes are allowed.

FAQ

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

Q2: Can ignore or suppression be added automatically? No. Exemptions are allowed only when the user explicitly accepts them 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 are no rules, exclude generated/vendor first, then explain to the user.

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

Q6: If it passes locally, can we say CI will pass? No. You also need to align the 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/, there is no need to load them all at once.