codeguard-groovy

Groovy Codeguard Gate

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

Start in 30 seconds

1. At the repository root, confirm 无专用标记文件 or the target file exists.
2. Detect the tool:npm-groovy-lint --version。
3. First do a read-only check:bash -c 'find . -name '"'"'*.groovy'"'"' -type f -not -path '"'"'*/node_modules/*'"'"' -print0 | xargs -0 -r npm-groovy-lint --no-insight'。
4. Classify the results into: code violations, missing configuration, missing tool, tool internal errors.
5. Only perform safe-to-fix items:npm-groovy-lint --fix。
6. Re-run lint, and execute the project's existing test/build gates.

Can directly propose:

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

Capability boundaries

✅ Good at handling

1. Based on .groovy and project markers to identify Groovy workspaces.
2. Run npm-groovy-lint '{file}' and preserve exit codes, scope, and tool version.
3. Distinguish between formatting, static rules, configuration, dependency, and environment failures.
4. Use npm-groovy-lint --fix to handle reversible issues and re-scan.
5. Report local results layered with CI/build/test evidence.

⚠️ Requires conditions

1. The target tool must be installed and the 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 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, 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 Groovy code style.
• AI modified .groovy, needs pre-commit verification.
• CI shows failures related to npm-groovy-lint '{file}' .
• Need to determine whether an issue can be auto-fixed, 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 audits, or license governance; use a dedicated security skill.
• When the user only asks to explain one 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 and credentials. By default it only reads local repository configuration and runs local tools; it does not install dependencies online, 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.5)
File Extension	.groovy
Project Marker	No dedicated marker file
Integration Configuration	build.gradle, build.gradle.kts, pom.xml
Tool Preparation	npm install -g npm-groovy-lint
Detection Command	使用命令查找与项目配置检查
lint	npm-groovy-lint '{file}'
format/fix	npm-groovy-lint --fix
Project-level gate	bash -c 'find . -name '"'"'*.groovy'"'"' -type f -not -path '"'"'*/node_modules/*'"'"' -print0 | xargs -0 -r npm-groovy-lint --no-insight'

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

Step 3: Detect Tools and Versions

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

Step 4: Run Read-Only Checks

Run bash -c 'find . -name '"'"'*.groovy'"'"' -type f -not -path '"'"'*/node_modules/*'"'"' -print0 | xargs -0 -r npm-groovy-lint --no-insight', 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 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 and narrow down the reproduction scope

Step 6: Controlled Fixes

Prefer to run npm-groovy-lint --fix. 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, 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: tools not run, configurations not seen, and platforms not verified must be explicitly marked.

Output Template

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

Gotchas

1. Missing tools are not a pass — must output UNVERIFIED and a clear preparation method.
2. formatter is not linter — all-green formatting cannot cover static rules or compile errors.
3. The root directory determines the result — Running on the wrong module may miss issues or load the wrong configuration.
4. Placeholders are not literal arguments — {file} and must be replaced with real, authorized paths.
5. Auto-fixes may enlarge the diff — After fixing, review the diff first, then run the regression gates.
6. Generated and vendor directories require an explicit policy — Do not scan or modify third-party content across the whole repository at will.

Domain Pitfalls and Fixes

1. Domain Pitfalls — Groovy's dynamic features limit static lint coverage; Gradle/Jenkins DSL requires validation against the host.

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 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 code first, then explain to the user.

Q5: How can too many changes at once be avoided? Fix in batches by failure category and file first, rerunning the original command and reviewing the diff for each batch.

Q6: If it passes locally, can we say CI will pass? No. CI's versions, environment variables, operating system, and command scope still need to be aligned.

Load Resources as Needed

• 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 all of them at once.