README.md

GenDiff

Description

"GenDiff" (difference generator) - is a program that determines the difference between two data structures.

Utility features:

• Support for different input formats: yaml, json
• Report generation in the form of plain text, stylish and json

Usage example:

# plain format
gendiff --format plain path/to/file.yml another/path/file.json

Property 'common.follow' was added with value: false
Property 'group1.baz' was updated. From 'bas' to 'bars'
Property 'group2' was removed

# stylish format
gendiff filepath1.json filepath2.json

{
  + follow: false
    setting1: Value 1
  - setting2: 200
  - setting3: true
  + setting3: {
        key: value
    }
  + setting4: blah blah
  + setting5: {
        key5: value5
    }
}

Requirements

• Node.js > 18.0
• Ubuntu, Macos or WSL (for Windows)

Install

git clone git@github.com:hitriylis/GenDiff

make install

npm link

Demonstration

Help:

Stylish format:

Plain format:

JSON format: