@yuu1111/quality-check 0.8.0 → 0.10.0

package/README.ja.md

@@ -10,6 +10,8 @@ Projectごとのscriptから個別に呼んでいたBiome、型検査、Knip、c
 bun add -D @yuu1111/quality-check
 ```
 
+engineのbinaryは利用Projectの `node_modules/.bin` から実行時に解決する engineを自分のscriptから呼ばないProjectではKnipが `@yuu1111/comment-check` などを未使用依存として報告するため `knip.ts` の `ignoreDependencies` で理由付きに宣言する
+
 ## Usage
 
 `quality.config.ts` で起動するengineとengineごとの起動条件を指定し、scriptから起動する
@@ -50,27 +52,29 @@ export default defineConfig({
 });
 ```
 
-engineごとの出力と集約summaryを並べて出し、どのengineが失敗したかを1回の実行で示す
+engineごとの出力と所要時間、集約summaryを並べて出し、どのengineが失敗したかと実行にかかった合計時間を1回の実行で示す
 
 ```text
 == biome ==
 Checked 128 files in 260ms. No fixes applied.
-biome: passed (exit 0)
+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)
+comment-check: failed (1 new, 0 resolved, 0 warnings, 118ms)
 
-quality-check: 1 of 3 engines failed
+quality-check: 1 of 3 engines failed (1250ms)
   failed: comment-check
   passed: biome, tsdoc-check
 ```
 
+終了codeは0が全engine成功、1が失敗したengineあり、2が設定またはengine起動の失敗
+
 ## Config
 
-| Field | Description |
+| Field | 説明 |
 |-------|-------------|
-| `engines` | 起動するengine 値は `true` または `false` |
+| `engines` | 起動するengine、値は `true` または `false` |
 | `config` | engineごとの起動条件 |
 | `baseline` | baseline fileのpath `false` なら差分判定を行わない |
 
@@ -78,7 +82,7 @@ engineは `biome` → `typecheck` → `knip` → `code-style-check` → `comment
 
 `engines` は起動の委任だけを表し、起動条件は `config` のengineの下へ置く engineごとの条件は複数行のobjectとして書き、ruleやoptionを足しても他のengineの行が動かないようにする engineが受け取る条件は次のとおり
 
-| engine | 起動するcommand | 受け取る条件 |
+| Engine | Command | 条件 |
 |--------|-----------------|--------------|
 | `biome` | `biome check` | `targets`、`args` 除外pathは `biome.json` が持つ |
 | `typecheck` | `tsc --noEmit` | `args`、`projects` 設定は `tsconfig.json` が持つ |
@@ -86,43 +90,37 @@ engineは `biome` → `typecheck` → `knip` → `code-style-check` → `comment
 | `code-style-check` | `code-style-check --json` | `ignore`、`targets`、`args` |
 | `comment-check` | `comment-check --json` | `ignore`、`targets`、`args`、`enable`（有効にするrule名） |
 | `document-style-check` | `document-style-check lint --json` | `ignore`、`targets`、`args`、`enable`（有効にするrule名） |
-| `tsdoc-check` | `tsdoc-check --json` | `ignore`、`targets`、`args`、`error`（違反として扱うrule名） |
+| `tsdoc-check` | `tsdoc-check --json` | `ignore`、`targets`、`args`、`enable`（有効にするrule名）、`error`（違反として扱うrule名） |
 
-`args` はengineの既定引数の後ろへ足す 設定fileで表せない起動条件や、engineの引数が変わったときの逃げ道として使う
+`args` はengineの既定引数の後ろへ足す
+設定fileで表せない起動条件や、engineの引数が変わったときの逃げ道として使う
+
+engineが受け取らない条件は渡さず、その旨をそのengineのsectionへ出す
+
+```text
+== biome ==
+biome: ignore skipped (biome.json holds its settings)
+```
+
+`enable` は `comment-check` と `document-style-check` と `tsdoc-check` の `--enable <rule>` になり、他のengineでは拒否される
+このCLIはengineを同梱しないため、opt-in ruleを有効にするProjectは対応するengine packageも同じ変更で更新する
+
+`comment-check` はbaseline差分を無効化する未作成のpathを渡して起動する
+新規と解消済みの判定はengineごとではなく統合CLIが1つのbaseline fileで行うため、既存の `comment-baseline.json` がある場合は `--update-baseline` で移す
+
+`typecheck` は `projects` に並べたtsconfigごとに `tsc --noEmit -p <path>` を起動する
+省略時はカレントの `tsconfig.json` を1回だけ読む
 
 ## Options
 
-| Option | Description |
+| Option | 説明 |
 |--------|-------------|
 | `--config <path>` | 読み込むconfig file（既定は `quality.config.ts`） |
 | `--baseline <path>` | baseline fileを上書きする |
-| `--ignore <path>` | 除外pathを追加する 複数指定できる |
+| `--ignore <path>` | 除外pathを追加する、複数指定できる |
 | `--update-baseline` | 現在の検出でbaselineを置き換える |
 | `--json` | engineごとの結果をJSONで出力する |
 
 `--ignore` と位置引数の対象pathは、その条件を受け取るengineへだけ渡す
 
-## Notes
-
-終了codeは0が全engine成功、1が失敗したengineあり、2が設定またはengine起動の失敗
-
 色は標準出力が端末のときだけ付ける `NO_COLOR` で無効にし、`FORCE_COLOR` で強制できる `--json` の出力には付けない
-
-色を扱えるengineへは自身の出力の色も許可する Biomeは `--colors=force`、tscは `--pretty` を受け取る
-
-engineが受け取らない条件を書いた場合は渡さず、その旨をそのengineのsectionへ出す
-
-```text
-== biome ==
-biome: ignore skipped (biome.json holds its settings)
-```
-
-Biome、型検査、Knipの設定は `biome.json`、`tsconfig.json`、`knip.ts` が持つ このCLIは同じfileからengineの起動と結果の集約だけを行う
-
-engineのbinaryは利用Projectの `node_modules/.bin` から実行時に解決する engineを自分のscriptから呼ばないProjectではKnipが `@yuu1111/comment-check` などを未使用依存として報告するため `knip.ts` の `ignoreDependencies` で理由付きに宣言する
-
-`comment-check` はbaseline差分を無効化する未作成のpathを渡して起動する 新規と解消済みの判定はengineごとではなく統合CLIが1つのbaseline fileで行うため、既存の `comment-baseline.json` がある場合は `--update-baseline` で移す
-
-`enable` は `comment-check` と `document-style-check` のopt-in ruleだけを受け取り、それぞれのcommandの `--enable <rule>` になる 他のengineへ書くとunknown optionとして拒否し、既定のrule集合は変えない このCLIはengineを同梱しないため、opt-in ruleを有効にするProjectは対応するengine packageも同じ変更で更新する
-
-`typecheck` は `projects` に並べたtsconfigごとに `tsc --noEmit -p <path>` を起動する 省略時はカレントの `tsconfig.json` を1回だけ読み、`args` はすべての起動へ足す

package/README.md

@@ -2,8 +2,7 @@
 
 # @yuu1111/quality-check
 
-Runs Biome, the type checker, Knip, code-style-check, comment-check,
-document-style-check, and the TSDoc checker from one CLI instead of one script per project.
+Runs Biome, the type checker, Knip, code-style-check, comment-check, document-style-check, and the TSDoc checker from one CLI instead of one script per project.
 The baseline diff lives here too.
 
 ## Install
@@ -12,10 +11,12 @@ The baseline diff lives here too.
 bun add -D @yuu1111/quality-check
 ```
 
+An engine binary is resolved at run time from the project's `node_modules/.bin`.
+A project that never calls an engine from its own scripts therefore sees Knip report `@yuu1111/comment-check` and its siblings as unused dependencies, so it declares them in `ignoreDependencies` with the reason.
+
 ## Usage
 
-Declare the engines to run and the conditions of each engine in
-`quality.config.ts`, then call the CLI from a script:
+Declare the engines to run and the conditions of each engine in `quality.config.ts`, then call the CLI from a script:
 
 ```json
 {
@@ -53,23 +54,24 @@ export default defineConfig({
 });
 ```
 
-Each engine prints its own section, and the summary names the engines that
-failed:
+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:
 
 ```text
 == biome ==
 Checked 128 files in 260ms. No fixes applied.
-biome: passed (exit 0)
+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)
+comment-check: failed (1 new, 0 resolved, 0 warnings, 118ms)
 
-quality-check: 1 of 3 engines failed
+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.
+
 ## Config
 
 | Field | Description |
@@ -78,12 +80,11 @@ quality-check: 1 of 3 engines failed
 | `config` | Conditions of each engine |
 | `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`.
+Engines run in the order `biome`, `typecheck`, `knip`, `code-style-check`, `comment-check`, `document-style-check`, `tsdoc-check`.
 
-`engines` only delegates the start-up, and the conditions belong under the
-engine in `config`. Write an engine's conditions as a multi-line object, so a
-new rule or option changes one engine's block alone. Each engine runs:
+`engines` only delegates the start-up, and the conditions belong under the engine in `config`.
+Write an engine's conditions as a multi-line object, so a new rule or option changes one engine's block alone.
+Each engine runs:
 
 | Engine | Command | Conditions |
 |--------|---------|------------|
@@ -93,10 +94,24 @@ new rule or option changes one engine's block alone. Each engine runs:
 | `code-style-check` | `code-style-check --json` | `ignore`, `targets`, `args` |
 | `comment-check` | `comment-check --json` | `ignore`, `targets`, `args`, `enable` (rule names to turn on) |
 | `document-style-check` | `document-style-check lint --json` | `ignore`, `targets`, `args`, `enable` (rule names to turn on) |
-| `tsdoc-check` | `tsdoc-check --json` | `ignore`, `targets`, `args`, `error` (rule names to fail on) |
+| `tsdoc-check` | `tsdoc-check --json` | `ignore`, `targets`, `args`, `enable` (rule names to turn on), `error` (rule names to fail on) |
+
+`args` is appended after the engine defaults, for conditions the config cannot express and for the case where an engine changes its arguments.
+
+A condition that an engine does not take is not passed on, and the section says so:
+
+```text
+== biome ==
+biome: ignore skipped (biome.json holds its settings)
+```
+
+`enable` becomes `--enable <rule>` on `comment-check`, `document-style-check`, and `tsdoc-check`, and the other engines reject the field.
+This CLI ships no engine of its own, so a project that turns an opt-in rule on updates the matching engine package in the same change.
+
+`comment-check` runs with an unwritten baseline path so that it reports every finding.
+The new-and-resolved diff is done by this CLI from a single baseline file, so an existing `comment-baseline.json` is moved over with `--update-baseline`.
 
-`args` is appended after the engine defaults, for conditions the config cannot
-express and for the case where an engine changes its arguments.
+`typecheck` starts `tsc --noEmit -p <path>` once per path in `projects`, and falls back to the current `tsconfig.json`.
 
 ## Options
 
@@ -110,45 +125,5 @@ express and for the case where an engine changes its arguments.
 
 `--ignore` and the positional targets reach only the engines that take them.
 
-## Notes
-
-Exit code 0 means every engine passed, 1 that at least one failed, and 2 that the
-configuration or an engine could not start.
-
-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.
-
-The engines that can color their own output receive the same permission: Biome
-gets `--colors=force` and tsc gets `--pretty`.
-
-A condition that an engine does not take is not passed on, and the section says
-so:
-
-```text
-== biome ==
-biome: ignore skipped (biome.json holds its settings)
-```
-
-Biome, the type checker, and Knip keep their settings in `biome.json`,
-`tsconfig.json`, and `knip.ts`. This CLI starts the engines from one file and
-aggregates the results.
-
-An engine binary is resolved at run time from the `node_modules/.bin` of the
-project. A project that never calls an engine from its own scripts therefore
-sees Knip report `@yuu1111/comment-check` and its siblings as unused
-dependencies, so it declares them in `ignoreDependencies` with the reason.
-
-`comment-check` runs with an unwritten baseline path so that it reports every
-finding. The new-and-resolved diff is done by this CLI from a single baseline
-file, so an existing `comment-baseline.json` is moved over with
-`--update-baseline`.
-
-`enable` names the opt-in rules of `comment-check` and `document-style-check`
-and becomes `--enable <rule>` on each of their commands. The other engines
-reject the field, and the default rule set stays as it is. This CLI ships no
-engine of its own, so a project that turns an opt-in rule on updates the
-matching engine package in the same change.
-
-`typecheck` starts `tsc --noEmit -p <path>` once per path in `projects`. Without
-it the current `tsconfig.json` is read once, and `args` are added to every
-start.
+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.

package/dist/cli.js

@@ -223,7 +223,7 @@ var ENGINE_OPTION_KEYS = {
   "code-style-check": ["args", "ignore", "targets"],
   "comment-check": ["args", "enable", "ignore", "targets"],
   "document-style-check": ["args", "enable", "ignore", "targets"],
-  "tsdoc-check": ["args", "error", "ignore", "targets"]
+  "tsdoc-check": ["args", "enable", "error", "ignore", "targets"]
 };
 function readStringArray(value, field) {
   if (value === undefined) {
@@ -264,7 +264,7 @@ function parseEngines(value, source) {
 }
 function parseEngineExtras(value, source, name) {
   const extras = {};
-  if (name === "comment-check" || name === "document-style-check") {
+  if (name === "comment-check" || name === "document-style-check" || name === "tsdoc-check") {
     const enable = readStringArray(value.enable, `${source}: config.${name}.enable`);
     if (enable !== undefined) {
       extras.enable = enable;
@@ -517,6 +517,7 @@ function buildEngineCommand(name, executable, context) {
   return [
     executable,
     "--json",
+    ...enableArguments(engineConfig(context.config, "tsdoc-check")),
     ...errorArguments,
     ...targets,
     ...ignoreArguments,
@@ -555,12 +556,17 @@ function describeCounts(result) {
   }
   return `${result.reported.length} new, ${result.resolved} resolved, ${result.warnings.length} warnings`;
 }
+function formatMillis(elapsedMs) {
+  return `${Math.round(elapsedMs)}ms`;
+}
 function describeStatus(result, paint) {
   if (result.status === "error") {
-    return paint("error", "error");
+    const status = paint("error", "error");
+    return result.durationMs === null ? status : `${status} (${formatMillis(result.durationMs)})`;
   }
   const tone = result.status === "passed" ? "pass" : "error";
-  return `${paint(result.status, tone)} (${describeCounts(result)})`;
+  const elapsed = result.durationMs === null ? "" : `, ${formatMillis(result.durationMs)}`;
+  return `${paint(result.status, tone)} (${describeCounts(result)}${elapsed})`;
 }
 function formatEngineSection(result, paint = plainPainter) {
   const lines = [paint(`== ${result.name} ==`, "header")];
@@ -583,14 +589,15 @@ function formatEngineSection(result, paint = plainPainter) {
   return lines.join(`
 `);
 }
-function formatSummary(results, paint = plainPainter) {
+function formatSummary(results, elapsedMs, paint = plainPainter) {
   const failed = results.filter((result) => result.status !== "passed").map((result) => result.name);
   const passed = results.filter((result) => result.status === "passed").map((result) => result.name);
+  const elapsed = ` (${formatMillis(elapsedMs)})`;
   if (failed.length === 0) {
-    return paint(`quality-check: ${results.length} engines passed`, "pass");
+    return paint(`quality-check: ${results.length} engines passed${elapsed}`, "pass");
   }
   const lines = [
-    paint(`quality-check: ${failed.length} of ${results.length} engines failed`, "error"),
+    paint(`quality-check: ${failed.length} of ${results.length} engines failed${elapsed}`, "error"),
     `  ${paint("failed:", "error")} ${failed.join(", ")}`
   ];
   if (passed.length > 0) {
@@ -599,10 +606,12 @@ function formatSummary(results, paint = plainPainter) {
   return lines.join(`
 `);
 }
-function toJsonReport(results) {
+function toJsonReport(results, elapsedMs) {
   return {
+    elapsedMs: Math.round(elapsedMs),
     engines: results.map((result) => ({
       detected: result.detected.length,
+      durationMs: result.durationMs === null ? null : Math.round(result.durationMs),
       exitCode: result.exitCode,
       message: result.message ?? null,
       name: result.name,
@@ -638,8 +647,8 @@ function parseJson(engine, stdout) {
   let value;
   try {
     value = JSON.parse(stdout);
-  } catch {
-    throw new Error(`${engine} did not print JSON`);
+  } catch (error) {
+    throw new Error(`${engine} did not print JSON`, { cause: error });
   }
   if (!isJsonObject(value)) {
     throw new Error(`${engine} printed an unexpected JSON value`);
@@ -754,25 +763,24 @@ async function runProcessEngine(name, options, executable, context, runner) {
     status: exitCode === 0 ? "passed" : "failed"
   };
 }
-async function executeEngine(name, options, context, runner) {
+async function runEngine(name, options, context, runner) {
   const executable = (options.resolve ?? resolveExecutable)(name, options.cwd);
+  const skipped = skippedEngineOptions(name, options.config.config?.[name]);
   if (executable === null) {
     return {
       ...baseResult(name, null, ""),
+      durationMs: null,
       message: `${ENGINE_BINS[name]} is not installed`,
+      skipped,
       status: "error"
     };
   }
-  if (isFindingEngine(name)) {
-    return await runFindingEngine(name, options, executable, context, runner);
-  }
-  return await runProcessEngine(name, options, executable, context, runner);
-}
-async function runEngine(name, options, context, runner) {
-  const result = await executeEngine(name, options, context, runner);
+  const startedAt = performance.now();
+  const result = isFindingEngine(name) ? await runFindingEngine(name, options, executable, context, runner) : await runProcessEngine(name, options, executable, context, runner);
   return {
     ...result,
-    skipped: skippedEngineOptions(name, options.config.config?.[name])
+    durationMs: performance.now() - startedAt,
+    skipped
   };
 }
 async function runEngines(options) {
@@ -837,6 +845,7 @@ async function main(argv) {
   }
   const config = await loadConfig(configPath);
   const baselinePath = resolveBaselinePath(options, config, cwd);
+  const startedAt = performance.now();
   const results = await runEngines({
     baseline: options.update || baselinePath === null ? null : readBaseline(baselinePath, "quality"),
     color,
@@ -845,6 +854,7 @@ async function main(argv) {
     overrides: { ignore: options.ignores, targets: options.targets },
     rawBaseline: join2(tmpdir(), `quality-check-raw-${process.pid}.json`)
   });
+  const elapsedMs = performance.now() - startedAt;
   if (options.update) {
     if (baselinePath === null) {
       console.error("baseline is disabled by the configuration");
@@ -856,12 +866,12 @@ async function main(argv) {
     return 0;
   }
   if (options.json) {
-    console.log(JSON.stringify(toJsonReport(results), null, "\t"));
+    console.log(JSON.stringify(toJsonReport(results, elapsedMs), null, "\t"));
   } else {
     for (const result of results) {
       console.log(formatEngineSection(result, paint));
     }
-    console.log(formatSummary(results, paint));
+    console.log(formatSummary(results, elapsedMs, paint));
   }
   return results.some((result) => result.status !== "passed") ? 1 : 0;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@yuu1111/quality-check",
-	"version": "0.8.0",
+	"version": "0.10.0",
 	"description": "Integrated quality check runner",
 	"repository": {
 		"type": "git",

package/src/config.ts

@@ -52,6 +52,8 @@ export interface DocumentStyleCheckOptions extends EngineOptions {
  * TSDoc検査へ渡す起動条件
  */
 export interface TsdocCheckOptions extends EngineOptions {
+	/** 既定で無効のopt-in ruleのうち有効にするrule名 */
+	enable?: string[];
 	/** 違反として扱うrule名 */
 	error?: string[];
 }
@@ -91,6 +93,9 @@ export interface QualityConfig {
 
 /**
  * 設定fileを型付けするための恒等関数
+ *
+ * @param config - 型付けする統合検査の設定
+ * @returns 引数をそのまま返した統合検査の設定
  */
 export function defineConfig(config: QualityConfig): QualityConfig {
 	return config;
@@ -128,7 +133,7 @@ const ENGINE_OPTION_KEYS: Record<EngineName, readonly string[]> = {
 	"code-style-check": ["args", "ignore", "targets"],
 	"comment-check": ["args", "enable", "ignore", "targets"],
 	"document-style-check": ["args", "enable", "ignore", "targets"],
-	"tsdoc-check": ["args", "error", "ignore", "targets"],
+	"tsdoc-check": ["args", "enable", "error", "ignore", "targets"],
 };
 
 function readStringArray(value: unknown, field: string): string[] | undefined {
@@ -197,7 +202,11 @@ function parseEngineExtras(
 	name: EngineName,
 ): ParsedEngineOptions {
 	const extras: ParsedEngineOptions = {};
-	if (name === "comment-check" || name === "document-style-check") {
+	if (
+		name === "comment-check" ||
+		name === "document-style-check" ||
+		name === "tsdoc-check"
+	) {
 		const enable = readStringArray(
 			value.enable,
 			`${source}: config.${name}.enable`,
@@ -290,6 +299,10 @@ function parseEngineConfig(
 
 /**
  * 読み込んだ設定を検証して不足分を補う
+ *
+ * @param value - config fileがexportした検証前の値
+ * @param source - errorメッセージへ載せるconfig fileのpath
+ * @returns 検証して既定値を補った統合検査の設定
  */
 export function parseConfig(value: unknown, source: string): QualityConfig {
 	if (!isJsonObject(value)) {
@@ -311,6 +324,9 @@ export function parseConfig(value: unknown, source: string): QualityConfig {
 
 /**
  * 有効なengineを実行順で返す
+ *
+ * @param config - engineの有効無効を持つ統合検査の設定
+ * @returns 有効なengine名を実行順に並べた配列
  */
 export function enabledEngines(config: QualityConfig): EngineName[] {
 	return ENGINE_NAMES.filter((name) => Boolean(config.engines[name]));
@@ -318,6 +334,11 @@ export function enabledEngines(config: QualityConfig): EngineName[] {
 
 /**
  * engineの起動条件を返す 無効なengineにはnullを返す
+ *
+ * @typeParam K - 起動条件を取り出すengine名の型
+ * @param config - engineごとの起動条件を持つ統合検査の設定
+ * @param name - 起動条件を取り出すengine名
+ * @returns 指定したengineの起動条件 無効なengineならnull
  */
 export function engineConfig<K extends EngineName>(
 	config: QualityConfig,
@@ -331,6 +352,9 @@ export function engineConfig<K extends EngineName>(
 
 /**
  * 作業ディレクトリからconfig fileを探す
+ *
+ * @param cwd - 探索を開始する作業ディレクトリのpath
+ * @returns 見つけたconfig fileのpath 見つからなければnull
  */
 export function findConfigFile(cwd: string): string | null {
 	for (const name of DEFAULT_CONFIG_FILES) {
@@ -344,6 +368,9 @@ export function findConfigFile(cwd: string): string | null {
 
 /**
  * config fileを読み込んで検証する
+ *
+ * @param path - 読み込むconfig fileのpath
+ * @returns 読み込んで検証した統合検査の設定
  */
 export async function loadConfig(path: string): Promise<QualityConfig> {
 	const module: unknown = await import(pathToFileURL(path).href);

package/src/engines.ts

@@ -85,6 +85,10 @@ export const ENGINE_LIMITS: Record<
 
 /**
  * engineが受け取らないため渡さなかった起動条件を返す
+ *
+ * @param name - 受け取れない起動条件を引くengine名
+ * @param options - engineへ渡そうとした起動条件
+ * @returns 渡さなかった起動条件とその理由の一覧
  */
 export function skippedEngineOptions(
 	name: EngineName,
@@ -106,6 +110,9 @@ export function skippedEngineOptions(
 
 /**
  * 検出をJSONで返すengineか
+ *
+ * @param name - 判定するengine名
+ * @returns 検出をJSONで返すengineならtrue
  */
 export function isFindingEngine(name: EngineName): boolean {
 	return (
@@ -118,6 +125,10 @@ export function isFindingEngine(name: EngineName): boolean {
 
 /**
  * node_modules/.binとPATHからengineの実行fileを探す
+ *
+ * @param name - 実行fileを探すengine名
+ * @param cwd - 探索を開始する作業ディレクトリのpath
+ * @returns 見つけた実行fileのpath PATHにも無ければnull
  */
 export function resolveExecutable(
 	name: EngineName,
@@ -193,6 +204,11 @@ function enableArguments(
 
 /**
  * engineへ渡すコマンドを組み立てる
+ *
+ * @param name - コマンドを組み立てるengine名
+ * @param executable - 起動するengineの実行fileのpath
+ * @param context - 設定と上書きを持つ実行条件
+ * @returns engineへ渡す引数を並べたコマンド
  */
 export function buildEngineCommand(
 	name: EngineName,
@@ -258,6 +274,7 @@ export function buildEngineCommand(
 	return [
 		executable,
 		"--json",
+		...enableArguments(engineConfig(context.config, "tsdoc-check")),
 		...errorArguments,
 		...targets,
 		...ignoreArguments,
@@ -267,6 +284,11 @@ export function buildEngineCommand(
 
 /**
  * engineの起動コマンドを順番に返す 型検査だけはprojectsごとに起動する
+ *
+ * @param name - コマンドを組み立てるengine名
+ * @param executable - 起動するengineの実行fileのpath
+ * @param context - 設定と上書きを持つ実行条件
+ * @returns 起動する順に並べたコマンドの配列
  */
 export function buildEngineCommands(
 	name: EngineName,
@@ -287,6 +309,10 @@ export function buildEngineCommands(
 
 /**
  * Bun.spawnでengineを起動する既定のrunner
+ *
+ * @param command - 実行fileと引数を並べたコマンド
+ * @param options - engineを起動する作業ディレクトリを持つ条件
+ * @returns 終了codeと標準出力と標準エラーを持つ結果
  */
 export async function runEngineProcess(
 	command: string[],