isaacscript 2.0.4 → 2.0.7

package/src/constants.ts

@@ -1,85 +0,0 @@
-import os from "os";
-import path from "path";
-
-const cwd = process.cwd();
-
-// https://stackoverflow.com/questions/9080085/node-js-find-home-directory-in-platform-agnostic-way
-const homeDir = os.homedir();
-
-// Miscellaneous
-export const CURRENT_DIRECTORY_NAME = path.basename(cwd);
-export const CWD = cwd;
-export const HOME_DIR = homeDir;
-export const FILE_SYNCED_MESSAGE = "File synced:";
-export const MOD_UPLOADER_PATH =
-  "C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\tools\\ModUploader\\ModUploader.exe";
-export const PROJECT_NAME = "IsaacScript";
-
-// isaacscript
-const REPO_ROOT = path.join(__dirname, "..", "..");
-
-// isaacscript/isaacscript-watcher
-export const DISABLE_IT_FILE = "disable.it";
-export const WATCHER_MOD_NAME = "isaacscript-watcher";
-export const WATCHER_MOD_SOURCE_PATH = path.join(REPO_ROOT, WATCHER_MOD_NAME);
-
-// isaacscript/file-templates
-const TEMPLATES_DIR = path.join(REPO_ROOT, "file-templates");
-
-// isaacscript/file-templates/static
-export const TEMPLATES_STATIC_DIR = path.join(TEMPLATES_DIR, "static");
-
-// isaacscript/file-templates/dynamic
-const TEMPLATES_DYNAMIC_DIR = path.join(TEMPLATES_DIR, "dynamic");
-export const GITIGNORE = "gitignore"; // Not named ".gitignore" to prevent NPM from deleting it
-export const GITIGNORE_TEMPLATE_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  GITIGNORE,
-);
-export const MAIN_TS = "main.ts";
-export const MAIN_TS_TEMPLATE_PATH = path.join(TEMPLATES_DYNAMIC_DIR, MAIN_TS);
-export const METADATA_XML = "metadata.xml";
-export const METADATA_XML_TEMPLATE_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  METADATA_XML,
-);
-export const METADATA_VDF = "metadata.vdf";
-export const METADATA_VDF_TEMPLATE_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  METADATA_VDF,
-);
-export const PACKAGE_JSON = "package.json";
-export const PACKAGE_JSON_TEMPLATE_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  PACKAGE_JSON,
-);
-export const README_MD = "README.md";
-export const README_MD_TEMPLATES_PATH = path.join(
-  TEMPLATES_DYNAMIC_DIR,
-  README_MD,
-);
-
-// project
-export const CONFIG_FILE_NAME = "isaacscript.json";
-export const CONFIG_FILE_PATH = path.join(CWD, CONFIG_FILE_NAME);
-export const TSCONFIG_PATH = path.join(CWD, "tsconfig.json");
-export const PACKAGE_JSON_PATH = path.join(CWD, "package.json");
-export const CONSTANTS_TS_PATH = path.join(CWD, "src", "constants.ts");
-export const YARN_LOCK_PATH = path.join(CWD, "yarn.lock");
-
-// project/mod
-export const MOD_SOURCE_PATH = path.join(CWD, "mod");
-export const MAIN_LUA = "main.lua";
-export const METADATA_XML_PATH = path.join(MOD_SOURCE_PATH, "metadata.xml");
-export const VERSION_TXT_PATH = path.join(MOD_SOURCE_PATH, "version.txt");
-
-// project/scripts
-const SCRIPTS_PATH = path.join(CWD, "scripts");
-export const PUBLISH_PRE_COPY_PY_PATH = path.join(
-  SCRIPTS_PATH,
-  "publish_pre_copy.py",
-);
-export const PUBLISH_POST_COPY_PY_PATH = path.join(
-  SCRIPTS_PATH,
-  "publish_post_copy.py",
-);

package/src/exec.ts

@@ -1,125 +0,0 @@
-import chalk from "chalk";
-import { execSync, spawnSync, SpawnSyncReturns } from "child_process";
-import { CWD } from "./constants";
-import { error } from "./utils";
-
-export function execExe(path: string, verbose: boolean, cwd = CWD): string {
-  if (verbose) {
-    console.log(`Executing binary: ${path}`);
-  }
-
-  let stdout: string;
-  try {
-    const buffer = execSync(`"${path}"`, {
-      cwd,
-    });
-    stdout = buffer.toString().trim();
-  } catch (err) {
-    error(`Failed to run "${chalk.green(path)}":`, err);
-  }
-
-  if (verbose) {
-    console.log(`Executed binary: ${path}`);
-  }
-
-  return stdout;
-}
-
-export function execPowershell(
-  command: string,
-  verbose = false,
-  cwd = CWD,
-): string {
-  if (verbose) {
-    console.log(`Executing PowerShell command: ${command}`);
-  }
-
-  let stdout: string;
-  try {
-    const buffer = execSync(command, {
-      shell: "powershell.exe",
-      cwd,
-    });
-    stdout = buffer.toString().trim();
-  } catch (err) {
-    error(`Failed to run PowerShell command "${chalk.green(command)}":`, err);
-  }
-
-  if (verbose) {
-    console.log(`Executed PowerShell command: ${command}`);
-  }
-
-  return stdout;
-}
-
-/** Returns a tuple of exit status and stdout. The stdout is trimmed for convenience. */
-export function execShell(
-  command: string,
-  args: string[] = [],
-  verbose = false,
-  allowFailure = false,
-  cwd = CWD,
-): [exitStatus: number, stdout: string] {
-  // On Windows, "spawnSync()" will not account for spaces in arguments. Thus, wrap everything in a
-  // double quote. This will cause arguments that naturally have double quotes to fail.
-  if (command.includes('"')) {
-    error(
-      "execShell cannot execute commands with double quotes in the command.",
-    );
-  }
-
-  const argsHasDoubleQuotes = args.some((arg) => arg.includes('"'));
-  if (argsHasDoubleQuotes) {
-    error(
-      "execShell cannot execute commands with double quotes in the arguments.",
-    );
-  }
-
-  const quotedArgs = args.map((arg) => `"${arg}"`);
-  const commandDescription = `${command} ${quotedArgs.join(" ")}`.trim();
-
-  if (verbose) {
-    console.log(`Executing command: ${commandDescription}`);
-  }
-
-  let spawnSyncReturns: SpawnSyncReturns<Buffer>;
-  try {
-    spawnSyncReturns = spawnSync(command, args, {
-      shell: true,
-      cwd,
-    });
-  } catch (err) {
-    error(
-      `Failed to run the "${chalk.green(commandDescription)}" command:`,
-      err,
-    );
-  }
-
-  if (verbose) {
-    console.log(`Executed command: ${commandDescription}`);
-  }
-
-  const exitStatus = spawnSyncReturns.status;
-  if (exitStatus === null) {
-    error(`Failed to get the return status of command: ${commandDescription}`);
-  }
-
-  const stdout = spawnSyncReturns.output.join("\n").trim();
-
-  if (exitStatus !== 0) {
-    if (allowFailure) {
-      return [exitStatus, stdout];
-    }
-
-    console.error(
-      `Failed to run the "${chalk.green(
-        commandDescription,
-      )}" command with an exit code of ${exitStatus}.`,
-    );
-    console.error("The output was as follows:");
-    console.error(stdout);
-    process.exit(1);
-  }
-
-  return [exitStatus, stdout];
-}

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>;
-}