isaacscript 2.0.4 → 2.0.7

package/isaacscript-watcher/main.lua

@@ -1,270 +0,0 @@
--- Includes
-local json = require("json")
-
--- Constants
-local MOD_NAME = "isaacscript-watcher"
-local RESTART_GAME_ON_RECOMPILATION = true
-local FRAMES_BEFORE_DISCONNECTED = 2 * 60 -- 2 seconds
-local FRAMES_BEFORE_TEXT_FADE = 2 * 60 -- 2 seconds
-local SPRITE_BOTTOM_RIGHT_OFFSET = Vector(-35, -60)
--- (enough so that it does not overlap with a pocket active + 2 pocket items)
-
--- Mod variables
-local saveData = {} -- An array of message objects.
-local restartFrame = 0
-local messageArray = {}
-local frameOfLastMsg = 0
-local frameOfLastSuccessfulLoad = 0
-local game = Game()
-local font = Font()
-font:Load("font/pftempestasevencondensed.fnt") -- A vanilla font good for this kind of text.
-local connected = false
-local sprite = nil
-
-local IsaacScriptWatcher = RegisterMod("IsaacScript Watcher", 1)
-
--- On mod initialization, nuke the "save#.dat" folder to get rid of old messages that might be left
--- there from IsaacScript.
-IsaacScriptWatcher:SaveData("")
-
-local function pushMessageArray(msg)
-  frameOfLastMsg = Isaac.GetFrameCount()
-
-  messageArray[#messageArray + 1] = msg
-  if #messageArray > 10 then
-    -- We only want to show 10 messages at a time.
-    table.remove(messageArray, 1)
-  end
-end
-
-local function getScreenBottomRightPos()
-  local screenWidth = Isaac.GetScreenWidth();
-  local screenHeight = Isaac.GetScreenHeight();
-
-  return Vector(screenWidth, screenHeight)
-end
-
--- ModCallbacks.MC_POST_RENDER (2)
-function IsaacScriptWatcher:PostRender()
-  -- Don't do anything while fading in to a new run to prevent crashes.
-  if game:GetFrameCount() < 1 then
-    return
-  end
-
-  IsaacScriptWatcher:RenderSprite()
-  IsaacScriptWatcher:RenderText()
-  IsaacScriptWatcher:LoadSaveDat()
-  IsaacScriptWatcher:CheckInput()
-  IsaacScriptWatcher:CheckRestart()
-end
-
-function IsaacScriptWatcher:RenderSprite()
-  -- Determine if IsaacScript is connected or not.
-  local frameCount = Isaac.GetFrameCount()
-  connected = frameCount - frameOfLastSuccessfulLoad <= FRAMES_BEFORE_DISCONNECTED
-
-  -- Set the sprite
-  if connected then
-    if sprite == nil then
-      sprite = Sprite()
-      sprite:Load("gfx/logo.anm2", true)
-      sprite:SetFrame("Default", 0)
-    end
-  else
-    if sprite ~= nil then
-      sprite = nil
-    end
-  end
-
-  -- Render it
-  if sprite ~= nil then
-    local bottomRightPos = getScreenBottomRightPos()
-    local position = bottomRightPos + SPRITE_BOTTOM_RIGHT_OFFSET
-    sprite:RenderLayer(0, position)
-  end
-end
-
-function IsaacScriptWatcher:RenderText()
-  -- Don't draw IsaacScript text when custom consoles are open.
-  if AwaitingTextInput then
-    return
-  end
-
-  if frameOfLastMsg == 0 then
-    return
-  end
-
-  if game:IsPaused() then
-    return
-  end
-
-  if ModConfigMenu ~= nil then
-    if ModConfigMenu.IsVisible then
-      return
-    end
-  end
-
-  -- Local variables
-  local x = 60
-  local y = 90
-  local scale = 1
-  local lineHeight = font:GetLineHeight() * scale
-
-  -- The text will slowly fade out.
-  local elapsedFrames = Isaac.GetFrameCount() - frameOfLastMsg
-  local alpha
-  if elapsedFrames <= FRAMES_BEFORE_TEXT_FADE then
-    alpha = 1
-  else
-    local fadeFrames = elapsedFrames - FRAMES_BEFORE_TEXT_FADE
-    alpha = 1 - (0.02 * fadeFrames)
-  end
-  if alpha <= 0 then
-    frameOfLastMsg = 0
-    return
-  end
-
-  local white = KColor(1, 1, 1, alpha)
-  local red = KColor(1, 0, 0, alpha)
-  local green = KColor(0, 1, 0, alpha)
-
-  -- Go through each message.
-  for i, msg in ipairs(messageArray) do
-    local color = white
-
-    local hasSuccess = string.match(msg, "Compilation successful.")
-    if hasSuccess ~= nil then
-      color = green
-    end
-
-    local hasErrors = string.match(msg, "Found [0-9]+ errors.")
-    if hasErrors ~= nil then
-      color = red
-    end
-
-    font:DrawStringScaledUTF8(
-      msg,
-      x,
-      y + ((i - 1) * lineHeight),
-      scale,
-      scale,
-      color,
-      0,
-      true
-    )
-  end
-end
-
-function IsaacScriptWatcher:LoadSaveDat()
-  -- Local variables
-  local isaacFrameCount = Isaac.GetFrameCount()
-
-  -- Read the "save.dat" file every third second, since file reads are expensive.
-  if isaacFrameCount % 20 ~= 0 then
-    return
-  end
-
-  -- Check to see if there a "save.dat" file for this save slot.
-  if not Isaac.HasModData(IsaacScriptWatcher) then
-    IsaacScriptWatcher:ClearSaveDat()
-    return
-  end
-
-  -- The server will write JSON data for us to the "save#.dat" file in the mod subdirectory.
-  if not pcall(IsaacScriptWatcher.Load) then
-    -- Sometimes loading can fail if the file is currently being being written to, so give up for
-    -- now and try again on the next interval.
-    Isaac.DebugString(
-      MOD_NAME
-      .. " - Failed to load the TypeScript Watcher \"save.dat\" on frame: "
-      .. tostring(isaacFrameCount)
-    )
-    return
-  end
-
-  if #saveData > 0 then
-    local saveDatContents = saveData
-    IsaacScriptWatcher:ClearSaveDat()
-    IsaacScriptWatcher:LoadSuccessful(saveDatContents)
-  end
-end
-
-function IsaacScriptWatcher:LoadSuccessful(saveDatContents)
-  frameOfLastSuccessfulLoad = Isaac.GetFrameCount()
-
-  for _, entry in ipairs(saveDatContents) do
-    -- Entry is e.g. { type: "command", data: "luamod revelations" }
-    if entry.type == "command" then
-      if entry.data == "restart" then
-        -- If we restart on the first frame that a run is loading, then the game can crash.
-        restartFrame = Isaac.GetFrameCount() + 1
-      else
-        Isaac.DebugString(MOD_NAME .. " - Executing command: " .. entry.data)
-        Isaac.ExecuteCommand(entry.data)
-      end
-    elseif entry.type == "msg" then
-      Isaac.DebugString(MOD_NAME .. " - " .. entry.data)
-      pushMessageArray(entry.data)
-    end
-  end
-end
-
-function IsaacScriptWatcher:ClearSaveDat()
-  saveData = {}
-  IsaacScriptWatcher:Save()
-end
-
-function IsaacScriptWatcher:Save()
-  local saveDataJSON = json.encode(saveData)
-  IsaacScriptWatcher:SaveData(saveDataJSON)
-end
-
-function IsaacScriptWatcher:Load()
-  -- Read the "save#.dat" file into a string.
-  local saveDataJSON = Isaac.LoadModData(IsaacScriptWatcher)
-
-  -- Handle the case of a 0 byte file.
-  if saveDataJSON == "" then
-    saveDataJSON = "{}"
-  end
-
-  -- Convert a JSON string to a Lua table.
-  saveData = json.decode(saveDataJSON)
-end
-
-function IsaacScriptWatcher:CheckInput()
-  if game:IsPaused() then
-    return
-  end
-
-  -- Ensure that this feature does not overlap with custom consoles by checking for the
-  -- "AwaitingTextInput" global variable.
-  if AwaitingTextInput then
-    return
-  end
-
-  -- Manually show the log when the user presses the "I" key on the keyboard.
-  if Input.IsButtonPressed(Keyboard.KEY_I, 0) then
-    frameOfLastMsg = Isaac.GetFrameCount()
-  end
-end
-
-function IsaacScriptWatcher:CheckRestart()
-  if not RESTART_GAME_ON_RECOMPILATION then
-    return
-  end
-
-  if restartFrame == 0 or restartFrame < Isaac.GetFrameCount() then
-    return
-  end
-  restartFrame = 0
-
-  Isaac.DebugString(MOD_NAME .. " - Restarting the run.")
-  Isaac.ExecuteCommand("restart")
-end
-
-IsaacScriptWatcher:AddCallback(ModCallbacks.MC_POST_RENDER, IsaacScriptWatcher.PostRender)
-
-local initMessage = "IsaacScript Watcher initialized."
-Isaac.DebugString(initMessage)
-pushMessageArray(initMessage)

package/isaacscript-watcher/metadata.xml

@@ -1,7 +0,0 @@
-<metadata>
-  <name>IsaacScript Watcher</name>
-  <directory>isaacscript-watcher</directory>
-  <description />
-  <version>1.0</version>
-  <visibility />
-</metadata>

package/isaacscript-watcher/resources/gfx/logo.anm2

@@ -1,27 +0,0 @@
-<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/lint.sh

@@ -1,38 +0,0 @@
-#!/bin/bash
-
-set -e # Exit on any errors
-
-# 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 )"
-
-SECONDS=0
-
-cd "$DIR"
-
-# Step 1 - Use Prettier to check formatting.
-npx prettier --check .
-
-# Step 2 - Use ESLint to lint the TypeScript.
-# Since all ESLint errors are set to warnings, we set max warnings to 0 so that warnings will fail
-# in CI.
-npx eslint --max-warnings 0 src
-
-# Step 3 - Spell check every file using cspell.
-# We use "--no-progress" and "--no-summary" because we want to only output errors.
-npx cspell --no-progress --no-summary
-
-# Step 4 - Check for unused imports.
-# The "--error" flag makes it return an error code of 1 if unused exports are found.
-npx ts-prune --error
-
-# Step 5 - Check for base file updates.
-bash "$DIR/check-file-updates.sh"
-
-# Step 6 - Check for orphaned words.
-bash "$DIR/check-orphaned-words.sh"
-
-# Step 7 - Check for gitignore updates from GitHub.
-bash "$DIR/check-gitignore.sh"
-
-echo "Successfully linted in $SECONDS seconds."

package/nuke.sh

@@ -1,18 +0,0 @@
-#!/bin/bash
-
-set -e # Exit on any errors
-
-# 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_LOCK="$DIR/package-lock.json"
-rm -f "$PACKAGE_LOCK"
-echo "Successfully deleted: $PACKAGE_LOCK"
-
-NODE_MODULES="$DIR/node_modules"
-rm -rf "$NODE_MODULES"
-echo "Successfully deleted: $NODE_MODULES"
-
-npm install
-echo "Successfully reinstalled Node dependencies."

package/publish.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-set -e # Exit on any errors
-
-# 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 )"
-
-cd "$DIR"
-pip install publish-npm --upgrade --quiet
-publish-npm "$@"

package/src/checkForWindowsTerminalBugs.ts

@@ -1,106 +0,0 @@
-import chalk from "chalk";
-import fs from "fs";
-import path from "path";
-import { HOME_DIR, PROJECT_NAME } from "./constants";
-import * as file from "./file";
-import { getInputYesNo } from "./prompt";
-import { error } from "./utils";
-
-const BASH_PROFILE_PATH = path.join(HOME_DIR, ".bash_profile");
-
-/**
- * By default, Git Bash for Windows uses MINGW64. This will not work correctly with the prompt
- * library. Try to detect this and warn the end-user.
- */
-export async function checkForWindowsTerminalBugs(
-  verbose: boolean,
-): Promise<void> {
-  if (process.platform !== "win32") {
-    return;
-  }
-
-  if (process.env["SHELL"] !== "C:\\Program Files\\Git\\usr\\bin\\bash.exe") {
-    return;
-  }
-
-  await checkForWindowsBugColor(verbose);
-}
-
-async function checkForWindowsBugColor(verbose: boolean) {
-  if (process.env["FORCE_COLOR"] === "true") {
-    return;
-  }
-
-  console.error(
-    chalk.red(
-      `Error: It looks like you are using Git Bash for Windows (MINGW64) without the "${chalk.green(
-        "FORCE_COLOR",
-      )}" environment variable.`,
-    ),
-  );
-  console.error(
-    "This is necessary in order for colors to work properly in the terminal.",
-  );
-
-  const shouldFixColors = await getInputYesNo(
-    "Do you want me to fix this for you?",
-  );
-  if (!shouldFixColors) {
-    return;
-  }
-
-  applyFixesToBashProfile(verbose);
-}
-
-function applyFixesToBashProfile(verbose: boolean) {
-  // Check to see if the Bash profile has data.
-  let bashProfileContents: string;
-  if (file.exists(BASH_PROFILE_PATH, verbose)) {
-    bashProfileContents = file.read(BASH_PROFILE_PATH, verbose);
-  } else {
-    bashProfileContents = "";
-  }
-
-  const appendText = getBashProfileAppendText(bashProfileContents);
-
-  try {
-    fs.appendFileSync(BASH_PROFILE_PATH, appendText);
-  } catch (err) {
-    error(`Failed to append text to "${BASH_PROFILE_PATH}":`, err);
-  }
-
-  console.log(
-    chalk.green("Complete!"),
-    `The terminal fixes have been added to: ${chalk.green(BASH_PROFILE_PATH)}`,
-  );
-  console.log(
-    chalk.red(
-      "Please close and re-open your terminal, then run this program again.",
-    ),
-  );
-  process.exit(0);
-}
-
-function getBashProfileAppendText(bashProfileContents: string) {
-  let newText = "";
-
-  if (
-    bashProfileContents !== "" &&
-    bashProfileContents[bashProfileContents.length - 1] !== "\n"
-  ) {
-    // If the Bash profile exists and has data, it should end in a newline. Add an extra newline if
-    // this is not the case.
-    newText += "\n";
-  }
-
-  if (bashProfileContents !== "") {
-    // If the Bash profile exists and has data, add an extra newline between the existing stuff and
-    // the new lines added by us.
-    newText += "\n";
-  }
-
-  newText += `# Terminal fixes added by ${PROJECT_NAME}\n`;
-  newText += "export FORCE_COLOR=true\n";
-
-  return newText;
-}

package/src/commands/copy/copy.ts

@@ -1,41 +0,0 @@
-import path from "path";
-import { MOD_SOURCE_PATH } from "../../constants";
-import { execShell } from "../../exec";
-import * as file from "../../file";
-import { Config } from "../../types/Config";
-import { getModTargetDirectoryName } from "../../utils";
-
-export function copy(argv: Record<string, unknown>, config: Config): void {
-  const verbose = argv["verbose"] === true;
-
-  const modTargetDirectoryName = getModTargetDirectoryName(config);
-  const modTargetPath = path.join(config.modsDirectory, modTargetDirectoryName);
-
-  compileAndCopy(MOD_SOURCE_PATH, modTargetPath, verbose);
-}
-
-export function compileAndCopy(
-  modSourcePath: string,
-  modTargetPath: string,
-  verbose: boolean,
-): void {
-  compile(verbose);
-  copyMod(modSourcePath, modTargetPath, verbose);
-}
-
-function compile(verbose: boolean) {
-  execShell("npx", ["tstl"], verbose);
-  console.log("Mod compiled successfully.");
-}
-
-function copyMod(
-  modSourcePath: string,
-  modTargetPath: string,
-  verbose: boolean,
-) {
-  if (file.exists(modTargetPath, verbose)) {
-    file.deleteFileOrDirectory(modTargetPath, verbose);
-  }
-  file.copy(modSourcePath, modTargetPath, verbose);
-  console.log("Mod copied successfully.");
-}

package/src/commands/init/checkIfProjectPathExists.ts

@@ -1,34 +0,0 @@
-import chalk from "chalk";
-import { CWD } from "../../constants";
-import * as file from "../../file";
-import { getInputYesNo } from "../../prompt";
-import { error } from "../../utils";
-
-export async function checkIfProjectPathExists(
-  projectPath: string,
-  yes: boolean,
-  verbose: boolean,
-): Promise<void> {
-  if (projectPath === CWD || !file.exists(projectPath, verbose)) {
-    return;
-  }
-
-  const fileType = file.isDir(projectPath, verbose) ? "directory" : "file";
-
-  if (yes) {
-    file.deleteFileOrDirectory(projectPath, verbose);
-    console.log(`Deleted ${fileType}: ${chalk.green(projectPath)}`);
-    return;
-  }
-
-  console.log(
-    `A ${fileType} already exists with a name of: ${chalk.green(projectPath)}`,
-  );
-  const shouldDelete = await getInputYesNo("Do you want me to delete it?");
-
-  if (!shouldDelete) {
-    error("Ok then. Goodbye.");
-  }
-
-  file.deleteFileOrDirectory(projectPath, verbose);
-}

package/src/commands/init/checkModSubdirectory.ts

@@ -1,20 +0,0 @@
-import chalk from "chalk";
-import { CWD } from "../../constants";
-import * as file from "../../file";
-import { error } from "../../utils";
-
-export function checkModSubdirectory(
-  projectPath: string,
-  modsDirectory: string,
-): void {
-  if (file.isSubDirOf(CWD, modsDirectory)) {
-    console.error(
-      `Error: The project directory of "${chalk.green(
-        projectPath,
-      )}" is a subdirectory of "${chalk.green(modsDirectory)}".`,
-    );
-    error(
-      'You are supposed to have your project folder somewhere else on the system than the Isaac mods directory. (This is because we don\'t want to upload the ".git" folder or the TypeScript files to the Steam Workshop.) Exiting.',
-    );
-  }
-}

package/src/commands/init/checkModTargetDirectory.ts

@@ -1,42 +0,0 @@
-import chalk from "chalk";
-import path from "path";
-import { PROJECT_NAME } from "../../constants";
-import * as file from "../../file";
-import { getInputYesNo } from "../../prompt";
-import { error } from "../../utils";
-
-export async function checkModTargetDirectory(
-  modsDirectory: string,
-  projectName: string,
-  yes: boolean,
-  verbose: boolean,
-): Promise<void> {
-  const modTargetPath = path.join(modsDirectory, projectName);
-  if (!file.exists(modTargetPath, verbose)) {
-    return;
-  }
-
-  const fileType = file.isDir(modTargetPath, verbose) ? "directory" : "file";
-
-  if (yes) {
-    file.deleteFileOrDirectory(modTargetPath, verbose);
-    console.log(`Deleted ${fileType}: ${chalk.green(modTargetPath)}`);
-    return;
-  }
-
-  console.log(
-    `A ${fileType} already exists at at the mod path of: ${chalk.green(
-      modTargetPath,
-    )}`,
-  );
-  console.log(
-    `${PROJECT_NAME} will need to sync your project folder with this directory.`,
-  );
-  const shouldDelete = await getInputYesNo("Do you want me to delete it?");
-
-  if (!shouldDelete) {
-    error("Ok then. Goodbye.");
-  }
-
-  file.deleteFileOrDirectory(modTargetPath, verbose);
-}