isaacscript 1.2.45 → 2.0.2

package/src/commands/monitor/copyWatcherMod.ts

@@ -9,13 +9,13 @@ 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
+  // 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
+  // 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);
   }
@@ -23,21 +23,19 @@ export function copyWatcherMod(config: Config, verbose: boolean): void {
   file.copy(WATCHER_MOD_SOURCE_PATH, watcherModPath, verbose);
 
   if (watcherModDisabled) {
-    // Since we deleted the directory, the "disable.it" file was deleted
-    // Restore it
+    // 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
+  // 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
+  // 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(

package/src/commands/monitor/monitor.ts

@@ -39,8 +39,8 @@ export function monitor(argv: Record<string, unknown>, config: Config): void {
   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
+  // 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);
   }
@@ -82,8 +82,7 @@ function spawnModDirectorySyncer(config: Config) {
     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"
+    // 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");

package/src/commands/monitor/notifyGame.ts

@@ -13,12 +13,12 @@ export function msg(data: string): void {
       continue;
     }
 
-    // Ignore the final message from tstl upon exiting the program
+    // Ignore the final message from tstl upon exiting the program.
     if (trimmedLine === "Terminate batch job (Y/N)?") {
       return;
     }
 
-    // Add a time prefix
+    // Add a time prefix.
     const formattedLine = `[${getTime()}] ${trimmedLine}`;
 
     sendMsgToSaveDatWriter({
@@ -27,7 +27,7 @@ export function msg(data: string): void {
     });
 
     // 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
+    // tstl errors from the IsaacScript terminal window or from looking at the in-game output.
     printMsgToStandardOut(formattedLine);
   }
 }

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

@@ -41,14 +41,14 @@ function init(verbose: boolean) {
 function onMessage(type: SaveDatMessageType, data: string, numRetries = 0) {
   const saveDat = readSaveDatFromDisk(VERBOSE);
   if (saveDat.length > MAX_MESSAGES) {
-    // If IsaacScript is running and
-    // 1) the game is not open
-    // 2) 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
+    // 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

package/src/exec.ts

@@ -60,9 +60,8 @@ export function execShell(
   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
+  // 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.",

package/src/file.ts

@@ -160,6 +160,31 @@ export function read(filePath: string, verbose: boolean): string {
   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}`);

package/src/prompt.ts

@@ -1,6 +1,5 @@
 // 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
+// Bash terminal. Thus, we revert to using the simpler Prompt library.
 
 import chalk from "chalk";
 import prompt from "prompt";
@@ -10,7 +9,7 @@ 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
+  // Override some of the prompt library's default values:
   // https://github.com/flatiron/prompt#customizing-your-prompt
   prompt.message = chalk.green("?");
   prompt.delimiter = " ";
@@ -23,7 +22,7 @@ export async function getInputYesNo(
 ): Promise<boolean> {
   prompt.start();
 
-  // Capitalize the letter that represents the default option
+  // Capitalize the letter that represents the default option.
   const y = defaultValue ? "Y" : "y";
   const n = defaultValue ? "n" : "N";
 
@@ -46,7 +45,7 @@ export async function getInputYesNo(
 
   const cleanedResponse = response.toLowerCase().trim();
 
-  // Default to true
+  // Default to true.
   if (cleanedResponse === "") {
     return defaultValue;
   }
@@ -59,8 +58,7 @@ export async function getInputYesNo(
     return false;
   }
 
-  error('Invalid response; must answer "yes" or "no".');
-  return false;
+  return error('Invalid response; must answer "yes" or "no".');
 }
 
 /** Returns trimmed input. */

package/src/utils.ts

@@ -33,7 +33,7 @@ export function isKebabCase(s: string): boolean {
 }
 
 /**
- * parseIntSafe is a more reliable version of parseInt. By default, "parseInt('1a')" will return
+ * `parseIntSafe` is a more reliable version of `parseInt`. By default, "parseInt('1a')" will return
  * "1", which is unexpected. This returns either an integer or NaN.
  */
 export function parseIntSafe(input: unknown): number {

package/src/validateNodeVersion.ts

@@ -4,13 +4,14 @@ import { parseSemVer } from "./utils";
 
 const REQUIRED_NODE_JS_MAJOR_VERSION = 16;
 
-// This program requires Node to be at least v16.0.0,
-// since that is the version that added the "fs.rmSync()" function
-// (I tested on Node v15.0.0 and it failed)
+/**
+ * This program requires Node to be at least v16.0.0, since that is the version that added the
+ * "fs.rmSync" function. (Node v15.0.0 is confirmed to not work.)
+ */
 export function validateNodeVersion(): void {
   const { version } = process;
-  const [majorVersion] = parseSemVer(version);
 
+  const [majorVersion] = parseSemVer(version);
   if (majorVersion >= REQUIRED_NODE_JS_MAJOR_VERSION) {
     return;
   }

package/tsconfig.eslint.json

@@ -1,11 +1,11 @@
-// A special TypeScript configuration file, used by ESLint only
+// A special TypeScript configuration file, used by ESLint only.
 {
   "extends": "./tsconfig.json",
   "include": [
-    // This must match the "include" setting in the "tsconfig.json" file
+    // This must match the "include" setting in the "tsconfig.json" file.
     "./src/**/*.ts",
 
-    // These are ESLint-only inclusions
+    // These are ESLint-only inclusions.
     "./.eslintrc.js",
   ],
 }

package/tsconfig.json

@@ -1,23 +1,21 @@
-// The configuration file for TypeScript
+// The configuration file for TypeScript.
 {
-  // We extend the standard IsaacScript config
+  // We extend the standard IsaacScript config:
   // https://github.com/IsaacScript/isaacscript-tsconfig/blob/main/tsconfig.node.json
   "extends": "isaacscript-tsconfig/tsconfig.node.json",
 
   // https://www.typescriptlang.org/docs/handbook/compiler-options.html
   "compilerOptions": {
-    // "outDir" specifies the output directory
-    // By default, it will put the compiled ".js" next to the respective ".ts" file,
-    // which will clutter the "src" directory
+    // "outDir" specifies the output directory.
+    // By default, it will put the compiled ".js" next to the respective ".ts" file, which will
+    // clutter the "src" directory.
     "outDir": "./dist",
 
-    // We need to import the "package.json" file to see what version we are running
-    // By default, this is false
+    // We need to import the "package.json" file to see what version we are running.
+    // By default, this is false.
     "resolveJsonModule": true,
   },
 
-  // A list of the TypeScript files to compile
-  "include": [
-    "./src/**/*.ts",
-  ],
+  // A list of the TypeScript files to compile.
+  "include": ["./src/**/*.ts"],
 }

package/update.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# Get the directory of this script:
 # https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 

package/file-templates/static/.cspell.json

@@ -1,11 +0,0 @@
-{
-    "version": "0.2",
-    "words": [
-        "dbaeumer",
-        "isaacscript",
-        "sarisia",
-        "steamapps",
-        "technote",
-        "tstl"
-    ]
-}