chore: update and add tooling jsdoc eslint tsc

Updates eslint and adds a jsdoc linting plugin as well as the fixes
the new linter warns about. Added typescript as a dependency and
modified package scripts to more clearly organize our tooling. 

NODE-2523

Author: nbbeeken

.eslintrc

@@ -1,32 +1,43 @@
 {
-  "extends": [
-    "eslint:recommended"
-  ],
+  "extends": ["eslint:recommended", "plugin:prettier/recommended", "plugin:jsdoc/recommended"],
   "env": {
     "node": true,
     "mocha": true,
     "es6": true
   },
-  "globals": {
-    "Promise": true,
-    "Set": true,
-    "Symbol": true
-  },
   "parserOptions": {
-    "ecmaVersion": 2017
+    "ecmaVersion": 2018
   },
-  "plugins": [
-    "prettier"
-  ],
+  "plugins": ["prettier", "jsdoc"],
   "rules": {
-    "prettier/prettier": ["error", {
-      "singleQuote": true,
-      "tabWidth": 2,
-      "printWidth": 100
-    }],
+    "prettier/prettier": "error",
+
+    "jsdoc/check-tag-names": [
+      "warn",
+      {
+        "definedTags": ["example-class", "example-method"]
+      }
+    ],
+    "jsdoc/require-jsdoc": "off",
+    "jsdoc/no-undefined-types": "off",
 
-    "no-console": 0,
-    "eqeqeq": ["error", "always", {"null": "ignore"}],
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-returns": "off",
+    "jsdoc/require-returns-description": "off",
+    "jsdoc/require-returns-type": "off",
+    "jsdoc/valid-types": "off",
+
+    "no-console": "off",
+    "eqeqeq": ["error", "always", { "null": "ignore" }],
     "strict": ["error", "global"]
+  },
+  "settings": {
+    "jsdoc": {
+      "check-types": false,
+      "mode": "typescript",
+      "tagNamePreference": {
+        "augments": "extends"
+      }
+    }
   }
 }

.evergreen/run-atlas-tests.sh

@@ -7,4 +7,4 @@ NODE_ARTIFACTS_PATH="${PROJECT_DIRECTORY}/node-artifacts"
 export NVM_DIR="${NODE_ARTIFACTS_PATH}/nvm"
 [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
 
-ATLAS_REPL="$ATLAS_REPL" ATLAS_SHRD="$ATLAS_SHRD" ATLAS_FREE="$ATLAS_FREE" ATLAS_TLS11="$ATLAS_TLS11" ATLAS_TLS12="$ATLAS_TLS12" npm run atlas
+ATLAS_REPL="$ATLAS_REPL" ATLAS_SHRD="$ATLAS_SHRD" ATLAS_FREE="$ATLAS_FREE" ATLAS_TLS11="$ATLAS_TLS11" ATLAS_TLS12="$ATLAS_TLS12" npm run check:atlas

.gitignore

@@ -10,6 +10,7 @@ pids
 *.dat
 *.png
 test*.*
+output
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
@@ -23,8 +24,6 @@ t.js
 .DS_Store
 test/benchmarks/performance-data
 .nyc_output/
-typings/
-jsconfig.json
 manual_tests/
 docs/build
 docs/Makefile
@@ -46,4 +45,3 @@ build/Release
 # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
 node_modules
 yarn.lock
-

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "tabWidth": 2,
+  "printWidth": 100
+}

lib/admin.js

@@ -11,7 +11,7 @@ const ListDatabasesOperation = require('./operations/list_databases');
 const executeOperation = require('./operations/execute_operation');
 
 /**
- * @fileOverview The **Admin** class is an internal class that allows convenient access to
+ * @file The **Admin** class is an internal class that allows convenient access to
  * the admin functionality and commands for MongoDB.
  *
  * **ADMIN Cannot directly be instantiated**
@@ -39,8 +39,12 @@ const executeOperation = require('./operations/execute_operation');
 
 /**
  * Create a new Admin instance (INTERNAL TYPE, do not instantiate directly)
+ *
  * @class
- * @return {Admin} a collection instance.
+ * @returns {Admin} a collection instance.
+ * @param {any} db
+ * @param {any} topology
+ * @param {any} promiseLibrary
  */
 function Admin(db, topology, promiseLibrary) {
   if (!(this instanceof Admin)) return new Admin(db, topology);
@@ -55,20 +59,22 @@ function Admin(db, topology, promiseLibrary) {
 
 /**
  * The callback format for results
+ *
  * @callback Admin~resultCallback
  * @param {MongoError} error An error instance representing the error during the execution.
  * @param {object} result The result object if the command was executed successfully.
  */
 
 /**
  * Execute a command
- * @method
+ *
+ * @function
  * @param {object} command The command hash
  * @param {object} [options] Optional settings.
  * @param {(ReadPreference|string)} [options.readPreference] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {number} [options.maxTimeMS] Number of milliseconds to wait before aborting the query.
  * @param {Admin~resultCallback} [callback] The command result callback
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.command = function(command, options, callback) {
   const args = Array.prototype.slice.call(arguments, 1);
@@ -84,10 +90,10 @@ Admin.prototype.command = function(command, options, callback) {
  * Retrieve the server information for the current
  * instance of the db client
  *
- * @param {Object} [options] optional parameters for this operation
+ * @param {object} [options] optional parameters for this operation
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.buildInfo = function(options, callback) {
   if (typeof options === 'function') (callback = options), (options = {});
@@ -104,10 +110,10 @@ Admin.prototype.buildInfo = function(options, callback) {
  * Retrieve the server information for the current
  * instance of the db client
  *
- * @param {Object} [options] optional parameters for this operation
+ * @param {object} [options] optional parameters for this operation
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.serverInfo = function(options, callback) {
   if (typeof options === 'function') (callback = options), (options = {});
@@ -123,10 +129,10 @@ Admin.prototype.serverInfo = function(options, callback) {
 /**
  * Retrieve this db's server status.
  *
- * @param {Object} [options] optional parameters for this operation
+ * @param {object} [options] optional parameters for this operation
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.serverStatus = function(options, callback) {
   if (typeof options === 'function') (callback = options), (options = {});
@@ -144,10 +150,10 @@ Admin.prototype.serverStatus = function(options, callback) {
 /**
  * Ping the MongoDB server and retrieve results
  *
- * @param {Object} [options] optional parameters for this operation
+ * @param {object} [options] optional parameters for this operation
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.ping = function(options, callback) {
   if (typeof options === 'function') (callback = options), (options = {});
@@ -162,7 +168,8 @@ Admin.prototype.ping = function(options, callback) {
 
 /**
  * Add a user to the database.
- * @method
+ *
+ * @function
  * @param {string} username The username.
  * @param {string} password The password.
  * @param {object} [options] Optional settings.
@@ -174,7 +181,7 @@ Admin.prototype.ping = function(options, callback) {
  * @param {object[]} [options.roles] Roles associated with the created user (only Mongodb 2.6 or higher)
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.addUser = function(username, password, options, callback) {
   const args = Array.prototype.slice.call(arguments, 2);
@@ -200,7 +207,8 @@ Admin.prototype.addUser = function(username, password, options, callback) {
 
 /**
  * Remove a user from a database
- * @method
+ *
+ * @function
  * @param {string} username The username.
  * @param {object} [options] Optional settings.
  * @param {(number|string)} [options.w] The write concern.
@@ -209,7 +217,7 @@ Admin.prototype.addUser = function(username, password, options, callback) {
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.removeUser = function(username, options, callback) {
   const args = Array.prototype.slice.call(arguments, 1);
@@ -235,7 +243,7 @@ Admin.prototype.removeUser = function(username, options, callback) {
  * @param {boolean} [options.background] Validates a collection in the background, without interrupting read or write traffic (only in MongoDB 4.4+)
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback.
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.validateCollection = function(collectionName, options, callback) {
   if (typeof options === 'function') (callback = options), (options = {});
@@ -257,7 +265,7 @@ Admin.prototype.validateCollection = function(collectionName, options, callback)
  * @param {boolean} [options.nameOnly=false] Whether the command should return only db names, or names and size info.
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback.
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.listDatabases = function(options, callback) {
   if (typeof options === 'function') (callback = options), (options = {});
@@ -273,10 +281,10 @@ Admin.prototype.listDatabases = function(options, callback) {
 /**
  * Get ReplicaSet status
  *
- * @param {Object} [options] optional parameters for this operation
+ * @param {object} [options] optional parameters for this operation
  * @param {ClientSession} [options.session] optional session to use for this operation
  * @param {Admin~resultCallback} [callback] The command result callback.
- * @return {Promise} returns Promise if no callback passed
+ * @returns {Promise} returns Promise if no callback passed
  */
 Admin.prototype.replSetGetStatus = function(options, callback) {
   if (typeof options === 'function') (callback = options), (options = {});