feat: rework eslint config

eslint.config.mjs

@@ -0,0 +1,56 @@
+// @ts-check
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import stylistic from '@stylistic/eslint-plugin';
+import * as augu from '@augu/eslint-config';
+
+export default tseslint.config(
+    {
+        ignores: [
+            'docs/*',
+            'dist/*',
+            'node_modules/*',
+        ],
+    },
+    eslint.configs.recommended,
+    ...tseslint.configs.recommendedTypeChecked,
+    ...tseslint.configs.stylisticTypeChecked,
+    // @ts-expect-error incorrect type from package, but still compatible
+    augu.javascript(),
+    // temp disable due to rule move from typescript-eslint (ts) -> stylistic (style)
+    // await augu.typescript(),
+    stylistic.configs['disable-legacy'],
+    {
+        languageOptions: {
+            parserOptions: {
+                projectService: true,
+                tsconfigRootDir: import.meta.dirname,
+            },
+        },
+        plugins: {
+            '@stylistic': stylistic,
+        },
+        rules: {
+            '@stylistic/semi': [ 'error' ],
+            '@stylistic/member-delimiter-style': [ 'error' ],
+            '@stylistic/indent': [ 'error', 4, { 'SwitchCase': 1 }],
+            '@stylistic/space-infix-ops': [ 'error' ],
+            '@stylistic/key-spacing': [ 'error', { 'mode': 'strict' }],
+            '@stylistic/keyword-spacing': [ 'error' ],
+            '@stylistic/indent-binary-ops': [ 'error', 4 ],
+            '@stylistic/type-generic-spacing': [ 'error' ],
+            '@stylistic/type-named-tuple-spacing': [ 'error' ],
+            '@stylistic/type-annotation-spacing': [ 'error', { 'before': false, 'after': true, 'overrides': { 'arrow': { 'before': true, 'after': true }}}],
+            '@stylistic/quotes': [ 'error', 'single' ],
+            '@stylistic/comma-dangle': [ 'error', 'always-multiline' ],
+            '@stylistic/brace-style': [ 'error', '1tbs' ],
+            '@stylistic/object-curly-spacing': [ 'error', 'always', { 'objectsInObjects': false, 'arraysInObjects': false }],
+            '@stylistic/array-bracket-spacing': [ 'error', 'always', { 'objectsInArrays': false, 'arraysInArrays': false }],
+            '@stylistic/block-spacing': [ 'error', 'always' ],
+            '@stylistic/arrow-spacing': 'error',
+            '@stylistic/switch-colon-spacing': [ 'error', { 'after': true, 'before': false }],
+            'camelcase': 'off',
+            'require-await': 'error',
+        },
+    },
+);

package.json

@@ -16,7 +16,7 @@
     "build": "npm run build:ts && npm run build:docs",
     "build:ts": "tsup --config tsup-config.json",
     "build:docs": "typedoc --theme default --readme README.md --out docs/ --entryPointStrategy expand src/.",
-    "lint": "eslint --fix --ext .ts",
+    "lint": "eslint .",
     "prepare": "npm run build:ts"
   },
   "keywords": [
@@ -44,15 +44,19 @@
     "ws": "^8.18.0"
   },
   "devDependencies": {
-    "@augu/eslint-config": "4.0.1",
-    "@types/node": "^20.14.11",
+    "@augu/eslint-config": "5.2.4",
+    "@eslint/js": "^9.9.0",
+    "@stylistic/eslint-plugin": "^2.6.2",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.2.0",
     "@types/node-fetch": "^2.6.11",
-    "@types/ws": "^8.5.11",
-    "@typescript-eslint/eslint-plugin": "^7.16.1",
-    "@typescript-eslint/parser": "^7.16.1",
-    "eslint": "^8.56.0",
-    "tsup": "^8.2.0",
-    "typedoc": "^0.26.4",
-    "typescript": "^5.5.3"
+    "@types/ws": "^8.5.12",
+    "@typescript-eslint/eslint-plugin": "^8.0.1",
+    "@typescript-eslint/parser": "^8.0.1",
+    "eslint": "^9.9.0",
+    "tsup": "^8.2.4",
+    "typedoc": "^0.26.5",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.0.1"
   }
 }

src/Constants.ts

@@ -7,27 +7,27 @@ export enum State {
     CONNECTED,
     RECONNECTING,
     DISCONNECTING,
-    DISCONNECTED
+    DISCONNECTED,
 }
 
 export enum VoiceState {
     SESSION_READY,
     SESSION_ID_MISSING,
     SESSION_ENDPOINT_MISSING,
-    SESSION_FAILED_UPDATE
+    SESSION_FAILED_UPDATE,
 }
 
 export enum OpCodes {
     PLAYER_UPDATE = 'playerUpdate',
     STATS = 'stats',
     EVENT = 'event',
-    READY = 'ready'
+    READY = 'ready',
 }
 
-export enum Versions {
-    REST_VERSION = 4,
-    WEBSOCKET_VERSION = 4
-}
+export const Versions = {
+    REST_VERSION: 4,
+    WEBSOCKET_VERSION: 4,
+};
 
 export const ShoukakuDefaults: Required<ShoukakuOptions> = {
     resume: false,
@@ -43,7 +43,7 @@ export const ShoukakuDefaults: Required<ShoukakuOptions> = {
     nodeResolver: (nodes) => [ ...nodes.values() ]
         .filter(node => node.state === State.CONNECTED)
         .sort((a, b) => a.penalties - b.penalties)
-        .shift()
+        .shift(),
 };
 
 export const ShoukakuClientInfo = `${Info.name}/${Info.version} (${Info.repository.url})`;
@@ -53,5 +53,5 @@ export const NodeDefaults: NodeOption = {
     url: '',
     auth: '',
     secure: false,
-    group: undefined
+    group: undefined,
 };

src/Shoukaku.ts

@@ -5,13 +5,13 @@ import { Connector } from './connectors/Connector';
 import { Constructor, mergeDefault } from './Utils';
 import { Player } from './guild/Player';
 import { Rest } from './node/Rest';
-import { Connection } from './guild/Connection.js';
+import { Connection } from './guild/Connection';
 
 export interface Structures {
     /**
      * A custom structure that extends the Rest class
      */
-    rest?:  Constructor<Rest>;
+    rest?: Constructor<Rest>;
     /**
      * A custom structure that extends the Player class
      */
@@ -85,7 +85,7 @@ export interface ShoukakuOptions {
     /**
      * Node Resolver to use if you want to customize it
      */
-    nodeResolver?: (nodes: Map<string, Node>, connection?: Connection) => Node|undefined;
+    nodeResolver?: (nodes: Map<string, Node>, connection?: Connection) => Node | undefined;
 }
 
 export interface VoiceChannelOptions {
@@ -134,17 +134,17 @@ export interface ShoukakuEvents {
     'raw': [name: string, json: unknown];
 }
 
-export declare interface Shoukaku {
+export declare interface IShoukaku {
     on<K extends keyof ShoukakuEvents>(event: K, listener: (...args: ShoukakuEvents[K]) => void): this;
     once<K extends keyof ShoukakuEvents>(event: K, listener: (...args: ShoukakuEvents[K]) => void): this;
     off<K extends keyof ShoukakuEvents>(event: K, listener: (...args: ShoukakuEvents[K]) => void): this;
-    emit(event: string | symbol, ...args: any[]): boolean;
+    emit(event: string | symbol, ...args: unknown[]): boolean;
 }
 
 /**
  * Main Shoukaku class
  */
-export class Shoukaku extends EventEmitter {
+export class Shoukaku extends EventEmitter implements IShoukaku {
     /**
      * Discord library connector
      */
@@ -168,7 +168,7 @@ export class Shoukaku extends EventEmitter {
     /**
      * Shoukaku instance identifier
      */
-    public id: string|null;
+    public id: string | null;
     /**
      * @param connector A Discord library connector
      * @param nodes An array that conforms to the NodeOption type that specifies nodes to connect to
@@ -187,7 +187,7 @@ export class Shoukaku extends EventEmitter {
     constructor(connector: Connector, nodes: NodeOption[], options: ShoukakuOptions = {}) {
         super();
         this.connector = connector.set(this);
-        this.options = mergeDefault(ShoukakuDefaults, options);
+        this.options = mergeDefault<ShoukakuOptions>(ShoukakuDefaults, options);
         this.nodes = new Map();
         this.connections = new Map();
         this.players = new Map();
@@ -214,13 +214,13 @@ export class Shoukaku extends EventEmitter {
      */
     public addNode(options: NodeOption): void {
         const node = new Node(this, options);
-        node.on('debug', (...args) => this.emit('debug', node.name, ...args));
-        node.on('reconnecting', (...args) => this.emit('reconnecting', node.name, ...args));
-        node.on('error', (...args) => this.emit('error', node.name, ...args));
-        node.on('close', (...args) => this.emit('close', node.name, ...args));
-        node.on('ready', (...args) => this.emit('ready', node.name, ...args));
-        node.on('raw', (...args) => this.emit('raw', node.name, ...args));
-        node.once('disconnect', (...args) => this.clean(node, ...args));
+        node.on('debug', (...args: unknown[]) => this.emit('debug', node.name, ...args));
+        node.on('reconnecting', (...args: unknown[]) => this.emit('reconnecting', node.name, ...args));
+        node.on('error', (...args: unknown[]) => this.emit('error', node.name, ...args));
+        node.on('close', (...args: unknown[]) => this.emit('close', node.name, ...args));
+        node.on('ready', (...args: unknown[]) => this.emit('ready', node.name, ...args));
+        node.on('raw', (...args: unknown[]) => this.emit('raw', node.name, ...args));
+        node.once('disconnect', (...args: unknown[]) => this.clean(node, ...args));
         node.connect();
         this.nodes.set(node.name, node);
     }
@@ -263,7 +263,7 @@ export class Shoukaku extends EventEmitter {
             const player = this.options.structures.player ? new this.options.structures.player(connection.guildId, node) : new Player(connection.guildId, node);
             const onUpdate = (state: VoiceState) => {
                 if (state !== VoiceState.SESSION_READY) return;
-                player.sendServerUpdate(connection);
+                void player.sendServerUpdate(connection);
             };
             await player.sendServerUpdate(connection);
             connection.on('connectionUpdate', onUpdate);
@@ -291,7 +291,7 @@ export class Shoukaku extends EventEmitter {
         if (player) {
             try {
                 await player.destroy();
-            } catch (_) { /* empty */ }
+            } catch { /* empty */ }
             player.clean();
             this.players.delete(guildId);
         }

src/Utils.ts

@@ -1,12 +1,13 @@
-export type Constructor<T> = new (...args: any[]) => T;
+export type Constructor<T> = new (...args: unknown[]) => T;
 
 /**
  * Merge the default options to user input
  * @param def Default options
  * @param given User input
  * @returns Merged options
  */
-export function mergeDefault<T extends { [key: string]: any }>(def: T, given: T): Required<T> {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function mergeDefault<T extends Record<string, any>>(def: T, given: T): Required<T> {
     if (!given) return def as Required<T>;
     const defaultKeys: (keyof T)[] = Object.keys(def);
     for (const key in given) {

src/connectors/Connector.ts

@@ -1,6 +1,8 @@
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access */
 import { NodeOption, Shoukaku } from '../Shoukaku';
 import { NodeDefaults } from '../Constants';
 import { mergeDefault } from '../Utils';
+import { ServerUpdate, StateUpdatePartial } from '../guild/Connection';
 
 export interface ConnectorMethods {
     sendPacket: any;
@@ -11,8 +13,9 @@ export const AllowedPackets = [ 'VOICE_STATE_UPDATE', 'VOICE_SERVER_UPDATE' ];
 
 export abstract class Connector {
     protected readonly client: any;
-    protected manager: Shoukaku|null;
+    protected manager: Shoukaku | null;
     constructor(client: any) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         this.client = client;
         this.manager = null;
     }
@@ -28,19 +31,19 @@ export abstract class Connector {
     }
 
     protected raw(packet: any): void {
-        if (!AllowedPackets.includes(packet.t)) return;
-        const guildId = packet.d.guild_id;
+        if (!AllowedPackets.includes(packet.t as string)) return;
+        const guildId = packet.d.guild_id as string;
         const connection = this.manager!.connections.get(guildId);
         if (!connection) return;
-        if (packet.t === 'VOICE_SERVER_UPDATE') return connection.setServerUpdate(packet.d);
-        const userId = packet.d.user_id;
+        if (packet.t === 'VOICE_SERVER_UPDATE') return connection.setServerUpdate(packet.d as ServerUpdate);
+        const userId = packet.d.user_id as string;
         if (userId !== this.manager!.id) return;
-        connection.setStateUpdate(packet.d);
+        connection.setStateUpdate(packet.d as StateUpdatePartial);
     }
 
     abstract getId(): string;
 
-    abstract sendPacket(shardId: number, payload: any, important: boolean): void;
+    abstract sendPacket(shardId: number, payload: unknown, important: boolean): void;
 
     abstract listen(nodes: NodeOption[]): void;
 }

src/connectors/libs/DiscordJS.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-explicit-any */
 import { Connector } from '../Connector';
 import { NodeOption } from '../../Shoukaku';
 

src/connectors/libs/Eris.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-explicit-any */
 import { Connector } from '../Connector';
 import { NodeOption } from '../../Shoukaku';
 

src/connectors/libs/OceanicJS.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-explicit-any */
 import { Connector } from '../Connector';
 import { NodeOption } from '../../Shoukaku';
 

src/connectors/libs/Seyfert.ts

@@ -1,9 +1,10 @@
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-explicit-any */
 import { Connector } from '../Connector';
 import { NodeOption } from '../../Shoukaku';
 
 export class Seyfert extends Connector {
     // sendPacket is where your library send packets to Discord Gateway
-    public sendPacket(shardId: number, payload: any, important: boolean): void {
+    public sendPacket(shardId: number, payload: unknown, important: boolean): void {
         return this.client.gateway.send(shardId, payload);
     }
     // getId is a getter where the lib stores the client user (the one logged in as a bot) id
@@ -13,13 +14,13 @@ export class Seyfert extends Connector {
     // Listen attaches the event listener to the library you are using
     public listen(nodes: NodeOption[]): void {
         this.client.events.values.RAW = {
-            data: { name: "raw" },
+            data: { name: 'raw' },
             run: (packet: any) => {
                 // Only attach to ready event once, refer to your library for its ready event
-                if (packet.t === "READY") return this.ready(nodes);
+                if (packet.t === 'READY') return this.ready(nodes);
                 // Attach to the raw websocket event, this event must be 1:1 on spec with dapi (most libs implement this)
                 return this.raw(packet);
-            }
-        }
+            },
+        };
     }
 }

src/connectors/libs/index.ts

@@ -1,4 +1,4 @@
 export * from './DiscordJS';
 export * from './Eris';
 export * from './OceanicJS';
-export * from "./Seyfert"
+export * from './Seyfert';