chore: increase linting strictness

Author: nbbeeken

.eslintrc.json

@@ -32,37 +32,6 @@
     "strict": ["error", "global"],
     "promise/no-native": "error",
 
-    // TBD
-    "@typescript-eslint/ban-types": "off",
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "@typescript-eslint/no-empty-function": "off",
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-this-alias": "off",
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "@typescript-eslint/no-var-requires": "off",
-    "no-var": "off",
-    "prefer-const": "off",
-    "prefer-spread": "off",
-    "prefer-rest-params": "off"
-
-    // possible future options
-    // "@typescript-eslint/ban-types": 2,
-    // "@typescript-eslint/explicit-module-boundary-types": 2,
-    // "@typescript-eslint/no-empty-function": 2,
-    // "@typescript-eslint/no-explicit-any": 2,
-    // "@typescript-eslint/no-this-alias": 2,
-    // "@typescript-eslint/no-non-null-assertion": 2,
-    // "@typescript-eslint/no-var-requires": 2,
-    // "no-var": 2,
-    // "prefer-const": 2
-  },
-  "settings": {
-    "jsdoc": {
-      "check-types": false,
-      "mode": "typescript",
-      "tagNamePreference": {
-        "augments": "extends"
-      }
-    }
+    "@typescript-eslint/no-explicit-any": "off"
   }
 }

package-lock.json

@@ -92,7 +92,7 @@
     "build:docs": "npm run build:dts && typedoc",
     "check:bench": "node test/benchmarks/driverBench",
     "check:coverage": "nyc npm run check:test",
-    "check:lint": "eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test",
+    "check:lint": "tsc -v && tsc --noEmit && eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test",
     "check:test": "mocha --recursive test/functional test/unit",
     "check:ts": "tsc --noEmit",
     "check:atlas": "mocha --config \"test/manual/mocharc.json\" test/manual/atlas_connectivity.test.js",

package.json

@@ -7,8 +7,8 @@ import type { MongoClient } from './mongo_client';
 
 /** @public */
 export class Instrumentation extends EventEmitter {
-  $MongoClient: any;
-  $prototypeConnect: any;
+  $MongoClient?: typeof MongoClient;
+  $prototypeConnect?: typeof MongoClient['connect'];
 
   /** @event */
   static readonly STARTED = 'started' as const;
@@ -21,13 +21,14 @@ export class Instrumentation extends EventEmitter {
     super();
   }
 
-  instrument(MongoClient: any, callback: Callback) {
+  instrument(mongoClientClass: typeof MongoClient, callback?: Callback): void {
     // store a reference to the original functions
-    this.$MongoClient = MongoClient;
-    const $prototypeConnect = (this.$prototypeConnect = MongoClient.prototype.connect);
+    this.$MongoClient = mongoClientClass;
+    const $prototypeConnect = (this.$prototypeConnect = mongoClientClass.prototype.connect);
 
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
     const instrumentation = this;
-    MongoClient.prototype.connect = function (this: MongoClient, callback: Callback) {
+    mongoClientClass.prototype.connect = function (this: MongoClient, callback: Callback) {
       // override monitorCommands to be switched on
       this.s.options = { ...(this.s.options ?? {}), monitorCommands: true };
 
@@ -42,12 +43,14 @@ export class Instrumentation extends EventEmitter {
       );
 
       return $prototypeConnect.call(this, callback);
-    };
+    } as MongoClient['connect'];
 
     if (typeof callback === 'function') callback(undefined, this);
   }
 
-  uninstrument() {
-    this.$MongoClient.prototype.connect = this.$prototypeConnect;
+  uninstrument(): void {
+    if (this.$MongoClient) {
+      this.$MongoClient.prototype.connect = this.$prototypeConnect as any;
+    }
   }
 }

src/apm.ts

@@ -25,6 +25,7 @@ export {
 
 /** @public */
 export interface Document {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [key: string]: any;
 }
 

src/bson.ts

@@ -216,7 +216,7 @@ export class BulkWriteResult {
     }
   }
 
-  toJSON(): object {
+  toJSON(): Document {
     return this.result;
   }
 
@@ -235,9 +235,9 @@ export class BulkWriteResult {
  * @category Error
  */
 export class WriteConcernError {
-  err: any;
+  err: { errmsg: string; code: number };
 
-  constructor(err: any) {
+  constructor(err: { errmsg: string; code: number }) {
     this.err = err;
   }
 
@@ -266,9 +266,9 @@ export class WriteConcernError {
  * @category Error
  */
 export class WriteError {
-  err: any;
+  err: { errmsg?: string; code: number; index: number; op: Document };
 
-  constructor(err: any) {
+  constructor(err: { errmsg?: string; code: number; index: number; op: Document }) {
     this.err = err;
   }
 
@@ -288,11 +288,11 @@ export class WriteError {
   }
 
   /** Returns the underlying operation that caused the error */
-  getOperation(): any {
+  getOperation(): Document {
     return this.err.op;
   }
 
-  toJSON(): { code: number; index: number; errmsg?: string; op: any } {
+  toJSON(): { code: number; index: number; errmsg?: string; op: Document } {
     return { code: this.err.code, index: this.err.index, errmsg: this.err.errmsg, op: this.err.op };
   }
 
@@ -578,8 +578,8 @@ export class BulkWriteError extends MongoError {
   result?: BulkWriteResult;
 
   /** Creates a new BulkWriteError */
-  constructor(error?: any, result?: BulkWriteResult) {
-    const message = error.err || error.errmsg || error.errMessage || error;
+  constructor(error?: MongoError, result?: BulkWriteResult) {
+    const message = (error as any).err || error?.errmsg || (error as any).errMessage || error;
     super(message);
 
     Object.assign(this, error);

src/bulk/common.ts

@@ -68,6 +68,9 @@ class OrderedBulkOperation extends BulkOperationBase {
   }
 }
 
-export function initializeOrderedBulkOp(collection: Collection, options: BulkWriteOptions) {
+export function initializeOrderedBulkOp(
+  collection: Collection,
+  options: BulkWriteOptions
+): OrderedBulkOperation {
   return new OrderedBulkOperation(collection, options);
 }

src/bulk/ordered.ts

@@ -97,6 +97,9 @@ class UnorderedBulkOperation extends BulkOperationBase {
   }
 }
 
-export function initializeUnorderedBulkOp(collection: Collection, options: BulkWriteOptions) {
+export function initializeUnorderedBulkOp(
+  collection: Collection,
+  options: BulkWriteOptions
+): UnorderedBulkOperation {
   return new UnorderedBulkOperation(collection, options);
 }

src/bulk/unordered.ts

@@ -209,6 +209,7 @@ export class ChangeStream extends EventEmitter {
       this.topology = parent.s.topology;
     } else if (parent instanceof MongoClient) {
       this.type = CHANGE_DOMAIN_TYPES.CLUSTER;
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       this.topology = parent.topology!;
     } else {
       throw new TypeError(
@@ -406,16 +407,16 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     }
   }
 
-  set resumeToken(token) {
+  set resumeToken(token: ResumeToken) {
     this._resumeToken = token;
     this.emit(ChangeStream.RESUME_TOKEN_CHANGED, token);
   }
 
-  get resumeToken() {
+  get resumeToken(): ResumeToken {
     return this._resumeToken;
   }
 
-  get resumeOptions() {
+  get resumeOptions(): Document {
     const result: Document = {};
     for (const optionName of CURSOR_OPTIONS) {
       if (Reflect.has(this.options, optionName)) {
@@ -438,7 +439,7 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     return result;
   }
 
-  cacheResumeToken(resumeToken: ResumeToken) {
+  cacheResumeToken(resumeToken: ResumeToken): void {
     if (this.bufferedCount() === 0 && this.cursorState.postBatchResumeToken) {
       this.resumeToken = this.cursorState.postBatchResumeToken;
     } else {
@@ -447,7 +448,7 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     this.hasReceived = true;
   }
 
-  _processBatch(batchName: string, response?: Document) {
+  _processBatch(batchName: string, response?: Document): void {
     const cursor = response?.cursor || {};
     if (cursor.postBatchResumeToken) {
       this.cursorState.postBatchResumeToken = cursor.postBatchResumeToken;
@@ -458,7 +459,7 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     }
   }
 
-  _initializeCursor(callback: Callback) {
+  _initializeCursor(callback: Callback): void {
     super._initializeCursor((err, result) => {
       if (err || result == null) {
         callback(err, result);
@@ -484,7 +485,7 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     });
   }
 
-  _getMore(callback: Callback) {
+  _getMore(callback: Callback): void {
     super._getMore((err, response) => {
       if (err) {
         callback(err);
@@ -646,7 +647,7 @@ function processError(changeStream: ChangeStream, error?: AnyError, callback?: C
     changeStream.closed = true;
   }
 
-  if (cursor && isResumableError(error, maxWireVersion(cursor.server))) {
+  if (cursor && isResumableError(error as MongoError, maxWireVersion(cursor.server))) {
     changeStream.cursor = undefined;
 
     // stop listening to all events from old cursor