Merge remote-tracking branch 'upstream/main' into remove-spread-op

Author: mattphillips

.eslintrc.json

@@ -0,0 +1,15 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true,
+        "jest": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module"
+    },
+    "rules": {
+    }
+}

.github/workflows/ci.yaml

@@ -0,0 +1,57 @@
+name: 'GitHub CI'
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test-node:
+    name: Test on Node.js v${{ matrix.node-version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: yarn
+      - run: yarn install
+      - run: yarn test:coverage
+      - uses: codecov/codecov-action@v2
+
+  test-os:
+    name: Test on ${{ matrix.os }} using Node.js LTS
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+          cache: yarn
+      - run: yarn install
+      - run: yarn test:coverage
+      - uses: codecov/codecov-action@v2
+
+  lint:
+    name: Run ESLint 
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+          cache: yarn
+      - run: yarn install
+      - run: yarn lint

.gitignore

@@ -2,3 +2,5 @@ node_modules/
 dist
 coverage
 npm-debug.log
+yarn-error.log
+dist-es

.travis.yml

@@ -8,8 +8,8 @@
 
 <hr />
 
-[![Build Status](https://img.shields.io/travis/mattphillips/deep-object-diff/master.svg?style=flat-square)](https://travis-ci.org/mattphillips/deep-object-diff/master)
-[![Code Coverage](https://img.shields.io/coveralls/mattphillips/deep-object-diff.svg?style=flat-square)](https://coveralls.io/github/mattphillips/deep-object-diff?branch=master)
+[![Build Status](https://github.com/mattphillips/deep-object-diff/actions/workflows/ci.yaml/badge.svg)](https://github.com/mattphillips/deep-object-diff/actions/workflows/ci.yaml)
+[![Code coverage](https://codecov.io/gh/mattphillips/deep-object-diff/branch/main/graph/badge.svg?token=EwnXzDGW3x)](https://codecov.io/gh/mattphillips/deep-object-diff)
 [![version](https://img.shields.io/npm/v/deep-object-diff.svg?style=flat-square)](https://www.npmjs.com/package/deep-object-diff)
 [![downloads](https://img.shields.io/npm/dm/deep-object-diff.svg?style=flat-square)](http://npm-stat.com/charts.html?package=deep-object-diff&from=2016-11-23)
 [![MIT License](https://img.shields.io/npm/l/deep-object-diff.svg?style=flat-square)](https://github.com/mattphillips/deep-object-diff/blob/master/LICENSE)
@@ -40,24 +40,10 @@ A small library that can deep diff two JavaScript Objects, including nested stru
 
 ## Importing
 
-ES6 / Babel:
 ``` js
 import { diff, addedDiff, deletedDiff, updatedDiff, detailedDiff } from 'deep-object-diff';
 ```
 
-ES5:
-``` js
-const { diff, addedDiff, deletedDiff, detailedDiff, updatedDiff } = require("deep-object-diff");
-
-// OR
-
-const diff = require("deep-object-diff").diff;
-const addedDiff = require("deep-object-diff").addedDiff;
-const deletedDiff = require("deep-object-diff").deletedDiff;
-const detailedDiff = require("deep-object-diff").detailedDiff;
-const updatedDiff = require("deep-object-diff").updatedDiff;
-```
-
 ## Usage:
 
 ### `diff`:

README.md

@@ -1,47 +1,44 @@
 {
   "name": "deep-object-diff",
-  "version": "1.1.0",
+  "version": "1.1.5",
   "description": "Deep diffs two objects, including nested structures of arrays and objects, and return the difference.",
-  "main": "dist/index.js",
+  "main": "cjs/index.js",
+  "module": "mjs/index.js",
+  "exports": {
+    ".": {
+      "import": "./mjs/index.js",
+      "require": "./cjs/index.js"
+    }
+  },
   "types": "./index.d.ts",
-  "files": [
-    "dist",
-    "index.d.ts",
-    "README.md"
-  ],
   "scripts": {
-    "build": "babel src -d dist --ignore *.test.js",
+    "build": "rm -rf dist && babel src -d dist/cjs && node scripts/build.mjs",
     "prepublish": "yarn build",
+    "lint": "eslint src",
     "test": "jest",
-    "test:coverage": "yarn test -- --coverage",
-    "test:report": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls",
+    "test:coverage": "yarn test --coverage",
     "test:watch": "yarn test -- --watch"
   },
   "author": "Matt Phillips",
   "license": "MIT",
   "devDependencies": {
-    "babel-cli": "^6.18.0",
-    "babel-core": "^6.18.2",
-    "babel-jest": "^22.0.0",
-    "babel-jest-assertions": "^0.1.0",
-    "babel-plugin-add-module-exports": "^0.2.1",
-    "babel-plugin-gwt": "^1.0.0",
-    "babel-plugin-transform-es2015-modules-umd": "^6.23.0",
-    "babel-preset-es2015": "^6.18.0",
-    "babel-preset-stage-0": "^6.16.0",
-    "coveralls": "^3.0.0",
-    "jest": "^23.6.0"
+    "@babel/cli": "^7.16.8",
+    "@babel/core": "^7.16.12",
+    "@babel/preset-env": "^7.16.11",
+    "babel-jest": "^27.4.6",
+    "eslint": "^8.7.0",
+    "jest": "^27.4.7"
   },
   "babel": {
     "presets": [
-      "es2015",
-      "stage-0"
-    ],
-    "plugins": [
-      "add-module-exports",
-      "transform-es2015-modules-umd",
-      "babel-jest-assertions",
-      "gwt"
+      [
+        "@babel/preset-env",
+        {
+          "targets": {
+            "node": "12"
+          }
+        }
+      ]
     ]
   },
   "repository": {

package.json

@@ -0,0 +1,26 @@
+import * as path from "path";
+import * as fs from "fs";
+
+const DIST = "dist";
+const SRC = "src";
+const MJS = "mjs";
+const CJS = "cjs";
+const PKG = "package.json";
+const FILES = ["index.d.ts", "README.md", "LICENSE"];
+
+fs.mkdirSync(path.join(DIST, MJS));
+fs.readdirSync("./src").forEach((file) => fs.copyFileSync(path.join(SRC, file), path.join(DIST, MJS, file)));
+
+fs.writeFileSync(path.join(DIST, CJS, PKG), JSON.stringify({ type: "commonjs" }, null, 2));
+fs.writeFileSync(path.join(DIST, MJS, PKG), JSON.stringify({ type: "module" }, null, 2));
+
+const pkg = fs.readFileSync(PKG, "utf-8");
+const json = JSON.parse(pkg);
+
+delete json.scripts;
+delete json.devDependencies;
+delete json.babel;
+
+fs.writeFileSync(path.join(DIST, PKG), JSON.stringify(json, null, 2));
+
+FILES.forEach((file) => fs.copyFileSync(file, path.join(DIST, file)));

scripts/build.mjs

@@ -1,14 +1,14 @@
-import { isEmpty, isObject, properObject } from '../utils';
+import { isEmpty, isObject, hasOwnProperty } from './utils';
 
 const addedDiff = (lhs, rhs) => {
 
   if (lhs === rhs || !isObject(lhs) || !isObject(rhs)) return {};
 
-  const l = properObject(lhs);
-  const r = properObject(rhs);
+  const l = lhs;
+  const r = rhs;
 
   return Object.keys(r).reduce((acc, key) => {
-    if (l.hasOwnProperty(key)) {
+    if (hasOwnProperty(l, key)) {
       const difference = addedDiff(l[key], r[key]);
 
       if (isObject(difference) && isEmpty(difference)) return acc;

src/added/index.js renamed to src/added.js

@@ -1,15 +1,15 @@
-import { isDate, isEmpty, isObject, properObject } from '../utils';
+import { isDate, isEmpty, isObject, hasOwnProperty } from './utils';
 
 const diff = (lhs, rhs) => {
   if (lhs === rhs) return {}; // equal return no diff
 
   if (!isObject(lhs) || !isObject(rhs)) return rhs; // return updated rhs
 
-  const l = properObject(lhs);
-  const r = properObject(rhs);
+  const l = lhs;
+  const r = rhs;
 
   const deletedValues = Object.keys(l).reduce((acc, key) => {
-    return r.hasOwnProperty(key) ? acc : { ...acc, [key]: undefined };
+    return hasOwnProperty(r, key) ? acc : { ...acc, [key]: undefined };
   }, {});
 
   if (isDate(l) || isDate(r)) {
@@ -19,11 +19,11 @@ const diff = (lhs, rhs) => {
 
   if (Array.isArray(r) && Array.isArray(l)) {
     const deletedValues = l.reduce((acc, item, index) => {
-      return r.hasOwnProperty(index) ? acc.concat(item) : acc.concat(undefined);
+      return hasOwnProperty(r, index) ? acc.concat(item) : acc.concat(undefined);
     }, []);
 
     return r.reduce((acc, rightItem, index) => {
-      if (!deletedValues.hasOwnProperty(index)) {
+      if (!hasOwnProperty(deletedValues, index)) {
         return acc.concat(rightItem);
       }
 
@@ -40,7 +40,7 @@ const diff = (lhs, rhs) => {
   }
 
   return Object.keys(r).reduce((acc, key) => {
-    if (!l.hasOwnProperty(key)) return { ...acc, [key]: r[key] }; // return added r key
+    if (!hasOwnProperty(l, key)) return { ...acc, [key]: r[key] }; // return added r key
 
     const difference = diff(l[key], r[key]);
 

src/arrayDiff/index.js renamed to src/arrayDiff.js

@@ -1,13 +1,13 @@
-import { isEmpty, isObject, properObject } from '../utils';
+import { isEmpty, isObject, hasOwnProperty } from './utils';
 
 const deletedDiff = (lhs, rhs) => {
   if (lhs === rhs || !isObject(lhs) || !isObject(rhs)) return {};
 
-  const l = properObject(lhs);
-  const r = properObject(rhs);
+  const l = lhs;
+  const r = rhs;
 
   return Object.keys(l).reduce((acc, key) => {
-    if (r.hasOwnProperty(key)) {
+    if (hasOwnProperty(r, key)) {
       const difference = deletedDiff(l[key], r[key]);
 
       if (isObject(difference) && isEmpty(difference)) return acc;

src/deleted/index.js renamed to src/deleted.js

@@ -1,6 +1,6 @@
-import addedDiff from '../added';
-import deletedDiff from '../deleted';
-import updatedDiff from '../updated';
+import addedDiff from './added';
+import deletedDiff from './deleted';
+import updatedDiff from './updated';
 
 const detailedDiff = (lhs, rhs) => ({
   added: addedDiff(lhs, rhs),

src/detailed/index.js renamed to src/detailed.js

@@ -1,15 +1,15 @@
-import { isDate, isEmpty, isObject, properObject } from '../utils';
+import { isDate, isEmptyObject, isObject, hasOwnProperty } from './utils';
 
 const diff = (lhs, rhs) => {
   if (lhs === rhs) return {}; // equal return no diff
 
   if (!isObject(lhs) || !isObject(rhs)) return rhs; // return updated rhs
 
-  const l = properObject(lhs);
-  const r = properObject(rhs);
+  const l = lhs;
+  const r = rhs;
 
   const deletedValues = Object.keys(l).reduce((acc, key) => {
-    if (!r.hasOwnProperty(key)) {
+    if (!hasOwnProperty(r, key)) {
       acc[key] = undefined;
 
     }
@@ -23,14 +23,16 @@ const diff = (lhs, rhs) => {
   }
 
   return Object.keys(r).reduce((acc, key) => {
-    if (!l.hasOwnProperty(key)){
+    if (!hasOwnProperty(l, key)){
       acc[key] = r[key]; // return added r key
       return acc;
     } 
 
     const difference = diff(l[key], r[key]);
 
-    if (isObject(difference) && isEmpty(difference) && !isDate(difference)) return acc; // return no diff
+    // If the difference is empty, and the lhs is an empty object or the rhs is not an empty object
+    if (isEmptyObject(difference) && !isDate(difference) && (isEmptyObject(l[key]) || !isEmptyObject(r[key])))
+      return acc; // return no diff
 
     acc[key] = difference // return updated key
     return acc; // return updated key

src/diff/index.js renamed to src/diff.js

@@ -1,4 +1,4 @@
-import { isObject } from './utils';
+import { isObject, hasOwnProperty } from './utils';
 
 const getLargerArray = (l, r) => l.length > r.length ? l : r;
 
@@ -16,7 +16,7 @@ const preserve = (diff, left, right) => {
       return {
         ...acc,
         [key]: array.reduce((acc2, item, index) => {
-          if (diff[key].hasOwnProperty(index)) {
+          if (hasOwnProperty(diff[key], index)) {
             acc2[index] = preserve(diff[key][index], leftArray[index], rightArray[index]); // diff recurse and check for nested arrays
             return acc2;
           }

src/preserveArray.js

@@ -1,25 +1,25 @@
-import { isDate, isEmpty, isObject, properObject } from '../utils';
+import { isDate, isEmptyObject, isObject, hasOwnProperty } from './utils';
 
 const updatedDiff = (lhs, rhs) => {
-
   if (lhs === rhs) return {};
 
   if (!isObject(lhs) || !isObject(rhs)) return rhs;
 
-  const l = properObject(lhs);
-  const r = properObject(rhs);
+  const l = lhs;
+  const r = rhs;
 
   if (isDate(l) || isDate(r)) {
     if (l.valueOf() == r.valueOf()) return {};
     return r;
   }
 
   return Object.keys(r).reduce((acc, key) => {
-
-    if (l.hasOwnProperty(key)) {
+    if (hasOwnProperty(l, key)) {
       const difference = updatedDiff(l[key], r[key]);
 
-      if (isObject(difference) && isEmpty(difference) && !isDate(difference)) return acc;
+      // If the difference is empty, and the lhs is an empty object or the rhs is not an empty object
+      if (isEmptyObject(difference) && !isDate(difference) && (isEmptyObject(l[key]) || !isEmptyObject(r[key])))
+        return acc; // return no diff
 
       acc[key] = difference;
       return acc;