@yuu1111/quality-check 0.10.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
 
@@ -103,7 +106,7 @@ 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も同じ変更で更新する
+値は導入済み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
 
@@ -106,7 +108,7 @@ 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.
+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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@yuu1111/quality-check",
-	"version": "0.10.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,26 +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 {
-	/** 既定で無効のopt-in ruleのうち有効にするrule名 */
-	enable?: string[];
-	/** 違反として扱うrule名 */
-	error?: string[];
+	/** 既定で無効のopt-in ruleのうち有効にするrule名 tsdoc-checkが公開するunionで縛る */
+	enable?: TsdocCheckRuleName[];
+	/** 違反として扱うrule名 tsdoc-checkが公開するunionで縛る */
+	error?: TsdocRule[];
 }
 
 /**
@@ -284,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}`);
@@ -294,7 +300,9 @@ function parseEngineConfig(
 		}
 		config[name] = parseEngineOptions(options, source, name);
 	}
-	return config;
+
+	// rule名はengineが公開するunionで縛る 実行時の入力は文字列として届くため検証済みの値をここで型へ寄せる
+	return config as Partial<EngineConfigMap>;
 }
 
 /**