Module-first setup (#68)

* module-first steup

* format

* run apidoc

* update CHANGELOG

Author: dai-shi

.codesandbox/ci.json

@@ -1,5 +1,10 @@
 {
   "buildCommand": "compile",
-  "sandboxes": ["vanilla", "vanilla-typescript-vanilla-ts", "new", "react-typescript-react-ts"],
+  "sandboxes": [
+    "vanilla",
+    "vanilla-typescript-vanilla-ts",
+    "new",
+    "react-typescript-react-ts"
+  ],
   "node": "18"
 }

.eslintrc.cjs

@@ -0,0 +1,34 @@
+/* eslint-env node */
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+    'prettier',
+  ],
+  ignorePatterns: ['dist/'],
+  settings: {
+    'import/resolver': {
+      typescript: true,
+    },
+  },
+  rules: {
+    'import/no-unresolved': ['error', { ignore: ['proxy-compare'] }],
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        args: 'all',
+        argsIgnorePattern: '^_',
+        caughtErrors: 'all',
+        caughtErrorsIgnorePattern: '^_',
+        destructuredArrayIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+        ignoreRestSiblings: true,
+      },
+    ],
+  },
+};

.eslintrc.json

@@ -0,0 +1,3 @@
+/pnpm-lock.yaml
+/dist
+/README.md

.prettierignore

@@ -2,103 +2,161 @@
 
 ## [Unreleased]
 
+### Changed
+
+- Module-first setup #68
+
+### Removed
+
+- Drop UMD support
+
 ## [2.6.0] - 2024-01-15
+
 ### Added
+
 - feat: custom equality function #67
 
 ## [2.5.1] - 2023-05-04
+
 ### Changed
+
 - fix: reuse target cache for inner createProxy runs #59
 
 ## [2.5.0] - 2023-02-14
+
 ### Added
+
 - feat: optional target cache for performance #56
 
 ## [2.4.2] - 2023-02-13
+
 ### Changed
+
 - fix: Don't unfreeze/copy targets w/object getters. #54
 
 ## [2.4.1] - 2023-02-07
+
 ### Changed
+
 - fix: remove unfrozen cache #53
 
 ## [2.4.0] - 2023-01-04
+
 ### Added
+
 - feat: better support of Object.hasOwn and "in" #47
 - feat: add an option to exclude object getters in affectedToPathList util #48
 
 ## [2.3.0] - 2022-08-13
+
 ### Added
+
 - feat: support proxy-polyfill #41
+
 ### Changed
+
 - fix: cache unfreeze results #44
 
 ## [2.2.0] - 2022-06-14
+
 ### Added
+
 - Support nested proxy #38
 
 ## [2.1.0] - 2022-03-16
+
 ### Added
+
 - Support getOwnPropertyDescriptor handler #34
 
 ## [2.0.3] - 2022-02-28
+
 ### Changed
+
 - Fix affectedToPathList to avoid maximum call stack size exceeded error (#32)
 
 ## [2.0.2] - 2021-08-13
+
 ### Changed
+
 - Fix package.json properly for ESM (#24)
 
 ## [2.0.1] - 2021-06-29
+
 ### Changed
+
 - Fix package.json for React Native (#21)
 
 ## [2.0.0] - 2021-05-15
+
 ### Changed
+
 - Drop mode in isDeepChanged [BREAKING CHANGE] (#18)
 - Rename exported functions [BREAKING CHANGE] (#19)
 
 ## [1.1.6] - 2021-01-21
+
 ### Changed
+
 - Fix object frozen afterwards (#9)
 - Some refactors
 
 ## [1.1.5] - 2021-01-20
+
 ### Changed
+
 - Fix read-only and non-configurable error (#8)
 
 ## [1.1.4] - 2021-01-14
+
 ### Changed
+
 - The markToTrack util takes optional second argument
 
 ## [1.1.3] - 2020-11-24
+
 ### Added
+
 - New markToTrack util
 
 ## [1.1.2] - 2020-11-21
+
 ### Changed
+
 - Improve copying frozen objects
 
 ## [1.1.1] - 2020-11-20
+
 ### Changed
+
 - Avoid mutating frozen objects
 
 ## [1.1.0] - 2020-11-18
+
 ### Changed
+
 - Fix `MODE_IGNORE_REF_EQUALITY` behavior
 
 ## [1.0.3] - 2020-11-01
+
 ### Added
+
 - affectedToPathList util
 
 ## [1.0.2] - 2020-07-02
+
 ### Changed
+
 - Modern build
 
 ## [1.0.1] - 2020-03-09
+
 ### Changed
+
 - Improve types
 
 ## [1.0.0] - 2020-03-08
+
 ### Added
+
 - Initial release

CHANGELOG.md

@@ -64,6 +64,7 @@ for this purpose you can use the `affectedToPathList` helper.
 *   `obj` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object that will be wrapped on the proxy.
 *   `affected` **[WeakMap](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)<[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object), unknown>** WeakMap that will hold the tracking of which properties in the proxied object were accessed.
 *   `proxyCache` **[WeakMap](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)<[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object), unknown>?** WeakMap that will help keep referential identity for proxies.
+*   `targetCache` **[WeakMap](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)<[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object), any>?**&#x20;
 
 #### Examples
 
@@ -102,6 +103,7 @@ on the proxy, then isChanged will only compare the affected properties.
 *   `affected` **[WeakMap](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)<[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object), unknown>** WeakMap that holds the tracking of which properties in the proxied object were accessed.
 *   `cache` **[WeakMap](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)<[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object), unknown>?** WeakMap that holds a cache of the comparisons for better performance with repetitive comparisons,
     and to avoid infinite loop with circular structures.
+*   `isEqual` **function (a: any, b: any): [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**  (optional, default `Object.is`)
 
 #### Examples
 

README.md

@@ -2,41 +2,44 @@
   "name": "proxy-compare",
   "description": "Compare two objects using accessed properties with Proxy",
   "version": "2.6.0",
+  "type": "module",
   "author": "Daishi Kato",
   "repository": {
     "type": "git",
     "url": "https://github.com/dai-shi/proxy-compare.git"
   },
   "source": "./src/index.ts",
-  "main": "./dist/index.umd.js",
-  "module": "./dist/index.modern.js",
-  "react-native": "./dist/index.modern.js",
-  "types": "./dist/src/index.d.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/src/index.d.ts",
-      "module": "./dist/index.modern.js",
-      "import": "./dist/index.modern.mjs",
-      "default": "./dist/index.umd.js"
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "default": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
     }
   },
   "sideEffects": false,
   "files": [
     "src",
     "dist"
   ],
+  "packageManager": "[email protected]",
   "scripts": {
-    "compile": "microbundle build -f modern,umd",
-    "postcompile": "cp dist/index.modern.mjs dist/index.modern.js && cp dist/index.modern.mjs.map dist/index.modern.js.map",
-    "test": "run-s eslint tsc-test jest",
-    "eslint": "eslint --ext .js,.ts --ignore-pattern dist .",
-    "jest": "jest",
-    "tsc-test": "tsc --project . --noEmit",
-    "apidoc": "documentation readme src --section API --markdown-toc false --parse-extension ts"
-  },
-  "jest": {
-    "preset": "ts-jest/presets/js-with-ts"
+    "compile": "rm -rf dist && pnpm run '/^compile:.*/'",
+    "compile:esm": "tsc -p tsconfig.esm.json",
+    "compile:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+    "test": "pnpm run '/^test:.*/'",
+    "test:format": "prettier -c .",
+    "test:lint": "eslint .",
+    "test:types": "tsc -p . --noEmit",
+    "test:spec": "vitest run",
+    "apidoc": "documentation readme src/index.ts --section API --markdown-toc false --parse-extension ts --require-extension ts"
   },
   "keywords": [
     "proxy",
@@ -46,19 +49,22 @@
     "deepequal"
   ],
   "license": "MIT",
-  "dependencies": {},
+  "prettier": {
+    "singleQuote": true
+  },
   "devDependencies": {
-    "@types/jest": "^29.5.11",
-    "@typescript-eslint/eslint-plugin": "^6.18.1",
-    "@typescript-eslint/parser": "^6.18.1",
-    "documentation": "^14.0.2",
-    "eslint": "^8.56.0",
-    "eslint-config-airbnb-base": "^15.0.0",
+    "@types/node": "^20.12.7",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
+    "documentation": "^14.0.3",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",
-    "jest": "^29.7.0",
-    "microbundle": "^0.15.1",
-    "npm-run-all": "^4.1.5",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.3.3"
+    "prettier": "^3.2.5",
+    "ts-expect": "^1.3.0",
+    "typescript": "^5.4.5",
+    "vite": "^5.2.10",
+    "vitest": "^1.5.2"
   }
 }