General Difference

This is a program that make a diff between two files.

Utils that was used

1. commander.js library
2. jest framework

Hexlet tests and linter status:

How to install

System requirements

Node.js v18 or higher

Installation

git clone https://github.com/Hisun0/frontend-project-46.git
cd ./frontend-project-46
make install

Posibilities

gendiff -h command will show you in terminal next:

Usage: gendiff [options] <filepath1> <filepath2>

Compares two configuration files and shows a difference.

Arguments:
  filepath1            required file path to get diff
  filepath2            required file path to get diff

Options:
  -V, --version        output the version number
  -f, --format <type>  output format (default: "stylish")
  -h, --help           display help for command

Making difference in plain text, stylish and json

Show example

For stylish format:

gendiff path/to/file1.json another/path/file2.json

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

For plain format:

gendiff -f 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

For json format:

gendiff -f json path/to/file1.json another/path/file2.json

[{"key":"common","value":[{"key":"follow","value":false,"status":"added"},{"key":"setting1","value":"Value 1","status":"unchanged"},{"key":"setting2","value":200,"status":"deleted"},{"key":"setting3","value":{"oldValue":true,"newValue":null},"status":"changed"},{"key":"setting4","value":"blah blah","status":"added"},{"key":"setting5","value":{"key5":"value5"},"status":"added"},{"key":"setting6","value":[{"key":"doge","value":[{"key":"wow","value":{"oldValue":"","newValue":"so much"},"status":"changed"}],"status":"nested"},{"key":"key","value":"value","status":"unchanged"},{"key":"ops","value":"vops","status":"added"}],"status":"nested"}],"status":"nested"},{"key":"group1","value":[{"key":"baz","value":{"oldValue":"bas","newValue":"bars"},"status":"changed"},{"key":"foo","value":"bar","status":"unchanged"},{"key":"nest","value":{"oldValue":{"key":"value"},"newValue":"str"},"status":"changed"}],"status":"nested"},{"key":"group2","value":{"abc":12345,"deep":{"id":45}},"status":"deleted"},{"key":"group3","value":{"deep":{"id":{"number":45}},"fee":100500},"status":"added"}]

Support two formats: yaml and json

How it looks in terminal

For stylish format:

This is example of nested json file, but, obviosly, that will work with flat json too :)

For plain format:

Flat files is our power! Stop, this is not a flat file...

For json format:

Oh no, again nested file...

Thank you for your attention!