codeguard-graphql

GraphQL Codeguard Gate

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

Start in 30 Seconds

1. At the repository root, confirm that 无专用标记文件 or the target file exists.
2. Probe the tool:npx --no-install eslint --version。
3. First do a read-only check:npx --no-install eslint --ext .graphql .。
4. Classify results as: code violations, missing configuration, missing tools, tool internal errors.
5. Only apply safe fixes:npx eslint --ext .graphql . --fix。
6. Re-run lint, and run the project's existing test/build gates.

You can directly ask:

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

Capability Boundaries

✅ Good at handling

1. Based on .graphql, .gql and project markers to identify GraphQL workspaces.
2. Run npx --no-install eslint --ext .graphql . and preserve exit codes, scope, and tool versions.
3. Distinguish formatting, static rules, configuration, dependency, and environment failures.
4. Use npx eslint --ext .graphql . --fix to handle reversible issues and re-scan.
5. Report local results separately from CI/build/test evidence.

⚠️ Conditions required

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.
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 pass as compilation, test, or security audit pass.
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 GraphQL code standards.
• AI modified .graphql, .gql, requiring pre-commit verification.
• CI shows failures related to npx --no-install eslint --ext .graphql . .
• 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 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 give a local explanation and do not claim the whole repository is 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 Facts
Status	stable(since Codeguard V0.4)
File Extensions	.graphql, .gql
Project Marker	No dedicated marker file
Integration Configuration	Subject to the repository's existing configuration
Tool Preparation	graphql-eslint
Probe Command	npx --no-install eslint --version
lint	npx --no-install eslint --ext .graphql .
format/fix	npx eslint --ext .graphql . --fix
Project-level gate	npx --no-install eslint --ext .graphql .

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 existing repository configuration and 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 npx --no-install eslint --version. If a tool is missing, the version is incompatible, or the configuration cannot be loaded, record it as "Unable to verify", not as a pass.

Step 4: Perform read-only checks

Run npx --no-install eslint --ext .graphql ., and record the command, working directory, exit code, tool version, and the first actionable error.

Step 5: Classify failures

Type	Typical Signals	Handling
Formatting	Indentation, whitespace, import order	Formatter is 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 raw evidence and narrow the reproduction scope

Step 6: Controlled fixes

Prefer running npx eslint --ext .graphql . --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, 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, configurations not seen, and platforms not verified must be clearly marked.

Output Template

GraphQL 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 issues 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 — Do not arbitrarily scan or modify third-party content across the entire repository.

Domain pitfalls and fixes

1. Domain pitfalls — GraphQL lint depends on the schema; without a schema, only limited document rules can be validated.

When information is insufficient

Do not just say "please provide more information." First provide 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 you conclude the code is fine? No. The status must be UNVERIFIED。

Q2: Can ignore or suppression 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 are no rules, exclude generated/vendor first, then explain to the user.

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

Q6: If it passes locally, can you say CI will pass? No. You also need to align CI's 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 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 there is no need to load all of them at once.