chore: adding eslint configs and scripts

Signed-off-by: Fawzi Abdulfattah <[email protected]>

Author: iifawzi

core/connectors/ioredis.connector.ts

@@ -1,5 +1,4 @@
 import { IClientConnector } from "@core/types";
-
 /**
  * AbstractProducer is an abstract class that provides basic functionalities for adding data to queues.
  * It ensures atomic operations if needed and handles graceful shutdown on process termination signals.
@@ -10,10 +9,7 @@ export default abstract class AbstractProducer<K> {
    * @param name - The name of the queue.
    * @param client - An instance of IClientConnector to interact with the queue.
    */
-  constructor(
-    private name: string,
-    private client: IClientConnector<K>
-  ) {
+  constructor(private name: string, private client: IClientConnector<K>) {
     process.once("SIGINT", this.handleShutdown.bind(this));
     process.once("SIGTERM", this.handleShutdown.bind(this));
   }
@@ -24,7 +20,7 @@ export default abstract class AbstractProducer<K> {
    * @param additionalQueues - Optional. Additional queues to which the data should be added atomically.
    * @returns A promise that resolves when the data has been added.
    */
-  public async add(data: any, additionalQueues?: string[]) {
+  public async add(data: unknown, additionalQueues?: string[]) {
     await this.client.create();
     if (additionalQueues && additionalQueues.length) {
       await this.client.addAtomic(this.name, additionalQueues, data);
@@ -39,7 +35,7 @@ export default abstract class AbstractProducer<K> {
    * @param additionalQueues - Optional. Additional queues to which the data should be added atomically.
    * @returns A promise that resolves when the data has been added.
    */
-  public async bulk(data: any[], additionalQueues: string[] = []) {
+  public async bulk(data: unknown[], additionalQueues: string[] = []) {
     await this.client.create();
     if (additionalQueues.length) {
       await this.client.bulkAtomic(this.name, additionalQueues, data);

core/producer/index.ts

@@ -38,7 +38,7 @@ export interface IClientConnector<K> {
     consumerId: string,
     count: number,
     block: number
-  ): Promise<any>;
+  ): Promise<unknown>; // TODO:: improve type
 
   /**
    * Acknowledges a message in a consumer group as processed.
@@ -74,7 +74,7 @@ export interface IClientConnector<K> {
    * @param data - The data to add to the queue.
    * @returns A promise that resolves when the data is added.
    */
-  add(queue: string, data: any): Promise<void>;
+  add(queue: string, data: unknown): Promise<void>;
 
   /**
    * Adds data atomically to the specified queue and additional queues.
@@ -83,15 +83,15 @@ export interface IClientConnector<K> {
    * @param data - The data to add to the queues.
    * @returns A promise that resolves when the data is added.
    */
-  addAtomic(queue: string, additionalQueues: string[], data: any): Promise<void>;
+  addAtomic(queue: string, additionalQueues: string[], data: unknown): Promise<void>;
 
   /**
    * Adds multiple data entries to the specified queue.
    * @param queue - The name of the queue.
    * @param data - An array of data entries to add to the queue.
    * @returns A promise that resolves when the data is added.
    */
-  bulk(queue: string, data: any[]): Promise<void>;
+  bulk(queue: string, data: unknown[]): Promise<void>;
 
   /**
    * Adds multiple data entries atomically to the specified queue and additional queues.
@@ -100,7 +100,7 @@ export interface IClientConnector<K> {
    * @param data - An array of data entries to add to the queues.
    * @returns A promise that resolves when the data is added.
    */
-  bulkAtomic(queue: string, additionalQueues: string[], data: any[]): Promise<void>;
+  bulkAtomic(queue: string, additionalQueues: string[], data: unknown[]): Promise<void>;
 
   /**
    * Sets a heartbeat for the specified worker.

core/types/client.connector.ts

@@ -0,0 +1,20 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default [
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    rules: {
+      "sort-imports": ["error", {
+        "ignoreCase": false,
+        "ignoreDeclarationSort": false,
+        "ignoreMemberSort": false,
+        "memberSyntaxSortOrder": ["none", "all", "multiple", "single"],
+        "allowSeparatedGroups": false
+      }]
+    }
+  }
+];

eslint.config.mjs

@@ -4,7 +4,8 @@
   "description": "RunMQ - A Pioneering message queue & batch processing solution for Node.js. Redefining task management like never before",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix ."
   },
   "_moduleAliases": {
     "@": "dist"
@@ -19,7 +20,14 @@
     "url": "https://github.com/runmq/queue/issues"
   },
   "homepage": "https://github.com/runmq/queue#readme",
+  "dependencies": {
+    "ioredis": "^5.4.1"
+  },
   "devDependencies": {
-    "@types/node": "^20.12.13"
+    "@eslint/js": "^9.4.0",
+    "@types/node": "^20.12.13",
+    "eslint": "^9.4.0",
+    "globals": "^15.3.0",
+    "typescript-eslint": "^7.11.0"
   }
 }