isaacscript 1.1.23 → 1.1.27

package/isaacscript-watcher/resources/gfx/{emoji-eyes.anm2 → logo.anm2}

@@ -1,27 +1,27 @@
-<AnimatedActor>
-	<Info CreatedBy="Unknown" CreatedOn="2/1/2017 6:09:20 AM" Version="2" Fps="30"/>
-	<Content>
-		<Spritesheets>
-			<Spritesheet Path="emoji-eyes.png" Id="0"/>
-		</Spritesheets>
-		<Layers>
-			<Layer Name="Layer 0" Id="0" SpritesheetId="0"/>
-		</Layers>
-		<Nulls/>
-		<Events/>
-	</Content>
-	<Animations DefaultAnimation="Default">
-		<Animation Name="Default" FrameNum="2" Loop="true">
-			<RootAnimation>
-				<Frame XPosition="0" YPosition="0" XScale="100" YScale="100" Delay="1" Visible="true" RedTint="255" GreenTint="255" BlueTint="255" AlphaTint="255" RedOffset="0" GreenOffset="0" BlueOffset="0" Rotation="0" Interpolated="false"/>
-			</RootAnimation>
-			<LayerAnimations>
-				<LayerAnimation LayerId="0" Visible="true">
-					<Frame XPosition="0" YPosition="0" XPivot="0" YPivot="0" XCrop="0" YCrop="0" Width="120" Height="120" XScale="15" YScale="15" Delay="1" Visible="true" RedTint="255" GreenTint="255" BlueTint="255" AlphaTint="255" RedOffset="0" GreenOffset="0" BlueOffset="0" Rotation="0" Interpolated="false"/>
-				</LayerAnimation>
-			</LayerAnimations>
-			<NullAnimations/>
-			<Triggers/>
-		</Animation>
-	</Animations>
-</AnimatedActor>
+<AnimatedActor>
+	<Info CreatedBy="Unknown" CreatedOn="2/1/2017 6:09:20 AM" Version="2" Fps="30"/>
+	<Content>
+		<Spritesheets>
+			<Spritesheet Path="logo.png" Id="0"/>
+		</Spritesheets>
+		<Layers>
+			<Layer Name="Layer 0" Id="0" SpritesheetId="0"/>
+		</Layers>
+		<Nulls/>
+		<Events/>
+	</Content>
+	<Animations DefaultAnimation="Default">
+		<Animation Name="Default" FrameNum="1" Loop="true">
+			<RootAnimation>
+				<Frame XPosition="0" YPosition="0" XScale="100" YScale="100" Delay="1" Visible="true" RedTint="255" GreenTint="255" BlueTint="255" AlphaTint="255" RedOffset="0" GreenOffset="0" BlueOffset="0" Rotation="0" Interpolated="false"/>
+			</RootAnimation>
+			<LayerAnimations>
+				<LayerAnimation LayerId="0" Visible="true">
+					<Frame XPosition="0" YPosition="0" XPivot="0" YPivot="0" XCrop="0" YCrop="0" Width="44" Height="28" XScale="66" YScale="66" Delay="1" Visible="true" RedTint="255" GreenTint="255" BlueTint="255" AlphaTint="255" RedOffset="0" GreenOffset="0" BlueOffset="0" Rotation="0" Interpolated="false"/>
+				</LayerAnimation>
+			</LayerAnimations>
+			<NullAnimations/>
+			<Triggers/>
+		</Animation>
+	</Animations>
+</AnimatedActor>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript",
-  "version": "1.1.23",
+  "version": "1.1.27",
   "description": "A command line tool for managing Isaac mods written in TypeScript",
   "homepage": "https://isaacscript.github.io/",
   "bugs": {
@@ -24,11 +24,11 @@
     "jsonc-parser": "^3.0.0",
     "moment": "^2.29.1",
     "npm-check-updates": "^11.8.5",
-    "prompts": "^2.4.1",
+    "prompts": "^2.4.2",
     "source-map-support": "^0.5.20",
-    "sync-directory": "^2.2.22",
-    "typescript": "4.4.3",
-    "typescript-to-lua": "^1.0.1",
+    "sync-directory": "^4.0.5",
+    "typescript": "4.4.4",
+    "typescript-to-lua": "^1.1.0",
     "update-notifier": "^5.1.0",
     "yargs": "^17.2.1"
   },
@@ -36,12 +36,11 @@
     "@types/command-exists": "^1.2.0",
     "@types/figlet": "^1.5.4",
     "@types/fs-extra": "^9.0.13",
-    "@types/node": "^16.10.1",
+    "@types/node": "^16.11.6",
     "@types/prompts": "^2.0.14",
     "@types/source-map-support": "^0.5.4",
     "@types/update-notifier": "^5.1.0",
-    "@types/yargs": "^17.0.3",
-    "isaacscript-lint": "^1.0.61",
-    "ts-prune": "^0.10.0"
+    "@types/yargs": "^17.0.4",
+    "isaacscript-lint": "^1.0.63"
   }
 }

package/src/checkForWindowsTerminalBugs.ts

@@ -4,7 +4,7 @@ import os from "os";
 import path from "path";
 import prompts from "prompts";
 import * as file from "./file";
-import { error, execExe } from "./misc";
+import { error, execExe } from "./util";
 
 // https://stackoverflow.com/questions/9080085/node-js-find-home-directory-in-platform-agnostic-way
 const homeDir = os.homedir();

package/src/commands/copy/copy.ts

@@ -1,12 +1,13 @@
 import path from "path";
-import { CURRENT_DIRECTORY_NAME, MOD_SOURCE_PATH } from "../../constants";
+import { MOD_SOURCE_PATH } from "../../constants";
 import * as file from "../../file";
-import { execShell } from "../../misc";
 import { monkeyPatchMainLua } from "../../monkeyPatch";
 import { Config } from "../../types/Config";
+import { execShell, getModTargetDirectoryName } from "../../util";
 
 export default function copy(config: Config): void {
-  const modTargetPath = path.join(config.modsDirectory, CURRENT_DIRECTORY_NAME);
+  const modTargetDirectoryName = getModTargetDirectoryName(config);
+  const modTargetPath = path.join(config.modsDirectory, modTargetDirectoryName);
   compileAndCopy(MOD_SOURCE_PATH, modTargetPath);
 }
 

package/src/commands/init/checkIfProjectPathExists.ts

@@ -2,7 +2,7 @@ import chalk from "chalk";
 import prompts from "prompts";
 import { CWD } from "../../constants";
 import * as file from "../../file";
-import { error } from "../../misc";
+import { error } from "../../util";
 
 export default async function checkIfProjectPathExists(
   projectPath: string,

package/src/commands/init/checkModTargetDirectory.ts

@@ -2,7 +2,7 @@ import chalk from "chalk";
 import path from "path";
 import prompts from "prompts";
 import * as file from "../../file";
-import { error } from "../../misc";
+import { error } from "../../util";
 
 export default async function checkModTargetDirectory(
   modsDirectory: string,

package/src/commands/init/createMod.ts

@@ -16,7 +16,7 @@ import {
   TEMPLATES_STATIC_DIR,
 } from "../../constants";
 import * as file from "../../file";
-import { execShell, snakeKebabToCamel } from "../../misc";
+import { execShell, snakeKebabToCamel } from "../../util";
 
 export default function createMod(
   projectName: string,

package/src/commands/init/getModsDir.ts

@@ -3,7 +3,7 @@ import os from "os";
 import path from "path";
 import prompts from "prompts";
 import * as file from "../../file";
-import { error } from "../../misc";
+import { error } from "../../util";
 
 // https://stackoverflow.com/questions/9080085/node-js-find-home-directory-in-platform-agnostic-way
 const homeDir = os.homedir();

package/src/commands/init/getProjectPath.ts

@@ -2,7 +2,7 @@ import chalk from "chalk";
 import path from "path";
 import prompts from "prompts";
 import { CURRENT_DIRECTORY_NAME, CWD } from "../../constants";
-import { error, hasWhiteSpace } from "../../misc";
+import { error, hasWhiteSpace } from "../../util";
 
 // From: https://gist.github.com/doctaphred/d01d05291546186941e1b7ddc02034d3
 const ILLEGAL_CHARACTERS_FOR_WINDOWS_FILENAMES = [

package/src/commands/init/installVSCodeExtensions.ts

@@ -2,7 +2,7 @@ import chalk from "chalk";
 import * as JSONC from "jsonc-parser";
 import path from "path";
 import * as file from "../../file";
-import { error, execShell } from "../../misc";
+import { error, execShell } from "../../util";
 
 export default function installVSCodeExtensions(projectPath: string): void {
   const extensions = getExtensionsFromJSON(projectPath);

package/src/commands/init/promptSaveSlot.ts

@@ -1,5 +1,5 @@
 import prompts from "prompts";
-import { error } from "../../misc";
+import { error } from "../../util";
 
 export default async function promptSaveSlot(
   argv: Record<string, unknown>,

package/src/commands/init/promptVSCode.ts

@@ -1,7 +1,7 @@
 import path from "path";
 import prompts from "prompts";
 import { MAIN_TS } from "../../constants";
-import { execShell } from "../../misc";
+import { execShell } from "../../util";
 
 export default async function promptVSCode(
   projectPath: string,

package/src/commands/monitor/copyWatcherMod.ts

@@ -1,6 +1,7 @@
 import path from "path";
 import {
   DISABLE_IT_FILE,
+  MAIN_LUA,
   WATCHER_MOD_NAME,
   WATCHER_MOD_SOURCE_PATH,
 } from "../../constants";
@@ -27,8 +28,26 @@ export default function copyWatcherMod(config: Config): void {
     file.write(disableItPath, "");
   }
 
+  // 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);
+  }
+
   // 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) {
+  const mainLuaPath = path.join(watcherModPath, MAIN_LUA);
+  const mainLua = file.read(mainLuaPath);
+
+  const modifiedMainLua = mainLua.replace(
+    "local RESTART_GAME_ON_RECOMPILATION = true",
+    "local RESTART_GAME_ON_RECOMPILATION = false",
+  );
+
+  file.write(mainLuaPath, modifiedMainLua);
+}

package/src/commands/monitor/getTSConfigInclude.ts

@@ -2,7 +2,7 @@ import chalk from "chalk";
 import * as JSONC from "jsonc-parser";
 import { TSCONFIG_PATH } from "../../constants";
 import * as file from "../../file";
-import { error } from "../../misc";
+import { error } from "../../util";
 
 export default function getTSConfigInclude(): string {
   const tsConfigRaw = file.read(TSCONFIG_PATH);

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

@@ -24,7 +24,7 @@ function init() {
   syncDirectory(modSourcePath, modTargetPath, {
     watch: true,
     type: "copy",
-    afterSync,
+    afterEachSync,
     onError,
     chokidarWatchOptions: {
       awaitWriteFinish: {
@@ -34,8 +34,14 @@ function init() {
   });
 }
 
-function afterSync(params: { type: string; relativePath: string }) {
-  if (params.type === "init:copy") {
+function afterEachSync(params?: {
+  eventType: string;
+  nodeType: string;
+  relativePath: string;
+  srcPath: string;
+  targetPath: string;
+}) {
+  if (params === undefined) {
     return;
   }
 
@@ -43,7 +49,9 @@ function afterSync(params: { type: string; relativePath: string }) {
     monkeyPatchMainLua(modTargetPath);
   }
 
-  send(`${FILE_SYNCED_MESSAGE} ${params.relativePath}`);
+  if (params.eventType !== "init:copy") {
+    send(`${FILE_SYNCED_MESSAGE} ${params.relativePath}`);
+  }
 }
 
 function onError(err: Error) {

package/src/commands/monitor/monitor.ts

@@ -2,7 +2,6 @@ import chalk from "chalk";
 import { ChildProcessWithoutNullStreams, fork, spawn } from "child_process";
 import path from "path";
 import {
-  CURRENT_DIRECTORY_NAME,
   CWD,
   FILE_SYNCED_MESSAGE,
   MAIN_LUA,
@@ -10,13 +9,13 @@ import {
   PACKAGE_JSON,
 } from "../../constants";
 import * as file from "../../file";
-import { error } from "../../misc";
 import { Config } from "../../types/Config";
+import { error, getModTargetDirectoryName } from "../../util";
 import copyWatcherMod from "./copyWatcherMod";
 import getTSConfigInclude from "./getTSConfigInclude";
 import * as notifyGame from "./notifyGame";
 import { spawnSaveDatWriter } from "./spawnSaveDatWriter";
-import touchSaveDatFiles from "./touchSaveDatFiles";
+import touchWatcherSaveDatFiles from "./touchWatcherSaveDatFiles";
 
 export default function monitor(
   argv: Record<string, unknown>,
@@ -30,11 +29,9 @@ export default function monitor(
     config.saveSlot = argv.saveSlot as number; // eslint-disable-line no-param-reassign
   }
 
-  // Prepare the watcher mod
+  // Prepare the IsaacScript watcher mod
   copyWatcherMod(config);
-
-  // Ensure that the "save#.dat" file exists
-  touchSaveDatFiles(config);
+  touchWatcherSaveDatFiles(config);
 
   // Subprocess #1 - The "save#.dat" file writer
   spawnSaveDatWriter(config);
@@ -53,7 +50,8 @@ export default function monitor(
   // Read the "tsconfig.json" file
   const tsConfigInclude = getTSConfigInclude();
   const resolvedIncludePath = path.resolve(CWD, tsConfigInclude);
-  const modTargetPath = path.join(config.modsDirectory, CURRENT_DIRECTORY_NAME);
+  const modTargetDirectoryName = getModTargetDirectoryName(config);
+  const modTargetPath = path.join(config.modsDirectory, modTargetDirectoryName);
 
   console.log("Automatically monitoring the following for changes:");
   console.log(
@@ -70,7 +68,8 @@ function spawnModDirectorySyncer(config: Config) {
   const processName = "modDirectorySyncer";
   const processDescription = "Directory syncer";
   const processPath = path.join(__dirname, processName, processName);
-  const modTargetPath = path.join(config.modsDirectory, CURRENT_DIRECTORY_NAME);
+  const modTargetName = getModTargetDirectoryName(config);
+  const modTargetPath = path.join(config.modsDirectory, modTargetName);
   const directorySycner = fork(processPath, [MOD_SOURCE_PATH, modTargetPath]);
 
   directorySycner.on("message", (msg: string) => {
@@ -80,7 +79,7 @@ function spawnModDirectorySyncer(config: Config) {
     // to reload the mod
     // Look for something like: "File synced: \main.lua"
     if (msg === `${FILE_SYNCED_MESSAGE} ${path.sep}${MAIN_LUA}`) {
-      notifyGame.command(`luamod ${CURRENT_DIRECTORY_NAME}`);
+      notifyGame.command(`luamod ${modTargetName}`);
       notifyGame.command("restart");
       notifyGame.msg("Reloaded the mod.");
     }

package/src/commands/monitor/notifyGame.ts

@@ -1,5 +1,5 @@
 import chalk from "chalk";
-import { getTime } from "../../misc";
+import { getTime } from "../../util";
 import { sendMsgToSaveDatWriter } from "./spawnSaveDatWriter";
 
 export function msg(data: string): void {

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

@@ -4,7 +4,7 @@ import chalk from "chalk";
 import * as JSONC from "jsonc-parser";
 import path from "path";
 import * as file from "../../../file";
-import { ensureAllCases, error } from "../../../misc";
+import { ensureAllCases, error } from "../../../util";
 import { SaveDatMessage, SaveDatMessageType } from "./types";
 
 const MAX_MESSAGES = 100;

package/src/commands/monitor/spawnSaveDatWriter.ts

@@ -1,8 +1,8 @@
 import { ChildProcess, fork } from "child_process";
 import path from "path";
 import { WATCHER_MOD_NAME } from "../../constants";
-import { error } from "../../misc";
 import { Config } from "../../types/Config";
+import { error } from "../../util";
 import { SaveDatMessage } from "./saveDatWriter/types";
 
 let saveDatWriter: ChildProcess | null = null;

package/src/commands/monitor/{touchSaveDatFiles.ts → touchWatcherSaveDatFiles.ts}

@@ -3,7 +3,7 @@ import { WATCHER_MOD_NAME } from "../../constants";
 import * as file from "../../file";
 import { Config } from "../../types/Config";
 
-export default function touchSaveDatFiles(config: Config): void {
+export default function touchWatcherSaveDatFiles(config: Config): void {
   const modsDataPath = path.join(config.modsDirectory, "..", "data");
   const watcherModDataPath = path.join(modsDataPath, WATCHER_MOD_NAME);
   if (!file.exists(watcherModDataPath)) {

package/src/commands/publish/publish.ts

@@ -3,7 +3,6 @@ import path from "path";
 import {
   CONFIG_FILE_NAME,
   CONSTANTS_TS_PATH,
-  CURRENT_DIRECTORY_NAME,
   METADATA_XML_PATH,
   MOD_SOURCE_PATH,
   PACKAGE_JSON_PATH,
@@ -12,9 +11,14 @@ import {
   VERSION_TXT_PATH,
 } from "../../constants";
 import * as file from "../../file";
-import { error, execShell, parseIntSafe } from "../../misc";
 import { monkeyPatchMainLua } from "../../monkeyPatch";
 import { Config } from "../../types/Config";
+import {
+  error,
+  execShell,
+  getModTargetDirectoryName,
+  parseIntSafe,
+} from "../../util";
 import { compileAndCopy } from "../copy/copy";
 
 export default function publish(
@@ -23,7 +27,8 @@ export default function publish(
 ): void {
   const skip = argv.skip === true;
   const setVersion = argv.setversion as string | undefined;
-  const modTargetPath = path.join(config.modsDirectory, CURRENT_DIRECTORY_NAME);
+  const modTargetDirectoryName = getModTargetDirectoryName(config);
+  const modTargetPath = path.join(config.modsDirectory, modTargetDirectoryName);
 
   if (setVersion !== undefined && /^\d+\.\d+\.\d+$/.exec(setVersion) === null) {
     error(

package/src/configFile.ts

@@ -5,8 +5,8 @@ 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 { error } from "./misc";
 import { Config } from "./types/Config";
+import { error } from "./util";
 
 export async function get(argv: Record<string, unknown>): Promise<Config> {
   const existingConfig = readExistingConfig();

package/src/file.ts

@@ -1,7 +1,7 @@
 import chalk from "chalk";
 import fs from "fs-extra";
 import path from "path";
-import { error } from "./misc";
+import { error } from "./util";
 
 export function copy(srcPath: string, dstPath: string): void {
   try {

package/src/main.ts

@@ -14,10 +14,10 @@ import monitor from "./commands/monitor/monitor";
 import publish from "./commands/publish/publish";
 import * as configFile from "./configFile";
 import { CWD } from "./constants";
-import { ensureAllCases, error } from "./misc";
 import parseArgs from "./parseArgs";
 import Command, { DEFAULT_COMMAND } from "./types/Command";
 import { Config } from "./types/Config";
+import { ensureAllCases, error } from "./util";
 import validateInIsaacScriptProject from "./validateInIsaacScriptProject";
 import validateNodeVersion from "./validateNodeVersion";
 import { validateOS } from "./validateOS";

package/src/types/Config.ts

@@ -6,6 +6,18 @@ export class Config {
   /** The save slot that you test your mod on. */
   saveSlot = 1;
 
+  /**
+   * By default, the target mod directory name will be the same as the project directory name. This
+   * setting allows you to customize it.
+   */
+  customTargetModDirectoryName?: string;
+
   /** The path to "steamcmd.exe". This is optional and only needed for automating publishing. */
   steamCmdPath?: string;
+
+  /**
+   * When your code is recompiled, IsaacScript watcher can restart the game to ensure that any
+   * run-related variables are properly reset. This is set to true by default.
+   */
+  enableIsaacScriptWatcherAutoRestart?: boolean;
 }

package/src/{misc.ts → util.ts}

@@ -1,7 +1,8 @@
 import chalk from "chalk";
 import { execSync, spawnSync, SpawnSyncReturns } from "child_process";
 import moment from "moment";
-import { CWD } from "./constants";
+import { CURRENT_DIRECTORY_NAME, CWD } from "./constants";
+import { Config } from "./types/Config";
 
 // Use this on a switch statement's default case to get
 // the linter to complain if a case was not predicted
@@ -76,6 +77,12 @@ export function execShell(
   return [exitStatus, stdout];
 }
 
+export function getModTargetDirectoryName(config: Config): string {
+  return config.customTargetModDirectoryName === undefined
+    ? CURRENT_DIRECTORY_NAME
+    : config.customTargetModDirectoryName;
+}
+
 export function getTime(): string {
   return moment().format("h:mm:ss A"); // e.g. "1:23:45 AM"
 }

package/src/validateNodeVersion.ts

@@ -1,5 +1,5 @@
 import chalk from "chalk";
-import { error } from "./misc";
+import { error } from "./util";
 
 const REQUIRED_MAJOR_VERSION = 16;
 

package/src/validateOS.ts

@@ -13,10 +13,7 @@ export function validateOS(): void {
     )} and ${chalk.green("Linux")}.`,
   );
   console.error(
-    "If you use another operating system and you want to use IsaacScript, contact Zamiel and let him know.",
-  );
-  console.error(
-    "(Since the program is written in TypeScript, porting to a new operating system should be easy, but is untested.)",
+    "If you use another operating system and you want to use IsaacScript, make a request in the community Discord server.",
   );
   process.exit(1);
 }

package/dist/src/commands/monitor/touchSaveDatFiles.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"touchSaveDatFiles.js","sourceRoot":"","sources":["../../../../src/commands/monitor/touchSaveDatFiles.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAwB;AACxB,+CAAmD;AACnD,iDAAmC;AAGnC,SAAwB,iBAAiB,CAAC,MAAc;IACtD,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACnE,MAAM,kBAAkB,GAAG,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,4BAAgB,CAAC,CAAC;IACrE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE;QACpC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;KAClC;IACD,MAAM,eAAe,GAAG,OAAO,MAAM,CAAC,QAAQ,MAAM,CAAC;IACrD,MAAM,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;IACnE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QAC7B,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;KACzB;AACH,CAAC;AAXD,oCAWC"}