@yuu1111/quality-check 0.11.0 → 4.0.0

package/src/config.ts

@@ -1,388 +0,0 @@
-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の名前 並び順が実行順になる
- */
-export const ENGINE_NAMES = [
-	"biome",
-	"typecheck",
-	"knip",
-	"code-style-check",
-	"comment-check",
-	"document-style-check",
-	"tsdoc-check",
-] as const;
-
-/**
- * engine名のunion型
- */
-export type EngineName = (typeof ENGINE_NAMES)[number];
-
-/**
- * engineへ渡す起動条件
- */
-export interface EngineOptions {
-	/** 検査から外すpath engineが受け取れないときはreportへ出す */
-	ignore?: string[];
-	/** 検査する対象path engineが受け取れないときはreportへ出す */
-	targets?: string[];
-	/** engineの既定引数の後ろへ足す引数 */
-	args?: string[];
-}
-
-/**
- * comment-checkへ渡す起動条件
- */
-export interface CommentCheckOptions extends EngineOptions {
-	/** 既定で無効のopt-in ruleのうち有効にするrule名 comment-checkが公開するunionで縛る */
-	enable?: CommentCheckRuleName[];
-}
-
-/**
- * document-style-checkへ渡す起動条件
- */
-export interface DocumentStyleCheckOptions extends EngineOptions {
-	/** 既定で無効のopt-in ruleのうち有効にするrule名 document-style-checkが公開するunionで縛る */
-	enable?: DocumentStyleCheckRuleName[];
-}
-
-/**
- * TSDoc検査へ渡す起動条件
- */
-export interface TsdocCheckOptions extends EngineOptions {
-	/** 既定で無効のopt-in ruleのうち有効にするrule名 tsdoc-checkが公開するunionで縛る */
-	enable?: TsdocCheckRuleName[];
-	/** 違反として扱うrule名 tsdoc-checkが公開するunionで縛る */
-	error?: TsdocRule[];
-}
-
-/**
- * 型検査へ渡す起動条件
- */
-export interface TypecheckOptions extends EngineOptions {
-	/** 型検査するtsconfigのpath 省略時はカレントのtsconfig.jsonを1回だけ読む */
-	projects?: string[];
-}
-
-/**
- * engine名ごとの起動条件
- */
-export interface EngineConfigMap {
-	biome: EngineOptions;
-	typecheck: TypecheckOptions;
-	knip: EngineOptions;
-	"code-style-check": EngineOptions;
-	"comment-check": CommentCheckOptions;
-	"document-style-check": DocumentStyleCheckOptions;
-	"tsdoc-check": TsdocCheckOptions;
-}
-
-/**
- * quality.config.tsが受け付ける統合検査の設定
- */
-export interface QualityConfig {
-	/** 起動するengine 値がfalseまたは未指定のengineは起動しない */
-	engines: Partial<Record<EngineName, boolean>>;
-	/** engineごとの起動条件 省略したengineは既定値で起動する */
-	config?: Partial<EngineConfigMap>;
-	/** baseline fileのpath falseなら差分判定を行わない */
-	baseline?: string | false;
-}
-
-/**
- * 設定fileを型付けするための恒等関数
- *
- * @param config - 型付けする統合検査の設定
- * @returns 引数をそのまま返した統合検査の設定
- */
-export function defineConfig(config: QualityConfig): QualityConfig {
-	return config;
-}
-
-/**
- * config fileを探索する既定のfile名
- */
-export const DEFAULT_CONFIG_FILES = [
-	"quality.config.ts",
-	"quality.config.mts",
-	"quality.config.js",
-	"quality.config.mjs",
-] as const;
-
-/**
- * baseline fileの既定名
- */
-export const DEFAULT_BASELINE_FILE = "quality-baseline.json";
-
-type JsonObject = Record<string, unknown>;
-
-function isJsonObject(value: unknown): value is JsonObject {
-	return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-function isEngineName(value: string): value is EngineName {
-	return (ENGINE_NAMES as readonly string[]).includes(value);
-}
-
-const ENGINE_OPTION_KEYS: Record<EngineName, readonly string[]> = {
-	biome: ["args", "ignore", "targets"],
-	typecheck: ["args", "ignore", "projects", "targets"],
-	knip: ["args", "ignore", "targets"],
-	"code-style-check": ["args", "ignore", "targets"],
-	"comment-check": ["args", "enable", "ignore", "targets"],
-	"document-style-check": ["args", "enable", "ignore", "targets"],
-	"tsdoc-check": ["args", "enable", "error", "ignore", "targets"],
-};
-
-function readStringArray(value: unknown, field: string): string[] | undefined {
-	if (value === undefined) {
-		return undefined;
-	}
-	if (
-		!Array.isArray(value) ||
-		value.some((entry) => typeof entry !== "string" || entry === "")
-	) {
-		throw new Error(`${field} must be an array of non-empty strings`);
-	}
-	return [...value] as string[];
-}
-
-function readBaseline(
-	value: unknown,
-	source: string,
-): string | false | undefined {
-	if (value === undefined || value === false) {
-		return value;
-	}
-	if (typeof value === "string" && value !== "") {
-		return value;
-	}
-	throw new Error(`${source}: baseline must be a path string or false`);
-}
-
-function parseEngines(
-	value: unknown,
-	source: string,
-): Partial<Record<EngineName, boolean>> {
-	if (!isJsonObject(value)) {
-		throw new Error(`${source} must export an engines object`);
-	}
-	const engines: Partial<Record<EngineName, boolean>> = {};
-	for (const [name, enabled] of Object.entries(value)) {
-		if (!isEngineName(name)) {
-			throw new Error(`${source}: unknown engine: ${name}`);
-		}
-		if (typeof enabled !== "boolean") {
-			throw new Error(
-				`${source}: engines.${name} must be a boolean 起動条件はconfigへ置く`,
-			);
-		}
-		engines[name] = enabled;
-	}
-	if (ENGINE_NAMES.every((name) => !engines[name])) {
-		throw new Error(`${source} must enable at least one engine`);
-	}
-	return engines;
-}
-
-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" ||
-		name === "tsdoc-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,
-	name: EngineName,
-): ParsedEngineOptions {
-	const unknown = Object.keys(value).filter(
-		(key) => !ENGINE_OPTION_KEYS[name].includes(key),
-	);
-	if (unknown.length > 0) {
-		throw new Error(
-			`${source}: config.${name} has an unknown option: ${unknown[0]}`,
-		);
-	}
-	const options: ParsedEngineOptions = {};
-	const ignore = readStringArray(
-		value.ignore,
-		`${source}: config.${name}.ignore`,
-	);
-	if (ignore !== undefined) {
-		options.ignore = ignore;
-	}
-	const targets = readStringArray(
-		value.targets,
-		`${source}: config.${name}.targets`,
-	);
-	if (targets !== undefined) {
-		options.targets = targets;
-	}
-	const args = readStringArray(value.args, `${source}: config.${name}.args`);
-	if (args !== undefined) {
-		options.args = args;
-	}
-	return { ...options, ...parseEngineExtras(value, source, name) };
-}
-
-function parseEngineConfig(
-	value: unknown,
-	source: string,
-): Partial<EngineConfigMap> | undefined {
-	if (value === undefined) {
-		return undefined;
-	}
-	if (!isJsonObject(value)) {
-		throw new Error(`${source}: config must be an object`);
-	}
-	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}`);
-		}
-		if (!isJsonObject(options)) {
-			throw new Error(`${source}: config.${name} must be an object`);
-		}
-		config[name] = parseEngineOptions(options, source, name);
-	}
-
-	// 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)) {
-		throw new Error(`${source} must export a config object`);
-	}
-	const config: QualityConfig = {
-		engines: parseEngines(value.engines, source),
-	};
-	const engineConfig = parseEngineConfig(value.config, source);
-	if (engineConfig !== undefined) {
-		config.config = engineConfig;
-	}
-	const baseline = readBaseline(value.baseline, source);
-	if (baseline !== undefined) {
-		config.baseline = baseline;
-	}
-	return config;
-}
-
-/**
- * 有効なengineを実行順で返す
- *
- * @param config - engineの有効無効を持つ統合検査の設定
- * @returns 有効なengine名を実行順に並べた配列
- */
-export function enabledEngines(config: QualityConfig): EngineName[] {
-	return ENGINE_NAMES.filter((name) => Boolean(config.engines[name]));
-}
-
-/**
- * engineの起動条件を返す 無効なengineにはnullを返す
- *
- * @typeParam K - 起動条件を取り出すengine名の型
- * @param config - engineごとの起動条件を持つ統合検査の設定
- * @param name - 起動条件を取り出すengine名
- * @returns 指定したengineの起動条件 無効なengineならnull
- */
-export function engineConfig<K extends EngineName>(
-	config: QualityConfig,
-	name: K,
-): EngineConfigMap[K] | null {
-	if (!config.engines[name]) {
-		return null;
-	}
-	return config.config?.[name] ?? ({} as EngineConfigMap[K]);
-}
-
-/**
- * 作業ディレクトリからconfig fileを探す
- *
- * @param cwd - 探索を開始する作業ディレクトリのpath
- * @returns 見つけたconfig fileのpath 見つからなければnull
- */
-export function findConfigFile(cwd: string): string | null {
-	for (const name of DEFAULT_CONFIG_FILES) {
-		const candidate = resolve(cwd, name);
-		if (existsSync(candidate)) {
-			return candidate;
-		}
-	}
-	return 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);
-	const value =
-		isJsonObject(module) && "default" in module ? module.default : module;
-	return parseConfig(value, path);
-}

package/src/engines.ts

@@ -1,333 +0,0 @@
-import { existsSync } from "node:fs";
-import { dirname, join } from "node:path";
-import {
-	type EngineName,
-	type EngineOptions,
-	engineConfig,
-	type QualityConfig,
-} from "./config";
-
-/**
- * 子プロセスとして起動したengineの生の結果
- */
-export interface EngineProcessResult {
-	exitCode: number | null;
-	stderr: string;
-	stdout: string;
-}
-
-/**
- * engineを起動して出力を返す関数 テストでは差し替える
- */
-export type EngineRunner = (
-	command: string[],
-	options: { cwd: string },
-) => Promise<EngineProcessResult>;
-
-/**
- * engineごとの実行file名
- */
-export const ENGINE_BINS: Record<EngineName, string> = {
-	biome: "biome",
-	"code-style-check": "code-style-check",
-	"comment-check": "comment-check",
-	"document-style-check": "document-style-check",
-	knip: "knip",
-	"tsdoc-check": "tsdoc-check",
-	typecheck: "tsc",
-};
-
-const WINDOWS_SHIMS = [".exe", ".cmd", ".bat", ""];
-const POSIX_SHIMS = [""];
-
-/**
- * コマンドラインから渡された起動条件の上書き
- */
-export interface RunOverrides {
-	ignore: string[];
-	targets: string[];
-}
-
-/**
- * engineのコマンドを組み立てるための実行条件
- */
-export interface EngineCommandContext {
-	config: QualityConfig;
-	/** engine自身の出力へ色を付けるか */
-	color: boolean;
-	/** 対応するengineへだけ足す上書き */
-	overrides: RunOverrides;
-	/** comment-checkのbaseline差分を無効化するために渡す未作成のpath */
-	rawBaseline: string;
-}
-
-/**
- * engineが受け取らない起動条件と、その設定の持ち主
- */
-export const ENGINE_LIMITS: Record<
-	EngineName,
-	Partial<Record<"ignore" | "targets", string>>
-> = {
-	biome: { ignore: "biome.json holds its settings" },
-	typecheck: {
-		ignore: "tsconfig.json holds its settings",
-		targets: "tsconfig.json and projects hold its settings",
-	},
-	knip: {
-		ignore: "knip.ts holds its settings",
-		targets: "knip analyzes the whole project",
-	},
-	"code-style-check": {},
-	"comment-check": {},
-	"document-style-check": {},
-	"tsdoc-check": {},
-};
-
-/**
- * engineが受け取らないため渡さなかった起動条件を返す
- *
- * @param name - 受け取れない起動条件を引くengine名
- * @param options - engineへ渡そうとした起動条件
- * @returns 渡さなかった起動条件とその理由の一覧
- */
-export function skippedEngineOptions(
-	name: EngineName,
-	options: EngineOptions | undefined,
-): string[] {
-	if (options === undefined) {
-		return [];
-	}
-	const limits = ENGINE_LIMITS[name];
-	const skipped: string[] = [];
-	for (const key of ["ignore", "targets"] as const) {
-		const reason = limits[key];
-		if (reason !== undefined && options[key] !== undefined) {
-			skipped.push(`${key} skipped (${reason})`);
-		}
-	}
-	return skipped;
-}
-
-/**
- * 検出をJSONで返すengineか
- *
- * @param name - 判定するengine名
- * @returns 検出をJSONで返すengineならtrue
- */
-export function isFindingEngine(name: EngineName): boolean {
-	return (
-		name === "code-style-check" ||
-		name === "comment-check" ||
-		name === "document-style-check" ||
-		name === "tsdoc-check"
-	);
-}
-
-/**
- * node_modules/.binとPATHからengineの実行fileを探す
- *
- * @param name - 実行fileを探すengine名
- * @param cwd - 探索を開始する作業ディレクトリのpath
- * @returns 見つけた実行fileのpath PATHにも無ければnull
- */
-export function resolveExecutable(
-	name: EngineName,
-	cwd: string,
-): string | null {
-	const shims = process.platform === "win32" ? WINDOWS_SHIMS : POSIX_SHIMS;
-	const bin = ENGINE_BINS[name];
-	let directory = cwd;
-	for (;;) {
-		for (const shim of shims) {
-			const candidate = join(
-				directory,
-				"node_modules",
-				".bin",
-				`${bin}${shim}`,
-			);
-			if (existsSync(candidate)) {
-				return candidate;
-			}
-		}
-		const parent = dirname(directory);
-		if (parent === directory) {
-			break;
-		}
-		directory = parent;
-	}
-	const onPath = Bun.which(bin);
-	return onPath ?? null;
-}
-
-/**
- * engine自身の出力へ色を付けるための引数を返す
- */
-function colorArguments(name: EngineName, color: boolean): string[] {
-	if (!color) {
-		return [];
-	}
-	if (name === "biome") {
-		return ["--colors=force"];
-	}
-	if (name === "typecheck") {
-		return ["--pretty"];
-	}
-	return [];
-}
-
-/**
- * 型検査のコマンドを組み立てる projectを渡すとそのtsconfigを読む
- */
-function buildTypecheckCommand(
-	executable: string,
-	context: EngineCommandContext,
-	project: string | undefined,
-): string[] {
-	const options = engineConfig(context.config, "typecheck") ?? {};
-	return [
-		executable,
-		"--noEmit",
-		...(project === undefined ? [] : ["--project", project]),
-		...colorArguments("typecheck", context.color),
-		...(options.args ?? []),
-	];
-}
-
-/**
- * opt-in ruleを有効にするコマンド引数へ展開する
- */
-function enableArguments(
-	options: { enable?: string[] } | null | undefined,
-): string[] {
-	return (options?.enable ?? []).flatMap((rule) => ["--enable", rule]);
-}
-
-/**
- * engineへ渡すコマンドを組み立てる
- *
- * @param name - コマンドを組み立てるengine名
- * @param executable - 起動するengineの実行fileのpath
- * @param context - 設定と上書きを持つ実行条件
- * @returns engineへ渡す引数を並べたコマンド
- */
-export function buildEngineCommand(
-	name: EngineName,
-	executable: string,
-	context: EngineCommandContext,
-): string[] {
-	const options: EngineOptions = engineConfig(context.config, name) ?? {};
-	const limits = ENGINE_LIMITS[name];
-	const extra = options.args ?? [];
-	const ignores =
-		limits.ignore === undefined
-			? [...(options.ignore ?? []), ...context.overrides.ignore]
-			: [];
-	const requested =
-		context.overrides.targets.length > 0
-			? context.overrides.targets
-			: (options.targets ?? ["."]);
-	const targets = limits.targets === undefined ? requested : [];
-	const ignoreArguments = ignores.flatMap((ignore) => ["--ignore", ignore]);
-	const rules = engineConfig(context.config, "tsdoc-check")?.error ?? [];
-	const errorArguments = rules.flatMap((rule) => ["--error", rule]);
-	if (name === "biome") {
-		return [
-			executable,
-			"check",
-			...colorArguments(name, context.color),
-			...targets,
-			...extra,
-		];
-	}
-	if (name === "typecheck") {
-		return buildTypecheckCommand(executable, context, undefined);
-	}
-	if (name === "knip") {
-		return [executable, ...extra];
-	}
-	if (name === "comment-check") {
-		return [
-			executable,
-			"--json",
-			"--baseline",
-			context.rawBaseline,
-			...enableArguments(engineConfig(context.config, "comment-check")),
-			...targets,
-			...ignoreArguments,
-			...extra,
-		];
-	}
-	if (name === "document-style-check") {
-		return [
-			executable,
-			"lint",
-			"--json",
-			...enableArguments(engineConfig(context.config, "document-style-check")),
-			...targets,
-			...ignoreArguments,
-			...extra,
-		];
-	}
-	if (name === "code-style-check") {
-		return [executable, "--json", ...targets, ...ignoreArguments, ...extra];
-	}
-	return [
-		executable,
-		"--json",
-		...enableArguments(engineConfig(context.config, "tsdoc-check")),
-		...errorArguments,
-		...targets,
-		...ignoreArguments,
-		...extra,
-	];
-}
-
-/**
- * engineの起動コマンドを順番に返す 型検査だけはprojectsごとに起動する
- *
- * @param name - コマンドを組み立てるengine名
- * @param executable - 起動するengineの実行fileのpath
- * @param context - 設定と上書きを持つ実行条件
- * @returns 起動する順に並べたコマンドの配列
- */
-export function buildEngineCommands(
-	name: EngineName,
-	executable: string,
-	context: EngineCommandContext,
-): string[][] {
-	const projects =
-		name === "typecheck"
-			? (engineConfig(context.config, "typecheck")?.projects ?? [])
-			: [];
-	if (projects.length === 0) {
-		return [buildEngineCommand(name, executable, context)];
-	}
-	return projects.map((project) =>
-		buildTypecheckCommand(executable, context, project),
-	);
-}
-
-/**
- * Bun.spawnでengineを起動する既定のrunner
- *
- * @param command - 実行fileと引数を並べたコマンド
- * @param options - engineを起動する作業ディレクトリを持つ条件
- * @returns 終了codeと標準出力と標準エラーを持つ結果
- */
-export async function runEngineProcess(
-	command: string[],
-	options: { cwd: string },
-): Promise<EngineProcessResult> {
-	const child = Bun.spawn({
-		cmd: command,
-		cwd: options.cwd,
-		stderr: "pipe",
-		stdout: "pipe",
-	});
-	const [stdout, stderr, exitCode] = await Promise.all([
-		new Response(child.stdout).text(),
-		new Response(child.stderr).text(),
-		child.exited,
-	]);
-	return { exitCode, stderr, stdout };
-}