@yuu1111/quality-check 0.9.0 → 0.11.0

package/README.ja.md

@@ -10,7 +10,10 @@ 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` で理由付きに宣言する
+このCLIは `comment-check`、`document-style-check`、`tsdoc-check` を、configの型がengineの公開するrule名を取り込むためpeer dependencyとして持つ
+package managerはこのCLIと一緒に導入し、engineのbinaryは利用Projectの `node_modules/.bin` から実行時に解決する
+
+`@yuu1111/code-style-check` を宣言するProjectではKnipが未使用依存として報告するため `knip.ts` の `ignoreDependencies` で理由付きに宣言する
 
 ## Usage
 
@@ -90,7 +93,7 @@ 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の引数が変わったときの逃げ道として使う
@@ -102,8 +105,8 @@ engineが受け取らない条件は渡さず、その旨をそのengineのsecti
 biome: ignore skipped (biome.json holds its settings)
 ```
 
-`enable` は `comment-check` と `document-style-check` の `--enable <rule>` になり、他のengineでは拒否される
-このCLIはengineを同梱しないため、opt-in ruleを有効にするProjectは対応するengine packageも同じ変更で更新する
+`enable` は `comment-check` と `document-style-check` と `tsdoc-check` の `--enable <rule>` になり、他のengineでは拒否される
+値は導入済みengineが `rule-ids` で公開するrule名で型付けするため、engineが知らない名前は起動時の失敗ではなく型errorになる
 
 `comment-check` はbaseline差分を無効化する未作成のpathを渡して起動する
 新規と解消済みの判定はengineごとではなく統合CLIが1つのbaseline fileで行うため、既存の `comment-baseline.json` がある場合は `--update-baseline` で移す

package/README.md

@@ -11,8 +11,10 @@ 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.
+`comment-check`, `document-style-check`, and `tsdoc-check` are peer dependencies of this CLI, because the config types embed the rule names those engines publish.
+A package manager installs them with this CLI, and each engine binary is resolved at run time from the project's `node_modules/.bin`.
+
+A project that declares `@yuu1111/code-style-check` sees Knip report it as an unused dependency, so it names it in `ignoreDependencies` with the reason.
 
 ## Usage
 
@@ -94,7 +96,7 @@ 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.
 
@@ -105,8 +107,8 @@ A condition that an engine does not take is not passed on, and the section says
 biome: ignore skipped (biome.json holds its settings)
 ```
 
-`enable` becomes `--enable <rule>` on `comment-check` and `document-style-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.
+`enable` becomes `--enable <rule>` on `comment-check`, `document-style-check`, and `tsdoc-check`, and the other engines reject the field.
+Each value is typed with the rule names the installed engine publishes from its `rule-ids` entry, so a name that engine does not know is a type error rather than a start-up failure.
 
 `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`.

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,
@@ -646,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`);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@yuu1111/quality-check",
-	"version": "0.9.0",
+	"version": "0.11.0",
 	"description": "Integrated quality check runner",
 	"repository": {
 		"type": "git",
@@ -29,6 +29,11 @@
 		"quality",
 		"lint"
 	],
+	"peerDependencies": {
+		"@yuu1111/comment-check": ">=2.3.0",
+		"@yuu1111/document-style-check": ">=0.5.0",
+		"@yuu1111/tsdoc-check": ">=2.2.0"
+	},
 	"devDependencies": {
 		"@yuu1111/shared": "workspace:*"
 	}

package/src/config.ts

@@ -1,6 +1,12 @@
 import { existsSync } from "node:fs";
 import { resolve } from "node:path";
 import { pathToFileURL } from "node:url";
+import type { OptInRuleId as CommentCheckRuleName } from "@yuu1111/comment-check/rule-ids";
+import type { OptInRuleId as DocumentStyleCheckRuleName } from "@yuu1111/document-style-check/rule-ids";
+import type {
+	OptInRuleId as TsdocCheckRuleName,
+	TsdocRule,
+} from "@yuu1111/tsdoc-check/rule-ids";
 
 /**
  * 統合CLIが起動できるengineの名前 並び順が実行順になる
@@ -36,24 +42,26 @@ export interface EngineOptions {
  * comment-checkへ渡す起動条件
  */
 export interface CommentCheckOptions extends EngineOptions {
-	/** 既定で無効のopt-in ruleのうち有効にするrule名 */
-	enable?: string[];
+	/** 既定で無効のopt-in ruleのうち有効にするrule名 comment-checkが公開するunionで縛る */
+	enable?: CommentCheckRuleName[];
 }
 
 /**
  * document-style-checkへ渡す起動条件
  */
 export interface DocumentStyleCheckOptions extends EngineOptions {
-	/** 既定で無効のopt-in ruleのうち有効にするrule名 */
-	enable?: string[];
+	/** 既定で無効のopt-in ruleのうち有効にするrule名 document-style-checkが公開するunionで縛る */
+	enable?: DocumentStyleCheckRuleName[];
 }
 
 /**
  * TSDoc検査へ渡す起動条件
  */
 export interface TsdocCheckOptions extends EngineOptions {
-	/** 違反として扱うrule名 */
-	error?: string[];
+	/** 既定で無効のopt-in ruleのうち有効にするrule名 tsdoc-checkが公開するunionで縛る */
+	enable?: TsdocCheckRuleName[];
+	/** 違反として扱うrule名 tsdoc-checkが公開するunionで縛る */
+	error?: TsdocRule[];
 }
 
 /**
@@ -91,6 +99,9 @@ export interface QualityConfig {
 
 /**
  * 設定fileを型付けするための恒等関数
+ *
+ * @param config - 型付けする統合検査の設定
+ * @returns 引数をそのまま返した統合検査の設定
  */
 export function defineConfig(config: QualityConfig): QualityConfig {
 	return config;
@@ -128,7 +139,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 +208,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`,
@@ -275,7 +290,7 @@ function parseEngineConfig(
 	if (!isJsonObject(value)) {
 		throw new Error(`${source}: config must be an object`);
 	}
-	const config: Partial<EngineConfigMap> = {};
+	const config: Partial<Record<EngineName, ParsedEngineOptions>> = {};
 	for (const [name, options] of Object.entries(value)) {
 		if (!isEngineName(name)) {
 			throw new Error(`${source}: unknown engine in config: ${name}`);
@@ -285,11 +300,17 @@ function parseEngineConfig(
 		}
 		config[name] = parseEngineOptions(options, source, name);
 	}
-	return config;
+
+	// rule名はengineが公開するunionで縛る 実行時の入力は文字列として届くため検証済みの値をここで型へ寄せる
+	return config as Partial<EngineConfigMap>;
 }
 
 /**
  * 読み込んだ設定を検証して不足分を補う
+ *
+ * @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 +332,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 +342,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 +360,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 +376,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[],