Add api-extractor linting

mongodb · Dec 2, 2020 · d93e6df · d93e6df
1 parent dabc6bf
commit d93e6df
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/api-extractor.json b/api-extractor.json
@@ -29,6 +29,10 @@
       "ae-internal-missing-underscore": {
         "logLevel": "none",
         "addToApiReportFile": false
+      },
+      "ae-forgotten-export": {
+        "logLevel": "error",
+        "addToApiReportFile": false
       }
     },
     "tsdocMessageReporting": {

diff --git a/package.json b/package.json
@@ -91,11 +91,12 @@
   "scripts": {
     "build:evergreen": "node .evergreen/generate_evergreen_tasks.js",
     "build:ts": "rimraf lib && tsc",
-    "build:dts": "npm run build:ts && api-extractor run --typescript-compiler-folder node_modules/typescript --local && rimraf 'lib/**/*.d.ts*'",
+    "build:dts": "npm run build:ts && api-extractor run && rimraf 'lib/**/*.d.ts*'",
     "build:docs": "npm run build:dts && typedoc",
     "check:bench": "node test/benchmarks/driverBench",
     "check:coverage": "nyc npm run check:test",
-    "check:lint": "npm run check:ts && eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test",
+    "check:lint": "npm run build:dts && npm run check:eslint",
+    "check:eslint": "eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test",
     "check:test": "mocha --recursive test/functional test/unit",
     "check:ts": "tsc -v && tsc --noEmit",
     "check:atlas": "mocha --config \"test/manual/mocharc.json\" test/manual/atlas_connectivity.test.js",

diff --git a/src/index.ts b/src/index.ts
@@ -144,6 +144,7 @@ export type {
   RemoveOptions as WireRemoveOptions
 } from './cmap/wire_protocol/index';
 export type { CollationOptions, WriteCommandOptions } from './cmap/wire_protocol/write_command';
+export type { QueryOptions } from './cmap/wire_protocol/query';
 export type { CollectionPrivate, CollectionOptions } from './collection';
 export type { AggregationCursorOptions } from './cursor/aggregation_cursor';
 export type {

diff --git a/tsdoc.json b/tsdoc.json
@@ -1,6 +1,5 @@
 {
     "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-    // Correct url: https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json
     "tagDefinitions": [
         {
             "syntaxKind": "block",