chore(internal): add linter for member ordering

After-the-End-of-All-Things · Sep 17, 2023 · 1f57cf0 · 1f57cf0
1 parent f66a22a
commit 1f57cf0
Show file tree

Hide file tree

Showing 18 changed files with 90 additions and 151 deletions.
diff --git a/server/.eslintrc.js b/server/.eslintrc.js
@@ -5,7 +5,7 @@ module.exports = {
     tsconfigRootDir : __dirname, 
     sourceType: 'module',
   },
-  plugins: ['@typescript-eslint/eslint-plugin'],
+  plugins: ['@typescript-eslint/eslint-plugin', 'sort-class-members'],
   extends: [
     'plugin:@typescript-eslint/recommended',
     'plugin:prettier/recommended',
@@ -23,11 +23,26 @@ module.exports = {
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-floating-promises': 'error',
     '@typescript-eslint/no-misused-promises': 'error',
-    "prettier/prettier": [
-      "error",
+    'prettier/prettier': [
+      'error',
       {
-        "endOfLine": "auto"
+        'endOfLine': 'auto'
       },
     ],
+		'sort-class-members/sort-class-members': [
+			2,
+			{
+				'order': [
+					'[static-properties]',
+					'[static-methods]',
+					'[properties]',
+					'[conventional-private-properties]',
+					'constructor',
+					'[methods]',
+					'[conventional-private-methods]'
+				],
+				'accessorPairPositioning': 'getThenSet'
+			}
+		]
   },
 };
diff --git a/server/package-lock.json b/server/package-lock.json
diff --git a/server/package.json b/server/package.json
@@ -40,6 +40,7 @@
     "@nestjs/websockets": "^10.2.4",
     "bcrypt": "^5.1.0",
     "censor-sensor": "^1.0.6",
+    "eslint-plugin-sort-class-members": "^1.18.0",
     "fast-json-patch": "^3.1.1",
     "fs-extra": "^11.1.1",
     "gameanalytics-node-sdk": "^1.1.4",

diff --git a/server/src/modules/achievements/achievements.schema.ts b/server/src/modules/achievements/achievements.schema.ts
@@ -10,18 +10,15 @@ import { ObjectId } from '@mikro-orm/mongodb';
 
 @Entity()
 export class Achievements implements IAchievements {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
-
   @Unique()
   @Property({ hidden: true })
   userId: string;
-
   @Property()
   achievements: Record<string, number>;
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
 
   constructor(userId: string) {
     this.userId = userId;

diff --git a/server/src/modules/content/content.service.ts b/server/src/modules/content/content.service.ts
@@ -24,10 +24,6 @@ censor.disableTier(2);
 
 @Injectable()
 export class ContentService {
-  public get censor(): CensorSensor {
-    return censor;
-  }
-
   public content = {
     meta: {},
     locations: {},
@@ -42,6 +38,12 @@ export class ContentService {
     npcs: {},
   };
 
+  constructor(private logger: Logger) {}
+
+  public get censor(): CensorSensor {
+    return censor;
+  }
+
   private get locations(): Record<string, ILocation> {
     return this.content.locations;
   }
@@ -82,8 +84,6 @@ export class ContentService {
     return this.content.npcs;
   }
 
-  constructor(private logger: Logger) {}
-
   public async reloadContent() {
     this.logger.log('Loading game content over HTTP...');
 

diff --git a/server/src/modules/crafting/crafting.schema.ts b/server/src/modules/crafting/crafting.schema.ts
@@ -10,9 +10,6 @@ import { ObjectId } from '@mikro-orm/mongodb';
 
 @Entity()
 export class Crafting implements ICrafting {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
 
@@ -25,7 +22,6 @@ export class Crafting implements ICrafting {
 
   @Property()
   armorerXp: number;
-
   @Property()
   artisanLevel: number;
 
@@ -44,6 +40,9 @@ export class Crafting implements ICrafting {
   @Property()
   currentlyCraftingDoneAt: number;
 
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
+
   constructor(userId: string) {
     this.userId = userId;
 

diff --git a/server/src/modules/discoveries/discoveries.schema.ts b/server/src/modules/discoveries/discoveries.schema.ts
@@ -10,9 +10,6 @@ import { ObjectId } from '@mikro-orm/mongodb';
 
 @Entity()
 export class Discoveries implements IDiscoveries {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
 
@@ -59,6 +56,9 @@ export class Discoveries implements IDiscoveries {
   @Property()
   totalMonsterClaims: number;
 
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
+
   constructor(userId: string) {
     this.userId = userId;
 

diff --git a/server/src/modules/fight/fight.schema.ts b/server/src/modules/fight/fight.schema.ts
@@ -17,9 +17,6 @@ import { generateUUID } from '@utils/uuid';
 
 @Entity()
 export class Fight implements IFight {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey()
   id!: string;
 
@@ -54,6 +51,9 @@ export class Fight implements IFight {
   @Property()
   statusMessage: IFightStatusMessage[];
 
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
+
   constructor(
     involvedPlayers: string[],
     turnOrder: string[],

diff --git a/server/src/modules/inventory/inventory.schema.ts b/server/src/modules/inventory/inventory.schema.ts
@@ -10,24 +10,19 @@ import { ObjectId } from '@mikro-orm/mongodb';
 
 @Entity()
 export class Inventory implements IInventory {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
-
   @Unique()
   @Property({ hidden: true })
   userId: string;
-
   @Property()
   equippedItems: Record<ItemSlot, IEquipment | undefined>;
-
   @Property()
   otherJobEquipment: Record<string, Record<ItemSlot, IEquipment | undefined>>;
-
   @Property()
   resources: Record<string, number>;
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
 
   constructor(userId: string) {
     this.userId = userId;

diff --git a/server/src/modules/inventory/inventoryitem.schema.ts b/server/src/modules/inventory/inventoryitem.schema.ts
@@ -10,24 +10,19 @@ import { ObjectId } from '@mikro-orm/mongodb';
 
 @Entity()
 export class InventoryItem implements IInventoryItem {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
-
   @Index()
   @Property({ hidden: true })
   userId: string;
-
   @Property()
   itemId: string;
-
   @Property()
   instanceId: string;
-
   @Property()
   isInUse: boolean;
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
 
   constructor(userId: string, itemId: string, instanceId: string) {
     this.userId = userId;

diff --git a/server/src/modules/lottery/dailylottery.schema.ts b/server/src/modules/lottery/dailylottery.schema.ts
@@ -10,24 +10,19 @@ import { generateUUID } from '@utils/uuid';
 
 @Entity()
 export class DailyRandomLottery {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
-
   @Property()
   internalId: string;
-
   @Index()
   @Property()
   createdAt: Date;
-
   @Property()
   winnerId: string;
-
   @Property()
   claimed: boolean;
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
 
   constructor(winnerId: string) {
     this.createdAt = new Date();

diff --git a/server/src/modules/market/marketitem.schema.ts b/server/src/modules/market/marketitem.schema.ts
@@ -11,9 +11,6 @@ import { generateUUID } from '@utils/uuid';
 
 @Entity()
 export class MarketItem implements IMarketItem {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
 
@@ -49,6 +46,9 @@ export class MarketItem implements IMarketItem {
   @Property()
   meta: IMarketItemMeta;
 
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
+
   constructor(
     userId: string,
     itemId: string,

diff --git a/server/src/modules/market/marketsale.schema.ts b/server/src/modules/market/marketsale.schema.ts
@@ -11,9 +11,6 @@ import { generateUUID } from '@utils/uuid';
 
 @Entity()
 export class MarketSale implements IMarketSale {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
 
@@ -49,6 +46,9 @@ export class MarketSale implements IMarketSale {
   @Index({ options: { expireAfterSeconds: 0 } })
   expiresAt: Date;
 
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
+
   constructor(
     seller: string,
     buyer: string,

diff --git a/server/src/modules/notification/notification.schema.ts b/server/src/modules/notification/notification.schema.ts
@@ -11,9 +11,6 @@ import { generateUUID } from '@utils/uuid';
 
 @Entity()
 export class Notification implements INotification {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
 
@@ -44,6 +41,9 @@ export class Notification implements INotification {
   @Property()
   actions?: INotificationAction[];
 
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
+
   constructor(
     userId: string,
     text: string,

diff --git a/server/src/modules/player/player.schema.ts b/server/src/modules/player/player.schema.ts
@@ -21,9 +21,6 @@ import { ObjectId } from '@mikro-orm/mongodb';
 
 @Entity()
 export class Player implements IPlayer {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
 
@@ -73,6 +70,9 @@ export class Player implements IPlayer {
   @Property()
   cosmetics: IPlayerCosmetics;
 
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
+
   constructor(userId: string) {
     this.userId = userId;
 

diff --git a/server/src/modules/stats/stats.schema.ts b/server/src/modules/stats/stats.schema.ts
@@ -11,9 +11,6 @@ import { Discoveries } from '@modules/discoveries/discoveries.schema';
 
 @Entity()
 export class Stats implements IStats {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
 
@@ -45,6 +42,9 @@ export class Stats implements IStats {
   @Property()
   stats: Partial<Record<TrackedStat, number>>;
 
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
+
   constructor(userId: string) {
     this.userId = userId;
 

diff --git a/server/src/modules/user/user.schema.ts b/server/src/modules/user/user.schema.ts
@@ -13,9 +13,6 @@ export type UserId = User['_id'];
 
 @Entity()
 export class User implements IUser {
-  @PrimaryKey()
-  _id!: ObjectId;
-
   @SerializedPrimaryKey()
   id!: string;
 
@@ -38,6 +35,9 @@ export class User implements IUser {
   @Property()
   email: string;
 
+  @PrimaryKey()
+  _id!: ObjectId;
+
   constructor(
     username: string,
     discriminator: string,

diff --git a/server/src/modules/wave/playerwave.schema.ts b/server/src/modules/wave/playerwave.schema.ts
@@ -9,23 +9,19 @@ import { ObjectId } from '@mikro-orm/mongodb';
 
 @Entity()
 export class PlayerWave {
-  @PrimaryKey({ hidden: true })
-  _id!: ObjectId;
-
   @SerializedPrimaryKey({ hidden: true })
   id!: string;
-
   @Index()
   @Property()
   playerWaving: string;
-
   @Index()
   @Property()
   playerWavingAt: string;
-
   @Property()
   @Index({ options: { expireAfterSeconds: 0 } })
   expiresAt: Date;
+  @PrimaryKey({ hidden: true })
+  _id!: ObjectId;
 
   constructor(
     playerWaving: string,