isaacscript-common 87.4.0 → 87.5.1

package/src/functions/trinkets.ts

@@ -69,9 +69,7 @@ export function getMysteriousPaperEffectForFrame(
   player: EntityPlayer,
   frameCount?: int,
 ): MysteriousPaperEffect | undefined {
-  if (frameCount === undefined) {
-    frameCount = player.FrameCount;
-  }
+  frameCount ??= player.FrameCount;
 
   if (!player.HasTrinket(TrinketType.MYSTERIOUS_PAPER)) {
     return undefined;

package/src/functions/tstlClass.ts

@@ -45,10 +45,10 @@ export function getTSTLClassName(object: unknown): string | undefined {
 }
 
 /**
- * Helper function to determine if a given object is a TypeScriptToLua `Map`.
+ * Helper function to determine if a given object is a `DefaultMap` from `isaacscript-common`.
  *
  * It is not reliable to use the `instanceof` operator to determine this because each Lua module has
- * their own copies of the entire lualib and thus their own instantiated version of a `Map`.
+ * their own copies of the entire lualib and thus their own instantiated version of a `DefaultMap`.
  */
 export function isDefaultMap(
   object: unknown,

package/src/functions/types.ts

@@ -18,7 +18,7 @@
  * Here, using `as` does not give an error because TypeScript allows you to assert a type to a
  * supertype or a subtype. Thus, using `as` to perform a type assertion is not as safe as using a
  * variable declaration or a helper function. However, if we use a variable declaration, then the
- * `isaacscript/strict-enums` rule is triggered, which requires suppressing the lint rule with a `//
+ * `complete/strict-enums` rule is triggered, which requires suppressing the lint rule with a `//
  * eslint-disable-next-line`. Thus, the safest and more concise way to do a type assertion is to use
  * a helper function.
  *
@@ -44,7 +44,7 @@ import type {
  * Helper function to safely cast an `int` to a `CardType`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asCardType(num: int): CardType {
   return num;
@@ -54,7 +54,7 @@ export function asCardType(num: int): CardType {
  * Helper function to safely cast an `int` to a `CollectibleType`. (This is better than using the
  * `as` TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asCollectibleType(num: int): CollectibleType {
   return num;
@@ -64,7 +64,7 @@ export function asCollectibleType(num: int): CollectibleType {
  * Helper function to safely cast an enum to an `int`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asFloat(num: number): float {
   return num;
@@ -74,7 +74,7 @@ export function asFloat(num: number): float {
  * Helper function to safely cast an enum to an `int`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asInt(num: number): int {
   return num;
@@ -84,7 +84,7 @@ export function asInt(num: number): int {
  * Helper function to safely cast an `int` to a `LevelStage`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asLevelStage(num: int): LevelStage {
   return num;
@@ -94,7 +94,7 @@ export function asLevelStage(num: int): LevelStage {
  * Helper function to safely cast an `int` to a `NPCState`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asNPCState(num: int): NPCState {
   return num;
@@ -104,7 +104,7 @@ export function asNPCState(num: int): NPCState {
  * Helper function to safely cast an enum to a `number`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asNumber(num: number): number {
   return num;
@@ -114,7 +114,7 @@ export function asNumber(num: number): number {
  * Helper function to safely cast an `int` to a `PillColor`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asPillColor(num: int): PillColor {
   return num;
@@ -124,7 +124,7 @@ export function asPillColor(num: int): PillColor {
  * Helper function to safely cast an `int` to a `PillEffect`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asPillEffect(num: int): PillEffect {
   return num;
@@ -134,7 +134,7 @@ export function asPillEffect(num: int): PillEffect {
  * Helper function to safely cast an `int` to a `PlayerType`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asPlayerType(num: int): PlayerType {
   return num;
@@ -144,7 +144,7 @@ export function asPlayerType(num: int): PlayerType {
  * Helper function to safely cast an `int` to a `RoomType`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asRoomType(num: int): RoomType {
   return num;
@@ -154,7 +154,7 @@ export function asRoomType(num: int): RoomType {
  * Helper function to safely cast an enum to a `string`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asString(str: string): string {
   return str;
@@ -164,7 +164,7 @@ export function asString(str: string): string {
  * Helper function to safely cast an `int` to a `TrinketType`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
- * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ * This is useful to satisfy the "complete/strict-enums" ESLint rule.
  */
 export function asTrinketType(num: int): TrinketType {
   return num;
@@ -174,7 +174,7 @@ export function isBoolean(variable: unknown): variable is boolean {
   return typeof variable === "boolean";
 }
 
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 export function isFunction(variable: unknown): variable is Function {
   return typeof variable === "function";
 }
@@ -225,7 +225,7 @@ export function isUserdata(variable: unknown): variable is LuaUserdata {
  *
  * Under the hood, this uses the built-in `tonumber` and `math.floor` functions.
  *
- * This is named `parseIntSafe` in order to match the helper function in `isaacscript-common-ts`.
+ * This is named `parseIntSafe` in order to match the helper function from `complete-common`.
  */
 export function parseIntSafe(string: string): int | undefined {
   if (!isString(string)) {

package/src/index.ts

@@ -32,8 +32,8 @@ export * from "./functions/challenges";
 export * from "./functions/characters";
 export * from "./functions/charge";
 export * from "./functions/chargeBar";
-export * from "./functions/collectibleTag";
 export * from "./functions/collectibles";
+export * from "./functions/collectibleTag";
 export * from "./functions/color";
 export * from "./functions/console";
 export * from "./functions/curses";
@@ -83,9 +83,9 @@ export * from "./functions/newArray";
 export * from "./functions/nextStage";
 export * from "./functions/npcDataStructures";
 export * from "./functions/npcs";
-export * from "./functions/pickupVariants";
 export * from "./functions/pickups";
 export * from "./functions/pickupsSpecific";
+export * from "./functions/pickupVariants";
 export * from "./functions/pills";
 export * from "./functions/playerCenter";
 export * from "./functions/playerCollectibles";
@@ -93,8 +93,8 @@ export * from "./functions/playerDataStructures";
 export * from "./functions/playerEffects";
 export * from "./functions/playerHealth";
 export * from "./functions/playerIndex";
-export * from "./functions/playerTrinkets";
 export * from "./functions/players";
+export * from "./functions/playerTrinkets";
 export * from "./functions/pocketItems";
 export * from "./functions/positionVelocity";
 export * from "./functions/pressurePlate";
@@ -107,10 +107,10 @@ export * from "./functions/rng";
 export * from "./functions/rockAlt";
 export * from "./functions/roomData";
 export * from "./functions/roomGrid";
+export * from "./functions/rooms";
 export * from "./functions/roomShape";
 export * from "./functions/roomShapeWalls";
 export * from "./functions/roomTransition";
-export * from "./functions/rooms";
 export * from "./functions/run";
 export * from "./functions/seeds";
 export * from "./functions/serialization";
@@ -136,19 +136,19 @@ export * from "./functions/utils";
 export * from "./functions/vector";
 export * from "./functions/versusScreen";
 export * from "./functions/weighted";
-export * from "./interfaces/ChargeBarSprites";
-export * from "./interfaces/Corner";
-export * from "./interfaces/CustomStageTSConfig";
-export * from "./interfaces/GridEntityCustomData";
-export * from "./interfaces/JSONRoomsFile";
-export * from "./interfaces/PlayerHealth";
-export * from "./interfaces/PlayerStats";
-export * from "./interfaces/PocketItemDescription";
-export * from "./interfaces/RoomDescription";
-export * from "./interfaces/SaveData";
-export * from "./interfaces/StageHistoryEntry";
-export * from "./interfaces/TSTLClassMetatable";
-export * from "./interfaces/TrinketSituation";
+export type * from "./interfaces/ChargeBarSprites";
+export type * from "./interfaces/Corner";
+export type * from "./interfaces/CustomStageTSConfig";
+export type * from "./interfaces/GridEntityCustomData";
+export type * from "./interfaces/JSONRoomsFile";
+export type * from "./interfaces/PlayerHealth";
+export type * from "./interfaces/PlayerStats";
+export type * from "./interfaces/PocketItemDescription";
+export type * from "./interfaces/RoomDescription";
+export type * from "./interfaces/SaveData";
+export type * from "./interfaces/StageHistoryEntry";
+export type * from "./interfaces/TrinketSituation";
+export type * from "./interfaces/TSTLClassMetatable";
 export * from "./maps/cardNameToTypeMap";
 export * from "./maps/characterNameToTypeMap";
 export * from "./maps/collectibleNameToTypeMap";
@@ -158,47 +158,47 @@ export * from "./maps/transformationNameToPlayerFormMap";
 export * from "./maps/trinketNameToTypeMap";
 export * from "./objects/colors";
 export * from "./objects/kColors";
-export * from "./types/AddSubtract";
-export * from "./types/AllButFirst";
-export * from "./types/AllButLast";
-export * from "./types/AnyClass";
-export * from "./types/AnyEntity";
-export * from "./types/AnyFunction";
-export * from "./types/AnyGridEntity";
-export * from "./types/CompositionTypeSatisfiesEnum";
-export * from "./types/ConversionHeartSubType";
-export * from "./types/Decrement";
-export * from "./types/ERange";
-export * from "./types/EntityID";
-export * from "./types/FunctionTuple";
-export * from "./types/GridEntityID";
-export * from "./types/HasFunction";
-export * from "./types/IRange";
-export * from "./types/Immutable";
-export * from "./types/Increment";
-export * from "./types/LowercaseKeys";
-export * from "./types/NaturalNumbersLessThan";
-export * from "./types/NaturalNumbersLessThanOrEqualTo";
-export * from "./types/ObjectValues";
+export type * from "./types/AddSubtract";
+export type * from "./types/AllButFirst";
+export type * from "./types/AllButLast";
+export type * from "./types/AnyClass";
+export type * from "./types/AnyEntity";
+export type * from "./types/AnyFunction";
+export type * from "./types/AnyGridEntity";
+export type * from "./types/CompositionTypeSatisfiesEnum";
+export type * from "./types/ConversionHeartSubType";
+export type * from "./types/Decrement";
+export type * from "./types/EntityID";
+export type * from "./types/ERange";
+export type * from "./types/FunctionTuple";
+export type * from "./types/GridEntityID";
+export type * from "./types/HasFunction";
+export type * from "./types/Immutable";
+export type * from "./types/Increment";
+export type * from "./types/IRange";
+export type * from "./types/LowercaseKeys";
+export type * from "./types/NaturalNumbersLessThan";
+export type * from "./types/NaturalNumbersLessThanOrEqualTo";
+export type * from "./types/ObjectValues";
 export * from "./types/PickingUpItem";
-export * from "./types/PickupIndex";
-export * from "./types/PlayerIndex";
-export * from "./types/PossibleStatType";
-export * from "./types/PublicInterface";
+export type * from "./types/PickupIndex";
+export type * from "./types/PlayerIndex";
+export type * from "./types/PossibleStatType";
+export type * from "./types/PublicInterface";
 export * from "./types/ReadonlyMap";
-export * from "./types/ReadonlyRecord";
+export type * from "./types/ReadonlyRecord";
 export * from "./types/ReadonlySet";
-export * from "./types/StartsWithLowercase";
-export * from "./types/StartsWithUppercase";
-export * from "./types/TSTLClass";
-export * from "./types/Tuple";
-export * from "./types/TupleKeys";
-export * from "./types/TupleToIntersection";
-export * from "./types/TupleToUnion";
-export * from "./types/TupleWithLengthBetween";
-export * from "./types/TupleWithMaxLength";
-export * from "./types/UnionToIntersection";
-export * from "./types/UppercaseKeys";
-export * from "./types/WeightedArray";
-export * from "./types/WidenLiteral";
-export * from "./types/Writable";
+export type * from "./types/StartsWithLowercase";
+export type * from "./types/StartsWithUppercase";
+export type * from "./types/TSTLClass";
+export type * from "./types/Tuple";
+export type * from "./types/TupleKeys";
+export type * from "./types/TupleToIntersection";
+export type * from "./types/TupleToUnion";
+export type * from "./types/TupleWithLengthBetween";
+export type * from "./types/TupleWithMaxLength";
+export type * from "./types/UnionToIntersection";
+export type * from "./types/UppercaseKeys";
+export type * from "./types/WeightedArray";
+export type * from "./types/WidenLiteral";
+export type * from "./types/Writable";

package/src/interfaces/SaveData.ts

@@ -104,7 +104,8 @@ type SerializableInsideArrayOrMap<T> =
                     : // Disallow functions.
                       // (We can only disallow functions when inside of containers, because we want
                       // to allow classes with methods attached to normal objects.)
-                      T extends Function // eslint-disable-line @typescript-eslint/ban-types
+                      // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+                      T extends Function
                       ? FunctionIsNotSerializable
                       : // Allow any other object, as long as the values are themselves serializable.
                         SerializableObject<T>;

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -975,12 +975,17 @@ export interface AddCallbackParametersCustom {
   ];
 
   [ModCallbackCustom.PRE_ITEM_PICKUP]:
-    | [callback: (player: EntityPlayer, pickingUpItem: PickingUpItem) => void]
+    | [
+        callback: (
+          player: EntityPlayer,
+          pickingUpItem: PickingUpItem,
+        ) => boolean | undefined,
+      ]
     | [
         callback: (
           player: EntityPlayer,
           pickingUpItem: PickingUpItemCollectible,
-        ) => void,
+        ) => boolean | undefined,
         itemType: ItemType.PASSIVE | ItemType.ACTIVE | ItemType.FAMILIAR,
         collectibleType?: CollectibleType,
       ]
@@ -988,7 +993,7 @@ export interface AddCallbackParametersCustom {
         callback: (
           player: EntityPlayer,
           pickingUpItem: PickingUpItemTrinket,
-        ) => void,
+        ) => boolean | undefined,
         itemType: ItemType.TRINKET,
         trinketType?: TrinketType,
       ];

package/src/lib/jsonLua.js

@@ -495,7 +495,7 @@ var lua_libs = {},
     },
     rawset: function (a, b, c) {
       if ("object" == typeof a && null != a && null != b)
-        return lua_rawset(a, b, c), [a];
+        return (lua_rawset(a, b, c), [a]);
       throw Error("Unable set key " + b + " in " + a);
     },
     select: function (a) {
@@ -901,7 +901,7 @@ lua_libs.table = {
     if (a.arraymode) return [a.uints.length];
     var b = 0,
       c;
-    for (c in a.uints) (a = parseFloat(c)), a > b && (b = a);
+    for (c in a.uints) ((a = parseFloat(c)), a > b && (b = a));
     return [b];
   },
   remove: function (a, b) {

package/src/objects/LRoomShapeToRectangles.ts

@@ -16,7 +16,7 @@ const TWO_BY_TWO_BOTTOM_RIGHT = newReadonlyVector(25, 13);
  * wall would be at "Vector(-1, -1)".)
  */
 // We don't use `as const` since we need the object to be indexable by all `RoomShape`.
-// eslint-disable-next-line isaacscript/require-capital-const-assertions
+// eslint-disable-next-line complete/require-capital-const-assertions
 export const L_ROOM_SHAPE_TO_RECTANGLES: Readonly<
   Partial<Record<RoomShape, LRoomRectangles>>
 > = {

package/src/objects/roomShapeToDoorSlotsToGridIndexDelta.ts

@@ -12,7 +12,7 @@ const DOWN = LEVEL_GRID_ROW_WIDTH;
  * top right corner in the case of `RoomShape.LTL`).
  */
 // We don't use `as const` since we need the map to be indexable by all `DoorSlot`.
-// eslint-disable-next-line isaacscript/require-capital-const-assertions
+// eslint-disable-next-line complete/require-capital-const-assertions
 export const ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA: Readonly<
   Record<RoomShape, ReadonlyMap<DoorSlot, int>>
 > = {

package/src/shouldFire.ts

@@ -1,6 +1,6 @@
 /*
 eslint sort-exports/sort-exports: [
-  "error",
+  "warn",
   {
     sortDir: "asc",
   },
@@ -217,6 +217,7 @@ export function shouldFireItemPickup(
   return (
     (callbackItemType === undefined ||
       callbackItemType === pickingUpItem.itemType) &&
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
     (callbackSubtype === undefined || callbackSubtype === pickingUpItem.subType)
   );
 }

package/src/types/AddSubtract.ts

@@ -1,9 +1,17 @@
-/** From: https://gist.github.com/ryandabler/8b4ff4f36aed47bc09acc03174638468 */
+/**
+ * Helper type to add two other types.
+ *
+ * From: https://gist.github.com/ryandabler/8b4ff4f36aed47bc09acc03174638468
+ */
 export type Add<A extends number, B extends number> = Length<
   [...BuildTuple<A>, ...BuildTuple<B>]
 >;
 
-/** From: https://gist.github.com/ryandabler/8b4ff4f36aed47bc09acc03174638468 */
+/**
+ * Helper type to subtract two other types.
+ *
+ * From: https://gist.github.com/ryandabler/8b4ff4f36aed47bc09acc03174638468
+ */
 export type Subtract<A extends number, B extends number> = A extends A
   ? BuildTuple<A> extends [...infer U, ...BuildTuple<B>]
     ? Length<U>

package/src/types/HasFunction.ts

@@ -1,7 +1,7 @@
 /** Helper type to check if an object or class has one or more functions/methods. */
 export type HasFunction<T> =
   Record<string, unknown> extends {
-    // eslint-disable-next-line @typescript-eslint/ban-types
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
     [K in keyof T as T[K] extends Function ? K : never]-?: 1;
   }
     ? never

package/src/types/Immutable.ts

@@ -21,7 +21,7 @@ type ImmutablePrimitive =
   | boolean
   | string
   | number
-  | Function; // eslint-disable-line @typescript-eslint/ban-types
+  | 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/TupleWithLengthBetween.ts

@@ -19,7 +19,7 @@ export type TupleWithLengthBetween<
 // -----
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
-/* eslint-disable isaacscript/require-unannotated-const-assertions */
+/* eslint-disable complete/require-unannotated-const-assertions */
 
 // @ts-expect-error Tuple of length 0 with min length 1 and max length 2.
 const zeroOneTwo: TupleWithLengthBetween<string, 1, 2> = [] as const;
@@ -38,6 +38,6 @@ const threeOneTwo: TupleWithLengthBetween<string, 1, 2> = [
 ] as const;
 
 /* eslint-enable @typescript-eslint/no-unused-vars */
-/* eslint-enable isaacscript/require-unannotated-const-assertions */
+/* eslint-enable complete/require-unannotated-const-assertions */
 
 // See "TupleWithMaxLength.ts" for more tests.

package/src/types/TupleWithMaxLength.ts

@@ -14,7 +14,7 @@ export type TupleWithMaxLength<T, MaxLength extends number> = readonly T[] & {
 // -----
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
-/* eslint-disable isaacscript/require-unannotated-const-assertions */
+/* eslint-disable complete/require-unannotated-const-assertions */
 
 // Tuple of length 0 with max length 0.
 const zeroZero: TupleWithMaxLength<string, 0> = [] as const;
@@ -44,4 +44,4 @@ const twoTwo: TupleWithMaxLength<string, 2> = ["1", "2"] as const;
 const threeTwo: TupleWithMaxLength<string, 2> = ["1", "2", "3"] as const;
 
 /* eslint-enable @typescript-eslint/no-unused-vars */
-/* eslint-enable isaacscript/require-unannotated-const-assertions */
+/* eslint-enable complete/require-unannotated-const-assertions */