isaacscript-common 87.9.6 → 87.9.7

package/src/functions/string.ts

@@ -172,7 +172,11 @@ export function parseSemanticVersion(versionString: string):
     return undefined;
   }
 
-  return { majorVersion, minorVersion, patchVersion };
+  return {
+    majorVersion,
+    minorVersion,
+    patchVersion,
+  };
 }
 
 export function removeAllCharacters(string: string, character: string): string {

package/src/functions/trinkets.ts

@@ -100,8 +100,7 @@ export function getTrinketDescription(trinketType: TrinketType): string {
   // "ItemConfigItem.Description" is bugged with vanilla items on patch v1.7.6, so we use a
   // hard-coded object as a workaround.
   const trinketDescription = TRINKET_DESCRIPTIONS[trinketType] as
-    | string
-    | undefined;
+    string | undefined;
   if (trinketDescription !== undefined) {
     return trinketDescription;
   }

package/src/functions/types.ts

@@ -184,6 +184,8 @@ export function isInteger(variable: unknown): variable is int {
     return false;
   }
 
+  // TypeScriptToLua does not support `Number.isSafeInteger`.
+  // eslint-disable-next-line unicorn/prefer-number-is-safe-integer
   return variable === Math.floor(variable);
 }
 

package/src/functions/ui.ts

@@ -3,37 +3,6 @@ import { game } from "../core/cachedClasses";
 import { UI_HEART_WIDTH, VectorZero } from "../core/constants";
 import { copyVector } from "./vector";
 
-/**
- * In the options menu, players have the ability to set a HUD offset (which gets written to the
- * `HudOffset` attribute in the "options.ini" file). This function uses the current HUD offset to
- * generate a vector that should be added to the corresponding position that you want to draw a UI
- * element at.
- *
- * For example:
- * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
- * - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
- */
-export function getHUDOffsetVector(): Readonly<Vector> {
-  // Convert e.g. 0.4 to 4.
-  const hudOffset = Math.floor(Options.HUDOffset * 10);
-
-  // Expected values are integers between 1 and 10.
-  if (hudOffset < 1 || hudOffset > 10) {
-    return copyVector(VectorZero);
-  }
-
-  const x = hudOffset * 2;
-  let y = hudOffset;
-  if (y >= 4) {
-    y++;
-  }
-  if (y >= 9) {
-    y++;
-  }
-
-  return Vector(x, y);
-}
-
 /**
  * Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
  * function will return 6.
@@ -92,6 +61,37 @@ export function getHeartsUIWidth(): int {
   return width;
 }
 
+/**
+ * In the options menu, players have the ability to set a HUD offset (which gets written to the
+ * `HudOffset` attribute in the "options.ini" file). This function uses the current HUD offset to
+ * generate a vector that should be added to the corresponding position that you want to draw a UI
+ * element at.
+ *
+ * For example:
+ * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
+ * - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
+ */
+export function getHUDOffsetVector(): Readonly<Vector> {
+  // Convert e.g. 0.4 to 4.
+  const hudOffset = Math.floor(Options.HUDOffset * 10);
+
+  // Expected values are integers between 1 and 10.
+  if (hudOffset < 1 || hudOffset > 10) {
+    return copyVector(VectorZero);
+  }
+
+  const x = hudOffset * 2;
+  let y = hudOffset;
+  if (y >= 4) {
+    y++;
+  }
+  if (y >= 9) {
+    y++;
+  }
+
+  return Vector(x, y);
+}
+
 export function getScreenBottomCenterPos(): Readonly<Vector> {
   const bottomRightPos = getScreenBottomRightPos();
   return Vector(bottomRightPos.X / 2, bottomRightPos.Y);

package/src/functions/utils.ts

@@ -65,6 +65,7 @@ export function assertNotNull<T>(
  */
 export function eRange(start: int, end?: int, increment = 1): readonly int[] {
   if (end === undefined) {
+    // eslint-disable-next-line unicorn/no-useless-recursion
     return eRange(0, start, increment);
   }
 
@@ -94,6 +95,20 @@ export function getTraversalDescription(
   return traversalDescription;
 }
 
+/**
+ * Helper function to check if a variable is within a certain range, inclusive on both ends.
+ *
+ * - For example, `inRange(1, 1, 3)` will return `true`.
+ * - For example, `inRange(0, 1, 3)` will return `false`.
+ *
+ * @param num The number to check.
+ * @param start The start of the range to check.
+ * @param end The end of the range to check.
+ */
+export function inRange(num: int, start: int, end: int): boolean {
+  return num >= start && num <= end;
+}
+
 /**
  * Helper function to return an array of integers with the specified range, inclusive on both ends.
  * (The "i" in the function name stands for inclusive.)
@@ -117,6 +132,7 @@ export function getTraversalDescription(
  */
 export function iRange(start: int, end?: int, increment = 1): readonly int[] {
   if (end === undefined) {
+    // eslint-disable-next-line unicorn/no-useless-recursion
     return iRange(0, start, increment);
   }
 
@@ -124,20 +140,6 @@ export function iRange(start: int, end?: int, increment = 1): readonly int[] {
   return eRange(start, exclusiveEnd, increment);
 }
 
-/**
- * Helper function to check if a variable is within a certain range, inclusive on both ends.
- *
- * - For example, `inRange(1, 1, 3)` will return `true`.
- * - For example, `inRange(0, 1, 3)` will return `false`.
- *
- * @param num The number to check.
- * @param start The start of the range to check.
- * @param end The end of the range to check.
- */
-export function inRange(num: int, start: int, end: int): boolean {
-  return num >= start && num <= end;
-}
-
 /**
  * Helper function to detect if there is two or more players currently playing.
  *
@@ -171,8 +173,7 @@ export function isRepentance(): boolean {
   );
 
   const classTable = metatable.get("__class") as
-    | LuaMap<string, unknown>
-    | undefined;
+    LuaMap<string, unknown> | undefined;
   assertDefined(
     classTable,
     'Failed to get the "__class" key of the Sprite metatable.',
@@ -217,8 +218,7 @@ export function isRepentogon(): boolean {
   );
 
   const classTable = metatable.get("__class") as
-    | LuaMap<string, unknown>
-    | undefined;
+    LuaMap<string, unknown> | undefined;
   assertDefined(
     classTable,
     'Failed to get the "__class" key of the Sprite metatable.',

package/src/functions/vector.ts

@@ -15,7 +15,7 @@ import {
 import { isTable } from "./types";
 import { assertDefined } from "./utils";
 
-export type SerializedVector = LuaMap<string, unknown> & {
+export type SerializedVector = Readonly<LuaMap<string, unknown>> & {
   readonly __serializedVectorBrand: symbol;
   readonly __kind: CopyableIsaacAPIClassType.VECTOR;
 };
@@ -89,7 +89,7 @@ export function getClosestVectorTo(
   vectors: readonly Vector[],
 ): Vector | undefined {
   let closestVector: Vector | undefined;
-  let closestDistance = Number.POSITIVE_INFINITY;
+  let closestDistance = Infinity;
   for (const vector of vectors) {
     const distance = referenceVector.Distance(vector);
 

package/src/interfaces/ChargeBarSprites.ts

@@ -3,10 +3,11 @@
  *
  * This is used in the `newChargeBarSprites` and related helper functions.
  */
+// eslint-disable-next-line complete/type-declaration-immutability
 export interface ChargeBarSprites {
-  back: Sprite;
-  meter: Sprite;
-  meterBattery: Sprite;
-  lines: Sprite;
-  maxCharges: int;
+  readonly back: Readonly<Sprite>;
+  readonly meter: Readonly<Sprite>;
+  readonly meterBattery: Readonly<Sprite>;
+  readonly lines: Readonly<Sprite>;
+  readonly maxCharges: int;
 }