refactor(cli): make more similar to complete-cli

Author: Zamiell

packages/isaacscript-cli/eslint.config.mjs

@@ -34,8 +34,8 @@ export default tseslint.config(
 
   {
     ignores: [
-      // We don't want to lint template files, since they won't actually have valid code inside of
-      // them yet.
+      // We do not want to lint template files, since they do not have valid code inside of them
+      // yet.
       "**/file-templates/**",
 
       // We do not want to lint the compiled plugins. (Unlike other files, they are compiled to the

packages/isaacscript-cli/src/banner.ts

@@ -1,14 +1,13 @@
 import chalk from "chalk";
-import { fatalError, getPackageJSONVersion } from "complete-node";
+import { fatalError } from "complete-node";
 import figlet from "figlet"; // Cannot be "import * as figlet" or else run-time errors occur.
-import { PROJECT_NAME, REPO_ROOT } from "./constants.js";
+import { PROJECT_NAME, PROJECT_VERSION } from "./constants.js";
 
 export function printBanner(): void {
   const banner = figlet.textSync(PROJECT_NAME);
   console.log(chalk.green(banner));
 
-  const isaacScriptCLIVersion = getPackageJSONVersion(REPO_ROOT);
-  const versionString = `v${isaacScriptCLIVersion}`;
+  const versionString = `v${PROJECT_VERSION}`;
   const bannerLines = banner.split("\n");
   const firstBannerLine = bannerLines[0];
   if (firstBannerLine === undefined) {

packages/isaacscript-cli/src/checkForWindowsTerminalBugs.ts

@@ -11,17 +11,12 @@ const BASH_PROFILE_PATH = path.join(HOME_DIR, ".bash_profile");
  * library. Try to detect this and warn the end-user.
  */
 export async function checkForWindowsTerminalBugs(): Promise<void> {
-  if (process.platform !== "win32") {
-    return;
-  }
-
   if (
-    process.env["SHELL"] !== String.raw`C:\Program Files\Git\usr\bin\bash.exe`
+    process.platform === "win32" &&
+    process.env["SHELL"] === String.raw`C:\Program Files\Git\usr\bin\bash.exe`
   ) {
-    return;
+    await checkForWindowsBugColor();
   }
-
-  await checkForWindowsBugColor();
 }
 
 async function checkForWindowsBugColor() {

packages/isaacscript-cli/src/commands/init/getProjectPath.ts

@@ -24,7 +24,7 @@ export async function getProjectPath(
   customDirectory: string | undefined,
   yes: boolean,
   forceName: boolean,
-): Promise<[string, boolean]> {
+): Promise<{ projectPath: string; createNewDir: boolean }> {
   let projectName = name;
   let projectPath: string;
   let createNewDir: boolean;
@@ -54,7 +54,7 @@ export async function getProjectPath(
   validateProjectName(projectName, forceName);
 
   console.log(`Using a project name of: ${chalk.green(projectName)}`);
-  return [projectPath, createNewDir];
+  return { projectPath, createNewDir };
 }
 
 async function getNewProjectName(): Promise<[string, string, boolean]> {

packages/isaacscript-cli/src/commands/init/init.ts

@@ -158,7 +158,7 @@ async function init(
   const packageManager = getPackageManagerUsedForNewProject(options);
 
   // Prompt the end-user for some information (and validate it as we go).
-  const [projectPath, createNewDir] = await getProjectPath(
+  const { projectPath, createNewDir } = await getProjectPath(
     name,
     useCurrentDirectory,
     customDirectory,

packages/isaacscript-cli/src/constants.ts

@@ -1,3 +1,4 @@
+import { findPackageRoot, getPackageJSONFieldsMandatory } from "complete-node";
 import os from "node:os";
 import path from "node:path";
 
@@ -8,7 +9,18 @@ export const HOME_DIR = os.homedir();
 export const FILE_SYNCED_MESSAGE = "File synced:";
 export const COMPILATION_SUCCESSFUL_MESSAGE = "Compilation successful.";
 export const MOD_UPLOADER_PATH = String.raw`C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac Rebirth\tools\ModUploader\ModUploader.exe`;
-export const PROJECT_NAME = "IsaacScript";
+
+const packageRoot = findPackageRoot();
+const { version, description } = getPackageJSONFieldsMandatory(
+  packageRoot,
+  "name",
+  "version",
+  "description",
+);
+
+export const PROJECT_NAME = "IsaacScript"; // We want to capitalize the name.
+export const PROJECT_VERSION = version;
+export const PROJECT_DESCRIPTION = description;
 
 // `isaacscript`
 export const REPO_ROOT = path.join(import.meta.dirname, "..");

packages/isaacscript-cli/src/git.ts

@@ -1,13 +1,8 @@
 import chalk from "chalk";
-import {
-  commandExists,
-  getPackageJSONVersion,
-  isFile,
-  readFile,
-} from "complete-node";
+import { commandExists, isFile, readFile } from "complete-node";
 import path from "node:path";
 import yaml from "yaml";
-import { HOME_DIR, PROJECT_NAME, REPO_ROOT } from "./constants.js";
+import { HOME_DIR, PROJECT_NAME, PROJECT_VERSION } from "./constants.js";
 import { execShell, execShellString } from "./exec.js";
 import type { GitHubCLIHostsYAML } from "./interfaces/GitHubCLIHostsYAML.js";
 import { getInputString, getInputYesNo } from "./prompt.js";
@@ -190,8 +185,7 @@ export function initGitRepository(
 
   if (isGitNameAndEmailConfigured(verbose)) {
     execShellString("git add --all", verbose, false, projectPath);
-    const isaacScriptCLIVersion = getPackageJSONVersion(REPO_ROOT);
-    const commitMessage = `chore: add files from ${PROJECT_NAME} ${isaacScriptCLIVersion} template`;
+    const commitMessage = `chore: add files from ${PROJECT_NAME} ${PROJECT_VERSION} template`;
     execShell(
       "git",
       ["commit", "--message", commitMessage],
@@ -209,7 +203,7 @@ export function initGitRepository(
   }
 }
 
-function isGitNameAndEmailConfigured(verbose: boolean) {
+function isGitNameAndEmailConfigured(verbose: boolean): boolean {
   const nameExitStatus = execShellString(
     "git config --global user.name",
     verbose,

packages/isaacscript-cli/src/packageManager.ts

@@ -29,9 +29,9 @@ export function getPackageManagerUsedForNewProject(
 }
 
 /**
- * Previously, this function determined the package manager based on certain commands existing, but
- * this is undesirable because some projects might prefer `npm`, even if they are forced to use
- * other package managers for other projects.
+ * Previously, this function determined the package manager based on certain commands existing.
+ * However, this is undesirable because some projects might prefer `npm`, even if they are forced to
+ * use other package managers for other projects.
  */
 function getDefaultPackageManager(): PackageManager {
   return PackageManager.npm;
@@ -77,7 +77,7 @@ function getPackageManagerFromOptions(options: PackageManagerOptions) {
     const npmExists = commandExists("npm");
     if (!npmExists) {
       fatalError(
-        `You specified the "--npm" flag, but "${chalk.green(
+        `You specified the "--npm" option, but "${chalk.green(
           "npm",
         )}" does not seem to be a valid command.`,
       );
@@ -90,7 +90,7 @@ function getPackageManagerFromOptions(options: PackageManagerOptions) {
     const yarnExists = commandExists("yarn");
     if (!yarnExists) {
       fatalError(
-        `You specified the "--yarn" flag, but "${chalk.green(
+        `You specified the "--yarn" option, but "${chalk.green(
           "yarn",
         )}" does not seem to be a valid command.`,
       );
@@ -103,7 +103,7 @@ function getPackageManagerFromOptions(options: PackageManagerOptions) {
     const pnpmExists = commandExists("pnpm");
     if (!pnpmExists) {
       fatalError(
-        `You specified the "--pnpm" flag, but "${chalk.green(
+        `You specified the "--pnpm" option, but "${chalk.green(
           "pnpm",
         )}" does not seem to be a valid command.`,
       );

packages/isaacscript-cli/src/parseArgs.ts

@@ -9,43 +9,39 @@
 //   - https://github.com/yargs/yargs
 //   - Sucks in TypeScript.
 //   - "commander" allows for more module command building.
-// - clack (4.3K stars)
-//   - https://github.com/natemoo-re/clack
-//   - ?
-// - arg [X} (1.2K stars)
+// - cac (2.7K stars)
+//   - https://github.com/cacjs/cac
+//   - Last release in 2022.
+// - arg [X] (1.2K stars)
 //   - https://github.com/vercel/arg
 //   - Does not support commands (i.e. positional arguments).
+// - clipanion (1.1K stars)
+//   - https://github.com/arcanis/clipanion
+//   - Written in TypeScript.
+//   - Used by Yarn.
+//   - Class-based.
+// - mri [X] (638 stars)
+//   - https://github.com/lukeed/mri
+//   - Written in JavaScript, no types.
 // - cmd-ts (193 stars)
 //   - https://github.com/Schniz/cmd-ts
-//   - ?
+//   - Written in TypeScript.
+//   - Last release in 2023.
 
 import { Command } from "@commander-js/extra-typings";
-import {
-  findPackageRoot,
-  getPackageJSONFieldsMandatory,
-  nukeDependencies,
-  updatePackageJSONDependencies,
-} from "complete-node";
+import { nukeDependencies, updatePackageJSONDependencies } from "complete-node";
 import { checkCommand, checkTSCommand } from "./commands/check/check.js";
 import { copyCommand } from "./commands/copy/copy.js";
 import { initCommand, initTSCommand } from "./commands/init/init.js";
 import { monitorCommand } from "./commands/monitor/monitor.js";
 import { publishCommand } from "./commands/publish/publish.js";
-import { CWD } from "./constants.js";
-
-const packageRoot = findPackageRoot();
-const { name, version, description } = getPackageJSONFieldsMandatory(
-  packageRoot,
-  "name",
-  "version",
-  "description",
-);
+import { CWD, PROJECT_DESCRIPTION, PROJECT_VERSION } from "./constants.js";
 
 export async function parseArgs(): Promise<void> {
   const program = new Command()
-    .name(name)
-    .description(`${description}.`)
-    .version(version, "-V, --version", "Output the version number.")
+    .name("isaacscript")
+    .description(`${PROJECT_DESCRIPTION}.`)
+    .version(PROJECT_VERSION, "-V, --version", "Output the version number.")
     .helpOption("-h, --help", "Display the list of commands and options.")
     .helpCommand(false)
     .allowExcessArguments(false) // By default, Commander.js will allow extra positional arguments.

packages/isaacscript-cli/src/validateNodeVersion.ts

@@ -1,6 +1,5 @@
 import chalk from "chalk";
 import { parseSemanticVersion } from "complete-common";
-import { fatalError } from "complete-node";
 import { PROJECT_NAME } from "./constants.js";
 
 // 20.11 is the minimum version that supports `import.meta.dirname`.
@@ -12,7 +11,7 @@ export function validateNodeVersion(): void {
 
   const semanticVersion = parseSemanticVersion(version);
   if (semanticVersion === undefined) {
-    fatalError(`Failed to parse the Node version: ${version}`);
+    throw new Error(`Failed to parse the Node version: ${version}`);
   }
 
   const { majorVersion, minorVersion } = semanticVersion;