help.ts

import chalk from "chalk";

import { logPipelessLine } from "../shared/cli/lines.js";
import { allArgOptions } from "../shared/options/args.js";

interface HelpTextSection {
	sectionHeading: string;
	subsections: {
		flags: Flag[];
		subheading: string | undefined;
		warning: string | undefined;
	}[];
}

interface Flag {
	description: string;
	flag: string;
	type: string;
}

interface Option {
	description: string;
	docsSection: string;
	type: string;
}

function logHelpTextSection(section: HelpTextSection): void {
	logPipelessLine();

	logPipelessLine(`   ${chalk.black.bgGreenBright(section.sectionHeading)}`);

	for (const subsection of section.subsections) {
		if (typeof subsection.warning === "string") {
			logPipelessLine(chalk.yellow(subsection.warning));
		}

		if (typeof subsection.subheading === "string") {
			logPipelessLine(chalk.green(subsection.subheading));
		}

		for (const option of subsection.flags) {
			const { description, flag, type } = option;
			logPipelessLine(
				chalk.cyan(
					`
      --${flag}${
				type !== "boolean" ? ` (${chalk.cyanBright(type)})` : ""
			}: ${description}`,
				),
			);
		}
	}
}

function createHelpTextSections(options: object): HelpTextSection[] {
	const helpTextSections: HelpTextSection[] = [];

	const core: HelpTextSection = {
		sectionHeading: "Core options:",
		subsections: [
			{
				flags: [],
				subheading: undefined,
				warning: undefined,
			},
		],
	};

	const optional: HelpTextSection = {
		sectionHeading: "Optional options:",
		subsections: [
			{
				flags: [],
				subheading: undefined,
				warning: undefined,
			},
		],
	};

	const optOut: HelpTextSection = {
		sectionHeading: "Opt-outs:",
		subsections: [
			{
				flags: [],
				subheading: undefined,
				warning: `
      ⚠️ Warning: Specifying any --exclude-* flag on the command-line will 
      cause the setup script to skip prompting for more excludes. ⚠️`,
			},
			{
				flags: [
					{
						description: `Skips network calls that fetch all-contributors
        data from GitHub`,
						flag: "exclude-contributors",
						type: "boolean",
					},
				],
				subheading: `
      You can prevent the migration script from making some network-based 
      changes using any or all of the following CLI flags:`,
				warning: undefined,
			},
			{
				flags: [],
				subheading: `
      You can prevent the migration script from making some changes on disk 
      using any or all of the following CLI flags:`,
				warning: undefined,
			},
		],
	};

	for (const option of Object.keys(options)) {
		const data = options[option as keyof object] as unknown as Option;

		if (data.docsSection === "core") {
			core.subsections[0].flags.push({
				description: data.description,
				flag: option,
				type: data.type,
			});
		}

		if (data.docsSection === "optional") {
			optional.subsections[0].flags.push({
				description: data.description,
				flag: option,
				type: data.type,
			});
		}

		if (data.docsSection === "opt-out") {
			optOut.subsections[0].flags.push({
				description: data.description,
				flag: option,
				type: data.type,
			});
		}

		if (data.docsSection === "skip-net") {
			optOut.subsections[1].flags.push({
				description: data.description,
				flag: option,
				type: data.type,
			});
		}

		if (data.docsSection === "skip-disk") {
			optOut.subsections[2].flags.push({
				description: data.description,
				flag: option,
				type: data.type,
			});
		}
	}

	helpTextSections.push(core, optional, optOut);

	return helpTextSections;
}

export function logHelpText(): void {
	const helpTextSections = createHelpTextSections(allArgOptions);

	logPipelessLine();

	logPipelessLine(
		chalk.cyan(
			`
      A quickstart-friendly TypeScript template with comprehensive formatting, 
      linting, releases, testing, and other great tooling built-in.
      `,
		),
	);

	for (const section of helpTextSections) {
		logHelpTextSection(section);

		logPipelessLine();
	}
}