refactor: Unify singular/plural naming for data structures

Author: oliversalzburg

packages/kitten-scientists/source/ReligionManager.ts

@@ -12,22 +12,22 @@ import {
   ReligionSettings,
   ReligionSettingsItem,
   UnicornItem,
-  UnicornItemArray,
+  UnicornItems,
 } from "./settings/ReligionSettings.js";
 import { cwarn } from "./tools/Log.js";
 import {
   BuildButton,
   ButtonModernController,
   ButtonModernModel,
   ReligionTab,
+  ReligionUpgrade,
   ReligionUpgradeInfo,
-  ReligionUpgrades,
+  TranscendenceUpgrade,
   TranscendenceUpgradeInfo,
-  TranscendenceUpgrades,
   TransformBtnController,
   UnicornItemVariant,
+  ZiggurathUpgrade,
   ZiggurathUpgradeInfo,
-  ZiggurathUpgrades,
 } from "./types/index.js";
 
 export class ReligionManager implements Automation {
@@ -181,7 +181,7 @@ export class ReligionManager implements Automation {
     }
   }
   private _buildNonUnicornBuildings() {
-    const alreadyHandled: Array<FaithItem | UnicornItem> = [...UnicornItemArray];
+    const alreadyHandled: Array<FaithItem | UnicornItem> = [...UnicornItems];
     const builds = Object.fromEntries(
       Object.entries(this.settings.buildings).filter(
         ([k, v]) => !alreadyHandled.includes(v.building),
@@ -227,15 +227,15 @@ export class ReligionManager implements Automation {
    * @see https://github.com/Bioniclegenius/NummonCalc/blob/112f716e2fde9956dfe520021b0400cba7b7113e/NummonCalc.js#L490
    * @returns The best unicorn building.
    */
-  getBestUnicornBuilding(): ZiggurathUpgrades | "unicornPasture" | null {
+  getBestUnicornBuilding(): ZiggurathUpgrade | "unicornPasture" | null {
     const pastureButton = this._bonfireManager.getBuildButton("unicornPasture");
     if (pastureButton === null) {
       return null;
     }
 
-    const validBuildings: Array<ZiggurathUpgrades | "unicornPasture"> = [
-      ...UnicornItemArray,
-    ].filter(item => item !== "unicornPasture");
+    const validBuildings: Array<ZiggurathUpgrade | "unicornPasture"> = [...UnicornItems].filter(
+      item => item !== "unicornPasture",
+    );
 
     // How many unicorns are produced per second.
     const unicornsPerSecondBase =
@@ -289,7 +289,7 @@ export class ReligionManager implements Automation {
     // by its effect on production of unicorns.
 
     let bestAmortization = Infinity;
-    let bestBuilding: ZiggurathUpgrades | "unicornPasture" | null = null;
+    let bestBuilding: ZiggurathUpgrade | "unicornPasture" | null = null;
     const unicornsPerTickBase = mustExist(
       this._host.game.bld.getBuildingExt("unicornPasture").meta.effects["unicornsPerTickBase"],
     );
@@ -442,11 +442,11 @@ export class ReligionManager implements Automation {
   ): ReligionUpgradeInfo | TranscendenceUpgradeInfo | ZiggurathUpgradeInfo | null {
     switch (variant) {
       case UnicornItemVariant.Ziggurat:
-        return this._host.game.religion.getZU(name as ZiggurathUpgrades) ?? null;
+        return this._host.game.religion.getZU(name as ZiggurathUpgrade) ?? null;
       case UnicornItemVariant.OrderOfTheSun:
-        return this._host.game.religion.getRU(name as ReligionUpgrades) ?? null;
+        return this._host.game.religion.getRU(name as ReligionUpgrade) ?? null;
       case UnicornItemVariant.Cryptotheology:
-        return this._host.game.religion.getTU(name as TranscendenceUpgrades) ?? null;
+        return this._host.game.religion.getTU(name as TranscendenceUpgrade) ?? null;
     }
     return null;
   }

packages/kitten-scientists/source/SpaceManager.ts

@@ -10,9 +10,9 @@ import {
   BuildButton,
   ButtonModernController,
   ButtonModernModel,
-  Missions,
+  Mission,
+  SpaceBuilding,
   SpaceBuildingInfo,
-  SpaceBuildings,
   SpaceTab,
 } from "./types/index.js";
 
@@ -52,7 +52,7 @@ export class SpaceManager implements Automation {
    * @param builds The buildings to build.
    */
   autoBuild(
-    builds: Partial<Record<SpaceBuildings, SpaceBuildingSetting>> = this.settings.buildings,
+    builds: Partial<Record<SpaceBuilding, SpaceBuildingSetting>> = this.settings.buildings,
   ) {
     const bulkManager = this._bulkManager;
     const trigger = this.settings.trigger;
@@ -62,7 +62,7 @@ export class SpaceManager implements Automation {
     this.manager.render();
 
     // Get the current metadata for all the referenced buildings.
-    const metaData: Partial<Record<SpaceBuildings, SpaceBuildingInfo>> = {};
+    const metaData: Partial<Record<SpaceBuilding, SpaceBuildingInfo>> = {};
     for (const build of Object.values(builds)) {
       metaData[build.building] = this.getBuild(build.building);
     }
@@ -74,7 +74,7 @@ export class SpaceManager implements Automation {
     // Build all entries in the build list, where we can build any items.
     for (const build of buildList) {
       if (build.count > 0) {
-        this.build(build.id as SpaceBuildings, build.count);
+        this.build(build.id as SpaceBuilding, build.count);
         refreshRequired = true;
       }
     }
@@ -97,7 +97,7 @@ export class SpaceManager implements Automation {
       if (
         0 < missions[i].val ||
         !missions[i].unlocked ||
-        !this.settings.unlockMissions.missions[missions[i].name as Missions].enabled
+        !this.settings.unlockMissions.missions[missions[i].name as Mission].enabled
       ) {
         continue;
       }
@@ -122,7 +122,7 @@ export class SpaceManager implements Automation {
     }
   }
 
-  build(name: SpaceBuildings, amount: number): void {
+  build(name: SpaceBuilding, amount: number): void {
     const build = this.getBuild(name);
     const button = this.getBuildButton(name);
 
@@ -150,7 +150,7 @@ export class SpaceManager implements Automation {
     }
   }
 
-  getBuild(name: SpaceBuildings): SpaceBuildingInfo {
+  getBuild(name: SpaceBuilding): SpaceBuildingInfo {
     return this._host.game.space.getBuilding(name);
   }
 

packages/kitten-scientists/source/TimeControlManager.ts

@@ -12,14 +12,14 @@ import {
   BuildButton,
   ButtonModernController,
   ButtonModernModel,
+  ChronoForgeUpgrade,
   ChronoForgeUpgradeInfo,
-  ChronoForgeUpgrades,
-  CycleArray,
+  Cycles,
   ShatterTCBtnController,
   TimeItemVariant,
   TimeTab,
+  VoidSpaceUpgrade,
   VoidSpaceUpgradeInfo,
-  VoidSpaceUpgrades,
 } from "./types/index.js";
 
 export class TimeControlManager {
@@ -424,7 +424,7 @@ export class TimeControlManager {
 
     // If skipping during this cycle was disabled, bail out.
     const currentCycle = this._host.game.calendar.cycle;
-    if (!this.settings.timeSkip.cycles[CycleArray[currentCycle]].enabled) {
+    if (!this.settings.timeSkip.cycles[Cycles[currentCycle]].enabled) {
       return;
     }
 
@@ -472,7 +472,7 @@ export class TimeControlManager {
       while (
         yearsPerCycle < canSkip &&
         this.settings.timeSkip.cycles[
-          CycleArray[((currentCycle + skipCycles) % cyclesPerEra) as CycleIndices]
+          Cycles[((currentCycle + skipCycles) % cyclesPerEra) as CycleIndices]
         ].enabled
       ) {
         willSkip += yearsPerCycle;
@@ -481,7 +481,7 @@ export class TimeControlManager {
       }
       if (
         this.settings.timeSkip.cycles[
-          CycleArray[((currentCycle + skipCycles) % cyclesPerEra) as CycleIndices]
+          Cycles[((currentCycle + skipCycles) % cyclesPerEra) as CycleIndices]
         ].enabled &&
         0 < canSkip
       ) {
@@ -498,13 +498,13 @@ export class TimeControlManager {
   }
 
   getBuild(
-    name: ChronoForgeUpgrades | VoidSpaceUpgrades,
+    name: ChronoForgeUpgrade | VoidSpaceUpgrade,
     variant: TimeItemVariant,
   ): ChronoForgeUpgradeInfo | VoidSpaceUpgradeInfo | null {
     if (variant === TimeItemVariant.Chronoforge) {
-      return this._host.game.time.getCFU(name as ChronoForgeUpgrades) ?? null;
+      return this._host.game.time.getCFU(name as ChronoForgeUpgrade) ?? null;
     } else {
-      return this._host.game.time.getVSU(name as VoidSpaceUpgrades) ?? null;
+      return this._host.game.time.getVSU(name as VoidSpaceUpgrade) ?? null;
     }
   }
 }

packages/kitten-scientists/source/TimeManager.ts

@@ -10,13 +10,13 @@ import {
   BuildButton,
   ButtonModernController,
   ButtonModernModel,
+  ChronoForgeUpgrade,
   ChronoForgeUpgradeInfo,
-  ChronoForgeUpgrades,
   FixCryochamberBtnController,
   TimeItemVariant,
   TimeTab,
+  VoidSpaceUpgrade,
   VoidSpaceUpgradeInfo,
-  VoidSpaceUpgrades,
 } from "./types/index.js";
 
 export class TimeManager {
@@ -92,7 +92,7 @@ export class TimeManager {
     for (const build of buildList) {
       if (build.count > 0) {
         this.build(
-          build.id as ChronoForgeUpgrades | VoidSpaceUpgrades,
+          build.id as ChronoForgeUpgrade | VoidSpaceUpgrade,
           build.variant as TimeItemVariant,
           build.count,
         );
@@ -106,7 +106,7 @@ export class TimeManager {
   }
 
   build(
-    name: ChronoForgeUpgrades | VoidSpaceUpgrades,
+    name: ChronoForgeUpgrade | VoidSpaceUpgrade,
     variant: TimeItemVariant,
     amount: number,
   ): void {
@@ -132,18 +132,18 @@ export class TimeManager {
   }
 
   getBuild(
-    name: ChronoForgeUpgrades | VoidSpaceUpgrades,
+    name: ChronoForgeUpgrade | VoidSpaceUpgrade,
     variant: TimeItemVariant,
   ): ChronoForgeUpgradeInfo | VoidSpaceUpgradeInfo | null {
     if (variant === TimeItemVariant.Chronoforge) {
-      return this._host.game.time.getCFU(name as ChronoForgeUpgrades) ?? null;
+      return this._host.game.time.getCFU(name as ChronoForgeUpgrade) ?? null;
     } else {
-      return this._host.game.time.getVSU(name as VoidSpaceUpgrades) ?? null;
+      return this._host.game.time.getVSU(name as VoidSpaceUpgrade) ?? null;
     }
   }
 
   getBuildButton(
-    name: ChronoForgeUpgrades | VoidSpaceUpgrades,
+    name: ChronoForgeUpgrade | VoidSpaceUpgrade,
     variant: TimeItemVariant,
   ): BuildButton<string, ButtonModernModel, ButtonModernController> | null {
     let buttons: Array<BuildButton>;

packages/kitten-scientists/source/settings/BonfireSettings.ts

@@ -1,6 +1,6 @@
 import { Maybe, isNil } from "@oliversalzburg/js-utils/nil.js";
 import { consumeEntriesPedantic } from "../tools/Entries.js";
-import { Building, BuildingArray, StagedBuilding, StagedBuildingArray } from "../types/index.js";
+import { Building, Buildings, StagedBuilding, StagedBuildings } from "../types/index.js";
 import { BuildingUpgradeSettings } from "./BuildingUpgradeSettings.js";
 import { Setting, SettingMax, SettingTrigger } from "./Settings.js";
 
@@ -96,11 +96,11 @@ export class BonfireSettings extends SettingTrigger {
     };
     const items = {} as BonfireBuildingSettings;
 
-    BuildingArray.forEach(item => {
+    Buildings.forEach(item => {
       if (item === "unicornPasture") return;
       items[item] = new BonfireBuildingSetting(item, !defaultOffBuilding.includes(item));
     });
-    StagedBuildingArray.forEach(item => {
+    StagedBuildings.forEach(item => {
       items[item] = new BonfireBuildingSetting(
         item,
         !defaultOffBuilding.includes(item),

packages/kitten-scientists/source/settings/BuildingUpgradeSettings.ts

@@ -1,6 +1,6 @@
 import { Maybe, isNil } from "@oliversalzburg/js-utils/nil.js";
 import { consumeEntriesPedantic } from "../tools/Entries.js";
-import { StagedBuilding, StagedBuildingArray } from "../types/index.js";
+import { StagedBuilding, StagedBuildings } from "../types/index.js";
 import { Setting } from "./Settings.js";
 
 export class BuildingUpgradeSetting extends Setting {
@@ -28,7 +28,7 @@ export class BuildingUpgradeSettings extends Setting {
 
   private initBuildings(): BuildingUpdateBuildingSettings {
     const items = {} as BuildingUpdateBuildingSettings;
-    StagedBuildingArray.forEach(item => {
+    StagedBuildings.forEach(item => {
       items[item] = new BuildingUpgradeSetting(item, true);
     });
     return items;

packages/kitten-scientists/source/settings/ElectLeaderSettings.ts

@@ -1,5 +1,5 @@
 import { Maybe, isNil } from "@oliversalzburg/js-utils/nil.js";
-import { Job, JobArray, Trait, TraitArray } from "../types/index.js";
+import { Job, Jobs, Trait, Traits } from "../types/index.js";
 import { Setting, SettingOptions } from "./Settings.js";
 
 export class ElectLeaderSettings extends Setting {
@@ -10,13 +10,13 @@ export class ElectLeaderSettings extends Setting {
     enabled = false,
     job = new SettingOptions<Job>(
       "priest",
-      JobArray.map(item => {
+      Jobs.map(item => {
         return { label: "", value: item };
       }),
     ),
     trait = new SettingOptions<Trait>(
       "wise",
-      TraitArray.map(item => {
+      Traits.map(item => {
         return { label: "", value: item };
       }),
     ),

packages/kitten-scientists/source/settings/EmbassySettings.ts

@@ -1,6 +1,6 @@
 import { Maybe, isNil } from "@oliversalzburg/js-utils/nil.js";
 import { consumeEntriesPedantic } from "../tools/Entries.js";
-import { Race, RaceArray } from "../types/index.js";
+import { Race, Races } from "../types/index.js";
 import { SettingMax, SettingTrigger } from "./Settings.js";
 
 export class EmbassySetting extends SettingMax {
@@ -28,7 +28,7 @@ export class EmbassySettings extends SettingTrigger {
 
   private initRaces(): EmbassyRaceSettings {
     const items = {} as EmbassyRaceSettings;
-    RaceArray.forEach(item => {
+    Races.forEach(item => {
       items[item] = new EmbassySetting(item, true);
     });
     return items;

packages/kitten-scientists/source/settings/LogFilterSettings.ts

@@ -22,7 +22,7 @@ export enum LogFilterItemVariant {
   misc = "ks-activity",
 }
 
-export const FilterItemArray = [
+export const FilterItems = [
   "accelerate",
   "adore",
   "build",
@@ -41,7 +41,7 @@ export const FilterItemArray = [
   "transcend",
   "upgrade",
 ] as const;
-export type FilterItem = (typeof FilterItemArray)[number];
+export type FilterItem = (typeof FilterItems)[number];
 
 export class LogFilterSettingsItem extends Setting {
   readonly #variant: LogFilterItemVariant;
@@ -70,7 +70,7 @@ export class LogFilterSettings extends Setting {
 
   private initFilters(): LogFilterSettingsItems {
     const items = {} as LogFilterSettingsItems;
-    FilterItemArray.forEach(item => {
+    FilterItems.forEach(item => {
       items[item] = new LogFilterSettingsItem(LogFilterItemVariant[item]);
     });
     return items;