@yuu1111/quality-check 0.9.0 → 0.10.0

package/README.ja.md

@@ -90,7 +90,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,7 +102,7 @@ engineが受け取らない条件は渡さず、その旨をそのengineのsecti
 biome: ignore skipped (biome.json holds its settings)
 ```
 
-`enable` は `comment-check` と `document-style-check` の `--enable <rule>` になり、他のengineでは拒否される
+`enable` は `comment-check` と `document-style-check` と `tsdoc-check` の `--enable <rule>` になり、他のengineでは拒否される
 このCLIはengineを同梱しないため、opt-in ruleを有効にするProjectは対応するengine packageも同じ変更で更新する
 
 `comment-check` はbaseline差分を無効化する未作成のpathを渡して起動する

package/README.md

@@ -94,7 +94,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,7 +105,7 @@ 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.
+`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.

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.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[],