codeguard-r

R Codeguard Gate

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

30-Second Start

1. At the repository root, confirm 无专用标记文件 or that the target files exist.
2. Probe tools:Rscript --version。
3. Read-only check first:Rscript -e 'lintr::lint_dir('"'"'.'"'"')'。
4. Classify results as: code violations, missing configuration, missing tools, tool internal errors.
5. Only perform safe fixable items:styler :: style_dir。
6. Re-run lint, and run the project's existing test/build gates.

You can directly ask:

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

Capability Boundaries

✅ Good At

1. Based on .r and project markers, identify the R workspace.
2. Run Rscript -e 'lintr::lint_dir('"'"'.'"'"')' and preserve exit codes, scope, and tool versions.
3. Distinguish formatting, static rules, configuration, dependency, and environment failures.
4. Use styler :: style_dir to handle reversible issues and rescan.
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 run 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, 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 R code standards.
• AI modified .r, requiring pre-commit validation.
• CI shows failures related to Rscript -e 'lintr::lint_dir('"'"'.'"'"')' .
• 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, so the corresponding language professional skill should be used instead.
• The main task is dependency vulnerabilities, security auditing, or license governance, so a dedicated security skill should be used.
• When the user only asks to explain one error message 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, 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	.r
Project Marker	No dedicated marker file
Access Configuration	Based on the repository's existing configuration
Tool Preparation	Rscript -e 'install.packages(c("lintr","styler"))'
Probe Command	使用命令查找与项目配置检查
lint	Rscript -e 'lintr::lint_dir('"'"'.'"'"')'
format/fix	styler :: style_dir
Project-level gate	Rscript -e 'lintr::lint_dir('"'"'.'"'"')'

Standard Workflow

Step 1: Determine the true 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 Based on the repository's existing configuration and in CI. The repository configuration takes precedence over this skill's examples; if the two conflict, report the discrepancy first.

Step 3: Probe 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: Perform read-only checks

Run Rscript -e 'lintr::lint_dir('"'"'.'"'"')', and record the command, working directory, exit code, tool version, and the first actionable error.

Step 5: Failure classification

Type	Typical Signal	Handling
Format	Indentation, whitespace, import order	Formatter is allowed; then check the diff
Static rules	unused, complexity, naming, dangerous API	Minimal semantic fix; no bulk guessing
Configuration	parser/config/schema not found	Fix the access 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 raw evidence and narrow the reproduction scope

Step 6: Controlled fixes

Prefer to run styler :: style_dir. 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 explicit; 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. Layer the 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 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

R 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 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-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 casually scan or modify third-party content across the whole repository.

Domain pitfalls and fixes

1. Domain pitfalls — R package projects and ordinary script directories have different lint scopes; package projects also need R CMD check.

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 auto-fixing 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. 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 are no rules, exclude generated/vendor first, then explain to the user.

Q5: How can I avoid changing too much at once? Fix in batches by failure category and file, rerunning the original command and reviewing the diff for each batch.

Q6: If it passes locally, can I say CI will pass? No. You also need to align CI's versions, environment variables, operating system, and command scope.

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/, and you do not have to load them all at once.