nuxt-layerscope 0.1.2 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.1.3
+
+- Notes and the `--verbose` line are printed after the report, in every command, so they are the
+  last thing on screen. `note:` is highlighted in a terminal.
+- `layerscope check` lists files with errors after files with only warnings, so the errors stay
+  next to the summary in a long report.
+- The text report colors severities, rule names and the summary in a terminal. `NO_COLOR` and
+  `FORCE_COLOR` are honoured.
+
 ## 0.1.2
 
 - A note appears when `nuxt.config` is newer than the registry, because changes to its

package/dist/api.d.mts

@@ -1,5 +1,6 @@
 import { a as Context, c as Layer, d as Reference, f as ReferenceKind, g as SourceOption, h as Severity, i as BaselineResult, l as LayerRule, m as RuleName, n as AnalyzeResult, o as Edge, p as ResolutionSource, r as BaselineEntry, s as Finding, t as defineConfig, u as LayerscopeConfig } from "./define-DNRGLVG_.mjs";
 import { t as ProjectConfig } from "./effective-Dqg4EwH_.mjs";
+import { styleText } from "node:util";
 //#region src/analyze/index.d.ts
 interface AnalyzeOptions {
   /** Defaults to `process.cwd()`. */
@@ -114,11 +115,15 @@ interface Registry {
   config?: ProjectConfig;
 }
 //#endregion
+//#region src/utils/style.d.ts
+/** Wraps text in terminal styles, e.g. `paint('red', 'error')`. */
+type Paint = (format: Parameters<typeof styleText>[0], text: string) => string;
+//#endregion
 //#region src/report/index.d.ts
 export declare const OUTPUT_FORMATS: readonly ['text', 'github', 'json'];
 type OutputFormat = (typeof OUTPUT_FORMATS)[number];
-/** Paths in the output are relative to `cwd`. */
-export declare function formatResult(result: AnalyzeResult, format: OutputFormat, cwd?: string): string;
+/** Paths in the output are relative to `cwd`. Only the text format uses `paint`. */
+export declare function formatResult(result: AnalyzeResult, format: OutputFormat, cwd?: string, paint?: Paint): string;
 //#endregion
 //#region src/report/json.d.ts
 /** Bumped on breaking changes to the JSON report shape. */

package/dist/api.mjs

@@ -1,6 +1,6 @@
 import { l as REGISTRY_FILE, u as REGISTRY_VERSION, v as LayerscopeError } from "./layer-factory-DFh7nkFH.mjs";
 import { t as defineConfig } from "./define-l62B9fVk.mjs";
 import { i as createBaseline, n as BASELINE_FILE, r as BASELINE_VERSION, t as analyze } from "./analyze-QaYmBXyK.mjs";
-import { i as JSON_REPORT_VERSION, n as formatResult, t as OUTPUT_FORMATS } from "./report-BNW0GCl9.mjs";
+import { i as JSON_REPORT_VERSION, n as formatResult, t as OUTPUT_FORMATS } from "./report-DShTCB59.mjs";
 import { r as buildGraph, t as findUnused } from "./unused-BtsPSfxb.mjs";
 export { BASELINE_FILE, BASELINE_VERSION, JSON_REPORT_VERSION, LayerscopeError, OUTPUT_FORMATS, REGISTRY_FILE, REGISTRY_VERSION, analyze, buildGraph, createBaseline, defineConfig, findUnused, formatResult };

package/dist/bin.mjs

@@ -2,7 +2,7 @@
 import { v as LayerscopeError } from "./layer-factory-DFh7nkFH.mjs";
 import { i as plural, r as pascalCase } from "./strings-CrOjNZmB.mjs";
 import { a as writeBaseline, i as createBaseline, n as BASELINE_FILE, t as analyze } from "./analyze-QaYmBXyK.mjs";
-import { n as formatResult, r as isOutputFormat, t as OUTPUT_FORMATS } from "./report-BNW0GCl9.mjs";
+import { a as paintFor, n as formatResult, r as isOutputFormat, t as OUTPUT_FORMATS } from "./report-DShTCB59.mjs";
 import { i as edgeStatus, n as GRAPH_LEVELS, r as buildGraph, t as findUnused } from "./unused-BtsPSfxb.mjs";
 import { relative, resolve } from "pathe";
 import { cac } from "cac";
@@ -20,14 +20,19 @@ function toSource(value) {
 	if (source === void 0) throw new LayerscopeError(`Unknown source "${value}". Use ${SOURCE_OPTIONS.join(", ")}.`);
 	return source;
 }
-/** Diagnostics go to stderr, so stdout stays machine-readable in every format. */
+/**
+* Diagnostics go to stderr, so stdout stays machine-readable in every format. Call it after the
+* report is written: notes at the end are the ones a reader still sees when the report scrolled.
+*/
 function writeNotes(result, verbose) {
-	const lines = result.notes.map((note) => `layerscope: note: ${note}`);
+	const paint = paintFor(process.stderr);
+	const lines = result.notes.map((note) => `${paint(["yellow", "bold"], "layerscope: note:")} ${note}`);
 	if (verbose) {
 		const kind = result.source === "registry" ? "the registry" : "the generated .d.ts files";
-		lines.unshift(`layerscope: symbols from ${kind} (${relative(process.cwd(), result.sourceFile)})`);
+		const source = relative(process.cwd(), result.sourceFile);
+		lines.unshift(paint("dim", `layerscope: symbols from ${kind} (${source})`));
 	}
-	if (lines.length > 0) process.stderr.write(`${lines.join("\n")}\n`);
+	if (lines.length > 0) process.stderr.write(`${process.stdout.isTTY ? "\n" : ""}${lines.join("\n")}\n`);
 }
 //#endregion
 //#region src/commands/check.ts
@@ -38,11 +43,11 @@ async function updateBaseline(rootDir, flags) {
 		prepare: flags.prepare,
 		source: toSource(flags.source)
 	});
-	writeNotes(result, flags.verbose === true);
 	const file = resolve(rootDir, flags.baseline);
 	writeBaseline(file, createBaseline(result.findings, rootDir));
 	const count = plural(result.findings.length, "finding");
 	process.stdout.write(`✔ Wrote ${count} to ${relative(process.cwd(), file)}\n`);
+	writeNotes(result, flags.verbose === true);
 	return 0;
 }
 async function check(root, flags) {
@@ -57,8 +62,8 @@ async function check(root, flags) {
 		source: toSource(flags.source),
 		baseline: flags.baseline
 	});
+	process.stdout.write(formatResult(result, format, process.cwd(), paintFor(process.stdout)));
 	writeNotes(result, flags.verbose === true);
-	process.stdout.write(formatResult(result, format));
 	return result.findings.some((finding) => finding.severity === "error") ? 1 : 0;
 }
 function registerCheck(cli) {
@@ -162,8 +167,8 @@ async function graph(root, flags) {
 		prepare: flags.prepare,
 		source: toSource(flags.source)
 	});
-	writeNotes(result, flags.verbose === true);
 	process.stdout.write(formatGraph(buildGraph(result, result.config, level), format));
+	writeNotes(result, flags.verbose === true);
 	return 0;
 }
 function registerGraph(cli) {
@@ -216,8 +221,8 @@ async function unused(root, flags) {
 		prepare: flags.prepare,
 		source: toSource(flags.source)
 	});
-	writeNotes(result, flags.verbose === true);
 	process.stdout.write(formatUnused(findUnused(result), format));
+	writeNotes(result, flags.verbose === true);
 	return 0;
 }
 function registerUnused(cli) {
@@ -331,10 +336,13 @@ async function why(symbol, root, flags) {
 		prepare: flags.prepare,
 		source: toSource(flags.source)
 	});
-	writeNotes(result, flags.verbose === true);
 	const targets = findUses(result, symbol, result.config);
-	if (targets.length === 0) throw new LayerscopeError(`No uses of "${symbol}" found.`);
+	if (targets.length === 0) {
+		writeNotes(result, flags.verbose === true);
+		throw new LayerscopeError(`No uses of "${symbol}" found.`);
+	}
 	process.stdout.write(formatWhy(symbol, targets, format));
+	writeNotes(result, flags.verbose === true);
 	return 0;
 }
 function registerWhy(cli) {

package/dist/index.mjs

@@ -106,7 +106,7 @@ function renderError(message) {
 //#region src/devtools/index.ts
 const DEVTOOLS_ROUTE = "/__layerscope";
 async function renderReport(nuxt, format) {
-	const [{ analyze }, { formatResult }] = await Promise.all([import("./analyze-DVzyPH7N.mjs"), import("./report-DtAi0vPb.mjs")]);
+	const [{ analyze }, { formatResult }] = await Promise.all([import("./analyze-DVzyPH7N.mjs"), import("./report-CKhXT50W.mjs")]);
 	const { rootDir, app } = nuxt.options;
 	const result = await analyze({ rootDir });
 	if (format === "json") return formatResult(result, "json", rootDir);

package/dist/{report-DtAi0vPb.mjs → report-CKhXT50W.mjs}

@@ -1,2 +1,2 @@
-import { n as formatResult, r as isOutputFormat, t as OUTPUT_FORMATS } from "./report-BNW0GCl9.mjs";
+import { n as formatResult, r as isOutputFormat, t as OUTPUT_FORMATS } from "./report-DShTCB59.mjs";
 export { OUTPUT_FORMATS, formatResult, isOutputFormat };

package/dist/{report-BNW0GCl9.mjs → report-DShTCB59.mjs}

@@ -1,6 +1,15 @@
 import { t as summarize } from "./summary-DiUYKMPe.mjs";
 import { i as plural } from "./strings-CrOjNZmB.mjs";
 import { relative } from "pathe";
+import { styleText } from "node:util";
+//#region src/utils/style.ts
+/** No styles: what the report functions use unless the CLI passes a painter for its terminal. */
+const plain = (_format, text) => text;
+/** Styles only when `stream` is a terminal; `NO_COLOR` and `FORCE_COLOR` are honoured. */
+function paintFor(stream) {
+	return (format, text) => styleText(format, text, { stream });
+}
+//#endregion
 //#region src/report/baseline.ts
 /** `layer-boundary useCart → web (×2)` */
 function describeEntry(entry) {
@@ -87,8 +96,8 @@ function formatJson(result, cwd) {
 //#endregion
 //#region src/report/text.ts
 const DETAIL_INDENT = " ".repeat(17);
-function formatFinding(finding, cwd) {
-	return [`  ${`${finding.line}:${finding.column}`.padEnd(8)}${finding.severity.padEnd(7)}${finding.message}  ${finding.rule}`, ...findingDetails(finding, cwd).map((detail) => `${DETAIL_INDENT}${detail}`)].join("\n");
+function formatFinding(finding, cwd, paint) {
+	return [`  ${paint("dim", `${finding.line}:${finding.column}`.padEnd(8))}${paint(finding.severity === "error" ? "red" : "yellow", finding.severity) + " ".repeat(7 - finding.severity.length)}${finding.message}  ${paint("dim", finding.rule)}`, ...findingDetails(finding, cwd).map((detail) => `${DETAIL_INDENT}${paint("dim", detail)}`)].join("\n");
 }
 function formatRemovable(baseline, cwd) {
 	if (baseline.removable.length === 0) return null;
@@ -96,17 +105,22 @@ function formatRemovable(baseline, cwd) {
 	const count = baseline.removable.length;
 	return [`${relative(cwd, baseline.file)}: ${plural(count, "fixed entry", "fixed entries")}. ${UPDATE_HINT} ${count === 1 ? "it" : "them"}.`, ...entries].join("\n");
 }
-function formatFooter(result) {
+function formatFooter(result, paint) {
 	const suppressed = result.baseline?.suppressed.length ?? 0;
 	const baselined = suppressed > 0 ? `, ${suppressed} more in the baseline` : "";
-	if (result.findings.length === 0) return `✔ No problems in ${plural(result.files.length, "file")} across ${plural(result.layers.length, "layer")}${baselined}`;
+	if (result.findings.length === 0) return `${paint(["green", "bold"], `✔ No problems in ${plural(result.files.length, "file")} across ${plural(result.layers.length, "layer")}`)}${baselined}`;
 	const { errors, warnings } = summarize(result.findings);
-	return `✖ ${plural(result.findings.length, "problem")} (${plural(errors, "error")}, ${plural(warnings, "warning")})${baselined}`;
+	const counts = `✖ ${plural(result.findings.length, "problem")} (${plural(errors, "error")}, ${plural(warnings, "warning")})`;
+	return `${paint(["bold", errors > 0 ? "red" : "yellow"], counts)}${baselined}`;
+}
+function hasError(findings) {
+	return findings.some((finding) => finding.severity === "error");
 }
-function formatText(result, cwd) {
-	const sections = [...Map.groupBy(result.findings, (finding) => relative(cwd, finding.file))].map(([file, findings]) => [file, ...findings.map((finding) => formatFinding(finding, cwd))].join("\n"));
+/** Files with errors come last, next to the summary, where they are least likely to scroll away. */
+function formatText(result, cwd, paint = plain) {
+	const sections = [...Map.groupBy(result.findings, (finding) => relative(cwd, finding.file))].toSorted(([, a], [, b]) => Number(hasError(a)) - Number(hasError(b))).map(([file, findings]) => [paint("underline", file), ...findings.map((finding) => formatFinding(finding, cwd, paint))].join("\n"));
 	const removable = result.baseline === void 0 ? null : formatRemovable(result.baseline, cwd);
-	return `${[...removable === null ? sections : [...sections, removable], formatFooter(result)].join("\n\n")}\n`;
+	return `${[...removable === null ? sections : [...sections, removable], formatFooter(result, paint)].join("\n\n")}\n`;
 }
 //#endregion
 //#region src/report/index.ts
@@ -123,9 +137,9 @@ const formatters = {
 function isOutputFormat(value) {
 	return Object.hasOwn(formatters, value);
 }
-/** Paths in the output are relative to `cwd`. */
-function formatResult(result, format, cwd = process.cwd()) {
-	return formatters[format](result, cwd);
+/** Paths in the output are relative to `cwd`. Only the text format uses `paint`. */
+function formatResult(result, format, cwd = process.cwd(), paint = plain) {
+	return formatters[format](result, cwd, paint);
 }
 //#endregion
-export { JSON_REPORT_VERSION as i, formatResult as n, isOutputFormat as r, OUTPUT_FORMATS as t };
+export { paintFor as a, JSON_REPORT_VERSION as i, formatResult as n, isOutputFormat as r, OUTPUT_FORMATS as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-layerscope",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Layer boundary checks for Nuxt apps that see auto-imports",
   "keywords": [
     "architecture",