codeguard-liquid

Liquid (Shopify) Codeguard Gate

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

30-Second Start

1. At the repository root, confirm 无专用标记文件 or the target file exists.
2. Detect tools:theme-check --version。
3. Read-only check first:theme-check .。
4. Classify results as: code violations, missing configuration, missing tools, tool internal errors.
5. Only perform safe-to-fix items:手工最小修复。
6. Rerun lint, and execute the project's existing test/build gates.

You can directly ask:

• "Check this Liquid (Shopify) project, do not modify anything for now, and give me the lint failure classification."
• "Only fix Liquid (Shopify) formatting issues; list semantic issues first."
• "Verify Liquid (Shopify) lint, test, and build evidence before committing."

Capability Boundaries

✅ Good At Handling

1. Based on .liquid and project markers, identify the Liquid (Shopify) workspace.
2. Execute theme-check . and retain the exit code, scope, and tool version.
3. Distinguish formatting, static rules, configuration, dependency, and environment failures.
4. Use 人工最小修复 to handle reversible issues and rescan.
5. Report local results and CI/build/test evidence in layers.

⚠️ Requirements

1. The target tool must already be installed and its version compatible with project constraints.
2. It must be executed 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.

❌ Out of Scope

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

When to Use

• The user requests checking or fixing Liquid (Shopify) code standards.
• AI modified .liquid, requiring pre-commit verification.
• CI has failures related to theme-check . .
• Need to determine whether an issue can be automatically 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 auditing, 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 entire repository is 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 log 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	.liquid
Project Marker	No dedicated marker file
Integration Configuration	Use the repository's existing configuration
Tool Preparation	gem install theme-check
Probe Command	使用命令查找与项目配置检查
lint	theme-check .
format/fix	未接入
Project-Level Gate	theme-check .

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 Use the repository's existing configuration and the actual commands in CI. Repository configuration takes precedence over the examples in this skill; if the two conflict, report the differences 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: Run Read-Only Checks

Run theme-check ., and record the command, working directory, exit code, tool version, and first actionable error.

Step 5: Failure Classification

Type	Typical Signal	Handling
Formatting	Indentation, whitespace, import order	Formatter is allowed, then inspect the diff
Static Rules	unused, complexity, naming, dangerous APIs	Minimal semantic fixes; no batch guessing
Configuration	parser/config/schema not found	Fix the integration or report preconditions
Environment	command not found, version conflict	Report installation/version requirements; do not install silently
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 issues 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. Write "Pass" only 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 rerun 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 that were not run, configurations that were not seen, and platforms that were not verified must be explicitly marked.

Output template

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

Gotchas

1. A missing tool is not a pass — 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 — third-party content must not be scanned or modified across the whole repository at will.

Domain pitfalls and fixes

1. Domain pitfall — Shopify Theme Check targets Shopify Liquid; other Liquid dialects must be confirmed separately.

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. Authoritative command in CI;
5. Whether auto-fix is allowed.

FAQ

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

Q2: Can ignore or suppression be added automatically? No. Exemptions may only be granted 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 too many changes at once be avoided? Fix in batches by failure category and file first, and rerun the original command and review the diff for each batch.

Q6: If it passes locally, can it be said that CI will pass? No. The CI version, environment variables, operating system, and command scope must still be aligned.

Load resources on demand

• When encountering exit codes, failure classification, or exemption decisions, read references/rules/gate-rules.md。
• When the language registry, toolchain, and project configuration need to be checked, read references/tooling/toolchain.md。
• When copyable task examples are needed, read by scenario examples/, and it is not necessary to load all of them at once.