fix: linter issues

Author: nbbeeken

.eslintrc.json

@@ -51,5 +51,9 @@
     "files": ["*.mjs"],
     "parserOptions": {"sourceType": "module"}
 
+  },{
+    "files": ["*.ts"],
+    "parserOptions": {"sourceType": "module"}
+
   }]
 }

package-lock.json

@@ -62,7 +62,7 @@
     "mocha-sinon": "^2.1.0",
     "mongodb-mock-server": "^2.0.1",
     "nyc": "^15.1.0",
-    "prettier": "^2.0.5",
+    "prettier": "2.1.1",
     "rimraf": "^3.0.2",
     "semver": "^5.5.0",
     "sinon": "^4.3.0",

package.json

@@ -9,7 +9,7 @@ import {
 import { GridFSBucketWriteStream, GridFSBucketWriteStreamOptions, GridFSChunk } from './upload';
 import { executeLegacyOperation, Callback, getTopology } from '../utils';
 import { WriteConcernOptions, WriteConcern } from '../write_concern';
-import type { Document, ObjectId } from '../bson';
+import type { ObjectId } from '../bson';
 import type { Db } from '../db';
 import type { ReadPreference } from '../read_preference';
 import type { Collection } from '../collection';

src/gridfs-stream/index.ts

@@ -25,11 +25,9 @@ export type WithId<TSchema> = EnhancedOmit<TSchema, '_id'> & { _id: InferIdType<
  * `TSchema['_id'] extends ObjectId` which translated to "Is the _id property ObjectId?"
  * we instead ask "Does ObjectId look like (have the same shape) as the _id?"
  */
-export type OptionalId<TSchema extends { _id?: any }> = ObjectId extends TSchema['_id']
-  ? // a Schema with ObjectId _id type or "any" or "indexed type" provided
-    EnhancedOmit<TSchema, '_id'> & { _id?: InferIdType<TSchema> }
-  : // a Schema provided but _id type is not ObjectId
-    WithId<TSchema>;
+export type OptionalId<TSchema extends { _id?: any }> = ObjectId extends TSchema['_id'] // a Schema with ObjectId _id type or "any" or "indexed type" provided
+  ? EnhancedOmit<TSchema, '_id'> & { _id?: InferIdType<TSchema> } // a Schema provided but _id type is not ObjectId
+  : WithId<TSchema>;
 
 /** TypeScript Omit (Exclude to be specific) does not work for objects with an "any" indexed type, and breaks discriminated unions @public */
 export type EnhancedOmit<TRecordOrUnion, KeyUnion> = string extends keyof TRecordOrUnion
@@ -45,6 +43,7 @@ export type WithoutId<TSchema> = Omit<TSchema, '_id'>;
 export type Query<TSchema> = Partial<TSchema> & Document;
 
 /** A MongoDB UpdateQuery is set of operators @public */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 export type UpdateQuery<TSchema> = Document; // TODO
 
 /** @see https://docs.mongodb.com/manual/reference/operator/aggregation/meta/#proj._S_meta @public */

src/mongo_types.ts

@@ -0,0 +1,28 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 2018
+    },
+    "plugins": [
+        "@typescript-eslint",
+        "prettier",
+        "eslint-plugin-tsdoc"
+    ],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "prettier/@typescript-eslint",
+        "plugin:prettier/recommended"
+    ],
+    "env": {
+        "node": true,
+        "mocha": false,
+        "es6": true
+    },
+    "rules": {
+        "prettier/prettier": "error",
+        "tsdoc/syntax": "warn",
+        "typescript-eslint/no-explicit-any": "off"
+    }
+}

test/types/.eslintrc.json

@@ -8,5 +8,5 @@ const db = new Db(new MongoClient(''), '');
 const collection = db.collection<Movie>('');
 
 // Ensure distinct takes all keys of the schema plus '_id'
-let x = (null as unknown) as Parameters<typeof collection.distinct>[0];
+const x = (null as unknown) as Parameters<typeof collection.distinct>[0];
 expectType<'_id' | keyof Movie>(x);

test/types/distinct.test-d.ts

@@ -18,7 +18,7 @@ const randomKeysIncludeIdC = new Collection<RandomKeysToNumberIncludingId>(db, '
 expectType<InsertRes<number>>(randomKeysIncludeIdC.insertOne({ a: 2, randomKey: 23, _id: 23 }));
 expectError(randomKeysIncludeIdC.insertOne({ a: 2, randomKey: 23 }));
 
-let arg1: Parameters<typeof randomKeysIncludeIdC.findOne>[0] = null as any;
+const arg1 = (null as unknown) as Parameters<typeof randomKeysIncludeIdC.findOne>[0];
 expectAssignable<Partial<RandomKeysToNumberIncludingId>>(arg1);
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////

test/types/indexed_schema.test-d.ts

@@ -1,4 +1,4 @@
-import { expectDeprecated, expectType, expectNotType, expectError, expectAssignable } from 'tsd';
+import { expectDeprecated, expectType } from 'tsd';
 
 import { Collection } from '../../src//collection';
 import { AggregationCursor } from '../../src//cursor/aggregation_cursor';

test/types/mongodb.test-d.ts

@@ -1,4 +1,4 @@
-import { expectType, expectError, expectNotType } from 'tsd';
+import { expectType, expectError, expectNotType, expectNotAssignable } from 'tsd';
 
 import { Collection } from '../../src/collection';
 import { ObjectId } from '../../src/bson';
@@ -21,7 +21,8 @@ interface Rectangle {
 type Shape = Circle | Rectangle;
 
 type c = Collection<Shape>;
-type i = Parameters<c['insertOne']>[0];
+// should not insert a portion of a type
+expectNotAssignable<Parameters<c['insertOne']>[0]>({ height: 2 });
 
 const shapesC = new Collection<Shape>(db, '');
 expectType<InsertRes>(shapesC.insertOne({ radius: 4 }));

test/types/union_schema.test-d.ts

@@ -0,0 +1,16 @@
+'use strict';
+
+const tsd = require('tsd');
+const { expect } = require('chai');
+
+describe('Exported Types', () => {
+  it('should be as expected', async () => {
+    const diagnostics = await tsd();
+    if (diagnostics.length !== 0) {
+      const messages = diagnostics
+        .map(d => `${d.fileName}:${d.line}:${d.column} - [${d.severity}]: ${d.message}`)
+        .join('\n');
+      expect.fail('\n' + messages);
+    }
+  });
+});