codeguard-cfml

CFML (ColdFusion) Codeguard Gate

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

Start in 30 seconds

1. At the repository root, confirm that 无专用标记文件 or the target file exists.
2. Detect tools:cflint --version。
3. First do a read-only check:bash -c 'find . \( -name '"'"'*.cfc'"'"' -o -name '"'"'*.cfm'"'"' \) -type f -print0 | xargs -0 -r cflint'。
4. Classify results as: code violations, missing configuration, missing tools, tool internal errors.
5. Only perform safe-to-fix items:手工最小修复。
6. Re-run lint, and run the project's existing test/build gates.

You can directly ask:

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

Capability boundaries

✅ Good at handling

1. Identify the CFML (ColdFusion) workspace based on .cfc, .cfm, .cfs and project markers.
2. Run cflint '{file}' and preserve exit codes, scope, and tool versions.
3. Distinguish between formatting, static rules, configuration, dependency, and environment failures.
4. Use 人工最小修复 to handle reversible issues and re-scan.
5. Report local results separately from CI/build/test evidence.

⚠️ Requires conditions

1. The target tool must be installed and its version must be compatible with 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 issues.
4. Do not claim "checks passed" when tools or configuration are missing.

When to use

• The user asks to check or fix CFML (ColdFusion) code standards.
• AI modified .cfc, .cfm, .cfs, and pre-commit verification is needed.
• CI shows failures related to cflint '{file}' .
• It is necessary 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 audits, 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 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

Project	Current Facts
Status	stable(since Codeguard V0.5)
File Extensions	.cfc, .cfm, .cfs
Project Markers	No dedicated marker file
Onboarding Configuration	Subject to the repository's existing configuration
Tool Preparation	brew install cflint
Probe Command	使用命令查找与项目配置检查
lint	cflint '{file}'
format/fix	未接入
Project-level gate	bash -c 'find . \( -name '"'"'*.cfc'"'"' -o -name '"'"'*.cfm'"'"' \) -type f -print0 | xargs -0 -r cflint'

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 difference first.

Step 3: Probe Tools and Versions

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

Step 4: Run Read-Only Checks

Run bash -c 'find . \( -name '"'"'*.cfc'"'"' -o -name '"'"'*.cfm'"'"' \) -type f -print0 | xargs -0 -r cflint', 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 formatter, then check the diff
Static Rules	unused, complexity, naming, dangerous APIs	Minimal semantic fixes; no bulk guessing
Configuration	parser/config/schema not found	Fix onboarding or report prerequisites
Environment	command not found, version conflict	Report installation/version requirements; do not silently install
Internal Tool Error	crash, timeout, parser exception	Preserve the original evidence and narrow the reproduction scope

Step 6: Controlled Fixes

Prefer to run 人工最小修复. Only handle problems that are certain and reversible; dependency upgrades, rule exemptions, generated files, and business semantic changes must be explained separately.

Step 7: Verification Loop

Rerun 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. Reverify with the same command: after a fix, the original command that triggered the failure must be rerun.
2. Layered 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 that were not run, configurations that were not seen, and platforms that were not verified must be explicitly marked.

Output template

CFML (ColdFusion) 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. A formatter is not a linter — all-green formatting cannot override static rules or compilation errors.
3. The root directory determines the result — running in the wrong module may miss checks 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 require an explicit policy — you must not casually scan or modify third-party content across the whole repository.

Domain pitfalls and fixes

1. Domain pitfalls — CFML dialect and engine differences affect CFLint results; Adobe CF or Lucee must be specified.

When there is insufficient information

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-fix is allowed.

FAQ

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

Q2: Can I automatically add ignore or suppression? 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; when 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, and after 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 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.