isaacscript 2.0.6 → 2.0.9

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 directorySyncer = fork(processPath, [MOD_SOURCE_PATH, modTargetPath]);
-
-  directorySyncer.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.");
-    }
-  });
-
-  directorySyncer.on("close", (code: number | null) => {
-    error(`Error: ${processDescription} subprocess closed with code: ${code}`);
-  });
-
-  directorySyncer.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: "",
-  });
-}

package/src/commands/monitor/saveDatWriter/saveDatWriter.ts

@@ -1,145 +0,0 @@
-import * as JSONC from "jsonc-parser";
-import path from "path";
-import { PROJECT_NAME } from "../../../constants";
-import * as file from "../../../file";
-import { ensureAllCases } from "../../../utils";
-import { SaveDatMessage, SaveDatMessageType } from "./types";
-
-const SUBPROCESS_NAME = "save#.dat writer";
-const BASE_ARGV_LENGTH = 2;
-const MAX_MESSAGES = 100;
-const VERBOSE = false;
-
-let saveDatPath: string;
-let saveDatFileName: string;
-
-init(VERBOSE);
-
-function init(verbose: boolean) {
-  const firstArg = process.argv[BASE_ARGV_LENGTH];
-  if (firstArg === undefined) {
-    throw new Error(
-      `The ${SUBPROCESS_NAME} process did not get a valid first argument.`,
-    );
-  }
-
-  saveDatPath = firstArg;
-  saveDatFileName = path.basename(saveDatPath);
-
-  // Check to see if the data directory exists
-  const watcherModDataPath = path.dirname(saveDatPath);
-  if (!file.exists(watcherModDataPath, verbose)) {
-    file.makeDir(watcherModDataPath, verbose);
-  }
-
-  // Listen for messages from the parent process
-  process.on("message", (msg: SaveDatMessage) => {
-    onMessage(msg.type, msg.data);
-  });
-}
-
-function onMessage(type: SaveDatMessageType, data: string, numRetries = 0) {
-  const saveDat = readSaveDatFromDisk(VERBOSE);
-  if (saveDat.length > MAX_MESSAGES) {
-    // If IsaacScript is running and:
-    // - the game is not open
-    // - or the game is open but the IsaacScript Watcher mod is disabled
-    //
-    // Then this process will continue to write to the "save#.dat" file, which can cause it to grow
-    // arbitrarily large (since there is no-one on the other side removing the messages). If there
-    // is N messages already in the queue, assume that no-one is listening and stop adding any more
-    // messages.
-    return;
-  }
-  addMessageToSaveDat(type, saveDat, data); // Mutates saveDat
-  writeSaveDatToDisk(type, data, saveDat, numRetries, VERBOSE);
-}
-
-function readSaveDatFromDisk(verbose: boolean) {
-  let saveDat: SaveDatMessage[];
-  if (file.exists(saveDatPath, verbose)) {
-    const saveDatRaw = file.read(saveDatPath, verbose);
-    try {
-      saveDat = JSONC.parse(saveDatRaw) as SaveDatMessage[];
-    } catch (err) {
-      send(`Failed to parse "${saveDatPath}": ${err}`);
-      process.exit(1);
-    }
-  } else {
-    saveDat = [];
-  }
-  if (!Array.isArray(saveDat)) {
-    saveDat = [];
-  }
-
-  return saveDat;
-}
-
-function addMessageToSaveDat(
-  type: SaveDatMessageType,
-  saveDat: SaveDatMessage[],
-  data: string,
-) {
-  switch (type) {
-    case "command":
-    case "ping": {
-      saveDat.push({
-        type,
-        data,
-      });
-
-      break;
-    }
-
-    case "msg": {
-      const lines = data.split("\n");
-      for (const line of lines) {
-        saveDat.push({
-          type,
-          data: line,
-        });
-      }
-
-      break;
-    }
-
-    default: {
-      ensureAllCases(type);
-      break;
-    }
-  }
-}
-
-function writeSaveDatToDisk(
-  type: SaveDatMessageType,
-  data: string,
-  saveDat: SaveDatMessage[],
-  numRetries: number,
-  verbose: boolean,
-) {
-  const saveDatRaw = JSON.stringify(saveDat, null, 2);
-  try {
-    file.writeTry(saveDatPath, saveDatRaw, verbose);
-  } catch (err) {
-    if (numRetries > 4) {
-      send(
-        `Failed to write to the ${saveDatFileName} for 5 times in a row. Maybe the file got locked somehow. ${PROJECT_NAME} will now exit.`,
-      );
-      send(`The writing error is as follows: ${err}`);
-      process.exit(1);
-    }
-
-    send(
-      `Writing to "${saveDatFileName}" failed. (The number of retries so far is ${numRetries}.) Trying again in 0.1 seconds...`,
-    );
-    setTimeout(() => {
-      onMessage(type, data, numRetries + 1);
-    }, 100);
-  }
-}
-
-function send(msg: string) {
-  if (process.send !== undefined) {
-    process.send(msg);
-  }
-}

package/src/commands/monitor/saveDatWriter/types.ts

@@ -1,6 +0,0 @@
-export type SaveDatMessageType = "command" | "msg" | "ping";
-
-export interface SaveDatMessage {
-  type: SaveDatMessageType;
-  data: string;
-}

package/src/commands/monitor/spawnSaveDatWriter.ts

@@ -1,36 +0,0 @@
-import { ChildProcess, fork } from "child_process";
-import path from "path";
-import { WATCHER_MOD_NAME } from "../../constants";
-import { Config } from "../../types/Config";
-import { error } from "../../utils";
-import { SaveDatMessage } from "./saveDatWriter/types";
-
-let saveDatWriter: ChildProcess | null = null;
-
-export function spawnSaveDatWriter(config: Config): void {
-  const processName = "saveDatWriter";
-  const processDescription = "save#.dat writer";
-  const processPath = path.join(__dirname, processName, processName);
-  const modsDataPath = path.join(config.modsDirectory, "..", "data");
-  const watcherModDataPath = path.join(modsDataPath, WATCHER_MOD_NAME);
-  const saveDatFileName = `save${config.saveSlot}.dat`;
-  const saveDatPath = path.join(watcherModDataPath, saveDatFileName);
-
-  saveDatWriter = fork(processPath, [saveDatPath], {
-    stdio: ["pipe", "pipe", "pipe", "ipc"],
-  });
-
-  saveDatWriter.on("close", (code: number | null) => {
-    error(`Error: ${processDescription} subprocess closed with code: ${code}`);
-  });
-
-  saveDatWriter.on("exit", (code: number | null) => {
-    error(`Error: ${processDescription} subprocess exited with code: ${code}`);
-  });
-}
-
-export function sendMsgToSaveDatWriter(msg: SaveDatMessage): void {
-  if (saveDatWriter !== null) {
-    saveDatWriter.send(msg);
-  }
-}

package/src/commands/monitor/touchWatcherSaveDatFiles.ts

@@ -1,20 +0,0 @@
-import path from "path";
-import { WATCHER_MOD_NAME } from "../../constants";
-import * as file from "../../file";
-import { Config } from "../../types/Config";
-
-export function touchWatcherSaveDatFiles(
-  config: Config,
-  verbose: boolean,
-): void {
-  const modsDataPath = path.join(config.modsDirectory, "..", "data");
-  const watcherModDataPath = path.join(modsDataPath, WATCHER_MOD_NAME);
-  if (!file.exists(watcherModDataPath, verbose)) {
-    file.makeDir(watcherModDataPath, verbose);
-  }
-  const saveDatFileName = `save${config.saveSlot}.dat`;
-  const saveDatPath = path.join(watcherModDataPath, saveDatFileName);
-  if (!file.exists(saveDatPath, verbose)) {
-    file.touch(saveDatPath, verbose);
-  }
-}