isaacscript 2.0.6 → 2.0.7

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

package/src/commands/publish/publish.ts

@@ -1,392 +0,0 @@
-import chalk from "chalk";
-import path from "path";
-import {
-  CONFIG_FILE_NAME,
-  CONSTANTS_TS_PATH,
-  METADATA_XML_PATH,
-  MOD_SOURCE_PATH,
-  MOD_UPLOADER_PATH,
-  PACKAGE_JSON_PATH,
-  PROJECT_NAME,
-  PUBLISH_POST_COPY_PY_PATH,
-  PUBLISH_PRE_COPY_PY_PATH,
-  VERSION_TXT_PATH,
-} from "../../constants";
-import { execExe, execPowershell, execShell } from "../../exec";
-import * as file from "../../file";
-import { Config } from "../../types/Config";
-import { error, getModTargetDirectoryName, parseIntSafe } from "../../utils";
-import { compileAndCopy } from "../copy/copy";
-import { gitCommitIfChanges, isGitDirty } from "../init/git";
-
-const UPDATE_SCRIPT_NAME = "update.sh";
-
-export function publish(argv: Record<string, unknown>, config: Config): void {
-  const skipVersionIncrement = argv["skip"] === true;
-  const setVersion = argv["setVersion"] as string | undefined;
-  const dryRun = argv["dryRun"] === true;
-  const onlyUpload = argv["onlyUpload"] === true;
-  const verbose = argv["verbose"] === true;
-
-  const modTargetDirectoryName = getModTargetDirectoryName(config);
-  const modTargetPath = path.join(config.modsDirectory, modTargetDirectoryName);
-
-  validateVersion(setVersion);
-  validateGitNotDirty(verbose);
-  validateIsaacScriptOtherCopiesNotRunning(verbose);
-
-  if (onlyUpload) {
-    uploadMod(modTargetPath, config.steamCmdPath, verbose);
-    return;
-  }
-
-  startPublish(
-    MOD_SOURCE_PATH,
-    modTargetPath,
-    skipVersionIncrement,
-    setVersion,
-    config.steamCmdPath,
-    dryRun,
-    verbose,
-  );
-}
-
-function validateVersion(setVersion: string | undefined) {
-  if (setVersion !== undefined && /^\d+\.\d+\.\d+$/.exec(setVersion) === null) {
-    error(
-      chalk.red(
-        `The version of "${setVersion}" does not match the semantic versioning format.`,
-      ),
-    );
-  }
-}
-
-function validateGitNotDirty(verbose: boolean) {
-  if (isGitDirty(verbose)) {
-    error(
-      chalk.red(
-        "Before publishing, you must push your current changes to git. (Version commits should be not contain any code changes.)",
-      ),
-    );
-  }
-}
-
-function validateIsaacScriptOtherCopiesNotRunning(verbose: boolean) {
-  if (process.platform !== "win32") {
-    return;
-  }
-
-  // From: https://securityboulevard.com/2020/01/get-process-list-with-command-line-arguments/
-  const stdout = execPowershell(
-    "Get-WmiObject Win32_Process -Filter \"name = 'node.exe'\" | Select-Object -ExpandProperty CommandLine",
-    verbose,
-  );
-  const lines = stdout.split("\r\n");
-  const otherCopiesOfRunningIsaacScript = lines.filter(
-    (line) =>
-      line.includes("node.exe") &&
-      line.includes("isaacscript") &&
-      !line.includes("isaacscript publish"),
-  );
-  if (otherCopiesOfRunningIsaacScript.length > 0) {
-    error(
-      chalk.red(
-        `Other copies of ${PROJECT_NAME} appear to be running. You must close those copies before publishing.`,
-      ),
-    );
-  }
-}
-
-function startPublish(
-  modSourcePath: string,
-  modTargetPath: string,
-  skipVersionIncrement: boolean,
-  setVersion: string | undefined,
-  steamCmdPath: string | undefined,
-  dryRun: boolean,
-  verbose: boolean,
-) {
-  updateDeps(verbose);
-
-  let version =
-    setVersion === undefined ? getVersionFromPackageJSON(verbose) : setVersion;
-  if (!skipVersionIncrement && setVersion === undefined) {
-    version = bumpVersionInPackageJSON(version, verbose);
-  } else if (setVersion !== undefined) {
-    writeVersionInPackageJSON(version, verbose);
-  }
-
-  writeVersionToConstantsTS(version, verbose);
-  writeVersionToMetadataXML(version, verbose);
-  writeVersionToVersionTXT(version, verbose);
-  runReleaseScriptPreCopy(verbose);
-  compileAndCopy(modSourcePath, modTargetPath, verbose);
-  purgeRoomXMLs(modTargetPath, verbose);
-  runReleaseScriptPostCopy(verbose);
-
-  if (!dryRun) {
-    gitCommitIfChanges(version, verbose);
-    uploadMod(modTargetPath, steamCmdPath, verbose);
-  }
-
-  const dryRunSuffix = dryRun ? " (dry run)" : "";
-  console.log(`\nPublished version ${version} successfully${dryRunSuffix}.`);
-}
-
-function updateDeps(verbose: boolean) {
-  if (!file.exists(UPDATE_SCRIPT_NAME, verbose)) {
-    error(
-      `The "${UPDATE_SCRIPT_NAME}" script does not exist in the current working directory.`,
-    );
-  }
-
-  execShell("bash", [UPDATE_SCRIPT_NAME], verbose);
-}
-
-function getVersionFromPackageJSON(verbose: boolean) {
-  if (!file.exists(PACKAGE_JSON_PATH, verbose)) {
-    error(
-      chalk.red(
-        `A "${PACKAGE_JSON_PATH}" was not found in the current directory.`,
-      ),
-    );
-  }
-
-  const packageJSONRaw = file.read(PACKAGE_JSON_PATH, verbose);
-  let packageJSON: Record<string, unknown>;
-  try {
-    packageJSON = JSON.parse(packageJSONRaw) as Record<string, unknown>;
-  } catch (err) {
-    error(`Failed to parse "${chalk.green(PACKAGE_JSON_PATH)}":`, err);
-  }
-
-  if (!Object.prototype.hasOwnProperty.call(packageJSON, "version")) {
-    error(
-      `The "${chalk.green(
-        PACKAGE_JSON_PATH,
-      )}" file does not have a "version" field.`,
-    );
-  }
-
-  if (typeof packageJSON["version"] !== "string") {
-    error(
-      `The "${chalk.green(
-        PACKAGE_JSON_PATH,
-      )}" file has a "version" field that is not a string.`,
-    );
-  }
-
-  return packageJSON["version"];
-}
-
-function bumpVersionInPackageJSON(version: string, verbose: boolean): string {
-  // Get the patch version (i.e. the third number)
-  const matches = /(\d+\.\d+\.)(\d+)/.exec(version);
-  if (matches === null) {
-    error(`Failed to parse the version of: ${version}`);
-  }
-
-  const versionPrefix = matches[1];
-  if (versionPrefix === undefined) {
-    error(`Failed to parse the first part of the version: ${version}`);
-  }
-
-  const patchVersionString = matches[2];
-  if (patchVersionString === undefined) {
-    error(`Failed to parse the second part of the version: ${version}`);
-  }
-
-  const patchVersion = parseIntSafe(patchVersionString);
-  if (Number.isNaN(patchVersion)) {
-    error(`Failed to convert "${patchVersionString}" to a number.`);
-  }
-
-  const incrementedPatchVersion = patchVersion + 1;
-  const incrementedVersion = `${versionPrefix}${incrementedPatchVersion}`;
-
-  const packageJSON = file.read(PACKAGE_JSON_PATH, verbose);
-  const newPackageJSON = packageJSON.replace(
-    /"version": ".+",/,
-    `"version": "${incrementedVersion}",`,
-  );
-  file.write(PACKAGE_JSON_PATH, newPackageJSON, verbose);
-
-  console.log(
-    `The version of ${incrementedVersion} was written to: ${PACKAGE_JSON_PATH}`,
-  );
-
-  return incrementedVersion;
-}
-
-function writeVersionInPackageJSON(version: string, verbose: boolean) {
-  const packageJSON = file.read(PACKAGE_JSON_PATH, verbose);
-  const newPackageJSON = packageJSON.replace(
-    /"version": ".+",/,
-    `"version": "${version}",`,
-  );
-  file.write(PACKAGE_JSON_PATH, newPackageJSON, verbose);
-
-  console.log(`The version of ${version} was written to: ${PACKAGE_JSON_PATH}`);
-}
-
-function writeVersionToConstantsTS(version: string, verbose: boolean) {
-  if (!file.exists(CONSTANTS_TS_PATH, verbose)) {
-    console.log(
-      'Skipping writing the version to "constants.ts" since it was not found.',
-    );
-    return;
-  }
-
-  const constantsTS = file.read(CONSTANTS_TS_PATH, verbose);
-  const newConstantsTS = constantsTS.replace(
-    /const VERSION = ".+"/,
-    `const VERSION = "${version}"`,
-  );
-  file.write(CONSTANTS_TS_PATH, newConstantsTS, verbose);
-
-  console.log(`The version of ${version} was written to: ${CONSTANTS_TS_PATH}`);
-}
-
-function writeVersionToMetadataXML(version: string, verbose: boolean) {
-  const metadataXML = file.read(METADATA_XML_PATH, verbose);
-  const newMetadataXML = metadataXML.replace(
-    /<version>.+<\/version>/,
-    `<version>${version}</version>`,
-  );
-  file.write(METADATA_XML_PATH, newMetadataXML, verbose);
-
-  console.log(`The version of ${version} was written to: ${METADATA_XML_PATH}`);
-}
-
-function writeVersionToVersionTXT(version: string, verbose: boolean) {
-  file.write(VERSION_TXT_PATH, version, verbose);
-
-  console.log(`The version of ${version} was written to: ${VERSION_TXT_PATH}`);
-}
-
-function runReleaseScriptPreCopy(verbose: boolean) {
-  if (!file.exists(PUBLISH_PRE_COPY_PY_PATH, verbose)) {
-    return;
-  }
-
-  console.log(`Running the "${PUBLISH_PRE_COPY_PY_PATH}" script.`);
-  let [, stdout] = execShell("python", [PUBLISH_PRE_COPY_PY_PATH], verbose);
-  stdout = stdout.trim();
-  if (stdout.length > 0) {
-    console.log(stdout);
-  }
-}
-
-function runReleaseScriptPostCopy(verbose: boolean) {
-  if (!file.exists(PUBLISH_POST_COPY_PY_PATH, verbose)) {
-    return;
-  }
-
-  console.log(`Running the "${PUBLISH_POST_COPY_PY_PATH}" script.`);
-  let [, stdout] = execShell("python", [PUBLISH_POST_COPY_PY_PATH], verbose);
-  stdout = stdout.trim();
-  if (stdout.length > 0) {
-    console.log(stdout);
-  }
-}
-
-function purgeRoomXMLs(modTargetPath: string, verbose: boolean) {
-  const roomsPath = path.join(modTargetPath, "resources", "rooms");
-  if (!file.exists(roomsPath, verbose) || !file.isDir(roomsPath, verbose)) {
-    return;
-  }
-
-  const roomFileList = file.getDirList(roomsPath, verbose);
-  roomFileList.forEach((fileName: string) => {
-    if (path.extname(fileName) === ".xml") {
-      const roomFilePath = path.join(roomsPath, fileName);
-      file.deleteFileOrDirectory(roomFilePath, verbose);
-    }
-  });
-}
-
-function uploadMod(
-  modTargetPath: string,
-  steamCmdPath: string | undefined,
-  verbose: boolean,
-) {
-  if (steamCmdPath === undefined) {
-    console.log(
-      `The "steamCmdPath" property was not found in the "${chalk.green(
-        CONFIG_FILE_NAME,
-      )}" file; assuming that we want to use the ModUploader tool.`,
-    );
-    execExe(MOD_UPLOADER_PATH, verbose, modTargetPath);
-  } else {
-    runSteamCmd(modTargetPath, steamCmdPath, verbose);
-  }
-}
-
-function runSteamCmd(
-  modTargetPath: string,
-  steamCmdPath: string,
-  verbose: boolean,
-) {
-  if (!file.exists(steamCmdPath, verbose)) {
-    error(
-      chalk.red(
-        `The path provided for "steamCmdPath" is "${steamCmdPath}", but that does not exist.`,
-      ),
-    );
-  }
-
-  const metadataVDFPath = path.join(modTargetPath, "metadata.vdf");
-  if (!file.exists(metadataVDFPath, verbose)) {
-    console.error(
-      chalk.red(
-        `A "metadata.vdf" file was not found in your mod directory. You must create this file in order for "steamcmd.exe" to work. Please see the ${PROJECT_NAME} docs:`,
-      ),
-    );
-    error(getIsaacScriptDocs());
-  }
-
-  const usernameVar = "STEAM_USERNAME";
-  const username = process.env[usernameVar];
-  if (username === undefined || username === "") {
-    console.error(
-      chalk.red(
-        `Failed to read the "${usernameVar}" environment variable from the ".env" file. Please see the ${PROJECT_NAME} docs:`,
-      ),
-    );
-    error(getIsaacScriptDocs());
-  }
-
-  const passwordVar = "STEAM_PASSWORD";
-  const password = process.env[passwordVar];
-  if (password === undefined || password === "") {
-    console.error(
-      chalk.red(
-        `Failed to read the "${passwordVar}" environment variable from the ".env" file. Please see the ${PROJECT_NAME} docs:`,
-      ),
-    );
-    error(getIsaacScriptDocs());
-  }
-
-  console.log("Uploading the mod to the Steam Workshop...");
-
-  execShell(
-    steamCmdPath,
-    [
-      "+login",
-      username,
-      password,
-      "+workshop_build_item",
-      metadataVDFPath,
-      "+quit",
-    ],
-    verbose,
-  );
-
-  console.log("Mod uploaded successfully.");
-}
-
-function getIsaacScriptDocs() {
-  return chalk.red(
-    "https://isaacscript.github.io/docs/publishing-to-the-workshop/#metadatavdf",
-  );
-}

package/src/configFile.ts

@@ -1,80 +0,0 @@
-import chalk from "chalk";
-import * as JSONC from "jsonc-parser";
-import path from "path";
-import { getModsDir } from "./commands/init/getModsDir";
-import { promptSaveSlot } from "./commands/init/promptSaveSlot";
-import { CONFIG_FILE_NAME, CONFIG_FILE_PATH, CWD } from "./constants";
-import * as file from "./file";
-import { Config } from "./types/Config";
-import { error } from "./utils";
-
-export async function get(argv: Record<string, unknown>): Promise<Config> {
-  const verbose = argv["verbose"] === true;
-  const yes = argv["yes"] === true;
-
-  const existingConfig = readExistingConfig(verbose);
-  if (existingConfig !== undefined) {
-    return existingConfig;
-  }
-
-  // No config file exists, so prompt the user for some information and create one
-  const modsDirectory = await getModsDir(argv, verbose);
-  const saveSlot = await promptSaveSlot(argv, yes);
-  const config = createObject(modsDirectory, saveSlot);
-  createFile(CWD, config, verbose);
-
-  return config;
-}
-
-function readExistingConfig(verbose: boolean): Config | undefined {
-  if (!file.exists(CONFIG_FILE_PATH, verbose)) {
-    return undefined;
-  }
-
-  const configRaw = file.read(CONFIG_FILE_PATH, verbose);
-  let config: Config;
-  try {
-    config = JSONC.parse(configRaw) as Config;
-  } catch (err) {
-    error(`Failed to parse the "${chalk.green(CONFIG_FILE_PATH)}" file:`, err);
-  }
-
-  if (config.modsDirectory === undefined) {
-    errorMissing(
-      "modsDirectory",
-      "This should be equal to the directory where Isaac mods live on your system.",
-    );
-  }
-
-  if (config.saveSlot === undefined) {
-    errorMissing(
-      "saveSlot",
-      "This should be equal to the save slot that you test your mods on.",
-    );
-  }
-
-  return config;
-}
-
-function errorMissing(field: string, description: string) {
-  error(
-    `The "${CONFIG_FILE_NAME}" file is missing a "${field}" value. ${description} Please add it.`,
-  );
-}
-
-export function createObject(modsDirectory: string, saveSlot: number): Config {
-  return {
-    modsDirectory,
-    saveSlot,
-  };
-}
-
-export function createFile(
-  projectPath: string,
-  config: Config,
-  verbose: boolean,
-): void {
-  const configFilePath = path.join(projectPath, CONFIG_FILE_NAME);
-  const configContents = JSON.stringify(config, null, 2);
-  file.write(configFilePath, configContents, verbose);
-}