refactor: #158 remove no-explicit-any ignore eslint rule (#159)

* removed tslint * add eslint * add default config * setup default config and npm run command * add command to node.js.yml * set rules to support current codebase * remove unused tslint.json * include sample files in eslint command * remove rule no-explicit-any * specify type for timer * remove any from filterKeys * explictly declare that error can be Error, String but still accept any from the end users * specify types in the sync worker * improve the IndexableError type * explain why any is allowed in CustomData * update package lock in sample * Update lib/raygun.sync.worker.ts Co-authored-by: Sumitra Manga <[email protected]> * remove empty line --------- Co-authored-by: Sumitra Manga <[email protected]>
MindscapeHQ · May 6, 2024 · 6ec163e · 6ec163e
1 parent b165b99
commit 6ec163e
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 16 deletions.
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -9,7 +9,6 @@ export default tseslint.config(
     {
         rules: {
             // TODO: Remove ignored rules and fix the code
-            "@typescript-eslint/no-explicit-any": "off",
             "@typescript-eslint/no-this-alias": "off",
             "@typescript-eslint/no-unused-vars": "off",
             "@typescript-eslint/no-var-requires": "off",

diff --git a/examples/express-sample/package-lock.json b/examples/express-sample/package-lock.json
diff --git a/lib/raygun.batch.ts b/lib/raygun.batch.ts
@@ -32,7 +32,7 @@ export const MAX_BATCH_SIZE_BYTES = 1638400;
 const MAX_BATCH_INNER_SIZE_BYTES = MAX_BATCH_SIZE_BYTES - 2; // for the starting and ending byte
 
 export class RaygunBatchTransport {
-  private timerId: any | null = null;
+  private timerId: NodeJS.Timeout | null = null;
   private httpOptions: HTTPOptions;
   private interval: number;
   private batchId: number = 0;

diff --git a/lib/raygun.messageBuilder.ts b/lib/raygun.messageBuilder.ts
@@ -31,18 +31,21 @@ type UserMessageData = RawUserData | string | undefined;
 const humanString = require("object-to-human-string");
 const packageDetails = require("../package.json");
 
-function filterKeys(obj: { [key: string]: any }, filters: string[]) {
+function filterKeys(obj: object, filters: string[]): object {
   if (!obj || !filters || typeof obj !== "object") {
     return obj;
   }
+  // Make temporary copy of the object to avoid mutating the original
+  // Cast to Record<string, object> to enforce type check and avoid using any
+  const _obj = { ...obj } as Record<string, object>;
   Object.keys(obj).forEach(function (i) {
     if (filters.indexOf(i) > -1) {
-      delete obj[i];
+      delete _obj[i];
     } else {
-      obj[i] = filterKeys(obj[i], filters);
+      _obj[i] = filterKeys(_obj[i], filters);
     }
   });
-  return obj;
+  return _obj;
 }
 
 function getStackTrace(
@@ -126,7 +129,8 @@ export class RaygunMessageBuilder {
     return this.message as Message;
   }
 
-  setErrorDetails(error: any) {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  setErrorDetails(error: Error | string | any) {
     if (
       !(error instanceof Error) &&
       typeof error !== "string" &&

diff --git a/lib/raygun.sync.worker.ts b/lib/raygun.sync.worker.ts
@@ -1,17 +1,17 @@
 import fs from "fs";
-
 import * as transport from "./raygun.transport";
 import { SendOptions, SendOptionsWithoutCB } from "./types";
+import { IncomingMessage } from "http";
 
 // Read stdin synchronously
 const data = fs.readFileSync(0, "utf-8");
 
 const options: SendOptionsWithoutCB = JSON.parse(data);
-const sendOptions = { ...options, callback };
+const sendOptions: SendOptions = { ...options, callback };
 
 transport.send(sendOptions);
 
-function callback(error: Error | null, result: any) {
+function callback(error: Error | null, result: IncomingMessage | null) {
   if (error) {
     console.log("Error sending with sync transport", error);
   } else {

diff --git a/lib/types.ts b/lib/types.ts
@@ -1,8 +1,9 @@
 import type { IncomingMessage } from "http";
 
-export type IndexableError = Error & {
-  [key: string]: any;
-};
+// IndexableError is a type that extends the Error type
+// and allows for any additional properties to be added to it.
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type IndexableError = Error & Record<string, any>;
 
 export type MessageBuilderOptions = {
   reportColumnNumbers?: boolean;
@@ -80,6 +81,8 @@ export type HTTPOptions = {
   apiKey: string;
 };
 
+// Allow any because users are free to set anything as CustomData
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type CustomData = any;
 
 export type RequestParams = ({ host: string } | { hostname: string }) &