isaacscript-common 87.9.6 → 87.9.8

package/src/interfaces/private/CustomStage.ts

@@ -15,4 +15,7 @@ export interface CustomStage extends CustomStageLua {
 
 export type RoomTypeMap = ReadonlyMap<RoomType, RoomShapeMap>;
 type RoomShapeMap = ReadonlyMap<RoomShape, RoomDoorSlotMap>;
-type RoomDoorSlotMap = ReadonlyMap<DoorSlotFlag, CustomStageRoomMetadata[]>;
+type RoomDoorSlotMap = ReadonlyMap<
+  DoorSlotFlag,
+  readonly CustomStageRoomMetadata[]
+>;

package/src/interfaces/private/CustomTrapdoorDescription.ts

@@ -1,9 +1,10 @@
 import type { LevelStage, StageType } from "isaac-typescript-definitions";
 
+// eslint-disable-next-line complete/type-declaration-immutability
 export interface CustomTrapdoorDescription {
-  destinationName: string | undefined;
-  destinationStage: LevelStage;
-  destinationStageType: StageType;
+  readonly destinationName: string | undefined;
+  readonly destinationStage: LevelStage;
+  readonly destinationStageType: StageType;
   open: boolean;
-  firstSpawn: boolean;
+  readonly firstSpawn: boolean;
 }

package/src/interfaces/private/ModUpgradedInterface.ts

@@ -8,7 +8,8 @@ import type { Feature } from "../../classes/private/Feature";
  * These methods are private on the real `ModUpgraded` class, so the instantiated class must be
  * unsafely type-asserted.
  */
+// eslint-disable-next-line complete/type-declaration-immutability
 export interface ModUpgradedInterface extends Mod {
-  initFeature: (feature: Feature) => void;
-  uninitFeature: (feature: Feature) => void;
+  readonly initFeature: (feature: Feature) => void;
+  readonly uninitFeature: (feature: Feature) => void;
 }

package/src/lib/jsonLua.js

@@ -118,7 +118,7 @@ function lua_newtable(a) {
   }
   if (a)
     if ((ensure_arraymode(b), 0 == b.uints.length)) b.uints = a;
-    else for (c = a.length; 0 < c--; ) b.uints[c] = a[c];
+    else for (c = a.length; 0 < c--;) b.uints[c] = a[c];
   return b;
 }
 function lua_newtable2(a) {
@@ -132,8 +132,8 @@ function lua_len(a) {
   if ("object" == typeof a && null != a) {
     if (null == a.length) {
       var b = 0;
-      if (a.arraymode) for (; null != a.uints[b++]; );
-      else for (; null != a.uints[++b]; );
+      if (a.arraymode) for (; null != a.uints[b++];);
+      else for (; null != a.uints[++b];);
       return (a.length = b - 1);
     }
     return a.length;
@@ -432,7 +432,7 @@ var lua_libs = {},
       return [_ipairs_next, a, 0];
     },
     load: function (a, b) {
-      for (var c = "", d; null != (d = a()) && "" != d; ) c += d;
+      for (var c = "", d; null != (d = a()) && "" != d;) c += d;
       try {
         return [lua_load(c, b)];
       } catch (e) {
@@ -457,7 +457,7 @@ var lua_libs = {},
         c;
       for (c in a.str) b.push(c);
       if (a.arraymode)
-        for (var d = a.uints.length; 0 < d--; )
+        for (var d = a.uints.length; 0 < d--;)
           null != a.uints[d] && b.push(d + 1);
       else for (c in a.uints) b.push(parseFloat(c));
       for (c in a.floats) b.push(parseFloat(c));
@@ -562,7 +562,7 @@ var lua_libs = {},
       ensure_arraymode(a);
       if (null != a.length) c = a.length;
       else {
-        for (c = 0; null != a.uints[c++]; );
+        for (c = 0; null != a.uints[c++];);
         a.length = --c;
       }
       if (null == b || 1 > b) b = 1;
@@ -608,7 +608,7 @@ var _lua_write_buffer = "",
   _lua_io = (lua_libs.io = {
     write: function () {
       _lua_write_buffer += Array.prototype.join.call(arguments, "");
-      for (var a = _lua_write_buffer.split("\n"); 1 < a.length; )
+      for (var a = _lua_write_buffer.split("\n"); 1 < a.length;)
         _lua_print(a.shift());
       _lua_write_buffer = a[0];
       return [];
@@ -821,7 +821,7 @@ lua_libs.string = {
   byte: function (a, b, c) {
     null == b && (b = 0);
     null == c && (c = b);
-    for (var d = []; b < c && b < a.length; ) d.push(a.charCodeAt(b));
+    for (var d = []; b < c && b < a.length;) d.push(a.charCodeAt(b));
     return d;
   },
   char: function () {
@@ -855,7 +855,7 @@ lua_libs.string = {
   },
   rep: function (a, b) {
     if ("string" == typeof a && "number" == typeof b) {
-      for (var c = []; 0 < b--; ) c.push(a);
+      for (var c = []; 0 < b--;) c.push(a);
       return [c.join("")];
     }
     throw Error("Input not string and number");
@@ -933,11 +933,11 @@ lua_libs.bit = {
   },
   tohex: function (a, b) {
     if (0 < b) {
-      for (var c = a.toString(16).substr(-b); c.length < b; ) c = "0" + c;
+      for (var c = a.toString(16).substr(-b); c.length < b;) c = "0" + c;
       return [c];
     }
     if (0 > b) {
-      for (c = a.toString(16).substr(b).toUpperCase(); c.length < -b; )
+      for (c = a.toString(16).substr(b).toUpperCase(); c.length < -b;)
         c = "0" + c;
       return [c];
     }

package/src/objects/isaacAPIClassTypeToFunctions.ts

@@ -57,27 +57,27 @@ export type SerializedIsaacAPIClass =
   | SerializedVector;
 
 export interface IsaacAPIClassTypeToType {
-  [CopyableIsaacAPIClassType.BIT_SET_128]: BitSet128;
-  [CopyableIsaacAPIClassType.COLOR]: Color;
-  [CopyableIsaacAPIClassType.K_COLOR]: KColor;
-  [CopyableIsaacAPIClassType.RNG]: RNG;
-  [CopyableIsaacAPIClassType.VECTOR]: Vector;
+  readonly [CopyableIsaacAPIClassType.BIT_SET_128]: Readonly<BitSet128>;
+  readonly [CopyableIsaacAPIClassType.COLOR]: Readonly<Color>;
+  readonly [CopyableIsaacAPIClassType.K_COLOR]: Readonly<KColor>;
+  readonly [CopyableIsaacAPIClassType.RNG]: Readonly<RNG>;
+  readonly [CopyableIsaacAPIClassType.VECTOR]: Readonly<Vector>;
 }
 
 export interface IsaacAPIClassTypeToSerializedType {
-  [CopyableIsaacAPIClassType.BIT_SET_128]: SerializedBitSet128;
-  [CopyableIsaacAPIClassType.COLOR]: SerializedColor;
-  [CopyableIsaacAPIClassType.K_COLOR]: SerializedKColor;
-  [CopyableIsaacAPIClassType.RNG]: SerializedRNG;
-  [CopyableIsaacAPIClassType.VECTOR]: SerializedVector;
+  readonly [CopyableIsaacAPIClassType.BIT_SET_128]: Readonly<SerializedBitSet128>;
+  readonly [CopyableIsaacAPIClassType.COLOR]: Readonly<SerializedColor>;
+  readonly [CopyableIsaacAPIClassType.K_COLOR]: Readonly<SerializedKColor>;
+  readonly [CopyableIsaacAPIClassType.RNG]: Readonly<SerializedRNG>;
+  readonly [CopyableIsaacAPIClassType.VECTOR]: Readonly<SerializedVector>;
 }
 
 export interface IsaacAPIClassTypeFunctions<T, SerializedT> {
-  is: (object: unknown) => object is T;
-  isSerialized: (object: unknown) => object is SerializedT;
-  copy: (object: T) => T;
-  serialize: (object: T) => SerializedT;
-  deserialize: (object: SerializedT) => T;
+  readonly is: (object: unknown) => object is T;
+  readonly isSerialized: (object: unknown) => object is SerializedT;
+  readonly copy: (object: T) => T;
+  readonly serialize: (object: T) => SerializedT;
+  readonly deserialize: (object: SerializedT) => T;
 }
 
 type IsaacAPIClassTypeToFunctions = {

package/src/patchErrorFunctions.ts

@@ -40,9 +40,12 @@ export function patchErrorFunction(): void {
   if (__PATCHED_ERROR !== undefined) {
     return;
   }
+  // eslint-disable-next-line unicorn/no-top-level-assignment-in-function
   __PATCHED_ERROR = true;
 
+  // eslint-disable-next-line unicorn/no-top-level-assignment-in-function
   vanillaError = error;
+  // eslint-disable-next-line unicorn/no-top-level-assignment-in-function
   error = errorWithTraceback;
 }
 

package/src/sets/entitiesWithArmorSet.ts

@@ -16,6 +16,7 @@ import {
   MotherVariant,
   PooterVariant,
   RoundWormVariant,
+  SpittyVariant,
   SubHorfVariant,
   SuckerVariant,
   UltraGreedVariant,
@@ -39,7 +40,7 @@ export const ENTITIES_WITH_ARMOR_SET = new ReadonlySet<string>([
   `${EntityType.HIVE}.${HiveVariant.TAINTED_MULLIGAN}`, // 22.3
   `${EntityType.BOOM_FLY}.${BoomFlyVariant.TAINTED_BOOM_FLY}`, // 25.6
   `${EntityType.HOPPER}.${HopperVariant.TAINTED_HOPPER}`, // 29.3
-  `${EntityType.SPITTY}`, // 31.1
+  `${EntityType.SPITTY}.${SpittyVariant.TAINTED_SPITTY}`, // 31.1
   `${EntityType.SUCKER}.${SuckerVariant.TAINTED_SUCKER}`, // 61.7
   `${EntityType.ISAAC}.${IsaacVariant.BLUE_BABY_HUSH}`, // 102.2
   `${EntityType.WALL_CREEP}.${WallCreepVariant.TAINTED_SOY_CREEP}`, // 240.3

package/src/shouldFire.ts

@@ -1,11 +1,4 @@
-/*
-eslint sort-exports/sort-exports: [
-  "warn",
-  {
-    sortDir: "asc",
-  },
-]
-*/
+/* eslint "perfectionist/sort-modules": "error" */
 
 // These are validation functions for specific types of callbacks. (End-users can provide optional
 // arguments during callback registration such that their function should only fire when certain
@@ -466,18 +459,6 @@ export function shouldFireSpikes(
   return callbackVariant === undefined || callbackVariant === variant;
 }
 
-export function shouldFireTNT(
-  fireArgs: [tnt: GridEntityTNT],
-  optionalArgs: [variant?: int],
-): boolean {
-  const [tnt] = fireArgs;
-  const [callbackVariant] = optionalArgs;
-
-  const variant = tnt.GetVariant();
-
-  return callbackVariant === undefined || callbackVariant === variant;
-}
-
 export function shouldFireTear(
   fireArgs:
     | [tear: EntityTear]
@@ -494,6 +475,18 @@ export function shouldFireTear(
   );
 }
 
+export function shouldFireTNT(
+  fireArgs: [tnt: GridEntityTNT],
+  optionalArgs: [variant?: int],
+): boolean {
+  const [tnt] = fireArgs;
+  const [callbackVariant] = optionalArgs;
+
+  const variant = tnt.GetVariant();
+
+  return callbackVariant === undefined || callbackVariant === variant;
+}
+
 export function shouldFireTrinketType(
   fireArgs: [player: EntityPlayer, trinketType: TrinketType],
   optionalArgs: [trinketType?: TrinketType],

package/src/types/AllButFirst.ts

@@ -1,5 +1,5 @@
 /** Helper type to create a new tuple containing all but the first element of another tuple. */
-export type AllButFirst<T extends unknown[]> = T extends [
+export type AllButFirst<T extends readonly unknown[]> = T extends readonly [
   unknown,
   ...infer Tail,
 ]

package/src/types/AllButLast.ts

@@ -1,4 +1,7 @@
 /** Helper type to create a new tuple containing all but the last element of another tuple. */
-export type AllButLast<T extends unknown[]> = T extends [...infer Head, unknown]
+export type AllButLast<T extends readonly unknown[]> = T extends readonly [
+  ...infer Head,
+  unknown,
+]
   ? Head
   : unknown[];

package/src/types/CompositionTypeSatisfiesEnum.ts

@@ -45,18 +45,18 @@ enum ObjectiveType {
 }
 
 interface FooObjective {
-  type: ObjectiveType.FOO;
-  fooThing: number;
+  readonly type: ObjectiveType.FOO;
+  readonly fooThing: number;
 }
 
 interface BarObjective {
-  type: ObjectiveType.BAR;
-  barThing: string;
+  readonly type: ObjectiveType.BAR;
+  readonly barThing: string;
 }
 
 interface BazObjective {
-  type: ObjectiveType.BAZ;
-  bazThing: string;
+  readonly type: ObjectiveType.BAZ;
+  readonly bazThing: string;
 }
 
 type Objective1 = FooObjective | BarObjective | BazObjective;

package/src/types/Immutable.ts

@@ -16,12 +16,7 @@ export type Immutable<T> = T extends ImmutablePrimitive
         : ImmutableObject<T>;
 
 type ImmutablePrimitive =
-  | undefined
-  | null
-  | boolean
-  | string
-  | number
-  | Function; // eslint-disable-line @typescript-eslint/no-unsafe-function-type
+  undefined | null | boolean | string | number | Function; // eslint-disable-line @typescript-eslint/no-unsafe-function-type
 type ImmutableArray<T> = ReadonlyArray<Immutable<T>>;
 type ImmutableMap<K, V> = ReadonlyMap<Immutable<K>, Immutable<V>>;
 type ImmutableSet<T> = ReadonlySet<Immutable<T>>;

package/src/types/PickingUpItem.ts

@@ -1,3 +1,5 @@
+/* eslint-disable complete/type-declaration-immutability */
+
 /**
  * This is the type that is fed to the `PRE_ITEM_PICKUP` and `POST_ITEM_PICKUP` custom callbacks.
  *
@@ -9,9 +11,7 @@ import { CollectibleType, ItemType } from "isaac-typescript-definitions";
 import { ReadonlySet } from "./ReadonlySet";
 
 export type PickingUpItem =
-  | PickingUpItemNull
-  | PickingUpItemCollectible
-  | PickingUpItemTrinket;
+  PickingUpItemNull | PickingUpItemCollectible | PickingUpItemTrinket;
 
 /** Part of `PickingUpItem`. */
 export interface PickingUpItemNull {

package/src/types/PossibleStatType.ts

@@ -5,8 +5,4 @@ import type { TearFlag } from "isaac-typescript-definitions";
  * type `float`, `EntityPlayer.CanFly` is of type `boolean`, and so on.
  */
 export type PossibleStatType =
-  | number
-  | boolean
-  | BitFlags<TearFlag>
-  | Color
-  | Vector;
+  number | boolean | BitFlags<TearFlag> | Color | Vector;