@yuu1111/quality-check 0.4.0 → 0.5.0

package/README.ja.md

@@ -35,7 +35,7 @@ export default defineConfig({
 		"tsdoc-check": true,
 	},
 	config: {
-		"comment-check": { ignore: ["FFXIVReplayAnalyzer"] },
+		"comment-check": { ignore: ["another-project"] },
 		"tsdoc-check": { error: ["missing-doc"] },
 	},
 });
@@ -96,6 +96,10 @@ engineは `biome` → `typecheck` → `knip` → `comment-check` → `document-s
 
 終了codeは0が全engine成功、1が失敗したengineあり、2が設定またはengine起動の失敗
 
+色は標準出力が端末のときだけ付ける `NO_COLOR` で無効にし、`FORCE_COLOR` で強制できる `--json` の出力には付けない
+
+色を扱えるengineへは自身の出力の色も許可する Biomeは `--colors=force`、tscは `--pretty` を受け取る
+
 engineが受け取らない条件を書いた場合は渡さず、その旨をそのengineのsectionへ出す
 
 ```text

package/README.md

@@ -38,7 +38,7 @@ export default defineConfig({
 		"tsdoc-check": true,
 	},
 	config: {
-		"comment-check": { ignore: ["FFXIVReplayAnalyzer"] },
+		"comment-check": { ignore: ["another-project"] },
 		"tsdoc-check": { error: ["missing-doc"] },
 	},
 });
@@ -104,6 +104,12 @@ express and for the case where an engine changes its arguments.
 Exit code 0 means every engine passed, 1 that at least one failed, and 2 that the
 configuration or an engine could not start.
 
+Color is added only when stdout is a terminal. `NO_COLOR` turns it off and
+`FORCE_COLOR` turns it on; the `--json` output stays plain.
+
+The engines that can color their own output receive the same permission: Biome
+gets `--colors=force` and tsc gets `--pretty`.
+
 A condition that an engine does not take is not passed on, and the section says
 so:
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@yuu1111/quality-check",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"description": "Integrated quality check runner",
 	"license": "MIT",
 	"repository": {

package/src/cli.ts

@@ -2,6 +2,7 @@
 import { tmpdir } from "node:os";
 import { join, resolve } from "node:path";
 import { createBaseline, readBaseline, writeBaseline } from "./baseline";
+import { ansiPainter, colorEnabled, plainPainter } from "./color";
 import {
 	DEFAULT_BASELINE_FILE,
 	findConfigFile,
@@ -125,6 +126,8 @@ async function main(argv: string[]): Promise<number> {
 		return 0;
 	}
 	const options = parseArguments(argv);
+	const color = colorEnabled(process.stdout, process.env);
+	const paint = color ? ansiPainter() : plainPainter;
 	const cwd = process.cwd();
 	const configPath = resolveConfigPath(options, cwd);
 	if (configPath === null) {
@@ -138,6 +141,7 @@ async function main(argv: string[]): Promise<number> {
 			options.update || baselinePath === null
 				? null
 				: readBaseline(baselinePath),
+		color,
 		config,
 		cwd,
 		overrides: { ignore: options.ignores, targets: options.targets },
@@ -153,7 +157,10 @@ async function main(argv: string[]): Promise<number> {
 		);
 		writeBaseline(baselinePath, baseline);
 		console.log(
-			`Recorded ${baseline.entries.length} entries in ${baselinePath}`,
+			paint(
+				`Recorded ${baseline.entries.length} entries in ${baselinePath}`,
+				"pass",
+			),
 		);
 		return 0;
 	}
@@ -161,9 +168,9 @@ async function main(argv: string[]): Promise<number> {
 		console.log(JSON.stringify(toJsonReport(results), null, "\t"));
 	} else {
 		for (const result of results) {
-			console.log(formatEngineSection(result));
+			console.log(formatEngineSection(result, paint));
 		}
-		console.log(formatSummary(results));
+		console.log(formatSummary(results, paint));
 	}
 	return results.some((result) => result.status !== "passed") ? 1 : 0;
 }

package/src/color.ts

@@ -0,0 +1,47 @@
+/**
+ * 出力行へ割り当てる装飾の種類
+ */
+export type Tone = "error" | "header" | "muted" | "pass" | "warn";
+
+/**
+ * toneに応じて文字列を装飾する関数
+ */
+export type Painter = (text: string, tone: Tone) => string;
+
+const ANSI_CODES: Record<Tone, string> = {
+	error: "31",
+	header: "36",
+	muted: "2",
+	pass: "32",
+	warn: "33",
+};
+
+/**
+ * 装飾を付けずにそのまま返すpainter
+ */
+export function plainPainter(text: string, _tone: Tone): string {
+	return text;
+}
+
+/**
+ * ANSI escapeでtoneを色へ割り当てるpainterを作る
+ */
+export function ansiPainter(): Painter {
+	return (text, tone) => `\u001b[${ANSI_CODES[tone]}m${text}\u001b[0m`;
+}
+
+/**
+ * 出力先と環境変数から装飾の可否を決める
+ */
+export function colorEnabled(
+	stream: { isTTY?: boolean | undefined },
+	env: Record<string, string | undefined>,
+): boolean {
+	if (env.NO_COLOR !== undefined && env.NO_COLOR !== "") {
+		return false;
+	}
+	if (env.FORCE_COLOR !== undefined && env.FORCE_COLOR !== "") {
+		return env.FORCE_COLOR !== "0";
+	}
+	return stream.isTTY === true;
+}

package/src/engines.ts

@@ -52,6 +52,8 @@ export interface RunOverrides {
  */
 export interface EngineCommandContext {
 	config: QualityConfig;
+	/** engine自身の出力へ色を付けるか */
+	color: boolean;
 	/** 対応するengineへだけ足す上書き */
 	overrides: RunOverrides;
 	/** comment-checkのbaseline差分を無効化するために渡す未作成のpath */
@@ -143,6 +145,22 @@ export function resolveExecutable(
 	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 [];
+}
+
 /**
  * engineへ渡すコマンドを組み立てる
  */
@@ -167,10 +185,21 @@ export function buildEngineCommand(
 	const rules = engineConfig(context.config, "tsdoc-check")?.error ?? [];
 	const errorArguments = rules.flatMap((rule) => ["--error", rule]);
 	if (name === "biome") {
-		return [executable, "check", ...targets, ...extra];
+		return [
+			executable,
+			"check",
+			...colorArguments(name, context.color),
+			...targets,
+			...extra,
+		];
 	}
 	if (name === "typecheck") {
-		return [executable, "--noEmit", ...extra];
+		return [
+			executable,
+			"--noEmit",
+			...colorArguments(name, context.color),
+			...extra,
+		];
 	}
 	if (name === "knip") {
 		return [executable, ...extra];

package/src/report.ts

@@ -1,9 +1,14 @@
+import { type Painter, plainPainter } from "./color";
 import { isFindingEngine } from "./engines";
 import type { NormalizedFinding } from "./findings";
 import type { EngineResult } from "./run";
 
-function describeFinding(finding: NormalizedFinding): string {
-	return `${finding.file}:${finding.line}:${finding.column} ${finding.rule} ${finding.severity} ${finding.text}`;
+function describeFinding(
+	finding: NormalizedFinding,
+	paint: Painter,
+	tone: "error" | "warn",
+): string {
+	return `${finding.file}:${finding.line}:${finding.column} ${finding.rule} ${paint(finding.severity, tone)} ${finding.text}`;
 }
 
 function describeCounts(result: EngineResult): string {
@@ -13,38 +18,48 @@ function describeCounts(result: EngineResult): string {
 	return `${result.reported.length} new, ${result.resolved} resolved, ${result.warnings.length} warnings`;
 }
 
-function describeStatus(result: EngineResult): string {
+function describeStatus(result: EngineResult, paint: Painter): string {
 	if (result.status === "error") {
-		return "error";
+		return paint("error", "error");
 	}
-	return `${result.status} (${describeCounts(result)})`;
+	const tone = result.status === "passed" ? "pass" : "error";
+	return `${paint(result.status, tone)} (${describeCounts(result)})`;
 }
 
 /**
  * engine1つ分の出力sectionを組み立てる
  */
-export function formatEngineSection(result: EngineResult): string {
-	const lines = [`== ${result.name} ==`];
+export function formatEngineSection(
+	result: EngineResult,
+	paint: Painter = plainPainter,
+): string {
+	const lines = [paint(`== ${result.name} ==`, "header")];
 	for (const skipped of result.skipped) {
-		lines.push(`${result.name}: ${skipped}`);
+		lines.push(paint(`${result.name}: ${skipped}`, "muted"));
 	}
 	if (result.output !== "" && !isFindingEngine(result.name)) {
 		lines.push(result.output);
 	}
-	for (const finding of [...result.reported, ...result.warnings]) {
-		lines.push(describeFinding(finding));
+	for (const finding of result.reported) {
+		lines.push(describeFinding(finding, paint, "error"));
+	}
+	for (const finding of result.warnings) {
+		lines.push(describeFinding(finding, paint, "warn"));
 	}
 	if (result.message !== undefined) {
-		lines.push(result.message);
+		lines.push(paint(result.message, "error"));
 	}
-	lines.push(`${result.name}: ${describeStatus(result)}`);
+	lines.push(`${result.name}: ${describeStatus(result, paint)}`);
 	return lines.join("\n");
 }
 
 /**
  * 失敗したengineを列挙した集約summaryを組み立てる
  */
-export function formatSummary(results: EngineResult[]): string {
+export function formatSummary(
+	results: EngineResult[],
+	paint: Painter = plainPainter,
+): string {
 	const failed = results
 		.filter((result) => result.status !== "passed")
 		.map((result) => result.name);
@@ -52,14 +67,17 @@ export function formatSummary(results: EngineResult[]): string {
 		.filter((result) => result.status === "passed")
 		.map((result) => result.name);
 	if (failed.length === 0) {
-		return `quality-check: ${results.length} engines passed`;
+		return paint(`quality-check: ${results.length} engines passed`, "pass");
 	}
 	const lines = [
-		`quality-check: ${failed.length} of ${results.length} engines failed`,
-		`  failed: ${failed.join(", ")}`,
+		paint(
+			`quality-check: ${failed.length} of ${results.length} engines failed`,
+			"error",
+		),
+		`  ${paint("failed:", "error")} ${failed.join(", ")}`,
 	];
 	if (passed.length > 0) {
-		lines.push(`  passed: ${passed.join(", ")}`);
+		lines.push(`  ${paint("passed:", "pass")} ${passed.join(", ")}`);
 	}
 	return lines.join("\n");
 }

package/src/run.ts

@@ -44,6 +44,8 @@ export interface EngineResult {
 export interface RunOptions {
 	/** 適用するbaseline nullなら差分判定を行わない */
 	baseline: BaselineFile | null;
+	/** engine自身の出力へ色を付けるか */
+	color: boolean;
 	config: QualityConfig;
 	cwd: string;
 	/** コマンドラインから渡された起動条件の上書き */
@@ -188,6 +190,7 @@ async function runEngine(
 export async function runEngines(options: RunOptions): Promise<EngineResult[]> {
 	const runner = options.runner ?? runEngineProcess;
 	const context: EngineCommandContext = {
+		color: options.color,
 		config: options.config,
 		overrides: options.overrides,
 		rawBaseline: options.rawBaseline,