Convert module to TypeScript (#24)

Author: koddsson

.gitignore

@@ -16,3 +16,4 @@ node_modules
 npm-debug.log
 
 coverage.html
+dist

index.d.ts

@@ -4,7 +4,7 @@
     "description": "Error constructor for test and validation frameworks that implements standardized AssertionError specification.",
     "author": "Jake Luer <jake@qualiancy.com> (http://qualiancy.com)",
     "license": "MIT",
-    "types": "./index.d.ts",
+    "types": "./dist/index.d.ts",
     "keywords": [
         "test",
         "assertion",
@@ -17,13 +17,18 @@
     "engines": {
         "node": ">=12"
     },
+    "files": [
+        "dist"
+    ],
     "type": "module",
-    "module": "./index.js",
-    "main": "./index.js",
+    "module": "./dist/index.js",
+    "main": "./dist/index.js",
     "scripts": {
+        "build": "tsc",
+        "pretest": "npm run build",
         "test": "npm run test:node && npm run test:typescript",
         "test:node": "NODE_ENV=test node ./test/index.js",
-        "test:typescript": "tsc test/typings.ts index.d.ts --noEmit"
+        "test:typescript": "tsc test/typings.ts dist/index.d.ts --noEmit"
     },
     "devDependencies": {
         "typescript": "^4.4.3"

index.js

@@ -0,0 +1,81 @@
+/**
+ * Return a function that will copy properties from
+ * one object to another excluding any originally
+ * listed. Returned function will create a new `{}`.
+ *
+ * @param {String} excluded properties ...
+ * @return {Function}
+ */
+function exclude(...args: string[]): (a: {}, b?: {}) => Record<string, unknown> {
+  var excludes = args
+
+  function excludeProps (res: Record<string, unknown>, obj: Record<string, unknown>) {
+    Object.keys(obj).forEach(function (key) {
+      if (!~excludes.indexOf(key)) res[key] = obj[key];
+    });
+  }
+
+  return function extendExclude () {
+    var args = [].slice.call(arguments)
+      , i = 0
+      , res = {};
+
+    for (; i < args.length; i++) {
+      excludeProps(res, args[i]);
+    }
+
+    return res;
+  };
+};
+
+export default class AssertionError<T> extends Error {
+  name = 'AssertionError'
+  showDiff: boolean
+  [key: string]: any
+
+  constructor(message: string, _props?: T, ssf?: Function) {
+    super()
+    var extend = exclude('name', 'message', 'stack', 'constructor', 'toJSON')
+      , props = extend(_props || {});
+
+    // default values
+    this.message = message || 'Unspecified AssertionError';
+    this.showDiff = false;
+
+    // copy from properties
+    for (var key in props) {
+      this[key] = props[key];
+    }
+
+    // capture stack trace
+    ssf = ssf || AssertionError;
+    if ((Error as any).captureStackTrace) {
+      (Error as any).captureStackTrace(this, ssf);
+    } else {
+      try {
+        throw new Error();
+      } catch(e: any) {
+        this.stack = e.stack;
+      }
+    }
+  }
+
+  /**
+   * Allow errors to be converted to JSON for static transfer.
+   *
+   * @param {Boolean} include stack (default: `true`)
+   * @return {Object} object that can be `JSON.stringify`
+   */
+
+  toJSON(stack: boolean) {
+    var extend = exclude('constructor', 'toJSON', 'stack')
+      , props = extend({ name: this.name }, this);
+
+    // include stack if exists and not turned off
+    if (false !== stack && this.stack) {
+      props.stack = this.stack;
+    }
+
+    return props;
+  };
+}

package.json

@@ -2,7 +2,7 @@
  * Include lib
  */
 
-import AssertionError from '../index.js'
+import AssertionError from '../dist/index.js'
 
 /*!
  * Simple test runner.

src/index.ts

@@ -1,7 +1,7 @@
-import AssertionError = require('../index');
+import AssertionError from '../src/index'
 
 const str: string = "";
-let e: AssertionError;
+let e;
 
 function foo () { }
 

test/index.js

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "module": "esnext",
+    "target": "es2017",
+    "lib": ["es2018", "dom"],
+    "strict": true,
+    "declaration": true,
+    "removeComments": true,
+    "preserveConstEnums": true,
+    "allowSyntheticDefaultImports": true,
+    "outDir": "dist"
+  },
+  "include": [
+    "src"
+]
+}