codeguard-kotlin

Kotlin 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 无专用标记文件 or the target file exists.
2. Detect tools:./gradlew --version。
3. First do a read-only check:./gradlew detekt。
4. Classify results as: code violations, missing configuration, missing tools, tool internal errors.
5. Only perform safely fixable items:./gradlew ktlintFormat。
6. Rerun lint, and run the project's existing test/build gates.

You can directly ask:

• "Check this Kotlin project, do not modify anything first, and give me a classification of lint failures."
• "Only fix Kotlin formatting issues; list semantic issues first."
• "Before commit, verify Kotlin lint, tests, and build evidence."

Capability boundaries

✅ Good at handling

1. Based on .kt, .kts and project markers, identify the Kotlin workspace.
2. Run ./gradlew detekt and retain the exit code, scope, and tool version.
3. Distinguish formatting, static rules, configuration, dependency, and environment-related failures.
4. Use ./gradlew ktlintFormat to handle reversible issues and rescan.
5. Report local results in layers with CI/build/test evidence.

⚠️ 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 passing formatter as passing compilation, tests, or security audit.
2. Do not silently install tools, upgrade dependencies, or modify team rules.
3. Do not use suppress/ignore/raise thresholds to mask real issues.
4. Do not claim "check passed" when tools or configuration are missing.

When to use

• The user asks to check or fix Kotlin code style.
• AI modified .kt, .kts, and pre-commit verification is needed.
• CI has failures related to ./gradlew detekt .
• Need to determine whether an issue can be fixed automatically or must be handled manually.

When not to use

• The main task is learning language syntax, framework design, or business modeling; use the corresponding language professional skill instead.
• The main task is dependency vulnerabilities, security audit, or license governance; use dedicated security skills.
• 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 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.2)
File Extensions	.kt, .kts
Project Marker	No dedicated marker file
Onboarding Config	build.gradle, build.gradle.kts, settings.gradle, pom.xml
Tool Preparation	The project must configure the detekt / ktlint plugins
Detection Command	使用命令查找与项目配置检查
lint	./gradlew detekt
format/fix	./gradlew ktlintFormat
Project-level gate	./gradlew detekt

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 build.gradle, build.gradle.kts, settings.gradle, pom.xml and the actual commands in CI. Repository configuration takes precedence over the examples in this skill; if the two conflict, report the difference first.

Step 3: Detect Tools and Versions

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

Step 4: Run Read-Only Checks

Run ./gradlew detekt, 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	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 onboarding 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 and narrow down the reproduction scope

Step 6: Controlled Fixes

Run ./gradlew ktlintFormatfirst. 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 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 Fabrication: tools not run, configuration not seen, and platforms not verified must be explicitly marked.

Output Template

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

Gotchas

1. A missing tool is not a pass — must output UNVERIFIED and a clear preparation method.
2. A formatter is not a linter — All-green formatting cannot override static rules or compilation errors.
3. 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 scan or modify third-party content across the entire repository at will.

Domain pitfalls and fixes

1. Domain pitfalls — Detekt and ktlint are different gates; the Gradle wrapper version and plugin configuration must be based on the project.

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 tools and versions;
3. Project configuration files;
4. Authoritative commands 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 ignore or suppression be added automatically? No. Exemptions are only allowed 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 I 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 I say CI will pass? No. You also need to align the CI versions, 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/, and there is no need to load them all at once.