@guanghechen/equal 2.0.0 → 2.0.2

package/CHANGELOG.md

@@ -1,8 +1,35 @@
 # Change Log
 
+## 2.0.2
+
+### Patch Changes
+
+- chore: vitest config auto-load aliases and coverage thresholds; style/doc formatting updates
+
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 2.0.1 (2025-02-07)
+
+### Improvements
+
+- Clean up build configs and standardize package exports
+
+### Documentation
+
+- Update README.md
+
+### Miscellaneous
+
+- Add LICENSE file
+- Migrate from lerna to changesets
+
+## 2.0.0 (2025-01-15)
+
+### Improvements
+
+- Switch to recommended ESLint stack
+
 ## 1.0.0-alpha.7 (2024-09-18)
 
 - :wrench: chore: upgrade devDependencies and fix configs

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present guanghechen (https://github.com/guanghechen)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -49,20 +49,83 @@
 </header>
 <br/>
 
-Inspired by https://github.com/epoberezkin/fast-deep-equal, re-published because it doesn't support ESM.
+The fastest deep equal with ES6 Map, Set and Typed arrays support. Inspired by
+[fast-deep-equal](https://github.com/epoberezkin/fast-deep-equal), re-published with ESM support.
 
-## Usage
+## Install
 
-- Use within ESM.
+- npm
 
-  ```javascript
-  import isEqual from '@guanghechen/equal'
-  console.log(isEqual({foo: 'bar'}, {foo: 'bar'})); // true
+  ```bash
+  npm install --save @guanghechen/equal
   ```
 
-- Use within CommonJS.
+- yarn
 
-  ```javascript
-  const isEqual = require('@guanghechen/equal')
-  console.log(isEqual({foo: 'bar'}, {foo: 'bar'})); // true
+  ```bash
+  yarn add @guanghechen/equal
   ```
+
+## Usage
+
+### Basic Comparison
+
+```typescript
+import isEqual from '@guanghechen/equal'
+
+// Primitives
+isEqual(1, 1)           // true
+isEqual('a', 'a')       // true
+isEqual(null, null)     // true
+isEqual(undefined, undefined) // true
+
+// Objects
+isEqual({ a: 1, b: 2 }, { a: 1, b: 2 })  // true
+isEqual({ a: 1 }, { a: 2 })              // false
+
+// Arrays
+isEqual([1, 2, 3], [1, 2, 3])  // true
+isEqual([1, 2], [1, 2, 3])     // false
+
+// Nested structures
+isEqual(
+  { user: { name: 'John', tags: ['admin'] } },
+  { user: { name: 'John', tags: ['admin'] } }
+) // true
+```
+
+### Named Export
+
+```typescript
+import { isEqual } from '@guanghechen/equal'
+
+isEqual({ foo: 'bar' }, { foo: 'bar' }) // true
+```
+
+### Special Types
+
+```typescript
+import isEqual from '@guanghechen/equal'
+
+// RegExp
+isEqual(/abc/gi, /abc/gi)  // true
+isEqual(/abc/g, /abc/i)    // false
+
+// Date
+isEqual(new Date('2024-01-01'), new Date('2024-01-01'))  // true
+
+// Custom valueOf/toString
+class Point {
+  constructor(public x: number, public y: number) {}
+  valueOf() { return this.x * 1000 + this.y }
+}
+isEqual(new Point(1, 2), new Point(1, 2))  // true
+```
+
+## Reference
+
+- [homepage][homepage]
+- Inspired by [fast-deep-equal](https://github.com/epoberezkin/fast-deep-equal)
+
+[homepage]:
+  https://github.com/guanghechen/sora/tree/@guanghechen/equal@2.0.0/packages/equal#readme

package/lib/cjs/index.cjs

@@ -32,12 +32,11 @@ function isEqual(x, y) {
         const keys = Object.keys(x);
         if (keys.length !== Object.keys(y).length)
             return false;
-        for (let i = 0; i < keys.length; ++i) {
-            if (!Object.prototype.hasOwnProperty.call(y, keys[i]))
+        for (const key of keys) {
+            if (!Object.prototype.hasOwnProperty.call(y, key))
                 return false;
         }
-        for (let i = 0; i < keys.length; ++i) {
-            const key = keys[i];
+        for (const key of keys) {
             if (key === '_owner' && x.$$typeof)
                 continue;
             if (!isEqual(x[key], y[key]))

package/lib/esm/index.mjs

@@ -28,12 +28,11 @@ function isEqual(x, y) {
         const keys = Object.keys(x);
         if (keys.length !== Object.keys(y).length)
             return false;
-        for (let i = 0; i < keys.length; ++i) {
-            if (!Object.prototype.hasOwnProperty.call(y, keys[i]))
+        for (const key of keys) {
+            if (!Object.prototype.hasOwnProperty.call(y, key))
                 return false;
         }
-        for (let i = 0; i < keys.length; ++i) {
-            const key = keys[i];
+        for (const key of keys) {
             if (key === '_owner' && x.$$typeof)
                 continue;
             if (!isEqual(x[key], y[key]))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/equal",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "The fastest deep equal with ES6 Map, Set and Typed arrays support.",
   "author": {
     "name": "guanghechen",
@@ -8,10 +8,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/equal@1.0.3",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/equal@2.0.0",
     "directory": "packages/equal"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/equal@1.0.3/packages/equal#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/equal@2.0.0/packages/equal#readme",
   "keywords": [
     "equal",
     "fast deep equal"
@@ -19,10 +19,10 @@
   "type": "module",
   "exports": {
     ".": {
+      "types": "./lib/types/index.d.ts",
       "source": "./src/index.ts",
       "import": "./lib/esm/index.mjs",
-      "require": "./lib/cjs/index.cjs",
-      "types": "./lib/types/index.d.ts"
+      "require": "./lib/cjs/index.cjs"
     }
   },
   "source": "./src/index.ts",
@@ -30,13 +30,6 @@
   "module": "./lib/esm/index.mjs",
   "types": "./lib/types/index.d.ts",
   "license": "MIT",
-  "scripts": {
-    "build": "rollup -c ../../rollup.config.mjs",
-    "clean": "rimraf lib",
-    "test": "vitest run --config ../../vitest.config.ts",
-    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
-    "test:update": "vitest run --config ../../vitest.config.ts -u"
-  },
   "files": [
     "lib/",
     "!lib/**/*.map",
@@ -45,5 +38,11 @@
     "LICENSE",
     "README.md"
   ],
-  "gitHead": "12990a720b31d50d217e2e17a6191256dc94eda6"
-}
+  "scripts": {
+    "build": "rollup -c ../../rollup.config.mjs",
+    "clean": "rimraf lib",
+    "test": "vitest run --config ../../vitest.config.ts",
+    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
+    "test:update": "vitest run --config ../../vitest.config.ts -u"
+  }
+}