@yuu1111/quality-check 0.6.0 → 0.7.1

package/README.ja.md

@@ -35,8 +35,16 @@ export default defineConfig({
 		"tsdoc-check": true,
 	},
 	config: {
-		"comment-check": { ignore: ["another-project"] },
-		"tsdoc-check": { error: ["missing-doc"] },
+		"comment-check": {
+			enable: ["japanese-period"],
+			ignore: ["another-project"],
+		},
+		"document-style-check": {
+			enable: ["japanese-period"],
+		},
+		"tsdoc-check": {
+			error: ["missing-doc"],
+		},
 	},
 });
 ```
@@ -67,15 +75,15 @@ quality-check: 1 of 3 engines failed
 
 engineは `biome` → `typecheck` → `knip` → `comment-check` → `document-style-check` → `tsdoc-check` の順に実行する
 
-`engines` は起動の委任だけを表し、起動条件は `config` のengineの下へ置く engineが受け取る条件は次のとおり
+`engines` は起動の委任だけを表し、起動条件は `config` のengineの下へ置く engineごとの条件は複数行のobjectとして書き、ruleやoptionを足しても他のengineの行が動かないようにする engineが受け取る条件は次のとおり
 
 | engine | 起動するcommand | 受け取る条件 |
 |--------|-----------------|--------------|
 | `biome` | `biome check` | `targets`、`args` 除外pathは `biome.json` が持つ |
 | `typecheck` | `tsc --noEmit` | `args`、`projects` 設定は `tsconfig.json` が持つ |
 | `knip` | `knip` | `args` 設定は `knip.ts` が持つ |
-| `comment-check` | `comment-check --json` | `ignore`、`targets`、`args` |
-| `document-style-check` | `document-style-check lint --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名） |
 
 `args` はengineの既定引数の後ろへ足す 設定fileで表せない起動条件や、engineの引数が変わったときの逃げ道として使う
@@ -113,5 +121,7 @@ engineのbinaryは利用Projectの `node_modules/.bin` から実行時に解決
 
 `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

@@ -38,8 +38,16 @@ export default defineConfig({
 		"tsdoc-check": true,
 	},
 	config: {
-		"comment-check": { ignore: ["another-project"] },
-		"tsdoc-check": { error: ["missing-doc"] },
+		"comment-check": {
+			enable: ["japanese-period"],
+			ignore: ["another-project"],
+		},
+		"document-style-check": {
+			enable: ["japanese-period"],
+		},
+		"tsdoc-check": {
+			error: ["missing-doc"],
+		},
 	},
 });
 ```
@@ -73,15 +81,16 @@ Engines run in the order `biome`, `typecheck`, `knip`, `comment-check`,
 `document-style-check`, `tsdoc-check`.
 
 `engines` only delegates the start-up, and the conditions belong under the
-engine in `config`. Each engine runs:
+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 |
 |--------|---------|------------|
 | `biome` | `biome check` | `targets`, `args`; `biome.json` holds the excluded paths |
 | `typecheck` | `tsc --noEmit` | `args`, `projects`; `tsconfig.json` holds the settings |
 | `knip` | `knip` | `args`; `knip.ts` holds the settings |
-| `comment-check` | `comment-check --json` | `ignore`, `targets`, `args` |
-| `document-style-check` | `document-style-check lint --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) |
 
 `args` is appended after the engine defaults, for conditions the config cannot
@@ -132,6 +141,12 @@ 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.

package/bin/cli.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env bun
+import { run } from "../dist/cli.js";
+
+run();

package/dist/cli.js

@@ -219,8 +219,8 @@ var ENGINE_OPTION_KEYS = {
   biome: ["args", "ignore", "targets"],
   typecheck: ["args", "ignore", "projects", "targets"],
   knip: ["args", "ignore", "targets"],
-  "comment-check": ["args", "ignore", "targets"],
-  "document-style-check": ["args", "ignore", "targets"],
+  "comment-check": ["args", "enable", "ignore", "targets"],
+  "document-style-check": ["args", "enable", "ignore", "targets"],
   "tsdoc-check": ["args", "error", "ignore", "targets"]
 };
 function readStringArray(value, field) {
@@ -260,6 +260,31 @@ function parseEngines(value, source) {
   }
   return engines;
 }
+function parseEngineExtras(value, source, name) {
+  const extras = {};
+  if (name === "comment-check" || name === "document-style-check") {
+    const enable = readStringArray(value.enable, `${source}: config.${name}.enable`);
+    if (enable !== undefined) {
+      extras.enable = enable;
+    }
+  }
+  if (name === "tsdoc-check") {
+    const error = readStringArray(value.error, `${source}: config.${name}.error`);
+    if (error !== undefined) {
+      extras.error = error;
+    }
+  }
+  if (name === "typecheck") {
+    const projects = readStringArray(value.projects, `${source}: config.${name}.projects`);
+    if (projects !== undefined) {
+      if (projects.length === 0) {
+        throw new Error(`${source}: config.${name}.projects must not be empty`);
+      }
+      extras.projects = projects;
+    }
+  }
+  return extras;
+}
 function parseEngineOptions(value, source, name) {
   const unknown = Object.keys(value).filter((key) => !ENGINE_OPTION_KEYS[name].includes(key));
   if (unknown.length > 0) {
@@ -278,22 +303,7 @@ function parseEngineOptions(value, source, name) {
   if (args !== undefined) {
     options.args = args;
   }
-  if (name === "tsdoc-check") {
-    const error = readStringArray(value.error, `${source}: config.${name}.error`);
-    if (error !== undefined) {
-      options.error = error;
-    }
-  }
-  if (name === "typecheck") {
-    const projects = readStringArray(value.projects, `${source}: config.${name}.projects`);
-    if (projects !== undefined) {
-      if (projects.length === 0) {
-        throw new Error(`${source}: config.${name}.projects must not be empty`);
-      }
-      options.projects = projects;
-    }
-  }
-  return options;
+  return { ...options, ...parseEngineExtras(value, source, name) };
 }
 function parseEngineConfig(value, source) {
   if (value === undefined) {
@@ -446,6 +456,9 @@ function buildTypecheckCommand(executable, context, project) {
     ...options.args ?? []
   ];
 }
+function enableArguments(options) {
+  return (options?.enable ?? []).flatMap((rule) => ["--enable", rule]);
+}
 function buildEngineCommand(name, executable, context) {
   const options = engineConfig(context.config, name) ?? {};
   const limits = ENGINE_LIMITS[name];
@@ -477,6 +490,7 @@ function buildEngineCommand(name, executable, context) {
       "--json",
       "--baseline",
       context.rawBaseline,
+      ...enableArguments(engineConfig(context.config, "comment-check")),
       ...targets,
       ...ignoreArguments,
       ...extra
@@ -487,6 +501,7 @@ function buildEngineCommand(name, executable, context) {
       executable,
       "lint",
       "--json",
+      ...enableArguments(engineConfig(context.config, "document-style-check")),
       ...targets,
       ...ignoreArguments,
       ...extra
@@ -843,4 +858,12 @@ async function main(argv) {
   }
   return results.some((result) => result.status !== "passed") ? 1 : 0;
 }
-runCli(main);
+function run() {
+  runCli(main);
+}
+if (import.meta.main) {
+  run();
+}
+export {
+  run
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@yuu1111/quality-check",
-	"version": "0.6.0",
+	"version": "0.7.1",
 	"description": "Integrated quality check runner",
 	"repository": {
 		"type": "git",
@@ -9,7 +9,7 @@
 	},
 	"type": "module",
 	"bin": {
-		"quality-check": "dist/cli.js"
+		"quality-check": "bin/cli.js"
 	},
 	"exports": {
 		".": "./src/config.ts",
@@ -17,6 +17,7 @@
 	},
 	"files": [
 		"README.ja.md",
+		"bin",
 		"src/config.ts",
 		"src/engines.ts",
 		"dist"

package/src/config.ts

@@ -31,6 +31,22 @@ export interface EngineOptions {
 	args?: string[];
 }
 
+/**
+ * comment-checkへ渡す起動条件
+ */
+export interface CommentCheckOptions extends EngineOptions {
+	/** 既定で無効のopt-in ruleのうち有効にするrule名 */
+	enable?: string[];
+}
+
+/**
+ * document-style-checkへ渡す起動条件
+ */
+export interface DocumentStyleCheckOptions extends EngineOptions {
+	/** 既定で無効のopt-in ruleのうち有効にするrule名 */
+	enable?: string[];
+}
+
 /**
  * TSDoc検査へ渡す起動条件
  */
@@ -54,8 +70,8 @@ export interface EngineConfigMap {
 	biome: EngineOptions;
 	typecheck: TypecheckOptions;
 	knip: EngineOptions;
-	"comment-check": EngineOptions;
-	"document-style-check": EngineOptions;
+	"comment-check": CommentCheckOptions;
+	"document-style-check": DocumentStyleCheckOptions;
 	"tsdoc-check": TsdocCheckOptions;
 }
 
@@ -107,8 +123,8 @@ const ENGINE_OPTION_KEYS: Record<EngineName, readonly string[]> = {
 	biome: ["args", "ignore", "targets"],
 	typecheck: ["args", "ignore", "projects", "targets"],
 	knip: ["args", "ignore", "targets"],
-	"comment-check": ["args", "ignore", "targets"],
-	"document-style-check": ["args", "ignore", "targets"],
+	"comment-check": ["args", "enable", "ignore", "targets"],
+	"document-style-check": ["args", "enable", "ignore", "targets"],
 	"tsdoc-check": ["args", "error", "ignore", "targets"],
 };
 
@@ -164,10 +180,53 @@ function parseEngines(
 }
 
 type ParsedEngineOptions = EngineOptions & {
+	enable?: string[];
 	error?: string[];
 	projects?: string[];
 };
 
+/**
+ * engine名ごとにしか受け取らない起動条件を読み取る
+ */
+function parseEngineExtras(
+	value: JsonObject,
+	source: string,
+	name: EngineName,
+): ParsedEngineOptions {
+	const extras: ParsedEngineOptions = {};
+	if (name === "comment-check" || name === "document-style-check") {
+		const enable = readStringArray(
+			value.enable,
+			`${source}: config.${name}.enable`,
+		);
+		if (enable !== undefined) {
+			extras.enable = enable;
+		}
+	}
+	if (name === "tsdoc-check") {
+		const error = readStringArray(
+			value.error,
+			`${source}: config.${name}.error`,
+		);
+		if (error !== undefined) {
+			extras.error = error;
+		}
+	}
+	if (name === "typecheck") {
+		const projects = readStringArray(
+			value.projects,
+			`${source}: config.${name}.projects`,
+		);
+		if (projects !== undefined) {
+			if (projects.length === 0) {
+				throw new Error(`${source}: config.${name}.projects must not be empty`);
+			}
+			extras.projects = projects;
+		}
+	}
+	return extras;
+}
+
 function parseEngineOptions(
 	value: JsonObject,
 	source: string,
@@ -200,28 +259,7 @@ function parseEngineOptions(
 	if (args !== undefined) {
 		options.args = args;
 	}
-	if (name === "tsdoc-check") {
-		const error = readStringArray(
-			value.error,
-			`${source}: config.${name}.error`,
-		);
-		if (error !== undefined) {
-			options.error = error;
-		}
-	}
-	if (name === "typecheck") {
-		const projects = readStringArray(
-			value.projects,
-			`${source}: config.${name}.projects`,
-		);
-		if (projects !== undefined) {
-			if (projects.length === 0) {
-				throw new Error(`${source}: config.${name}.projects must not be empty`);
-			}
-			options.projects = projects;
-		}
-	}
-	return options;
+	return { ...options, ...parseEngineExtras(value, source, name) };
 }
 
 function parseEngineConfig(

package/src/engines.ts

@@ -179,6 +179,15 @@ function buildTypecheckCommand(
 	];
 }
 
+/**
+ * opt-in ruleを有効にするコマンド引数へ展開する
+ */
+function enableArguments(
+	options: { enable?: string[] } | null | undefined,
+): string[] {
+	return (options?.enable ?? []).flatMap((rule) => ["--enable", rule]);
+}
+
 /**
  * engineへ渡すコマンドを組み立てる
  */
@@ -223,6 +232,7 @@ export function buildEngineCommand(
 			"--json",
 			"--baseline",
 			context.rawBaseline,
+			...enableArguments(engineConfig(context.config, "comment-check")),
 			...targets,
 			...ignoreArguments,
 			...extra,
@@ -233,6 +243,7 @@ export function buildEngineCommand(
 			executable,
 			"lint",
 			"--json",
+			...enableArguments(engineConfig(context.config, "document-style-check")),
 			...targets,
 			...ignoreArguments,
 			...extra,