isaacscript 2.0.6 → 2.0.9

package/src/checkForWindowsTerminalBugs.ts

@@ -1,106 +0,0 @@
-import chalk from "chalk";
-import fs from "fs";
-import path from "path";
-import { HOME_DIR, PROJECT_NAME } from "./constants";
-import * as file from "./file";
-import { getInputYesNo } from "./prompt";
-import { error } from "./utils";
-
-const BASH_PROFILE_PATH = path.join(HOME_DIR, ".bash_profile");
-
-/**
- * By default, Git Bash for Windows uses MINGW64. This will not work correctly with the prompt
- * library. Try to detect this and warn the end-user.
- */
-export async function checkForWindowsTerminalBugs(
-  verbose: boolean,
-): Promise<void> {
-  if (process.platform !== "win32") {
-    return;
-  }
-
-  if (process.env["SHELL"] !== "C:\\Program Files\\Git\\usr\\bin\\bash.exe") {
-    return;
-  }
-
-  await checkForWindowsBugColor(verbose);
-}
-
-async function checkForWindowsBugColor(verbose: boolean) {
-  if (process.env["FORCE_COLOR"] === "true") {
-    return;
-  }
-
-  console.error(
-    chalk.red(
-      `Error: It looks like you are using Git Bash for Windows (MINGW64) without the "${chalk.green(
-        "FORCE_COLOR",
-      )}" environment variable.`,
-    ),
-  );
-  console.error(
-    "This is necessary in order for colors to work properly in the terminal.",
-  );
-
-  const shouldFixColors = await getInputYesNo(
-    "Do you want me to fix this for you?",
-  );
-  if (!shouldFixColors) {
-    return;
-  }
-
-  applyFixesToBashProfile(verbose);
-}
-
-function applyFixesToBashProfile(verbose: boolean) {
-  // Check to see if the Bash profile has data.
-  let bashProfileContents: string;
-  if (file.exists(BASH_PROFILE_PATH, verbose)) {
-    bashProfileContents = file.read(BASH_PROFILE_PATH, verbose);
-  } else {
-    bashProfileContents = "";
-  }
-
-  const appendText = getBashProfileAppendText(bashProfileContents);
-
-  try {
-    fs.appendFileSync(BASH_PROFILE_PATH, appendText);
-  } catch (err) {
-    error(`Failed to append text to "${BASH_PROFILE_PATH}":`, err);
-  }
-
-  console.log(
-    chalk.green("Complete!"),
-    `The terminal fixes have been added to: ${chalk.green(BASH_PROFILE_PATH)}`,
-  );
-  console.log(
-    chalk.red(
-      "Please close and re-open your terminal, then run this program again.",
-    ),
-  );
-  process.exit(0);
-}
-
-function getBashProfileAppendText(bashProfileContents: string) {
-  let newText = "";
-
-  if (
-    bashProfileContents !== "" &&
-    bashProfileContents[bashProfileContents.length - 1] !== "\n"
-  ) {
-    // If the Bash profile exists and has data, it should end in a newline. Add an extra newline if
-    // this is not the case.
-    newText += "\n";
-  }
-
-  if (bashProfileContents !== "") {
-    // If the Bash profile exists and has data, add an extra newline between the existing stuff and
-    // the new lines added by us.
-    newText += "\n";
-  }
-
-  newText += `# Terminal fixes added by ${PROJECT_NAME}\n`;
-  newText += "export FORCE_COLOR=true\n";
-
-  return newText;
-}

package/src/commands/copy/copy.ts

@@ -1,41 +0,0 @@
-import path from "path";
-import { MOD_SOURCE_PATH } from "../../constants";
-import { execShell } from "../../exec";
-import * as file from "../../file";
-import { Config } from "../../types/Config";
-import { getModTargetDirectoryName } from "../../utils";
-
-export function copy(argv: Record<string, unknown>, config: Config): void {
-  const verbose = argv["verbose"] === true;
-
-  const modTargetDirectoryName = getModTargetDirectoryName(config);
-  const modTargetPath = path.join(config.modsDirectory, modTargetDirectoryName);
-
-  compileAndCopy(MOD_SOURCE_PATH, modTargetPath, verbose);
-}
-
-export function compileAndCopy(
-  modSourcePath: string,
-  modTargetPath: string,
-  verbose: boolean,
-): void {
-  compile(verbose);
-  copyMod(modSourcePath, modTargetPath, verbose);
-}
-
-function compile(verbose: boolean) {
-  execShell("npx", ["tstl"], verbose);
-  console.log("Mod compiled successfully.");
-}
-
-function copyMod(
-  modSourcePath: string,
-  modTargetPath: string,
-  verbose: boolean,
-) {
-  if (file.exists(modTargetPath, verbose)) {
-    file.deleteFileOrDirectory(modTargetPath, verbose);
-  }
-  file.copy(modSourcePath, modTargetPath, verbose);
-  console.log("Mod copied successfully.");
-}

package/src/commands/init/checkIfProjectPathExists.ts

@@ -1,34 +0,0 @@
-import chalk from "chalk";
-import { CWD } from "../../constants";
-import * as file from "../../file";
-import { getInputYesNo } from "../../prompt";
-import { error } from "../../utils";
-
-export async function checkIfProjectPathExists(
-  projectPath: string,
-  yes: boolean,
-  verbose: boolean,
-): Promise<void> {
-  if (projectPath === CWD || !file.exists(projectPath, verbose)) {
-    return;
-  }
-
-  const fileType = file.isDir(projectPath, verbose) ? "directory" : "file";
-
-  if (yes) {
-    file.deleteFileOrDirectory(projectPath, verbose);
-    console.log(`Deleted ${fileType}: ${chalk.green(projectPath)}`);
-    return;
-  }
-
-  console.log(
-    `A ${fileType} already exists with a name of: ${chalk.green(projectPath)}`,
-  );
-  const shouldDelete = await getInputYesNo("Do you want me to delete it?");
-
-  if (!shouldDelete) {
-    error("Ok then. Goodbye.");
-  }
-
-  file.deleteFileOrDirectory(projectPath, verbose);
-}

package/src/commands/init/checkModSubdirectory.ts

@@ -1,20 +0,0 @@
-import chalk from "chalk";
-import { CWD } from "../../constants";
-import * as file from "../../file";
-import { error } from "../../utils";
-
-export function checkModSubdirectory(
-  projectPath: string,
-  modsDirectory: string,
-): void {
-  if (file.isSubDirOf(CWD, modsDirectory)) {
-    console.error(
-      `Error: The project directory of "${chalk.green(
-        projectPath,
-      )}" is a subdirectory of "${chalk.green(modsDirectory)}".`,
-    );
-    error(
-      'You are supposed to have your project folder somewhere else on the system than the Isaac mods directory. (This is because we don\'t want to upload the ".git" folder or the TypeScript files to the Steam Workshop.) Exiting.',
-    );
-  }
-}

package/src/commands/init/checkModTargetDirectory.ts

@@ -1,42 +0,0 @@
-import chalk from "chalk";
-import path from "path";
-import { PROJECT_NAME } from "../../constants";
-import * as file from "../../file";
-import { getInputYesNo } from "../../prompt";
-import { error } from "../../utils";
-
-export async function checkModTargetDirectory(
-  modsDirectory: string,
-  projectName: string,
-  yes: boolean,
-  verbose: boolean,
-): Promise<void> {
-  const modTargetPath = path.join(modsDirectory, projectName);
-  if (!file.exists(modTargetPath, verbose)) {
-    return;
-  }
-
-  const fileType = file.isDir(modTargetPath, verbose) ? "directory" : "file";
-
-  if (yes) {
-    file.deleteFileOrDirectory(modTargetPath, verbose);
-    console.log(`Deleted ${fileType}: ${chalk.green(modTargetPath)}`);
-    return;
-  }
-
-  console.log(
-    `A ${fileType} already exists at at the mod path of: ${chalk.green(
-      modTargetPath,
-    )}`,
-  );
-  console.log(
-    `${PROJECT_NAME} will need to sync your project folder with this directory.`,
-  );
-  const shouldDelete = await getInputYesNo("Do you want me to delete it?");
-
-  if (!shouldDelete) {
-    error("Ok then. Goodbye.");
-  }
-
-  file.deleteFileOrDirectory(modTargetPath, verbose);
-}

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.',
-    );
-  }
-}