isaacscript 2.0.4 → 2.0.7

package/src/commands/init/createMod.ts

@@ -1,196 +0,0 @@
-import chalk from "chalk";
-import path from "path";
-import * as configFile from "../../configFile";
-import {
-  GITIGNORE,
-  GITIGNORE_TEMPLATE_PATH,
-  MAIN_TS,
-  MAIN_TS_TEMPLATE_PATH,
-  METADATA_VDF,
-  METADATA_VDF_TEMPLATE_PATH,
-  METADATA_XML,
-  METADATA_XML_TEMPLATE_PATH,
-  PACKAGE_JSON,
-  PACKAGE_JSON_TEMPLATE_PATH,
-  README_MD,
-  README_MD_TEMPLATES_PATH,
-  TEMPLATES_STATIC_DIR,
-} from "../../constants";
-import { execShell } from "../../exec";
-import * as file from "../../file";
-import { initGitRepository } from "./git";
-
-export function createMod(
-  projectName: string,
-  projectPath: string,
-  createNewDir: boolean,
-  modsDirectory: string,
-  saveSlot: number,
-  gitRemoteURL: string | undefined,
-  skipNPMInstall: boolean,
-  verbose: boolean,
-): void {
-  if (createNewDir) {
-    file.makeDir(projectPath, verbose);
-  }
-
-  const config = configFile.createObject(modsDirectory, saveSlot);
-  configFile.createFile(projectPath, config, verbose);
-  const targetModDirectory = path.join(config.modsDirectory, projectName);
-
-  makeSubdirectories(projectPath, verbose);
-  copyStaticFiles(projectPath, verbose);
-  copyDynamicFiles(projectName, projectPath, targetModDirectory, verbose);
-  updateNodeModules(projectPath, verbose);
-  installNodeModules(projectPath, skipNPMInstall, verbose);
-  formatFiles(projectPath, verbose);
-
-  // Only make the initial commit once all of the files have been copied and formatted
-  initGitRepository(projectPath, gitRemoteURL, verbose);
-
-  console.log(`Successfully created mod: ${chalk.green(projectName)}`);
-}
-
-function makeSubdirectories(projectPath: string, verbose: boolean) {
-  // The "src" directory is created during copying of static files.
-  for (const subdirectory of ["mod"]) {
-    const srcPath = path.join(projectPath, subdirectory);
-    file.makeDir(srcPath, verbose);
-  }
-}
-
-/** Copy static files, like ".eslintrc.js", "tsconfig.json", etc. */
-function copyStaticFiles(projectPath: string, verbose: boolean) {
-  const staticFileList = file.getDirList(TEMPLATES_STATIC_DIR, verbose);
-  staticFileList.forEach((fileName: string) => {
-    const templateFilePath = path.join(TEMPLATES_STATIC_DIR, fileName);
-    const destinationFilePath = path.join(projectPath, fileName);
-    if (!file.exists(destinationFilePath, verbose)) {
-      file.copy(templateFilePath, destinationFilePath, verbose);
-    }
-  });
-
-  // Rename ".cspell.json.template" to ".cspell.json.template". (If it is kept as ".cspell.json",
-  // then local spell checking will fail.)
-  const cSpellConfigPath = path.join(projectPath, ".cspell.json.template");
-  const correctCSpellConfigPath = path.join(projectPath, ".cspell.json");
-  file.rename(cSpellConfigPath, correctCSpellConfigPath, verbose);
-}
-
-/** Copy files that need to have text replaced inside of them. */
-function copyDynamicFiles(
-  projectName: string,
-  projectPath: string,
-  targetModDirectory: string,
-  verbose: boolean,
-) {
-  // ".gitignore"
-  {
-    const fileName = GITIGNORE;
-    const templatePath = GITIGNORE_TEMPLATE_PATH;
-    const template = file.read(templatePath, verbose);
-
-    // Prepend a header with the project name
-    let separatorLine = "# ";
-    for (let i = 0; i < projectName.length; i++) {
-      separatorLine += "-";
-    }
-    separatorLine += "\n";
-    const gitignoreHeader = `${separatorLine}# ${projectName}\n${separatorLine}\n`;
-    const gitignore = gitignoreHeader + template;
-
-    const destinationPath = path.join(projectPath, `.${fileName}`); // We need to prepend a period
-    file.write(destinationPath, gitignore, verbose);
-  }
-
-  // "package.json"
-  {
-    // Modify and copy the file
-    const fileName = PACKAGE_JSON;
-    const templatePath = PACKAGE_JSON_TEMPLATE_PATH;
-    const template = file.read(templatePath, verbose);
-    const packageJSON = template.replace(/MOD-NAME-TO-REPLACE/g, projectName);
-    const destinationPath = path.join(projectPath, fileName);
-    file.write(destinationPath, packageJSON, verbose);
-  }
-
-  // "README.md"
-  {
-    const fileName = README_MD;
-    const templatePath = README_MD_TEMPLATES_PATH;
-    const template = file.read(templatePath, verbose);
-    const readmeMD = template.replace(/MOD-NAME-TO-REPLACE/g, projectName);
-    const destinationPath = path.join(projectPath, fileName);
-    file.write(destinationPath, readmeMD, verbose);
-  }
-
-  // "mod/metadata.xml"
-  {
-    const fileName = METADATA_XML;
-    const templatePath = METADATA_XML_TEMPLATE_PATH;
-    const template = file.read(templatePath, verbose);
-    const metadataXML = template.replace(/MOD-NAME-TO-REPLACE/g, projectName);
-    const modPath = path.join(projectPath, "mod");
-    const destinationPath = path.join(modPath, fileName);
-    file.write(destinationPath, metadataXML, verbose);
-  }
-
-  // "mod/metadata.vdf"
-  {
-    const fileName = METADATA_VDF;
-    const templatePath = METADATA_VDF_TEMPLATE_PATH;
-    const template = file.read(templatePath, verbose);
-    const metadataVDF = template.replace(/MOD-TARGET-DIR/g, targetModDirectory);
-    const modPath = path.join(projectPath, "mod");
-    const destinationPath = path.join(modPath, fileName);
-    file.write(destinationPath, metadataVDF, verbose);
-  }
-
-  // "src/main.ts"
-  {
-    // Convert snake_case and kebab-case to camelCase. (Kebab-case in particular will make the
-    // example TypeScript file fail to compile.)
-    const srcPath = path.join(projectPath, "src");
-    const fileName = MAIN_TS;
-    const templatePath = MAIN_TS_TEMPLATE_PATH;
-    const template = file.read(templatePath, verbose);
-    const mainTS = template.replace(/MOD-NAME-TO-REPLACE/g, projectName);
-    const destinationPath = path.join(srcPath, fileName);
-    file.write(destinationPath, mainTS, verbose);
-  }
-}
-
-/** The "package.json" file has to be copied first before this step. */
-function updateNodeModules(projectPath: string, verbose: boolean) {
-  console.log("Finding out the latest versions of the NPM packages...");
-  execShell(
-    "npx",
-    ["npm-check-updates", "--upgrade", "--packageFile", "package.json"],
-    verbose,
-    false,
-    projectPath,
-  );
-}
-
-function installNodeModules(
-  projectPath: string,
-  skipNPMInstall: boolean,
-  verbose: boolean,
-) {
-  if (skipNPMInstall) {
-    return;
-  }
-
-  console.log("Installing node modules... (This can take a long time.)");
-  execShell("npm", ["install"], verbose, false, projectPath);
-}
-
-function formatFiles(projectPath: string, verbose: boolean) {
-  execShell(
-    "npx",
-    ["prettier", "--write", projectPath],
-    verbose,
-    false,
-    projectPath,
-  );
-}

package/src/commands/init/getModsDir.ts

@@ -1,107 +0,0 @@
-import chalk from "chalk";
-import path from "path";
-import { HOME_DIR } from "../../constants";
-import * as file from "../../file";
-import { getInputString } from "../../prompt";
-import { error } from "../../utils";
-
-const MODS = "mods";
-
-const DEFAULT_MODS_PATH_WINDOWS = path.join(
-  "C:",
-  "Program Files (x86)",
-  "Steam",
-  "steamapps",
-  "common",
-  "The Binding of Isaac Rebirth",
-  MODS,
-);
-
-/** This is a subdirectory of `$HOME`. */
-const DEFAULT_MODS_PATH_LINUX = path.join(
-  HOME_DIR,
-  ".local",
-  "share",
-  "Steam",
-  "steamapps",
-  "common",
-  "The Binding of Isaac Rebirth",
-  MODS,
-);
-
-export async function getModsDir(
-  argv: Record<string, unknown>,
-  verbose: boolean,
-): Promise<string> {
-  if (argv["modsDirectory"] !== undefined) {
-    // They specified the "--mods-directory" command-line flag, so there is no need to prompt the
-    // user for it.
-    return argv["modsDirectory"] as string;
-  }
-
-  const defaultModsPath = getDefaultModsPath(process.platform);
-
-  if (
-    file.exists(defaultModsPath, verbose) &&
-    file.isDir(defaultModsPath, verbose)
-  ) {
-    return defaultModsPath;
-  }
-
-  console.error(
-    `Failed to find your mods directory at: ${chalk.green(defaultModsPath)}`,
-  );
-  const modsDir = await getInputString(
-    `Enter the full path to the "${MODS}" directory on your system, which should be next to your "isaac-ng.exe" program:`,
-  );
-
-  if (modsDir === "") {
-    error("Error: You did not provide a response; exiting.");
-  }
-
-  if (!file.exists(modsDir, verbose)) {
-    error(
-      `Error: The directory of "${chalk.green(
-        modsDir,
-      )}" does not exist. Exiting.`,
-    );
-  }
-
-  if (!file.isDir(modsDir, verbose)) {
-    error(
-      `Error: The path of "${chalk.green(
-        modsDir,
-      )}" is not a directory. Exiting.`,
-    );
-  }
-
-  if (path.basename(modsDir) !== MODS) {
-    error(
-      `Error: You entered a path of "${chalk.green(
-        modsDir,
-      )}", but you need to input a directory with a name of "${MODS}" at the end. Exiting.`,
-    );
-  }
-
-  return modsDir;
-}
-
-function getDefaultModsPath(platform: string) {
-  switch (platform) {
-    case "win32": {
-      return DEFAULT_MODS_PATH_WINDOWS;
-    }
-
-    case "linux": {
-      return DEFAULT_MODS_PATH_LINUX;
-    }
-
-    default: {
-      return error(
-        `There does not exist a default mod path for the platform of: ${chalk.green(
-          platform,
-        )}`,
-      );
-    }
-  }
-}

package/src/commands/init/getProjectPath.ts

@@ -1,111 +0,0 @@
-import chalk from "chalk";
-import path from "path";
-import { CURRENT_DIRECTORY_NAME, CWD } from "../../constants";
-import { getInputString, getInputYesNo } from "../../prompt";
-import { error, hasWhiteSpace, isKebabCase } from "../../utils";
-
-// From: https://gist.github.com/doctaphred/d01d05291546186941e1b7ddc02034d3
-const ILLEGAL_CHARACTERS_FOR_WINDOWS_FILENAMES = [
-  "<",
-  ">",
-  ":",
-  '"',
-  "/",
-  "\\",
-  "|",
-  "?",
-  "*",
-];
-
-export async function getProjectPath(
-  argv: Record<string, unknown>,
-  useCurrentDir: boolean,
-  yes: boolean,
-  forceName: boolean,
-): Promise<[string, boolean]> {
-  let projectName = getProjectNameFromCommandLineArgument(argv);
-  let projectPath: string;
-  let createNewDir: boolean;
-  if (useCurrentDir) {
-    // The "--use-current-dir" command-line flag was specified, so there is no need to prompt the
-    // user.
-    projectName = CURRENT_DIRECTORY_NAME;
-    projectPath = CWD;
-    createNewDir = false;
-  } else if (projectName !== undefined) {
-    // The project name was specified on the command-line.
-    projectPath = path.join(CWD, projectName);
-    createNewDir = true;
-  } else if (yes) {
-    // The "--yes" command-line flag was specified and the project name was not specified on the
-    // command-line, so default to using the current directory.
-    projectName = CURRENT_DIRECTORY_NAME;
-    projectPath = CWD;
-    createNewDir = false;
-  } else {
-    // The project name was not specified on the command-line, so prompt the user for it.
-    [projectName, projectPath, createNewDir] = await getNewProjectName();
-  }
-
-  validateProjectName(projectName, forceName);
-
-  console.log(`Using a project name of: ${chalk.green(projectName)}`);
-  return [projectPath, createNewDir];
-}
-
-function getProjectNameFromCommandLineArgument(
-  argv: Record<string, unknown>,
-): string | undefined {
-  const name = argv["name"];
-  return typeof name === "string" && name !== "" ? name : undefined;
-}
-
-async function getNewProjectName(): Promise<[string, string, boolean]> {
-  console.log("You did not specify a project name as a command-line argument.");
-  const shouldUseCurrentDir = await getInputYesNo(
-    `Would you like to create a new project using the current directory "${chalk.green(
-      CURRENT_DIRECTORY_NAME,
-    )}" as the root?`,
-  );
-
-  if (shouldUseCurrentDir) {
-    return [CURRENT_DIRECTORY_NAME, CWD, false];
-  }
-
-  const projectName = await getInputString("Enter the name of the project:");
-  const projectPath = path.join(CWD, projectName);
-
-  return [projectName, projectPath, true];
-}
-
-function validateProjectName(projectName: string, forceName: boolean) {
-  if (projectName === "") {
-    error("Error: You cannot have a blank project name.");
-  }
-
-  if (process.platform === "win32") {
-    for (const character of ILLEGAL_CHARACTERS_FOR_WINDOWS_FILENAMES) {
-      if (projectName.includes(character)) {
-        error(
-          `Error: The "${character}" character is not allowed in a Windows file name.`,
-        );
-      }
-    }
-  }
-
-  if (forceName) {
-    return;
-  }
-
-  if (hasWhiteSpace(projectName)) {
-    error(
-      'Error: The project name has whitespace in it, which is not allowed. Use kebab-case for your project name. (e.g. "green-candle")',
-    );
-  }
-
-  if (!isKebabCase(projectName)) {
-    error(
-      'Error: The project name is not in kebab-case. (Kebab-case is the style of using all lowercase letters, with words separated by hyphens.) Project names must use kebab-case to match GitHub repository standards. If necessary, you can override this check with the "--force-name" flag.',
-    );
-  }
-}

package/src/commands/init/git.ts

@@ -1,249 +0,0 @@
-import chalk from "chalk";
-import commandExists from "command-exists";
-import path from "path";
-import yaml from "yaml";
-import { PROJECT_NAME } from "../../constants";
-import { execShell } from "../../exec";
-import * as file from "../../file";
-import { getInputString, getInputYesNo } from "../../prompt";
-import { GitHubCLIHostsYAML } from "../../types/GitHubCLIHostsYAML";
-import { error, parseSemVer } from "../../utils";
-
-const REQUIRED_GIT_MAJOR_VERSION = 2;
-const REQUIRED_GIT_MINOR_VERSION = 30;
-
-export async function promptGitHubRepoOrGitRemoteURL(
-  projectName: string,
-  yes: boolean,
-  verbose: boolean,
-): Promise<string | undefined> {
-  // We do not need to prompt the user if they do not have Git installed
-  if (!commandExists.sync("git")) {
-    console.log(
-      'Git does not seem to be installed. (The "git" command is not in the path.) Skipping Git-related things.',
-    );
-    return undefined;
-  }
-
-  validateNewGitVersion(verbose);
-
-  const gitHubUsername = getGitHubUsername(verbose);
-  if (gitHubUsername !== undefined) {
-    const [exitStatus] = execShell(
-      "gh",
-      ["repo", "view", projectName],
-      verbose,
-      true,
-    );
-    const gitHubRepoExists = exitStatus === 0;
-    const url = `https://github.com/${gitHubUsername}/${projectName}`;
-
-    if (gitHubRepoExists) {
-      console.log(
-        `Detected an existing GitHub repository at: ${chalk.green(url)}`,
-      );
-      const guessedRemoteURL = getGitRemoteURL(projectName, gitHubUsername);
-
-      if (yes) {
-        console.log(
-          `Using a Git remote URL of: ${chalk.green(guessedRemoteURL)}`,
-        );
-        return guessedRemoteURL;
-      }
-
-      const shouldUseGuessedURL = await getInputYesNo(
-        `Do you want to use a Git remote URL of: ${chalk.green(
-          guessedRemoteURL,
-        )}`,
-      );
-      if (shouldUseGuessedURL) {
-        return guessedRemoteURL;
-      }
-
-      // Assume that since they do not want to connect this project to the existing GitHub
-      // repository, they do not want to initialize a remote Git URL at all.
-      return undefined;
-    }
-
-    if (yes) {
-      execShell("gh", ["repo", "create", projectName, "--public"]);
-      console.log(`Created a new GitHub repository at: ${chalk.green(url)}`);
-      return getGitRemoteURL(projectName, gitHubUsername);
-    }
-
-    const createNewGitHubRepo = await getInputYesNo(
-      `Would you like to create a new GitHub repository at: ${chalk.green(
-        url,
-      )}`,
-    );
-    if (createNewGitHubRepo) {
-      execShell("gh", ["repo", "create", projectName, "--public"]);
-      console.log("Successfully created a new GitHub repository.");
-      return getGitRemoteURL(projectName, gitHubUsername);
-    }
-
-    // Assume that since they do not want to create a new GitHub repository, they do not want to
-    // initialize a remote Git URL at all.
-    return undefined;
-  }
-
-  const gitRemoteURL =
-    await getInputString(`Paste in the remote Git URL for your project.
-For example, if you have an SSH key, it would be something like:
-${chalk.green("git@github.com:Alice/green-candle.git")}
-If you don't have an SSH key, it would be something like:
-${chalk.green("https://github.com/Alice/green-candle.git")}
-If you don't want to initialize a Git repository for this project, press enter to skip.
-`);
-
-  return gitRemoteURL === "" ? undefined : gitRemoteURL;
-}
-
-function validateNewGitVersion(verbose: boolean) {
-  const [, stdout] = execShell("git", ["--version"], verbose);
-
-  const outputPrefix = "git version ";
-  if (!stdout.startsWith(outputPrefix)) {
-    error(
-      `Failed to parse the output from the "git --version" command: ${stdout}`,
-    );
-  }
-
-  const gitVersionString = stdout.slice(outputPrefix.length);
-  const [majorVersion, minorVersion] = parseSemVer(gitVersionString);
-
-  if (
-    majorVersion >= REQUIRED_GIT_MAJOR_VERSION &&
-    minorVersion >= REQUIRED_GIT_MINOR_VERSION
-  ) {
-    return;
-  }
-
-  console.error(`Your Git version is: ${chalk.red(gitVersionString)}`);
-  console.error(
-    `${PROJECT_NAME} requires a Git version of ${chalk.red(
-      `${REQUIRED_GIT_MAJOR_VERSION}.${REQUIRED_GIT_MINOR_VERSION}.0`,
-    )} or greater.`,
-  );
-  console.error(
-    `Please upgrade your version of Git before using ${PROJECT_NAME}.`,
-  );
-  process.exit(1);
-}
-
-function getGitHubUsername(verbose: boolean) {
-  // If the GitHub CLI is installed, we can derive the user's GitHub username
-  if (!commandExists.sync("gh")) {
-    return undefined;
-  }
-
-  const appData = process.env["APPDATA"];
-  if (appData === undefined || appData === "") {
-    return undefined;
-  }
-
-  const githubCLIHostsPath = path.join(appData, "GitHub CLI", "hosts.yml");
-  if (!file.exists(githubCLIHostsPath, verbose)) {
-    return undefined;
-  }
-
-  const configYAMLRaw = file.read(githubCLIHostsPath, verbose);
-  const configYAML = yaml.parse(configYAMLRaw) as GitHubCLIHostsYAML;
-
-  const githubCom = configYAML["github.com"];
-  if (githubCom === undefined) {
-    return undefined;
-  }
-
-  const { user } = githubCom;
-  if (user === undefined || user === "") {
-    return undefined;
-  }
-
-  return user;
-}
-
-function getGitRemoteURL(projectName: string, gitHubUsername: string) {
-  return `git@github.com:${gitHubUsername}/${projectName}.git`;
-}
-
-export function initGitRepository(
-  projectPath: string,
-  gitRemoteURL: string | undefined,
-  verbose: boolean,
-): void {
-  if (!commandExists.sync("git")) {
-    return;
-  }
-
-  if (gitRemoteURL === undefined) {
-    return;
-  }
-
-  execShell("git", ["init"], verbose, false, projectPath);
-  execShell("git", ["branch", "-M", "main"], verbose, false, projectPath);
-
-  if (isGitNameAndEmailConfigured(verbose)) {
-    execShell("git", ["add", "--all"], verbose, false, projectPath);
-    execShell(
-      "git",
-      ["commit", "--message", `${PROJECT_NAME} template`],
-      verbose,
-      false,
-      projectPath,
-    );
-  }
-
-  if (gitRemoteURL !== undefined) {
-    execShell(
-      "git",
-      ["remote", "add", "origin", gitRemoteURL],
-      verbose,
-      false,
-      projectPath,
-    );
-  }
-}
-
-function isGitNameAndEmailConfigured(verbose: boolean) {
-  const [nameExitStatus] = execShell(
-    "git",
-    ["config", "--global", "user.name"],
-    verbose,
-    true,
-  );
-
-  const [emailExitStatus] = execShell(
-    "git",
-    ["config", "--global", "user.email"],
-    verbose,
-    true,
-  );
-
-  return nameExitStatus === 0 && emailExitStatus === 0;
-}
-
-export function isGitDirty(verbose: boolean): boolean {
-  // From: https://remarkablemark.org/blog/2017/10/12/check-git-dirty/
-  const [, stdout] = execShell("git", ["status", "--porcelain"], verbose);
-  return stdout !== "";
-}
-
-export function gitCommitIfChanges(version: string, verbose: boolean): void {
-  // Throw an error if this is not a git repository
-  execShell("git", ["status"], verbose);
-
-  if (!isGitDirty(verbose)) {
-    console.log("There are no changes to commit.");
-    return;
-  }
-
-  const commitMessage = `v${version}`;
-  execShell("git", ["add", "-A"], verbose);
-  execShell("git", ["commit", "-m", commitMessage], verbose);
-  execShell("git", ["push"], verbose);
-
-  console.log(
-    `Committed and pushed to the git repository with a message of: ${commitMessage}`,
-  );
-}