Merge pull request #116 from jeremymeng/add-api-extractor

Add api-extractor to help reviewing API changes

.gitignore

@@ -55,6 +55,7 @@ typings/
 dist/
 output/
 out/
+temp/
 typedoc
 
 # package lock file

api-extractor.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "typings/lib/index.d.ts",
+  "docModel": {
+    "enabled": true
+  },
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "./review"
+  },
+  "dtsRollup": {
+    "enabled": true,
+    "publicTrimmedFilePath": "./typings/rhea-promise.d.ts",
+  },
+  "messages": {
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "none"
+      }
+    },
+    "extractorMessageReporting": {
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      },
+      "ae-unresolved-link": {
+        "logLevel": "none"
+      }
+    }
+  }
+}

package.json

@@ -26,6 +26,7 @@
   ],
   "devDependencies": {
     "@azure/abort-controller": "^1.0.1",
+    "@microsoft/api-extractor": "^7.47.9",
     "@types/chai": "^4.3.7",
     "@types/debug": "^4.0.0",
     "@types/mocha": "^10.0.0",
@@ -46,7 +47,8 @@
     "lint": "eslint .",
     "tsc": "tsc",
     "prebuild": "rimraf dist && rimraf typings",
-    "build": "npm run lint && npm run tsc",
+    "build": "npm run lint && npm run tsc && npm run extract-api",
+    "extract-api": "api-extractor run --local",
     "test": "npm run build && mocha -r ts-node/register ./test/*.spec.ts",
     "prepack": "npm i && npm run build"
   },