日本語

@yuu1111/quality-check

Integrated CLI that runs the configured engines and owns the baseline diff.

Install

bun add -D @yuu1111/quality-check

The four finding engines code-style-check, comment-check, document-style-check, and tsdoc-check are built into this package. bun build bundles those private workspace packages into dist/cli.js, so installing this package is enough and no engine package has to be installed or resolved at run time. Biome, tsc, and Knip stay child processes and resolve from the project's node_modules/.bin.

Usage

Declare the engines to run in quality.json, then call the CLI from a script:

{
  "scripts": {
    "check:quality": "quality-check"
  }
}

{
  "$schema": "./node_modules/@yuu1111/quality-check/schema.json",
  "failOnWarnings": true,
  "biome": {
    "enabled": true
  },
  "comment-check": {
    "enabled": true,
    "includes": ["**", "!another-project/**"],
    "rules": {
      "preset": "recommended",
      "content": {
        "japanese-period": "on"
      }
    }
  },
  "document-style-check": {
    "enabled": true,
    "rules": {
      "preset": "all"
    }
  },
  "tsdoc-check": {
    "enabled": true,
    "rules": {
      "preset": "all"
    }
  }
}

Each engine prints its own section with its own time, and the summary names the engines that failed and the total time the run took:

== biome ==
Checked 128 files in 260ms. No fixes applied.
biome: passed (exit 0, 296ms)

== comment-check ==
src/queue.ts:18:2 placeholder-comment placeholder comment should be resolved or tracked
comment-check: failed (1 new, 0 resolved, 0 warnings, 118ms)

quality-check: 1 of 3 engines failed (1250ms)
  failed: comment-check
  passed: biome, tsdoc-check

Exit code 0 means every engine passed, 1 that at least one failed, and 2 that the configuration or an engine could not start.

Pass engine names to run only those engines:

quality-check biome knip
quality-check comment-check docs

Positional arguments that match an engine name select engines and the rest are target paths. --update-baseline always runs every enabled engine, so combining it with an engine selection is rejected. A path that matches an engine name needs a ./ prefix, as in quality-check ./biome.

Config

| Field | Description | |-------|-------------| | <engine> | One section per engine; enabled starts it | | <engine>.includes | Globs inspected by the four built-in finding engines | | <engine>.rules | Rule selection of the four built-in finding engines | | failOnWarnings | Treat warnings as blocking findings and apply the same policy to Biome | | baseline | Baseline file path; false disables the diff |

Engines run in the order biome, typecheck, knip, code-style-check, comment-check, document-style-check, tsdoc-check.

Each engine owns a top-level section that holds enabled and the conditions that engine takes. A condition an engine does not take is rejected, so a typo fails at start-up instead of being ignored. biome, typecheck, and knip run as child processes, and the four finding engines run in-process.

| Engine | Command | Conditions | |--------|---------|------------| | biome | biome check | args; biome.json selects the files | | typecheck | tsc --noEmit | args, projects; tsconfig.json holds the settings | | knip | knip | args; knip.ts holds the settings | | code-style-check | in-process | includes, rules | | comment-check | in-process | includes, rules | | document-style-check | in-process | includes, rules | | tsdoc-check | in-process | includes, rules |

args applies only to the child-process engines and is appended after the engine defaults, for conditions the config cannot express and for the case where an engine changes its arguments. When failOnWarnings is true, the runner passes --error-on-warnings to Biome automatically and uses the exit codes of the other child-process engines as-is.

includes selects paths relative to the project root with globs. It defaults to **, while an empty array inspects nothing. A negative glob excludes files selected earlier, and a later positive glob can include them again, so order matters.

A command line override an engine does not take is not passed on, and the section says so:

== biome ==
biome: ignore skipped (biome.json holds its settings)

rules selects which rules of the built-in engines run and how they are reported. rules.preset selects in bulk: recommended is the engine default, all turns every rule on, and none turns every rule off. A group key names one of the rule groups the engine publishes and takes off, on, warn, or error for every rule in that group. An object under a group key names single rules. The most specific setting wins, so a preset, a group, and a rule may be written in that order. off also works for a rule that is on by default, and on keeps the engine default severity. warn and error change the severity in every finding engine and turn an opt-in rule on first. A group or rule name that the engine does not know is a configuration error, and the published schema.json teaches an editor the same names. The selection is handed to the built-in engines directly, so the CLI no longer turns it into --enable, --disable, or --error arguments.

No check engine keeps a baseline of its own, so the new-and-resolved diff is done by this CLI from a single baseline file.

typecheck starts tsc --noEmit -p <path> once per path in projects, and falls back to the current tsconfig.json.

Rules

Each built-in engine publishes its own rule vocabulary, and one document holds the options and rules of each engine:

| Engine | Groups | Reference | |--------|--------|-----------| | code-style-check | spacing | docs/engines/code-style-check.md | | comment-check | suppression, shape, content | docs/engines/comment-check.md | | document-style-check | whitespace, typography, structure, content | docs/engines/document-style-check.md | | tsdoc-check | syntax, documentation, contract, suppression | docs/engines/tsdoc-check.md |

Baseline

A project that adopts the checks on an existing tree records the findings it has today in quality-baseline.json, so only the findings it adds later fail. --update-baseline replaces that file with the current findings:

quality-check --update-baseline

Every run reports the new findings and counts the baseline entries that no longer appear as resolved. Fix the new findings, and run --update-baseline only when the team accepts one on purpose. An entry is identified by its engine, rule, file, and message, so a change to a message re-baselines that rule. Set baseline to false in quality.json to diff nothing and report every finding.

Commands

quality-check document-style runs the review ledger of the built-in document-style-check engine:

quality-check document-style lint .
quality-check document-style lint --write .
quality-check document-style lint --preset all .
quality-check document-style scan doc.md --rules SKILL.md --review review.json
quality-check document-style check doc.md --rules SKILL.md --review review.json

| Command | Description | |---------|-------------| | scan | Write an unconfirmed review record for the given documents | | check | Verify a filled review record against the current documents and rules | | lint | Report mechanical violations, or fix them with --write |

The review file pins the document bytes and the rules bytes by hash, so editing either one invalidates the record. check only confirms that every candidate carries a decision and a reason; it does not judge the writing.

Options

| Option | Description | |--------|-------------| | --config <path> | Config file to load (default quality.json) | | --baseline <path> | Override the baseline file | | --ignore <path> | Add an excluded path, repeatable | | --update-baseline | Replace the baseline with the current findings | | --json | Print the per-engine results as JSON | | document-style <command> | Run the review ledger (scan, check, or lint) |

--ignore and the positional targets reach only the engines that take them.

document-style

| Option | Description | |--------|-------------| | --rules <path> | Rules file that holds the criteria, required by scan and check | | --review <path> | Review file to write or read | | --preset <preset> | Start from the recommended (default), all, or none preset | | --enable <rule> | Run an opt-in rule, repeatable | | --disable <rule> | Turn a rule off, repeatable | | --ignore <path> | Path to leave out, repeatable | | --write | Apply lint fixes instead of reporting them | | --json | Print findings as JSON |

Color is added only when stdout is a terminal. NO_COLOR turns it off and FORCE_COLOR turns it on; the --json output stays plain.