feat: init

Author: ali-master

.eslintignore

@@ -0,0 +1,4 @@
+# package.json is formatted by package managers, so we ignore it here
+package.json
+build
+node_modules

.prettierignore

@@ -1,2 +1,3 @@
 # package.json is formatted by package managers, so we ignore it here
-package.json
+build
+node_modules

.prettierrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  "printWidth": 100,
+  "trailingComma": "all",
+  "singleQuote": false,
+  "semi": true,
+  "tabWidth": 2,
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": false,
+  "arrowParens": "always"
+}

README.md

@@ -1,3 +1,73 @@
-# json-diff-patch
+# JsonDiffPatch
 
-Find Diff in JSON
+This document provides an overview of the test suite for the JsonDiffPatch library, which is designed to showcase the capabilities and features of the library through various examples and test cases.
+
+## Overview
+
+JsonDiffPatch is a library that allows for the diffing and patching of JSON objects.
+
+```bash
+npm install json-diff-patch
+```
+
+1. Import JsonDiffPatch in your project:
+
+```javascript
+import { DiffPatcher } from 'json-diff-patch';
+```
+
+2. Create a `DiffPatcher` instance:
+
+```javascript
+const diffPatcher = new DiffPatcher();
+```
+
+3. Use the `diff`, `patch`, and `reverse` methods to work with your JSON objects:
+
+- **Diff**: To find the difference between two objects.
+- **Patch**: To apply a patch to an object.
+- **Reverse**: To reverse a patch.
+
+## Examples
+
+### Diffing Two Objects
+
+```javascript
+const left = { name: 'John', age: 25 };
+const right = { name: 'John', age: 26 };
+
+const delta = diffPatcher.diff(left, right);
+console.log(delta);
+// Output: { age: [25, 26] }
+```
+
+### Patching an Object
+
+```javascript
+const original = { name: 'John', age: 25 };
+const delta = { age: [25, 26] };
+
+const patched = diffPatcher.patch(original, delta);
+console.log(patched);
+// Output: { name: 'John', age: 26 }
+```
+
+### Using Property Filter
+
+In scenarios where you want to ignore certain properties during diffing, you can use the `propertyFilter` option.
+
+```javascript
+const options = {
+  propertyFilter: function(name) {
+    return name.slice(0, 1) !== '$';
+  },
+};
+const diffPatcherWithFilter = new DiffPatcher(options);
+
+const left = { data: { $volatile: 123, stable: 456 } };
+const right = { data: { $volatile: 124, stable: 456 } };
+
+const delta = diffPatcherWithFilter.diff(left, right);
+console.log(delta);
+// Output: undefined (since the change is in a filtered property)
+```

package.json

@@ -19,17 +19,14 @@
     "test:lint": "eslint src --ext .ts",
     "test:prettier": "prettier \"src/**/*.ts\" --list-different",
     "test:spelling": "cspell \"{README.md,.github/*.md,src/**/*.ts}\"",
-    "test:unit": "nyc --silent ava",
+    "test:unit": "cross-env CI=true vitest",
     "check-cli": "run-s test diff-integration-tests check-integration-tests",
     "check-integration-tests": "run-s check-integration-test:*",
     "diff-integration-tests": "mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'",
     "watch:build": "tsc -p tsconfig.json -w",
-    "watch:test": "nyc --silent ava --watch",
-    "cov": "run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html",
-    "cov:html": "nyc report --reporter=html",
-    "cov:lcov": "nyc report --reporter=lcov",
-    "cov:send": "run-s cov:lcov && codecov",
-    "cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
+    "watch:test": "vitest --watch",
+    "test:ui": "run-s test:watch -- --ui",
+    "test:coverage": "run-s test:unit -- run --coverage",
     "doc": "run-s doc:html && open-cli build/docs/index.html",
     "doc:html": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs",
     "doc:json": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json",
@@ -39,34 +36,30 @@
     "prepare-release": "run-s reset-hard test cov:check doc:html version doc:publish"
   },
   "engines": {
-    "node": ">=10"
-  },
-  "dependencies": {
-    "@bitauth/libauth": "^1.17.1"
+    "node": ">=14"
   },
   "devDependencies": {
-    "@ava/typescript": "^1.1.1",
-    "@istanbuljs/nyc-config-typescript": "^1.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.0.1",
-    "@typescript-eslint/parser": "^4.0.1",
-    "ava": "^3.12.1",
-    "codecov": "^3.5.0",
-    "cspell": "^4.1.0",
+    "@typescript-eslint/eslint-plugin": "^7.16.1",
+    "@typescript-eslint/parser": "^7.16.1",
+    "@vitest/coverage-istanbul": "^2.0.3",
+    "@vitest/ui": "^2.0.3",
+    "cross-env": "^7.0.3",
+    "cspell": "^8.11.0",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^7.8.0",
-    "eslint-config-prettier": "^6.11.0",
+    "eslint": "^9.7.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-functional": "^3.0.2",
-    "eslint-plugin-import": "^2.22.0",
-    "gh-pages": "^3.1.0",
+    "eslint-plugin-functional": "^6.6.3",
+    "eslint-plugin-import": "^2.29.1",
+    "gh-pages": "^6.1.1",
     "npm-run-all": "^4.1.5",
-    "nyc": "^15.1.0",
-    "open-cli": "^6.0.1",
-    "prettier": "^2.1.1",
-    "standard-version": "^9.0.0",
-    "ts-node": "^9.0.0",
-    "typedoc": "^0.19.0",
-    "typescript": "^4.0.2"
+    "open-cli": "^8.0.0",
+    "prettier": "^3.3.3",
+    "standard-version": "^9.5.0",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.26.4",
+    "typescript": "^5.5.3",
+    "vitest": "^2.0.3"
   },
   "files": [
     "build/main",
@@ -76,31 +69,5 @@
     "CHANGELOG.md",
     "LICENSE",
     "README.md"
-  ],
-  "ava": {
-    "failFast": true,
-    "timeout": "60s",
-    "typescript": {
-      "rewritePaths": {
-        "src/": "build/main/"
-      }
-    },
-    "files": [
-      "!build/module/**"
-    ]
-  },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
-  },
-  "prettier": {
-    "singleQuote": true
-  },
-  "nyc": {
-    "extends": "@istanbuljs/nyc-config-typescript",
-    "exclude": [
-      "**/*.spec.js"
-    ]
-  }
+  ]
 }