feat!: v2-ts

This commit is a reimplementation of the original deep-dif in Typescript. In this commit, we address all issues reported since the beginning. See ./test/regression/issue-???.ts for details on particular issues.

BREAKING CHANGE: Interface has changed, reporting has changed, usage has changed! See the README.

Author: Phillip Clark

.circleci/config.yml

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+insert_final_newline = false
+trim_trailing_whitespace = false
+
+[*.{js,json,ts,mts,yml,yaml}]
+indent_size = 2
+indent_style = space

.editorconfig

@@ -0,0 +1 @@
+/**/*.js

.eslintignore

@@ -0,0 +1,26 @@
+{
+  "env": {
+    "browser": false,
+    "es6": true,
+    "node": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "tsconfig.json",
+    "sourceType": "module",
+    "ecmaVersion": 2020
+  },
+  "plugins": ["@typescript-eslint", "tap"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "rules": {
+    // The following rule is enabled only to supplement the inline suppression
+    // examples, and because it is not a recommended rule, you should either
+    // disable it, or understand what it enforces.
+    // https://typescript-eslint.io/rules/explicit-function-return-type/
+    "@typescript-eslint/explicit-function-return-type": "warn"
+  }
+}

.eslintrc

@@ -0,0 +1,17 @@
+name: Node.js CI
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: volta-cli/action@v1
+      - run: npm ci --no-audit
+      - run: npm run lint --if-present
+      - run: npm test
+      - run: npm run build --if-present
+        env:
+          CI: true

.eslintrc.json

@@ -1,3 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependencies
 node_modules/
-coverage/
-test-results.xml
+
+# Coverage & Test output
+coverage
+.tap/
+
+# Transpiled files
+build/
+
+# VS Code
+.vscode/
+!.vscode/tasks.js
+
+# JetBrains IDEs
+.idea/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Misc
+.DS_Store

.github/workflows/nodejs.yml

@@ -0,0 +1,12 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "overrides": [
+    {
+      "files": ["*.ts", "*.mts"],
+      "options": {
+        "parser": "typescript"
+      }
+    }
+  ]
+}

.gitignore

@@ -7,24 +7,26 @@
     {
       "type": "node",
       "request": "launch",
-      "name": "Launch Program",
-      "program": "${workspaceFolder}/examples/array-change.js"
+      "name": "tap (current file)",
+      "program": "${workspaceFolder}/node_modules/.bin/tap",
+      "args": ["${relativeFile}"],
+      "cwd": "${workspaceFolder}"
     },
     {
-      "name": "Run mocha",
+      "name": "ts-node (current file)",
       "type": "node",
       "request": "launch",
-      "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
-      "stopOnEntry": false,
-      "args": [
-        "test/**/*.js",
-        "--no-timeouts"
+      "args": ["${relativeFile}"],
+      "runtimeArgs": [
+        "-r",
+        "tsconfig-paths/register",
+        "-r",
+        "ts-node/register",
+        "--loader",
+        "ts-node/esm"
       ],
       "cwd": "${workspaceRoot}",
-      "runtimeExecutable": null,
-      "env": {
-        "NODE_ENV": "testing"
-      }
+      "internalConsoleOptions": "openOnSessionStart"
     }
   ]
-}
+}