@lewishowles/cli-style 0.3.0 → 0.4.1

package/src/patterns/diagnostic-report.js

@@ -1,13 +1,7 @@
 import { profiles } from "../profiles/profiles.js";
 import { status } from "../primitives/status.js";
 import { resultTypes } from "../theme/results.js";
-import {
-	formatLabel,
-	isNonEmptyString,
-	isRecord,
-	renderSection,
-	renderTitle,
-} from "./helpers.js";
+import { formatLabel, isNonEmptyString, isRecord, renderSection, renderTitle } from "./helpers.js";
 
 // Diagnostic reports use a stable title when the caller does not provide one.
 const defaultTitle = "Diagnostic report";
@@ -49,9 +43,10 @@ export function diagnosticReport(report, options = {}) {
 		renderSkippedChecks(report.skippedChecks, options),
 		renderNextActions(report.nextActions, options),
 	].filter((section) => section !== "");
-	const title = typeof report.title === "string" && report.title !== ""
-		? report.title
-		: defaultTitle;
+
+	const title =
+		typeof report.title === "string" && report.title !== "" ? report.title : defaultTitle;
+
 	return [renderTitle(title, options), ...sections].join("\n\n");
 }
 
@@ -69,11 +64,10 @@ function renderChecks(checks, options) {
 	const validChecks = Array.isArray(checks)
 		? checks.filter((check) => isRecord(check) && isNonEmptyString(check.name))
 		: [];
-	const lines = validChecks.map((check) => status(
-		check.result,
-		formatLabel(check.name, check.detail, options),
-		options,
-	));
+
+	const lines = validChecks.map((check) =>
+		status(check.result, formatLabel(check.name, check.detail, options), options),
+	);
 
 	return renderSection("Checks", lines, options);
 }
@@ -92,11 +86,8 @@ function renderFindings(findings, options) {
 	const validFindings = Array.isArray(findings)
 		? findings.filter((finding) => isRecord(finding) && isNonEmptyString(finding.message))
 		: [];
-	const lines = validFindings.map((finding) => status(
-		finding.result,
-		finding.message,
-		options,
-	));
+
+	const lines = validFindings.map((finding) => status(finding.result, finding.message, options));
 
 	return renderSection("Findings", lines, options);
 }
@@ -115,11 +106,10 @@ function renderSkippedChecks(skippedChecks, options) {
 	const validChecks = Array.isArray(skippedChecks)
 		? skippedChecks.filter((check) => isRecord(check) && isNonEmptyString(check.name))
 		: [];
-	const lines = validChecks.map((check) => status(
-		resultTypes.SKIPPED,
-		formatLabel(check.name, check.reason, options),
-		options,
-	));
+
+	const lines = validChecks.map((check) =>
+		status(resultTypes.SKIPPED, formatLabel(check.name, check.reason, options), options),
+	);
 
 	return renderSection("Skipped checks", lines, options);
 }
@@ -135,9 +125,7 @@ function renderSkippedChecks(skippedChecks, options) {
  *     Rendered next-action section.
  */
 function renderNextActions(nextActions, options) {
-	const validActions = Array.isArray(nextActions)
-		? nextActions.filter(isNonEmptyString)
-		: [];
+	const validActions = Array.isArray(nextActions) ? nextActions.filter(isNonEmptyString) : [];
 	const lines = validActions.map((action, index) => `${index + 1}. ${action}`);
 
 	return renderSection("Next actions", lines, options, false);

package/src/patterns/helpers.js

@@ -81,12 +81,10 @@ export function renderSection(title, lines, options, listItems = true) {
 		return "";
 	}
 
-	const heading = options.profile === profiles.AGENT
-		? `## ${title}`
-		: title;
-	const content = options.profile === profiles.AGENT && listItems
-		? lines.map((line) => `- ${line}`)
-		: lines;
+	const heading = options.profile === profiles.AGENT ? `## ${title}` : title;
+
+	const content =
+		options.profile === profiles.AGENT && listItems ? lines.map((line) => `- ${line}`) : lines;
 
 	return [heading, ...content].join("\n");
 }

package/src/patterns/next-step-block.js

@@ -42,12 +42,17 @@ export function nextStepBlock(nextStep, options = {}) {
 
 	const title = isNonEmptyString(nextStep.title) ? nextStep.title : defaultTitle;
 	const next = renderNext(nextStep.next, options);
+
 	const reason = isNonEmptyString(nextStep.reason)
 		? renderSection("Why", [nextStep.reason], options, false)
 		: "";
+
 	const commands = renderCommands(nextStep.commands, options);
-	const alternatives = normaliseStringList(nextStep.alternatives)
-		.map((alternative) => `- ${alternative}`);
+
+	const alternatives = normaliseStringList(nextStep.alternatives).map(
+		(alternative) => `- ${alternative}`,
+	);
+
 	const sections = [
 		next,
 		reason,
@@ -101,12 +106,7 @@ function renderCommands(commands, options) {
 	}
 
 	if (options.profile === profiles.AGENT) {
-		return [
-			"## Commands",
-			"```sh",
-			...validCommands,
-			"```",
-		].join("\n");
+		return ["## Commands", "```sh", ...validCommands, "```"].join("\n");
 	}
 
 	return renderSection(

package/src/patterns/task-summary.js

@@ -49,6 +49,7 @@ export function taskSummary(summary, options = {}) {
 	const detail = formatLabel(task, summary.summary, options);
 	const completed = normaliseStringList(summary.completed).map((item) => `- ${item}`);
 	const remaining = normaliseStringList(summary.remaining).map((item) => `- ${item}`);
+
 	const sections = [
 		status(summary.result ?? resultTypes.UNKNOWN, detail, options),
 		renderSection("Completed", completed, options, false),

package/src/primitives/bar-chart.js

@@ -31,9 +31,7 @@ export function barChart(options = {}) {
 	const maximum = Math.max(...rows.map((row) => Math.abs(row.value)), 1);
 	const width = normaliseWidth(options.barWidth);
 
-	return rows
-		.map((row) => renderRow(row, labelWidth, maximum, width, options))
-		.join("\n");
+	return rows.map((row) => renderRow(row, labelWidth, maximum, width, options)).join("\n");
 }
 
 /**
@@ -49,13 +47,14 @@ function normaliseRows(rows) {
 		return [];
 	}
 
-	return rows.filter((row) => (
-		row !== null
-		&& typeof row === "object"
-		&& typeof row.label === "string"
-		&& row.label !== ""
-		&& Number.isFinite(row.value)
-	));
+	return rows.filter(
+		(row) =>
+			row !== null &&
+			typeof row === "object" &&
+			typeof row.label === "string" &&
+			row.label !== "" &&
+			Number.isFinite(row.value),
+	);
 }
 
 /**
@@ -101,9 +100,10 @@ function renderRow(row, labelWidth, maximum, width, options) {
 	}
 
 	const renderedLabel = foreground(label, chartColours.label, options);
-	const renderedBar = barWidth === 0
-		? ""
-		: foreground(bar.slice(0, barWidth), barColour(row), options);
+
+	const renderedBar =
+		barWidth === 0 ? "" : foreground(bar.slice(0, barWidth), barColour(row), options);
+
 	const barPadding = bar.slice(barWidth);
 	const renderedValue = foreground(String(row.value), chartColours.value, options);
 

package/src/primitives/panel.js

@@ -34,22 +34,16 @@ export function panel(options = {}) {
 	const lines = options.lines ?? [];
 
 	if (options.profile === profiles.CI) {
-		return [
-			...(options.title === undefined ? [] : [options.title]),
-			...lines,
-		].join("\n");
+		return [...(options.title === undefined ? [] : [options.title]), ...lines].join("\n");
 	}
 
 	const width = Math.max(options.panelWidth ?? defaultWidth, 4);
-	const panelLines = [
-		"",
-		...(options.title === undefined ? [] : [options.title]),
-		...lines,
-		"",
-	];
+	const panelLines = ["", ...(options.title === undefined ? [] : [options.title]), ...lines, ""];
 
 	return panelLines
-		.map((line, index) => renderLine(line, width, index === 1 && options.title !== undefined, options))
+		.map((line, index) =>
+			renderLine(line, width, index === 1 && options.title !== undefined, options),
+		)
 		.join("\n");
 }
 

package/src/primitives/status.js

@@ -22,9 +22,10 @@ import { getResultSymbol, getResultToken, resultTypes } from "../theme/results.j
 export function status(resultType = resultTypes.UNKNOWN, detail = "", options = {}) {
 	const token = getResultToken(resultType);
 	const symbol = getResultSymbol(resultType, options);
-	const label = typeof options.label === "string" && options.label !== ""
-		? options.label
-		: token.label;
+
+	const label =
+		typeof options.label === "string" && options.label !== "" ? options.label : token.label;
+
 	const prefix = `${symbol} ${label}`;
 	const detailText = detail === "" ? "" : ` ${detail}`;
 

package/src/primitives/step-progress.js

@@ -67,12 +67,14 @@ export function stepProgress(options = {}) {
 
 	const current = normaliseCurrent(options.current, steps.length);
 
-	return steps.map((label, index) => {
-		const state = stateForIndex(index, current);
-		const count = `${index + 1}/${steps.length}`;
-
-		return `${count} ${step(label, state, options)}`;
-	}).join("\n");
+	return steps
+		.map((label, index) => {
+			const state = stateForIndex(index, current);
+			const count = `${index + 1}/${steps.length}`;
+
+			return `${count} ${step(label, state, options)}`;
+		})
+		.join("\n");
 }
 
 /**

package/src/primitives/table.js

@@ -34,8 +34,11 @@ export function table(options = {}) {
 	}
 
 	const widths = columnWidths(columns, rows);
-	const naturalWidth = widths.reduce((total, width) => total + width, 0)
-		+ (columnSeparator.length * (columns.length - 1));
+
+	const naturalWidth =
+		widths.reduce((total, width) => total + width, 0) +
+		columnSeparator.length * (columns.length - 1);
+
 	const availableWidth = Number.isFinite(options.width) ? options.width : defaultWidth;
 
 	if (naturalWidth > availableWidth) {
@@ -58,14 +61,15 @@ function normaliseColumns(columns) {
 		return [];
 	}
 
-	return columns.filter((column) => (
-		column !== null
-		&& typeof column === "object"
-		&& typeof column.key === "string"
-		&& column.key !== ""
-		&& typeof column.label === "string"
-		&& column.label !== ""
-	));
+	return columns.filter(
+		(column) =>
+			column !== null &&
+			typeof column === "object" &&
+			typeof column.key === "string" &&
+			column.key !== "" &&
+			typeof column.label === "string" &&
+			column.label !== "",
+	);
 }
 
 /**
@@ -95,10 +99,9 @@ function normaliseRows(rows) {
  *     Column widths.
  */
 function columnWidths(columns, rows) {
-	return columns.map((column) => Math.max(
-		column.label.length,
-		...rows.map((row) => cellValue(row[column.key]).length),
-	));
+	return columns.map((column) =>
+		Math.max(column.label.length, ...rows.map((row) => cellValue(row[column.key]).length)),
+	);
 }
 
 /**
@@ -117,25 +120,28 @@ function columnWidths(columns, rows) {
  */
 function renderTable(columns, rows, widths, options) {
 	const header = columns
-		.map((column, index) => renderHeader(
-			padColumn(column.label, widths[index], index, columns.length),
-			options,
-		))
+		.map((column, index) =>
+			renderHeader(padColumn(column.label, widths[index], index, columns.length), options),
+		)
 		.join(columnSeparator);
+
 	const ruleCharacter = options.unicode === false ? "-" : "─";
-	const rule = widths
-		.map((width) => ruleCharacter.repeat(width))
-		.join(columnSeparator);
-	const renderedRule = options.colour === true
-		? foreground(rule, tableColours.border, options)
-		: rule;
-	const body = rows.map((row) => columns
-		.map((column, index) => renderCell(
-			padColumn(cellValue(row[column.key]), widths[index], index, columns.length),
-			index,
-			options,
-		))
-		.join(columnSeparator));
+	const rule = widths.map((width) => ruleCharacter.repeat(width)).join(columnSeparator);
+
+	const renderedRule =
+		options.colour === true ? foreground(rule, tableColours.border, options) : rule;
+
+	const body = rows.map((row) =>
+		columns
+			.map((column, index) =>
+				renderCell(
+					padColumn(cellValue(row[column.key]), widths[index], index, columns.length),
+					index,
+					options,
+				),
+			)
+			.join(columnSeparator),
+	);
 
 	return [header, renderedRule, ...body].join("\n");
 }
@@ -173,14 +179,17 @@ function padColumn(value, width, index, columnCount) {
 function renderBlocks(columns, rows, options) {
 	const labelWidth = Math.max(...columns.map((column) => column.label.length));
 
-	return rows.map((row) => columns
-		.map((column) => {
-			const label = renderHeader(column.label.padEnd(labelWidth, " "), options);
-			const value = renderCell(cellValue(row[column.key]), 0, options);
-
-			return `${label}${columnSeparator}${value}`;
-		})
-		.join("\n"))
+	return rows
+		.map((row) =>
+			columns
+				.map((column) => {
+					const label = renderHeader(column.label.padEnd(labelWidth, " "), options);
+					const value = renderCell(cellValue(row[column.key]), 0, options);
+
+					return `${label}${columnSeparator}${value}`;
+				})
+				.join("\n"),
+		)
 		.join("\n\n");
 }
 
@@ -231,9 +240,7 @@ function renderCell(value, columnIndex, options) {
 		return value;
 	}
 
-	const colour = columnIndex === 0
-		? tableColours.primaryText
-		: tableColours.secondaryText;
+	const colour = columnIndex === 0 ? tableColours.primaryText : tableColours.secondaryText;
 
 	return foreground(value, colour, options);
 }

package/src/reporters/create-reporter.js

@@ -1,4 +1,5 @@
 import { isNonEmptyString } from "../patterns/helpers.js";
+import { divider } from "../primitives/divider.js";
 import { status as renderStatus } from "../primitives/status.js";
 import {
 	getHighestSeverityResult,
@@ -29,26 +30,66 @@ export function createReporter(options = {}) {
 		...reporterDefaults,
 		...options,
 	};
+
 	const lines = [];
 
 	return {
-		group: (label, items = [], groupOptions = {}) => append(lines, renderGroup(label, items, {
-			...reporterOptions,
-			...groupOptions,
-		})),
+		divider: (label, detail = "", dividerOptions = {}) =>
+			append(
+				lines,
+				renderReporterDivider(label, detail, {
+					...reporterOptions,
+					...dividerOptions,
+				}),
+			),
+		group: (label, items = [], groupOptions = {}) =>
+			append(
+				lines,
+				renderGroup(label, items, {
+					...reporterOptions,
+					...groupOptions,
+				}),
+			),
 		lines,
 		render: () => lines.join("\n"),
-		section: (label, detail = "", sectionOptions = {}) => append(lines, renderSection(label, detail, {
-			...reporterOptions,
-			...sectionOptions,
-		})),
-		status: (resultType, label, detail = "", statusOptions = {}) => append(lines, renderReporterStatus(resultType, label, detail, {
-			...reporterOptions,
-			...statusOptions,
-		})),
+		section: (label, detail = "", sectionOptions = {}) =>
+			append(
+				lines,
+				renderSection(label, detail, {
+					...reporterOptions,
+					...sectionOptions,
+				}),
+			),
+		status: (resultType, label, detail = "", statusOptions = {}) =>
+			append(
+				lines,
+				renderReporterStatus(resultType, label, detail, {
+					...reporterOptions,
+					...statusOptions,
+				}),
+			),
 	};
 }
 
+/**
+ * Render a reporter phase divider.
+ *
+ * @param  {string}  label
+ *     Divider label.
+ * @param  {string}  detail
+ *     Optional supporting detail.
+ * @param  {object}  options
+ *     Rendering options.
+ * @returns  {string}
+ *     Rendered divider.
+ */
+export function renderReporterDivider(label, detail = "", options = {}) {
+	return divider({
+		...options,
+		label: formatLabel(label, detail),
+	});
+}
+
 /**
  * Render a reporter group without mutating a reporter instance.
  *
@@ -63,7 +104,10 @@ export function createReporter(options = {}) {
  */
 export function renderGroup(label, items = [], options = {}) {
 	const normalisedItems = normaliseItems(items);
-	const resultType = options.result ?? getHighestSeverityResult(normalisedItems.map((item) => item.result));
+
+	const resultType =
+		options.result ?? getHighestSeverityResult(normalisedItems.map((item) => item.result));
+
 	const summary = options.summary ?? summariseItems(normalisedItems);
 	const groupLine = renderReporterStatus(resultType, label, summary, options);
 
@@ -133,6 +177,24 @@ function append(lines, value) {
 	return value;
 }
 
+/**
+ * Combine a label and optional detail for compact phase dividers.
+ *
+ * @param  {string}  label
+ *     Main label.
+ * @param  {string}  detail
+ *     Optional supporting detail.
+ * @returns  {string}
+ *     Combined label.
+ */
+function formatLabel(label, detail) {
+	if (!isNonEmptyString(detail)) {
+		return label;
+	}
+
+	return `${label} · ${detail}`;
+}
+
 /**
  * Keep only rows that can render useful output.
  *
@@ -151,9 +213,10 @@ function normaliseItems(items) {
 		.map((item) => ({
 			detail: isNonEmptyString(item.detail) ? item.detail : "",
 			label: isNonEmptyString(item.label) ? item.label : getResultToken(item.result).label,
-			result: getResultToken(item.result) === getResultToken(resultTypes.UNKNOWN)
-				? resultTypes.UNKNOWN
-				: item.result,
+			result:
+				getResultToken(item.result) === getResultToken(resultTypes.UNKNOWN)
+					? resultTypes.UNKNOWN
+					: item.result,
 		}));
 }
 

package/src/theme/results.js

@@ -16,8 +16,8 @@ export const severityOrder = [
 	resultTypes.WARNING,
 	resultTypes.PARTIAL,
 	resultTypes.UNKNOWN,
-	resultTypes.SUCCESS,
 	resultTypes.SKIPPED,
+	resultTypes.SUCCESS,
 	resultTypes.INFO,
 	resultTypes.UNCHANGED,
 ];