feat: Add help cli

src/bin/help.ts

@@ -0,0 +1,230 @@
+import chalk from "chalk";
+
+import { logLine } from "../shared/cli/lines.js";
+
+export function logHelpText(version: string): void {
+	logLine();
+
+	logLine(chalk.cyan(`✨ template-typescript-node-package v${version} ✨`));
+
+	logLine(
+		chalk.cyan(
+			`
+      A quickstart-friendly TypeScript template with comprehensive formatting, 
+      linting, releases, testing, and other great tooling built-in.
+      `,
+		),
+	);
+
+	logLine();
+
+	logLine(chalk.black.bgGreenBright("Core options:"));
+
+	logLine(
+		chalk.cyan(
+			`
+      --base: Whether to scaffold the repository with:
+        • everything: that comes with the template (${chalk.cyanBright.bold(
+					"recommended",
+				)})
+        • minimum: amounts of tooling, essentially opting out of everything
+        • prompt: for which portions to exclude
+      `,
+			`
+      --create-repository: Whether to create a corresponding repository on 
+        github.com (if it doesn't yet exist)
+      `,
+			`
+      --mode: Whether to:
+        • create: a new repository in a child directory
+        • initialize: a freshly repository in the current directory
+        • migrate: an existing repository in the current directory
+      `,
+			`
+      --description (${chalk.cyanBright.bold(
+				"string",
+			)}): Sentence case description of the repository 
+        (e.g. A quickstart-friendly TypeScript package with lots of great 
+        repository tooling. ✨)
+      `,
+			`
+      --owner (${chalk.cyanBright.bold(
+				"string",
+			)}): GitHub organization or user the repository is 
+        underneath (e.g. JoshuaKGoldberg)
+      `,
+			`
+      --repository (${chalk.cyanBright.bold(
+				"string",
+			)}): The kebab-case name of the repository 
+        (e.g. create-typescript-app)
+      `,
+			`
+      --title (${chalk.cyanBright.bold(
+				"string",
+			)}): Title Case title for the repository to be used in 
+        documentation (e.g. Create TypeScript App)
+      `,
+		),
+	);
+
+	logLine();
+
+	logLine(chalk.black.bgGreenBright("Optional options:"));
+
+	logLine(
+		chalk.cyan(
+			`
+      --author (${chalk.cyanBright.bold(
+				"string",
+			)}): Username on npm to publish packages under (by 
+        default, an existing npm author, or the currently logged in npm user, 
+        or ${chalk.cyanBright("owner.")}${chalk.magentaBright("toLowerCase()")})
+      `,
+			`
+      --email (${chalk.cyanBright.bold(
+				"string",
+			)}): Email address to be listed as the point of contact in 
+        docs and packages (e.g. [email protected])
+      `,
+			`
+      --funding (${chalk.cyanBright.bold(
+				"string",
+			)}): GitHub organization or username to mention in 
+        ${chalk.cyanBright("funding.yml")} (by default, owner)
+      `,
+		),
+	);
+
+	logLine();
+
+	logLine(chalk.black.bgGreenBright("Opt-outs:"));
+
+	logLine();
+
+	logLine(
+		chalk.yellow(
+			`
+      ⚠️ Warning: Specifying any --exclude-* flag on the command-line will 
+      cause the setup script to skip prompting for more excludes. ⚠️
+      `,
+		),
+	);
+
+	logLine(
+		chalk.cyan(
+			`
+      --exclude-compliance: Don't add a GitHub Actions workflow to verify that 
+        PRs match an expected format.
+      `,
+			`
+      --exclude-contributors: Don't add all-contributors to track contributions 
+        and display them in a README.md table.
+      `,
+			`
+      --exclude-lint-json: Don't apply linting and sorting to ${chalk.cyanBright(
+				"*.json",
+			)} and 
+        ${chalk.cyanBright("*.jsonc")} files.
+      `,
+			`
+      --exclude-lint-knip: Don't add Knip to detect unused files, dependencies, 
+        and code exports.
+      `,
+			`
+      --exclude-lint-md: Don't apply linting to ${chalk.cyanBright(
+				"*.md",
+			)} files.
+      `,
+			`
+      --exclude-lint-package-json: Don't add npm-package-json-lint to lint for 
+        package.json correctness.
+      `,
+			`
+      --exclude-lint-packages: Don't add a pnpm dedupe workflow to ensure 
+        packages aren't duplicated unnecessarily.
+      `,
+			`
+      --exclude-lint-perfectionist: Don't apply eslint-plugin-perfectionist to 
+        ensure imports, keys, and so on are in sorted order.
+      `,
+			`
+      --exclude-lint-spelling: Don't add cspell to spell check against 
+        dictionaries of known words.
+      `,
+			`
+      --exclude-lint-yml: Don't apply linting and sorting to ${chalk.cyanBright(
+				"*.yaml",
+			)} and ${chalk.cyanBright("*.yml")} 
+        files.
+      `,
+			`
+      --exclude-releases: Don't add release-it to generate changelogs, package 
+        bumps, and publishes based on conventional commits.
+      `,
+			`
+      --exclude-renovate: Don't add a Renovate config to dependencies 
+        up-to-date with PRs.
+      `,
+			`
+      --exclude-tests: Don't add Vitest tooling for fast unit tests, configured 
+        with coverage tracking.
+      `,
+		),
+	);
+
+	logLine();
+
+	logLine(
+		chalk.green(
+			`
+      You can prevent the migration script from making some network-based 
+      changes using any or all of the following CLI flags:
+      `,
+		),
+	);
+
+	logLine(
+		chalk.cyan(
+			`
+      --exclude-contributors: Skips network calls that fetch 
+        all-contributors data from GitHub
+      `,
+			`
+      --skip-github-api: Skips calling to GitHub APIs.
+      `,
+			`
+      --skip-install: Skips installing all the new template 
+        packages with pnpm.
+      `,
+		),
+	);
+
+	logLine();
+
+	logLine(
+		chalk.green(
+			`
+      You can prevent the migration script from making some changes on disk 
+      using any or all of the following CLI flags:
+      `,
+		),
+	);
+
+	logLine(
+		chalk.cyan(
+			`
+      --skip-removal: Skips removing setup docs and scripts, 
+        including this ${chalk.cyanBright("docs/")} directory
+      `,
+			`
+      --skip-restore: Skips the prompt offering to restore the 
+        repository if an error occurs during setup
+      `,
+			`
+      --skip-uninstall: Skips uninstalling packages only used for 
+        setup scripts
+      `,
+		),
+	);
+}

src/bin/index.ts

@@ -7,6 +7,7 @@ import { create } from "../create/index.js";
 import { initialize } from "../initialize/index.js";
 import { migrate } from "../migrate/index.js";
 import { logLine } from "../shared/cli/lines.js";
+import { logHelpText } from "./help.js";
 import { StatusCodes } from "../shared/codes.js";
 import { promptForMode } from "./mode.js";
 
@@ -39,11 +40,22 @@ export async function bin(args: string[]) {
 	const { values } = parseArgs({
 		args,
 		options: {
+			help: {
+				short: "h",
+				type: "boolean",
+			},
 			mode: { type: "string" },
 		},
 		strict: false,
 	});
 
+	const help = values.help;
+
+	if (help) {
+		logHelpText("");
+		return 0;
+	}
+
 	const mode = await promptForMode(values.mode);
 	if (typeof mode !== "string") {
 		prompts.outro(chalk.red(mode?.message ?? operationMessage("cancelled")));