portal-x/backend-project-lvl2

# PROJECT 'Generate difference'

[![Build Status](https://travis-ci.org/portal-x/backend-project-lvl2.svg?branch=master)](https://travis-ci.org/portal-x/backend-project-lvl2)
[![Maintainability](https://api.codeclimate.com/v1/badges/413a2f24806cbc5270d3/maintainability)](https://codeclimate.com/github/portal-x/backend-project-lvl2/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/413a2f24806cbc5270d3/test_coverage)](https://codeclimate.com/github/portal-x/backend-project-lvl2/test_coverage)

gendiff compares two configuration files and shows difference.
The package can be used as CLI utility or Node.js package that can be used in your project.

gendiff supports file extensions such as json, yaml, yml, ini. It can output the result in 'tree' and 'plain' formats. It's also possible to output in json format for data exchange using the json option. You can select the output format by setting the option flag -f (--format). By default output format 'tree'.

For example:

```bash
$ gendiff --format plain project/configurations/before.json project/configurations/after.json
```

or

```bash
$ gendiff project/configurations/before.ini project/configurations/after.ini
```

[![asciicast](https://asciinema.org/a/wqiAl0MuWK2Ntixk9XQKkNS5D.svg)](https://asciinema.org/a/wqiAl0MuWK2Ntixk9XQKkNS5D)
[![asciicast](https://asciinema.org/a/DjwYoe9T8EP9Zf9hEgxo28WOe.svg)](https://asciinema.org/a/DjwYoe9T8EP9Zf9hEgxo28WOe)
[![asciicast](https://asciinema.org/a/ONHRxftuhPFNoiG4COiVs9Dyx.svg)](https://asciinema.org/a/ONHRxftuhPFNoiG4COiVs9Dyx)
[![asciicast](https://asciinema.org/a/PgTyYQfxYbEe7algKv3qUjt8m.svg)](https://asciinema.org/a/PgTyYQfxYbEe7algKv3qUjt8m)

## Setup

```sh
$ git clone https://github.com/portal-x/cli-gen_diff.git
$ make install
$ npm link
```

## gendiff module for node.js

```sh
$ npm install cli-gen_diff
```

## API

gendiff supports file extensions such as json, yaml, yml, ini. It can output the result in 'tree' and 'plain' formats. It's also possible to output in json format for data exchange. Set the json in parameter. By default output format 'tree'.

For example:

```sh
import gendiff from 'gendiff';

const diff = gendiff('./forExample/before.json', '/user/documents/after.json', 'json');

```