refactor(cli): create-key help display

packages/astro/src/cli/create-key/core/create-key.ts

@@ -0,0 +1,29 @@
+import type { Logger } from '../../../core/logger/core.js';
+import type { HelpDisplay, KeyGenerator } from '../definitions.js';
+
+interface CreateKeyOptions {
+	logger: Logger;
+	keyGenerator: KeyGenerator;
+	helpDisplay: HelpDisplay;
+}
+
+export async function createKey({ logger, keyGenerator, helpDisplay }: CreateKeyOptions) {
+	if (helpDisplay.shouldFire()) {
+		return helpDisplay.show({
+			commandName: 'astro create-key',
+			tables: {
+				Flags: [['--help (-h)', 'See all available flags.']],
+			},
+			description: 'Generates a key to encrypt props passed to Server islands.',
+		});
+	}
+
+	const key = await keyGenerator.generate();
+
+	logger.info(
+		'crypto',
+		`Generated a key to encrypt props passed to Server islands. To reuse the same key across builds, set this value as ASTRO_KEY in an environment variable on your build server.
+
+ASTRO_KEY=${key}`,
+	);
+}

packages/astro/src/cli/create-key/definitions.ts

@@ -0,0 +1,23 @@
+import type { HelpPayload } from './domain/help-payload.js';
+
+export interface KeyGenerator {
+	generate: () => Promise<string>;
+}
+
+export interface HelpDisplay {
+	shouldFire: () => boolean;
+	show: (payload: HelpPayload) => void;
+}
+
+export interface TextStyler {
+	bgWhite: (msg: string) => string;
+	black: (msg: string) => string;
+	dim: (msg: string) => string;
+	green: (msg: string) => string;
+	bold: (msg: string) => string;
+	bgGreen: (msg: string) => string;
+}
+
+export interface AstroVersionProvider {
+	getVersion: () => string;
+}

packages/astro/src/cli/create-key/domain/help-payload.ts

@@ -0,0 +1,7 @@
+export interface HelpPayload {
+	commandName: string;
+	headline?: string;
+	usage?: string;
+	tables?: Record<string, [command: string, help: string][]>;
+	description?: string;
+}

packages/astro/src/cli/create-key/infra/build-time-astro-version-provider.ts

@@ -0,0 +1,9 @@
+import type { AstroVersionProvider } from '../definitions.js';
+
+export function createBuildTimeAstroVersionProvider(): AstroVersionProvider {
+	return {
+		getVersion() {
+			return process.env.PACKAGE_VERSION ?? '';
+		},
+	};
+}

packages/astro/src/cli/create-key/infra/crypto-key-generator.ts

@@ -0,0 +1,12 @@
+import { createKey, encodeKey } from '../../../core/encryption.js';
+import type { KeyGenerator } from '../definitions.js';
+
+export function createCryptoKeyGenerator(): KeyGenerator {
+	return {
+		async generate() {
+			const key = await createKey();
+			const encoded = await encodeKey(key);
+			return encoded;
+		},
+	};
+}

packages/astro/src/cli/create-key/infra/kleur-text-styler.ts

@@ -0,0 +1,6 @@
+import * as colors from 'kleur/colors';
+import type { TextStyler } from '../definitions.js';
+
+export function createKleurTextStyler(): TextStyler {
+	return colors;
+}

packages/astro/src/cli/create-key/infra/logger-help-display.ts

@@ -0,0 +1,76 @@
+import type { Logger } from '../../../core/logger/core.js';
+import type { Flags } from '../../flags.js';
+import type { AstroVersionProvider, HelpDisplay, TextStyler } from '../definitions.js';
+
+interface LoggerHelpDisplayOptions {
+	logger: Logger;
+	textStyler: TextStyler;
+	astroVersionProvider: AstroVersionProvider;
+	// TODO: find something better
+	flags: Flags;
+}
+
+export function createLoggerHelpDisplay({
+	logger,
+	flags,
+	textStyler,
+	astroVersionProvider,
+}: LoggerHelpDisplayOptions): HelpDisplay {
+	return {
+		shouldFire() {
+			return !!(flags.help || flags.h);
+		},
+		show({ commandName, description, headline, tables, usage }) {
+			const linebreak = () => '';
+			const title = (label: string) => `  ${textStyler.bgWhite(textStyler.black(` ${label} `))}`;
+			const table = (rows: [string, string][], { padding }: { padding: number }) => {
+				const split = process.stdout.columns < 60;
+				let raw = '';
+
+				for (const row of rows) {
+					if (split) {
+						raw += `    ${row[0]}\n    `;
+					} else {
+						raw += `${`${row[0]}`.padStart(padding)}`;
+					}
+					raw += '  ' + textStyler.dim(row[1]) + '\n';
+				}
+
+				return raw.slice(0, -1); // remove latest \n
+			};
+
+			let message = [];
+
+			if (headline) {
+				message.push(
+					linebreak(),
+					`  ${textStyler.bgGreen(textStyler.black(` ${commandName} `))} ${textStyler.green(
+						`v${astroVersionProvider.getVersion()}`,
+					)} ${headline}`,
+				);
+			}
+
+			if (usage) {
+				message.push(linebreak(), `  ${textStyler.green(commandName)} ${textStyler.bold(usage)}`);
+			}
+
+			if (tables) {
+				function calculateTablePadding(rows: [string, string][]) {
+					return rows.reduce((val, [first]) => Math.max(val, first.length), 0) + 2;
+				}
+
+				const tableEntries = Object.entries(tables);
+				const padding = Math.max(...tableEntries.map(([, rows]) => calculateTablePadding(rows)));
+				for (const [tableTitle, tableRows] of tableEntries) {
+					message.push(linebreak(), title(tableTitle), table(tableRows, { padding }));
+				}
+			}
+
+			if (description) {
+				message.push(linebreak(), `${description}`);
+			}
+
+			logger.info('SKIP_FORMAT', message.join('\n') + '\n');
+		},
+	};
+}

packages/astro/src/cli/index.ts

@@ -109,9 +109,33 @@ async function runCommand(cmd: string, flags: yargs.Arguments) {
 			return;
 		}
 		case 'create-key': {
-			const { createKey } = await import('./create-key/index.js');
-			const exitCode = await createKey({ flags });
-			return process.exit(exitCode);
+			const [
+				{ createLoggerFromFlags },
+				{ createCryptoKeyGenerator },
+				{ createKleurTextStyler },
+				{ createBuildTimeAstroVersionProvider },
+				{ createLoggerHelpDisplay },
+				{ createKey },
+			] = await Promise.all([
+				import('./flags.js'),
+				import('./create-key/infra/crypto-key-generator.js'),
+				import('./create-key/infra/kleur-text-styler.js'),
+				import('./create-key/infra/build-time-astro-version-provider.js'),
+				import('./create-key/infra/logger-help-display.js'),
+				import('./create-key/core/create-key.js'),
+			]);
+			const logger = createLoggerFromFlags(flags);
+			const keyGenerator = createCryptoKeyGenerator();
+			const textStyler = createKleurTextStyler();
+			const astroVersionProvider = createBuildTimeAstroVersionProvider();
+			const helpDisplay = createLoggerHelpDisplay({
+				logger,
+				flags,
+				textStyler,
+				astroVersionProvider,
+			});
+			await createKey({ logger, keyGenerator, helpDisplay });
+			return;
 		}
 		case 'docs': {
 			const { docs } = await import('./docs/index.js');

packages/astro/src/core/messages.ts

@@ -333,6 +333,7 @@ export function formatErrorMessage(err: ErrorWithMetadata, showFullStacktrace: b
 	return output.join('\n');
 }
 
+/** @deprecated Migrate to HelpDisplay */
 export function printHelp({
 	commandName,
 	headline,

packages/astro/test/units/assets/fonts/orchestrate.test.js

@@ -20,9 +20,8 @@ import { createBuildUrlProxyHashResolver } from '../../../../dist/assets/fonts/i
 import { createDevUrlResolver } from '../../../../dist/assets/fonts/implementations/url-resolver.js';
 import { orchestrate } from '../../../../dist/assets/fonts/orchestrate.js';
 import { defineAstroFontProvider } from '../../../../dist/assets/fonts/providers/index.js';
-import { defaultLogger } from '../../test-utils.js';
+import { createSpyLogger, defaultLogger } from '../../test-utils.js';
 import {
-	createSpyLogger,
 	createSpyStorage,
 	fakeFontMetricsResolver,
 	fakeHasher,

packages/astro/test/units/assets/fonts/utils.js

@@ -83,31 +83,6 @@ export const fakeFontMetricsResolver = {
 	},
 };
 
-export function createSpyLogger() {
-	/** @type {Array<{ type: string; label: string | null; message: string }>} */
-	const logs = [];
-
-	/** @type {import('../../../../dist/core/logger/core').Logger} */
-	const logger = {
-		debug: (label, ...messages) => {
-			logs.push(...messages.map((message) => ({ type: 'debug', label, message })));
-		},
-		error: (label, message) => {
-			logs.push({ type: 'error', label, message });
-		},
-		info: (label, message) => {
-			logs.push({ type: 'info', label, message });
-		},
-		warn: (label, message) => {
-			logs.push({ type: 'warn', label, message });
-		},
-	};
-	return {
-		logs,
-		logger,
-	};
-}
-
 /**
  * @param {string} input
  */