Skip to content
/ gendiff Public

A simple utility to generate differences between two configuration files.

License

Notifications You must be signed in to change notification settings

zradj/gendiff

Repository files navigation

Gendiff

CI Maintainability Test Coverage

This utility is made to compare two files and print the difference between them. You can use it as a library in your JavaScript code as well.

JSON, YAML and INI files are supported.

Note: you can compare files with different extensions, e.g. you can compare before.yml and after.json.

Setup

As a utility

Clone this repository and run these commands in it:

npm install
npm link

After that, you will be able to use the utility. For help use:

gendiff -h

As a library

Firstly, install the library as a dependency in your project:

npm install VilerIT/gendiff

Then, import it into your source code:

import genDiff from 'gendiff';

or

const genDiff = require('gendiff');

Formats

Available formats - stylish, plain, json.

Stylish is used by default, but if you want to change it, run:

gendiff [filepath1] [filepath2] -f <your format here>

or, if you use this project as a library, run genDiff with following parameters:

genDiff('[filepath1]', '[filepath2]', '<your format here>');

Demonstration

JSON

asciicast

YAML

asciicast

INI

asciicast

Plain format

asciicast

JSON format

asciicast

About

A simple utility to generate differences between two configuration files.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published