isaacscript 2.0.4 → 2.0.7

package/src/commands/init/init.ts

@@ -1,93 +0,0 @@
-import chalk from "chalk";
-import commandExists from "command-exists";
-import path from "path";
-import { CWD, PROJECT_NAME } from "../../constants";
-import { checkIfProjectPathExists } from "./checkIfProjectPathExists";
-import { checkModSubdirectory } from "./checkModSubdirectory";
-import { checkModTargetDirectory } from "./checkModTargetDirectory";
-import { createMod } from "./createMod";
-import { getModsDir } from "./getModsDir";
-import { getProjectPath } from "./getProjectPath";
-import { promptGitHubRepoOrGitRemoteURL } from "./git";
-import { installVSCodeExtensions } from "./installVSCodeExtensions";
-import { promptSaveSlot } from "./promptSaveSlot";
-import { promptVSCode } from "./promptVSCode";
-
-export async function init(argv: Record<string, unknown>): Promise<void> {
-  const skipNPMInstall = argv["skipNpmInstall"] === true;
-  const useCurrentDir = argv["useCurrentDir"] === true;
-  const verbose = argv["verbose"] === true;
-  const vscode = argv["vscode"] === true;
-  const yes = argv["yes"] === true;
-  const forceName = argv["forceName"] === true;
-
-  // Prompt the end-user for some information (and validate it as we go)
-  const [projectPath, createNewDir] = await getProjectPath(
-    argv,
-    useCurrentDir,
-    yes,
-    forceName,
-  );
-  await checkIfProjectPathExists(projectPath, yes, verbose);
-  const modsDirectory = await getModsDir(argv, verbose);
-  checkModSubdirectory(projectPath, modsDirectory);
-  const projectName = path.basename(projectPath);
-  await checkModTargetDirectory(modsDirectory, projectName, yes, verbose);
-  const saveSlot = await promptSaveSlot(argv, yes);
-  const gitRemoteURL = await promptGitHubRepoOrGitRemoteURL(
-    projectName,
-    yes,
-    verbose,
-  );
-
-  // Now that we have asked the user all of the questions we need, we can create the project
-  createMod(
-    projectName,
-    projectPath,
-    createNewDir,
-    modsDirectory,
-    saveSlot,
-    gitRemoteURL,
-    skipNPMInstall,
-    verbose,
-  );
-
-  await openVSCode(projectPath, vscode, verbose);
-  printFinishMessage(projectPath, projectName);
-}
-
-async function openVSCode(
-  projectPath: string,
-  vscode: boolean,
-  verbose: boolean,
-) {
-  const VSCodeCommand = getVSCodeCommand();
-  if (VSCodeCommand === null) {
-    console.log(
-      'VSCode does not seem to be installed. (The "code" command is not in the path.) Skipping VSCode-related things.',
-    );
-    return;
-  }
-
-  installVSCodeExtensions(projectPath, VSCodeCommand, verbose);
-  await promptVSCode(projectPath, VSCodeCommand, vscode, verbose);
-}
-
-function getVSCodeCommand() {
-  for (const VSCodeCommand of ["code", "codium", "code-oss", "code-insiders"]) {
-    if (commandExists.sync(VSCodeCommand)) {
-      return VSCodeCommand;
-    }
-  }
-
-  return null;
-}
-
-function printFinishMessage(projectPath: string, projectName: string) {
-  let commandsToType = "";
-  if (projectPath !== CWD) {
-    commandsToType += `"${chalk.green(`cd ${projectName}`)}" and `;
-  }
-  commandsToType += `"${chalk.green("npx isaacscript")}"`;
-  console.log(`Now, start ${PROJECT_NAME} by typing ${commandsToType}.`);
-}

package/src/commands/init/installVSCodeExtensions.ts

@@ -1,47 +0,0 @@
-import chalk from "chalk";
-import * as JSONC from "jsonc-parser";
-import path from "path";
-import { execShell } from "../../exec";
-import * as file from "../../file";
-import { error } from "../../utils";
-
-export function installVSCodeExtensions(
-  projectPath: string,
-  VSCodeCommand: string,
-  verbose: boolean,
-): void {
-  const extensions = getExtensionsFromJSON(projectPath, verbose);
-  for (const extensionName of extensions) {
-    execShell(VSCodeCommand, ["--install-extension", extensionName], verbose);
-  }
-}
-
-interface ExtensionsJSON {
-  recommendations: string[];
-}
-
-function getExtensionsFromJSON(projectPath: string, verbose: boolean) {
-  const extensionsJSONPath = path.join(
-    projectPath,
-    ".vscode",
-    "extensions.json",
-  );
-
-  if (!file.exists(extensionsJSONPath, verbose)) {
-    return [];
-  }
-
-  const extensionsJSONRaw = file.read(extensionsJSONPath, verbose);
-
-  let extensionsJSON: ExtensionsJSON;
-  try {
-    extensionsJSON = JSONC.parse(extensionsJSONRaw) as ExtensionsJSON;
-  } catch (err) {
-    error(
-      `Failed to parse the "${chalk.green(extensionsJSONPath)}" file:`,
-      err,
-    );
-  }
-
-  return extensionsJSON.recommendations;
-}

package/src/commands/init/promptSaveSlot.ts

@@ -1,27 +0,0 @@
-import { getInputInt } from "../../prompt";
-import { error } from "../../utils";
-
-export async function promptSaveSlot(
-  argv: Record<string, unknown>,
-  yes: boolean,
-): Promise<number> {
-  if (argv["saveSlot"] !== undefined) {
-    // They specified the "--save-slot" command-line flag, so there is no need to prompt the user
-    // for it.
-    return argv["saveSlot"] as number; // yargs converts this to a number
-  }
-
-  if (yes) {
-    return 1;
-  }
-
-  const saveSlot = await getInputInt(
-    "In-game, will you test your mod on save slot 1, 2, or 3?",
-  );
-
-  if (saveSlot !== 1 && saveSlot !== 2 && saveSlot !== 3) {
-    error("Error: You must choose a number between 1 and 3.");
-  }
-
-  return saveSlot;
-}

package/src/commands/init/promptVSCode.ts

@@ -1,33 +0,0 @@
-import path from "path";
-import { MAIN_TS } from "../../constants";
-import { execShell } from "../../exec";
-import { getInputYesNo } from "../../prompt";
-
-export async function promptVSCode(
-  projectPath: string,
-  VSCodeCommand: string,
-  vscode: boolean,
-  verbose: boolean,
-): Promise<void> {
-  if (vscode) {
-    // They supplied the "--vscode" command-line flag, so there is no need to prompt the user.
-    openVSCode(projectPath, VSCodeCommand, verbose);
-    return;
-  }
-
-  const shouldOpenVSCode = await getInputYesNo(
-    "Do you want to open your new project in VSCode now?",
-  );
-  if (shouldOpenVSCode) {
-    openVSCode(projectPath, VSCodeCommand, verbose);
-  }
-}
-
-function openVSCode(
-  projectPath: string,
-  VSCodeCommand: string,
-  verbose: boolean,
-) {
-  const MAIN_TS_PATH = path.join(projectPath, "src", MAIN_TS);
-  execShell(VSCodeCommand, [projectPath, MAIN_TS_PATH], verbose);
-}

package/src/commands/monitor/copyWatcherMod.ts

@@ -1,54 +0,0 @@
-import path from "path";
-import {
-  DISABLE_IT_FILE,
-  MAIN_LUA,
-  WATCHER_MOD_NAME,
-  WATCHER_MOD_SOURCE_PATH,
-} from "../../constants";
-import * as file from "../../file";
-import { Config } from "../../types/Config";
-
-export function copyWatcherMod(config: Config, verbose: boolean): void {
-  // Check to see if this mod was disabled.
-  const watcherModPath = path.join(config.modsDirectory, WATCHER_MOD_NAME);
-  const disableItPath = path.join(watcherModPath, DISABLE_IT_FILE);
-  const watcherModDisabled = file.exists(disableItPath, verbose);
-
-  // Delete and re-copy the watcher mod every time IsaacScript starts. This ensures that it is
-  // always the latest version.
-  if (file.exists(watcherModPath, verbose)) {
-    file.deleteFileOrDirectory(watcherModPath, verbose);
-  }
-
-  file.copy(WATCHER_MOD_SOURCE_PATH, watcherModPath, verbose);
-
-  if (watcherModDisabled) {
-    // Since we deleted the directory, the "disable.it" file was deleted. Restore it.
-    file.write(disableItPath, "", verbose);
-  }
-
-  // By default, the IsaacScript watcher mod automatically restarts the game, so we only need to
-  // disable it if the config option is explicitly set to false.
-  if (config.enableIsaacScriptWatcherAutoRestart === false) {
-    disableIsaacScriptWatcherAutomaticRestart(watcherModPath, verbose);
-  }
-
-  // If we copied a new version of the watcher mod into place, but the user currently has the game
-  // open, then the old version will stay loaded. However, if the watcher mod reloads itself, the
-  // game will crash, so there is no automated solution for this.
-}
-
-function disableIsaacScriptWatcherAutomaticRestart(
-  watcherModPath: string,
-  verbose: boolean,
-) {
-  const mainLuaPath = path.join(watcherModPath, MAIN_LUA);
-  const mainLua = file.read(mainLuaPath, verbose);
-
-  const modifiedMainLua = mainLua.replace(
-    "local RESTART_GAME_ON_RECOMPILATION = true",
-    "local RESTART_GAME_ON_RECOMPILATION = false",
-  );
-
-  file.write(mainLuaPath, modifiedMainLua, verbose);
-}

package/src/commands/monitor/modDirectorySyncer/modDirectorySyncer.ts

@@ -1,67 +0,0 @@
-import syncDirectory from "sync-directory";
-import { FILE_SYNCED_MESSAGE } from "../../../constants";
-
-const SUBPROCESS_NAME = "directory syncer";
-const BASE_ARGV_LENGTH = 2;
-
-let modSourcePath: string;
-let modTargetPath: string;
-
-init();
-
-function init() {
-  const firstArg = process.argv[BASE_ARGV_LENGTH];
-  if (firstArg === undefined) {
-    throw new Error(
-      `The ${SUBPROCESS_NAME} process did not get a valid first argument.`,
-    );
-  }
-
-  const secondArg = process.argv[BASE_ARGV_LENGTH + 1];
-  if (secondArg === undefined) {
-    throw new Error(
-      `The ${SUBPROCESS_NAME} process did not get the right amount of arguments.`,
-    );
-  }
-
-  modSourcePath = firstArg;
-  modTargetPath = secondArg;
-
-  syncDirectory(modSourcePath, modTargetPath, {
-    watch: true,
-    type: "copy",
-    afterEachSync,
-    onError,
-    chokidarWatchOptions: {
-      awaitWriteFinish: {
-        stabilityThreshold: 1000,
-      },
-    },
-  });
-}
-
-function afterEachSync(params?: {
-  eventType: string;
-  nodeType: string;
-  relativePath: string;
-  srcPath: string;
-  targetPath: string;
-}) {
-  if (params === undefined) {
-    return;
-  }
-
-  if (params.eventType !== "init:copy") {
-    send(`${FILE_SYNCED_MESSAGE} ${params.relativePath}`);
-  }
-}
-
-function onError(err: Error) {
-  send(`The directory syncer encountered an error: ${err}`);
-}
-
-function send(msg: string) {
-  if (process.send !== undefined) {
-    process.send(msg);
-  }
-}

package/src/commands/monitor/monitor.ts

@@ -1,180 +0,0 @@
-import chalk from "chalk";
-import { fork, spawn } from "child_process";
-import * as JSONC from "jsonc-parser";
-import path from "path";
-import {
-  CWD,
-  FILE_SYNCED_MESSAGE,
-  MAIN_LUA,
-  MOD_SOURCE_PATH,
-  PROJECT_NAME,
-  TSCONFIG_PATH,
-} from "../../constants";
-import * as file from "../../file";
-import { Config } from "../../types/Config";
-import { error, getModTargetDirectoryName } from "../../utils";
-import { copyWatcherMod } from "./copyWatcherMod";
-import * as notifyGame from "./notifyGame";
-import { spawnSaveDatWriter } from "./spawnSaveDatWriter";
-import { touchWatcherSaveDatFiles } from "./touchWatcherSaveDatFiles";
-
-export function monitor(argv: Record<string, unknown>, config: Config): void {
-  const verbose = argv["verbose"] === true;
-
-  // If they specified some command-line flags, override the values found in the config file
-  if (argv["modsDirectory"] !== undefined) {
-    config.modsDirectory = argv["modsDirectory"] as string; // eslint-disable-line no-param-reassign
-  }
-  if (argv["saveSlot"] !== undefined) {
-    config.saveSlot = argv["saveSlot"] as number; // eslint-disable-line no-param-reassign
-  }
-
-  // Read the "tsconfig.json" file
-  const tsConfigInclude = getFirstTSConfigIncludePath(verbose);
-  const resolvedIncludePath = path.resolve(CWD, tsConfigInclude);
-  const modTargetDirectoryName = getModTargetDirectoryName(config);
-  const modTargetPath = path.join(config.modsDirectory, modTargetDirectoryName);
-
-  // Prepare the IsaacScript watcher mod
-  copyWatcherMod(config, verbose);
-  touchWatcherSaveDatFiles(config, verbose);
-
-  // Delete and re-copy the mod every time IsaacScript starts. This ensures that it is always the
-  // latest version.
-  if (file.exists(modTargetPath, verbose)) {
-    file.deleteFileOrDirectory(modTargetPath, true);
-  }
-
-  // Subprocess #1 - The "save#.dat" file writer
-  spawnSaveDatWriter(config);
-
-  // Subprocess #2 - The mod directory syncer
-  spawnModDirectorySyncer(config);
-
-  // Subprocess #3 - tstl --watch (to automatically convert TypeScript to Lua)
-  spawnTSTLWatcher();
-
-  // Also, start constantly pinging the watcher mod
-  setInterval(() => {
-    notifyGame.ping();
-  }, 1000); // Every second
-
-  console.log("Automatically monitoring the following for changes:");
-  console.log(
-    `1) your TypeScript code:     ${chalk.green(resolvedIncludePath)}`,
-  );
-  console.log(`2) the source mod directory: ${chalk.green(MOD_SOURCE_PATH)}`);
-  console.log("");
-  console.log(`Copying files to:            ${chalk.green(modTargetPath)}`);
-  console.log("");
-  // (the process will now continue indefinitely for as long as the subprocesses exist)
-}
-
-function spawnModDirectorySyncer(config: Config) {
-  const processName = "modDirectorySyncer";
-  const processDescription = "Directory syncer";
-  const processPath = path.join(__dirname, processName, processName);
-  const modTargetName = getModTargetDirectoryName(config);
-  const modTargetPath = path.join(config.modsDirectory, modTargetName);
-  const directorySycner = fork(processPath, [MOD_SOURCE_PATH, modTargetPath]);
-
-  directorySycner.on("message", (msg: string) => {
-    notifyGame.msg(msg);
-
-    // If the "main.lua" file was successfully copied over, we also have to tell isaacscript-watcher
-    // to reload the mod. Look for something like: "File synced: \main.lua"
-    if (msg === `${FILE_SYNCED_MESSAGE} ${path.sep}${MAIN_LUA}`) {
-      notifyGame.command(`luamod ${modTargetName}`);
-      notifyGame.command("restart");
-      notifyGame.msg("Reloaded the mod.");
-    }
-  });
-
-  directorySycner.on("close", (code: number | null) => {
-    error(`Error: ${processDescription} subprocess closed with code: ${code}`);
-  });
-
-  directorySycner.on("exit", (code: number | null) => {
-    error(`Error: ${processDescription} subprocess exited with code: ${code}`);
-  });
-}
-
-function spawnTSTLWatcher() {
-  const processDescription = "tstl";
-  const tstl = spawn("npx", ["tstl", "--watch", "--preserveWatchOutput"], {
-    shell: true,
-  });
-
-  tstl.stdout.on("data", (data: Buffer[]) => {
-    const msg = data.toString().trim();
-    if (msg.includes("Starting compilation in watch mode...")) {
-      const newMsg = `${PROJECT_NAME} is now watching for changes.`;
-      notifyGame.msg(newMsg);
-    } else if (
-      msg.includes("File change detected. Starting incremental compilation...")
-    ) {
-      const newMsg = "TypeScript change detected. Compiling...";
-      notifyGame.msg(newMsg);
-    } else if (msg.includes("Found 0 errors. Watching for file changes.")) {
-      const newMsg = "Compilation successful.";
-      notifyGame.msg(newMsg);
-    } else {
-      notifyGame.msg(msg);
-    }
-  });
-
-  tstl.stderr.on("data", (data: Buffer[]) => {
-    const msg = data.toString().trim();
-    if (msg === "^C") {
-      // Hide the line that appears when you cancel the program with Ctrl + c
-      return;
-    }
-    notifyGame.msg(`Error: ${msg}`);
-  });
-
-  tstl.on("close", (code) => {
-    error(`Error: ${processDescription} subprocess exited with code: ${code}`);
-  });
-
-  tstl.on("exit", (code) => {
-    error(`Error: ${processDescription} subprocess exited with code: ${code}`);
-  });
-}
-
-function getFirstTSConfigIncludePath(verbose: boolean): string {
-  const tsConfigRaw = file.read(TSCONFIG_PATH, verbose);
-  let tsConfig: Record<string, string[]>;
-  try {
-    tsConfig = JSONC.parse(tsConfigRaw) as Record<string, string[]>;
-  } catch (err) {
-    error(`Failed to parse "${chalk.green(TSCONFIG_PATH)}":`, err);
-  }
-
-  const include = tsConfig["include"];
-  if (include === undefined) {
-    error(
-      `Your "${chalk.green(
-        TSCONFIG_PATH,
-      )}" file does not have an "include" property, which is surely a mistake. Delete the file and re-run ${PROJECT_NAME}.`,
-    );
-  }
-
-  if (!Array.isArray(include)) {
-    error(
-      `Your "${chalk.green(
-        TSCONFIG_PATH,
-      )}" file has an "include" property that is not an array, which is surely a mistake. Delete the file and re-run ${PROJECT_NAME}.`,
-    );
-  }
-
-  const firstInclude = include[0];
-  if (firstInclude === undefined) {
-    error(
-      `Your "${chalk.green(
-        TSCONFIG_PATH,
-      )}" file has an empty "include" property, which is surely a mistake. Delete the file and re-run ${PROJECT_NAME}.`,
-    );
-  }
-
-  return firstInclude;
-}

package/src/commands/monitor/notifyGame.ts

@@ -1,59 +0,0 @@
-import chalk from "chalk";
-import { getTime } from "../../utils";
-import { sendMsgToSaveDatWriter } from "./spawnSaveDatWriter";
-
-export function msg(data: string): void {
-  const formattedData = data
-    .replace(/\r\n/g, "\n") // Replace Windows newlines with Unix newlines
-    .trim(); // Trim whitespace
-
-  for (const line of formattedData.split("\n")) {
-    const trimmedLine = line.trim();
-    if (trimmedLine === "") {
-      continue;
-    }
-
-    // Ignore the final message from tstl upon exiting the program.
-    if (trimmedLine === "Terminate batch job (Y/N)?") {
-      return;
-    }
-
-    // Add a time prefix.
-    const formattedLine = `[${getTime()}] ${trimmedLine}`;
-
-    sendMsgToSaveDatWriter({
-      type: "msg",
-      data: formattedLine,
-    });
-
-    // We also print the message to standard out so that the end-user can choose between reading
-    // tstl errors from the IsaacScript terminal window or from looking at the in-game output.
-    printMsgToStandardOut(formattedLine);
-  }
-}
-
-function printMsgToStandardOut(data: string) {
-  let coloredData = data;
-
-  if (data.match(/Compilation successful./g) !== null) {
-    coloredData = chalk.green(data);
-  } else if (data.match(/error/g) !== null) {
-    coloredData = chalk.red(data);
-  }
-
-  console.log(coloredData);
-}
-
-export function command(data: string): void {
-  sendMsgToSaveDatWriter({
-    type: "command",
-    data,
-  });
-}
-
-export function ping(): void {
-  sendMsgToSaveDatWriter({
-    type: "ping",
-    data: "",
-  });
-}