isaacscript 2.0.6 → 2.0.9

package/src/file.ts

@@ -1,235 +0,0 @@
-import chalk from "chalk";
-import fs from "fs-extra";
-import path from "path";
-import { error } from "./utils";
-
-export function copy(srcPath: string, dstPath: string, verbose: boolean): void {
-  if (verbose) {
-    console.log(`Copying: ${srcPath} --> ${dstPath}`);
-  }
-
-  try {
-    // "copySync()" is a "fs-extra" method for copying directories recursively
-    fs.copySync(srcPath, dstPath, {
-      recursive: true,
-    });
-  } catch (err) {
-    error(
-      `Failed to copy directory "${chalk.green(srcPath)}" to "${chalk.green(
-        dstPath,
-      )}":`,
-      err,
-    );
-  }
-
-  if (verbose) {
-    console.log(`Copied: ${srcPath} --> ${dstPath}`);
-  }
-}
-
-export function deleteFileOrDirectory(
-  filePath: string,
-  verbose: boolean,
-): void {
-  if (verbose) {
-    console.log(`Deleting: ${filePath}`);
-  }
-
-  try {
-    fs.rmSync(filePath, {
-      recursive: true,
-    });
-  } catch (err) {
-    error(
-      `Failed to delete file or directory "${chalk.green(filePath)}":`,
-      err,
-    );
-  }
-
-  if (verbose) {
-    console.log(`Deleted: ${filePath}`);
-  }
-}
-
-export function exists(filePath: string, verbose: boolean): boolean {
-  if (verbose) {
-    console.log(`Checking to see if the following path exists: ${filePath}`);
-  }
-
-  let pathExists: boolean;
-  try {
-    pathExists = fs.existsSync(filePath);
-  } catch (err) {
-    error(`Failed to check if "${chalk.green(filePath)}" exists:`, err);
-  }
-
-  if (verbose) {
-    console.log(`Path exists: ${pathExists}`);
-  }
-
-  return pathExists;
-}
-
-export function getDirList(dirPath: string, verbose: boolean): string[] {
-  if (verbose) {
-    console.log(`Getting a directory list from: ${dirPath}`);
-  }
-
-  let fileList: string[];
-  try {
-    fileList = fs.readdirSync(dirPath);
-  } catch (err) {
-    error(
-      `Failed to get the files in the "${chalk.green(dirPath)}" directory:`,
-      err,
-    );
-  }
-
-  if (verbose) {
-    console.log(`Got a directory list from: ${dirPath}`);
-  }
-
-  return fileList;
-}
-
-function getFileStats(filePath: string, verbose: boolean): fs.Stats {
-  if (verbose) {
-    console.log(`Getting file stats from: ${filePath}`);
-  }
-
-  let fileStats: fs.Stats;
-  try {
-    fileStats = fs.statSync(filePath);
-  } catch (err) {
-    error(`Failed to get the file stats for "${chalk.green(filePath)}":`, err);
-  }
-
-  if (verbose) {
-    console.log(`Got file stats from: ${filePath}`);
-  }
-
-  return fileStats;
-}
-
-export function isDir(filePath: string, verbose: boolean): boolean {
-  const fileStats = getFileStats(filePath, verbose);
-  return fileStats.isDirectory();
-}
-
-export function isSubDirOf(dir: string, parent: string): boolean {
-  const relative = path.relative(parent, dir);
-  return (
-    relative !== "" && !relative.startsWith("..") && !path.isAbsolute(relative)
-  );
-}
-
-export function makeDir(dirPath: string, verbose: boolean): void {
-  if (verbose) {
-    console.log(`Making a directory: ${dirPath}`);
-  }
-
-  try {
-    fs.mkdirSync(dirPath, {
-      recursive: true,
-    });
-  } catch (err) {
-    error(`Failed to create the "${chalk.green(dirPath)}" directory:`, err);
-  }
-
-  if (verbose) {
-    console.log(`Made a directory: ${dirPath}`);
-  }
-}
-
-export function read(filePath: string, verbose: boolean): string {
-  if (verbose) {
-    console.log(`Reading a file: ${filePath}`);
-  }
-
-  let fileContents: string;
-  try {
-    fileContents = fs.readFileSync(filePath, "utf8");
-  } catch (err) {
-    error(`Failed to read the "${chalk.green(filePath)}" file:`, err);
-  }
-
-  if (verbose) {
-    console.log(`Read a file: ${filePath}`);
-  }
-
-  return fileContents;
-}
-
-export function rename(
-  srcPath: string,
-  dstPath: string,
-  verbose: boolean,
-): void {
-  if (verbose) {
-    console.log(`Renaming: ${srcPath} --> ${dstPath}`);
-  }
-
-  try {
-    fs.renameSync(srcPath, dstPath);
-  } catch (err) {
-    error(
-      `Failed to rename "${chalk.green(srcPath)}" to "${chalk.green(
-        dstPath,
-      )}":`,
-      err,
-    );
-  }
-
-  if (verbose) {
-    console.log(`Renamed: ${srcPath} --> ${dstPath}`);
-  }
-}
-
-export function touch(filePath: string, verbose: boolean): void {
-  if (verbose) {
-    console.log(`Touching: ${filePath}`);
-  }
-
-  try {
-    const fileHandle = fs.openSync(filePath, "w");
-    fs.closeSync(fileHandle);
-  } catch (err) {
-    error(`Failed to touch the "${chalk.green(filePath)}" file:`, err);
-  }
-
-  if (verbose) {
-    console.log(`Touched: ${filePath}`);
-  }
-}
-
-export function write(filePath: string, data: string, verbose: boolean): void {
-  if (verbose) {
-    console.log(`Writing data to: ${filePath}`);
-  }
-
-  try {
-    fs.writeFileSync(filePath, data);
-  } catch (err) {
-    error(`Failed to write to the "${chalk.green(filePath)}" file:`, err);
-  }
-
-  if (verbose) {
-    console.log(`Wrote data to: ${filePath}`);
-  }
-}
-
-export function writeTry(
-  filePath: string,
-  data: string,
-  verbose: boolean,
-): void {
-  if (verbose) {
-    console.log(`Writing data to: ${filePath}`);
-  }
-
-  fs.writeFileSync(filePath, data);
-
-  if (verbose) {
-    console.log(`Wrote data to: ${filePath}`);
-  }
-}

package/src/main.ts

@@ -1,131 +0,0 @@
-#!/usr/bin/env node
-
-import chalk from "chalk";
-import * as dotenv from "dotenv";
-import figlet from "figlet";
-import path from "path";
-import sourceMapSupport from "source-map-support";
-import updateNotifier from "update-notifier";
-import pkg from "../package.json";
-import { checkForWindowsTerminalBugs } from "./checkForWindowsTerminalBugs";
-import { copy } from "./commands/copy/copy";
-import { init } from "./commands/init/init";
-import { monitor } from "./commands/monitor/monitor";
-import { publish } from "./commands/publish/publish";
-import * as configFile from "./configFile";
-import { CWD, PROJECT_NAME, YARN_LOCK_PATH } from "./constants";
-import { execShell } from "./exec";
-import * as file from "./file";
-import { parseArgs } from "./parseArgs";
-import { promptInit } from "./prompt";
-import { Command, DEFAULT_COMMAND } from "./types/Command";
-import { Config } from "./types/Config";
-import { ensureAllCases, error } from "./utils";
-import { validateInIsaacScriptProject } from "./validateInIsaacScriptProject";
-import { validateNodeVersion } from "./validateNodeVersion";
-import { validateOS } from "./validateOS";
-
-main().catch((err) => {
-  error(`${PROJECT_NAME} failed:`, err);
-});
-
-async function main(): Promise<void> {
-  sourceMapSupport.install();
-  promptInit();
-  validateNodeVersion();
-  validateOS();
-  loadEnvironmentVariables();
-
-  // Get command line arguments
-  const argv = parseArgs();
-  const verbose = argv["verbose"] === true;
-
-  printBanner();
-
-  // Check for a new version
-  updateNotifier({ pkg }).notify();
-
-  // Pre-flight checks
-  await checkForWindowsTerminalBugs(verbose);
-
-  await handleCommands(argv, verbose);
-}
-
-function loadEnvironmentVariables() {
-  const envFile = path.join(CWD, ".env");
-  dotenv.config({ path: envFile });
-}
-
-function printBanner() {
-  console.log(chalk.green(figlet.textSync(PROJECT_NAME)));
-  const bannerLength = 55; // From measuring the banner created by Figlet
-  const version = `v${pkg.version}`;
-  const leftPaddingAmount = Math.floor((bannerLength + version.length) / 2);
-  console.log(version.padStart(leftPaddingAmount));
-  console.log();
-}
-
-async function handleCommands(argv: Record<string, unknown>, verbose: boolean) {
-  const positionalArgs = argv["_"] as string[];
-  let command: Command;
-  if (positionalArgs.length > 0) {
-    command = positionalArgs[0] as Command;
-  } else {
-    command = DEFAULT_COMMAND;
-  }
-
-  let config = new Config();
-  if (command !== "init") {
-    validateInIsaacScriptProject(verbose);
-    config = await configFile.get(argv);
-
-    ensureDepsAreInstalled(verbose);
-  }
-
-  switch (command) {
-    case "monitor": {
-      monitor(argv, config);
-      break;
-    }
-
-    case "init": {
-      await init(argv);
-      break;
-    }
-
-    case "copy": {
-      copy(argv, config);
-      break;
-    }
-
-    case "publish": {
-      publish(argv, config);
-      break;
-    }
-
-    default: {
-      ensureAllCases(command);
-      break;
-    }
-  }
-
-  if (command !== "monitor") {
-    process.exit(0);
-  }
-}
-
-function ensureDepsAreInstalled(verbose: boolean) {
-  if (file.exists(YARN_LOCK_PATH, verbose)) {
-    console.log(
-      'Running "yarn" to ensure that the project\'s dependencies are installed correctly.',
-    );
-    execShell("yarn");
-    return;
-  }
-
-  // https://stackoverflow.com/questions/57016579/checking-if-package-json-dependencies-match-the-installed-dependencies
-  console.log(
-    'Running "npm install" to ensure that the project\'s dependencies are installed correctly.',
-  );
-  execShell("npm", ["install"], verbose);
-}

package/src/parseArgs.ts

@@ -1,127 +0,0 @@
-import yargs from "yargs";
-import { PROJECT_NAME } from "./constants";
-
-export function parseArgs(): Record<string, unknown> {
-  const yargsObject = yargs(process.argv.slice(2))
-    .strict()
-    .usage("usage: isaacscript <command> [options]")
-    .scriptName("isaacscript")
-
-    .command("monitor", "Monitor a project for changes. (default)", (builder) =>
-      builder
-        .option("mods-directory", {
-          alias: "m",
-          type: "string",
-          description: "The directory where Isaac mods live on your system",
-        })
-        .option("save-slot", {
-          alias: "s",
-          type: "number",
-          choices: [1, 2, 3],
-          description: "The save slot in-game that you use",
-        })
-        .option("verbose", {
-          alias: "v",
-          type: "boolean",
-          description: "Enable verbose output",
-        }),
-    )
-
-    .command(
-      "init [name]",
-      `Initialize a new ${PROJECT_NAME} mod.`,
-      (builder) =>
-        builder
-          .option("yes", {
-            alias: "y",
-            type: "boolean",
-            description:
-              'Answer yes to every dialog option, similar to how "npm init --yes" works.',
-          })
-          .option("use-current-dir", {
-            alias: "u",
-            type: "boolean",
-            description:
-              "Use the current directory as the root for the project",
-          })
-          .option("mods-directory", {
-            alias: "m",
-            type: "string",
-            description: "The directory where Isaac mods live on your system",
-          })
-          .option("save-slot", {
-            alias: "s",
-            type: "number",
-            choices: [1, 2, 3],
-            description: "The in-game save slot that you use",
-          })
-          .option("vscode", {
-            alias: "c",
-            type: "boolean",
-            description: "Open the project in VSCode after initialization",
-          })
-          .option("skip-npm-install", {
-            alias: "i",
-            type: "boolean",
-            description:
-              'Don\'t automatically run "npm install" after initializing the project',
-          })
-          .option("force-name", {
-            alias: "f",
-            type: "boolean",
-            description: "Allow project names that are normally illegal",
-          })
-          .option("verbose", {
-            alias: "v",
-            type: "boolean",
-            description: "Enable verbose output",
-          }),
-    )
-
-    .command("copy", "Only compile & copy the mod.", (builder) =>
-      builder.option("verbose", {
-        alias: "v",
-        type: "boolean",
-        description: "Enable verbose output",
-      }),
-    )
-
-    .command(
-      "publish",
-      "Bump the version & automatically publish the new files using the steamcmd tool.",
-      (builder) =>
-        builder
-          .option("skip", {
-            alias: "s",
-            type: "boolean",
-            description: "skip incrementing the version number",
-          })
-          .option("set-version", {
-            alias: "t",
-            type: "string",
-            description:
-              "specify the version number instead of incrementing it",
-          })
-          .option("dry-run", {
-            alias: "d",
-            type: "boolean",
-            description: "skip invoking steamcmd",
-          })
-          .option("only-upload", {
-            alias: "u",
-            type: "boolean",
-            description:
-              "only upload the mod to the Steam Workshop (without doing anything else)",
-          })
-          .option("verbose", {
-            alias: "v",
-            type: "boolean",
-            description: "Enable verbose output",
-          }),
-    )
-
-    .alias("h", "help") // By default, only "--help" is enabled
-    .alias("v", "version"); // By default, only "--version" is enabled
-
-  return yargsObject.argv as Record<string, unknown>;
-}

package/src/prompt.ts

@@ -1,109 +0,0 @@
-// Both the Inquirer.js library and the Prompts library have a bug where text is duplicated in a Git
-// Bash terminal. Thus, we revert to using the simpler Prompt library.
-
-import chalk from "chalk";
-import prompt from "prompt";
-import { error, parseIntSafe } from "./utils";
-
-const VALID_YES_RESPONSES = new Set(["yes", "ye", "y"]);
-const VALID_NO_RESPONSES = new Set(["no", "n"]);
-
-export function promptInit(): void {
-  // Override some of the prompt library's default values:
-  // https://github.com/flatiron/prompt#customizing-your-prompt
-  prompt.message = chalk.green("?");
-  prompt.delimiter = " ";
-  prompt.colors = false;
-}
-
-export async function getInputYesNo(
-  msg: string,
-  defaultValue = true,
-): Promise<boolean> {
-  prompt.start();
-
-  // Capitalize the letter that represents the default option.
-  const y = defaultValue ? "Y" : "y";
-  const n = defaultValue ? "n" : "N";
-
-  const questionSuffix = `(${y}\\${n})`;
-  const description = `${chalk.bold(msg)} ${chalk.gray(questionSuffix)}`;
-
-  const { response } = await prompt.get({
-    properties: {
-      response: {
-        type: "string",
-        description,
-      },
-    },
-  });
-
-  if (typeof response !== "string") {
-    console.log(typeof response);
-    error("Failed to get a proper response from the prompt library.");
-  }
-
-  const cleanedResponse = response.toLowerCase().trim();
-
-  // Default to true.
-  if (cleanedResponse === "") {
-    return defaultValue;
-  }
-
-  if (VALID_YES_RESPONSES.has(cleanedResponse)) {
-    return true;
-  }
-
-  if (VALID_NO_RESPONSES.has(cleanedResponse)) {
-    return false;
-  }
-
-  return error('Invalid response; must answer "yes" or "no".');
-}
-
-/** Returns trimmed input. */
-export async function getInputString(
-  msg: string,
-  defaultValue?: string,
-): Promise<string> {
-  prompt.start();
-
-  let description = `${chalk.bold(msg)}`;
-  if (defaultValue !== undefined) {
-    description += ` ${chalk.gray(`(${defaultValue})`)}`;
-  }
-
-  const { response } = await prompt.get({
-    properties: {
-      response: {
-        type: "string",
-        description,
-      },
-    },
-  });
-
-  if (typeof response !== "string") {
-    error("Failed to get a proper response from the prompt library.");
-  }
-
-  if (response === "" && defaultValue !== undefined) {
-    return defaultValue;
-  }
-
-  return response.trim();
-}
-
-export async function getInputInt(
-  msg: string,
-  defaultValue = 1,
-): Promise<number> {
-  const defaultValueString = defaultValue.toString();
-  const string = await getInputString(msg, defaultValueString);
-  const int = parseIntSafe(string);
-
-  if (Number.isNaN(int)) {
-    error("Error: You must enter an integer.");
-  }
-
-  return int;
-}

package/src/types/Command.ts

@@ -1,3 +0,0 @@
-export type Command = "monitor" | "init" | "copy" | "publish";
-
-export const DEFAULT_COMMAND = "monitor";

package/src/types/Config.ts

@@ -1,23 +0,0 @@
-export class Config {
-  /** The "mods" directory that lives next to the "isaac-ng.exe" program. */
-  modsDirectory =
-    "C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\mods";
-
-  /** The save slot that you test your mod on. */
-  saveSlot = 1;
-
-  /**
-   * By default, the target mod directory name will be the same as the project directory name. This
-   * setting allows you to customize it.
-   */
-  customTargetModDirectoryName?: string;
-
-  /** The path to "steamcmd.exe". This is optional and only needed for automating publishing. */
-  steamCmdPath?: string;
-
-  /**
-   * When your code is recompiled, IsaacScript watcher can restart the game to ensure that any
-   * run-related variables are properly reset. This is set to true by default.
-   */
-  enableIsaacScriptWatcherAutoRestart?: boolean;
-}

package/src/types/GitHubCLIHostsYAML.ts

@@ -1,7 +0,0 @@
-export interface GitHubCLIHostsYAML {
-  "github.com": {
-    user: string;
-    oauth_token: string;
-    git_protocol: string;
-  };
-}