made chainable API first class interface

.prettierrc.js

@@ -4,6 +4,6 @@ module.exports = {
   semi: true,
   singleQuote: true,
   printWidth: 120,
-  brackedSpacing: false,
+  bracketSpacing: false,
   arrowParens: "avoid"
 };

.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Mocha Tests",
+      "type": "node",
+      "request": "attach",
+      "port": 9229,
+      "protocol": "inspector",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "timeout": 5000,
+      "stopOnEntry": false
+    }
+  ]
+}

.vscode/settings.json

@@ -17,5 +17,8 @@
     "titleBar.inactiveBackground": "#1f2e3999",
     "titleBar.inactiveForeground": "#e7e7e799"
   },
+  "mochaExplorer.files": "test/**/*.ts",
+  "mochaExplorer.require": "ts-node/register",
+  "mochaExplorer.debuggerConfig": "Debug Mocha Tests",
   "peacock.color": "#1f2e39"
 }

package.json

@@ -41,6 +41,9 @@
     "shift-validator": "^5.0.0"
   },
   "devDependencies": {
+    "@microsoft/api-documenter": "^7.8.19",
+    "@microsoft/api-extractor": "^7.8.15",
+    "@microsoft/tsdoc": "^0.12.20",
     "@types/chai": "^4.2.11",
     "@types/debug": "^4.1.5",
     "@types/mocha": "^7.0.2",
@@ -52,6 +55,8 @@
     "mocha": "^7.1.2",
     "prettier": "^1.18.2",
     "ts-node": "^8.10.1",
+    "typedoc": "^0.17.7",
+    "typedoc-plugin-markdown": "^2.3.1",
     "typescript": "^3.9.2"
   },
   "scripts": {
@@ -61,8 +66,11 @@
     "prepublishOnly": "npm run compile",
     "format": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
     "watch": "tsc -w",
+    "generate-docs": "npm run compile && api-extractor run --local --verbose && api-documenter markdown -i temp -o new-docs",
+    "typedoc": "typedoc --hideSources --hideBreadcrumbs --excludePrivate --excludeNotExported --stripInternal --disableSources",
+    "test-examples": "npm run compile && api-extractor run --local --verbose && ts-node -O '{\"resolveJsonModule\":true}' test/doclint/examples.ts",
     "test": "mocha"
   },
   "author": "Jarrod Overson",
   "license": "Apache-2.0"
-}
+}

src/debug.ts

@@ -0,0 +1,3 @@
+import DEBUG from 'debug';
+
+export const debug = DEBUG('shift-refactor');