SuperAPI AI Directory

codeguard-vue

Coding & development

View repository

Updated 10-15 21:48

About this skill

Vue 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 tools:npx --no-install eslint --version。
  3. First perform a read-only check:npx --no-install eslint --ext .vue .。
  4. Classify results into: code violations, missing configuration, missing tools, tool internal errors.
  5. Only perform this on items that can be safely fixed:npx eslint --ext .vue . --fix。
  6. Rerun lint, and execute the project's existing test/build gates.

You can directly ask:

  • "Check this Vue project, do not modify anything first, and give me the lint failure classification."
  • "Only fix Vue formatting issues, and list semantic issues first."
  • "Verify Vue lint, test, and build evidence before committing."

Capability Boundaries

✅ Good at handling

  1. Identify the Vue workspace based on .vue and project markers.
  2. Execute npx --no-install eslint --ext .vue . and retain the exit code, scope, and tool version.
  3. Distinguish formatting, static rules, configuration, dependency, and environment failures.
  4. Use npx eslint --ext .vue . --fix to handle reversible issues and rescan.
  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 the 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 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 conceal real issues.
  4. Do not claim "check passed" when tools or configuration are missing.

When to use

  • The user requests checking or fixing Vue code standards.
  • AI modified .vueand pre-commit verification is needed.
  • CI has a failure related to npx --no-install eslint --ext .vue . .
  • Need to determine whether an issue can be fixed automatically or must be handled manually.

When not to use

  • When the main task is learning language syntax, framework design, or business modeling, use the corresponding language professional skill instead.
  • When the main task is dependency vulnerabilities, security auditing, or license governance, use a dedicated security skill.
  • When the user only asks to explain a single error and there is no project context, provide a localized explanation first and do not claim the repository is fully 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. Check the diff before any automatic fix; destructive or large-scale modifications must be explicitly confirmed by the user.

Execution Contract

Project Current Facts
Status stable(since Codeguard V0.4)
File Extensions .vue
Project Markers No dedicated marker file
Integration Config eslint.config.js, eslint.config.mjs, eslint.config.cjs, eslint.config.ts, .eslintrc.json, .eslintrc.js, .eslintrc.yml, .pre-commit-config.yaml, .eslintrc, .eslintrc.cjs
Tool Preparation eslint-plugin-vue
Probe Commands npx --no-install eslint --version
lint npx --no-install eslint --ext .vue .
format/fix npx eslint --ext .vue . --fix
Project-level gate npx --no-install eslint --ext .vue .

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 that will be scanned; do not guess based on the current directory.

Step 2: Read the Project Contract

Read eslint.config.js, eslint.config.mjs, eslint.config.cjs, eslint.config.ts, .eslintrc.json, .eslintrc.js, .eslintrc.yml, .pre-commit-config.yaml, .eslintrc, .eslintrc.cjs 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 npx --no-install eslint --version. Missing tools, incompatible versions, or failure to load configuration are all recorded as "cannot verify," not as passing.

Step 4: Perform Read-only Checks

Run npx --no-install eslint --ext .vue ., recording 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 Allow the 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 the integration or report prerequisites
Environment command not found, version conflicts Report installation/version requirements; do not install silently
Tool Internal Errors crash, timeout, parser exceptions Preserve the original evidence and narrow the reproduction scope

Step 6: Controlled Fixes

Prefer to run npx eslint --ext .vue . --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 "passing" when the command, scope, and exit code are all clear; otherwise write "not run" or "cannot 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 Takes Precedence: 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

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

Gotchas

  1. Missing tools are not passing — you 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. The root directory determines the result — Running in the wrong module may miss detection 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 whole repository.

Domain pitfalls and fixes

  1. Domain pitfalls — Vue SFCs need a parser/plugin matching the Vue version; an ordinary ESLint configuration may skip <template>。

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

FAQ

Q1: If the tool is not installed, can it be concluded that 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; when there are no rules, exclude generated/vendor first, then explain to the user.

Q5: How can I avoid making too many changes at once? First fix in batches by failure category and file, and for each batch rerun the original command and review the diff.

Q6: If it passes locally, can you 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 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.