Housekeeping

.eslintrc

@@ -1,24 +1,3 @@
 {
-  "extends": ["standard"],
-  "plugins": ["standard"],
-  "rules": {
-    "semi": [2, "always"],
-    "space-before-function-paren": [2, "never"],
-    "max-len": [2, 80, 2],
-    "camelcase": [2, { "properties": "always" }],
-    "linebreak-style": [2, "unix"],
-    "new-cap": [2, { "newIsCap": true, "capIsNew": true }],
-    "arrow-body-style": [2, "as-needed"],
-    "arrow-parens": [2, "as-needed"],
-    "prefer-arrow-callback": 0,
-    "prefer-template": 0,
-
-    "no-var": 2,
-    "no-undef": 2,
-    "no-param-reassign": 2,
-    "comma-dangle": [2, "always-multiline"]
-  },
-  "env": {
-    "node": true
-  }
+  "extends": "plugin:bpmn-io/recommended"
 }

.github/workflows/CI.yml

@@ -0,0 +1,23 @@
+name: CI
+on: [ push, pull_request ]
+jobs:
+  Build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node-version: [ 20 ]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Use Node.js ${{matrix.node-version}}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{matrix.node-version}}
+        cache: 'npm'
+    - name: Install dependencies
+      run: npm ci
+    - name: Build
+      run: npm run all

.gitignore

@@ -1,20 +1,3 @@
-node_modules
-lib-cov
-*.seed
-*.log
-*.csv
-*.dat
-*.out
-*.pid
-*.gz
-.DS_Store
-
-pids
-logs
-results
+node_modules
 coverage
-.nyc_output
-dist
-build
-
-npm-debug.log
+.nyc_output

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to [diffpatch](https://github.com/bpmn-io/diffpatch) are documented here. We use [semantic versioning](http://semver.org/) for releases.
+
+## Unreleased
+
+___Note:__ Yet to be released changes appear here._
+
+* `CHORE`: make ESM only module
+* `CHORE`: move library to `lib`
+* `CHORE`: dependency bumps
+* `CHORE`: drop `formatters` main export
+
+## ...
+
+See `git log` for older updates.

README.md

@@ -3,7 +3,7 @@
 
 # diffpatch
 
-[![Build Status](https://secure.travis-ci.com/bpmn-io/diffpatch.svg)](http://travis-ci.com/bpmn-io/diffpatch)
+[![CI](https://github.com/bpmn-io/diffpatch/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/diffpatch/actions/workflows/CI.yml)
 
 Diff and patch JavaScript objects.
 
@@ -257,4 +257,4 @@ This library is a fork of [jsondiffpatch](https://github.com/benjamine/jsondiffp
 
 ## License
 
-MIT
+MIT

bin/diffpatch

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+
+/* eslint-env node */
+
+import { DiffPatcher } from '../lib/index.js';
+import ConsoleFormatter from '../lib/formatters/console.js';
+
+import fs from 'node:fs';
+
+const fileLeft = process.argv[2];
+const fileRight = process.argv[3];
+
+if (!fileLeft || !fileRight) {
+  console.log('\n  USAGE: diffpatch left.json right.json');
+  process.exit(1);
+}
+
+const left = JSON.parse(fs.readFileSync(fileLeft));
+const right = JSON.parse(fs.readFileSync(fileRight));
+
+const delta = new DiffPatcher().diff(left, right);
+
+console.log(new ConsoleFormatter().format(delta));

src/contexts/context.js → lib/contexts/context.js

@@ -1,4 +1,4 @@
-import Pipe from '../pipe';
+import Pipe from '../pipe.js';
 
 export default class Context {
   setResult(result) {
@@ -32,7 +32,7 @@ export default class Context {
     child.root = this.root || this;
     child.options = child.options || this.options;
     if (!this.children) {
-      this.children = [child];
+      this.children = [ child ];
       this.nextAfterChildren = this.next || null;
       this.next = child;
     } else {

src/contexts/diff.js → lib/contexts/diff.js

@@ -1,5 +1,5 @@
-import Context from './context';
-import defaultClone from '../clone';
+import Context from './context.js';
+import defaultClone from '../clone.js';
 
 class DiffContext extends Context {
   constructor(left, right) {

src/contexts/patch.js → lib/contexts/patch.js

@@ -1,4 +1,4 @@
-import Context from './context';
+import Context from './context.js';
 
 class PatchContext extends Context {
   constructor(left, delta) {

src/contexts/reverse.js → lib/contexts/reverse.js

@@ -1,4 +1,4 @@
-import Context from './context';
+import Context from './context.js';
 
 class ReverseContext extends Context {
   constructor(delta) {

src/diffpatcher.js → lib/diffpatcher.js

@@ -1,17 +1,17 @@
-import Processor from './processor';
-import Pipe from './pipe';
-import DiffContext from './contexts/diff';
-import PatchContext from './contexts/patch';
-import ReverseContext from './contexts/reverse';
-import clone from './clone';
+import Processor from './processor.js';
+import Pipe from './pipe.js';
+import DiffContext from './contexts/diff.js';
+import PatchContext from './contexts/patch.js';
+import ReverseContext from './contexts/reverse.js';
+import clone from './clone.js';
 
-import * as trivial from './filters/trivial';
-import * as nested from './filters/nested';
-import * as arrays from './filters/arrays';
-import * as dates from './filters/dates';
-import * as texts from './filters/texts';
+import * as trivial from './filters/trivial.js';
+import * as nested from './filters/nested.js';
+import * as arrays from './filters/arrays.js';
+import * as dates from './filters/dates.js';
+import * as texts from './filters/texts.js';
 
-class DiffPatcher {
+export default class DiffPatcher {
   constructor(options) {
     this.processor = new Processor(options);
     this.processor.pipe(
@@ -76,5 +76,3 @@ class DiffPatcher {
     return clone(value);
   }
 }
-
-export default DiffPatcher;