# compare-json

Compares two or more JSON files and detects which keys are missing.

## Install

```
npm install -g compare-json
```

## Run

When installed you can run the `comparejson` command from your command line.

For example:

```
$ comparejson ./test/fixture/*.json
```

![Result screenshot](https://github.com/nolemmings/compare-json/blob/master/screenshot.png?raw=true)

## Options

For options, you can also run help `$ comparejson --help`

<table>
  <thead>
    <tr>
      <th width="25%">Flag</th>
      <th width="15%">Short Flag</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>--help</td>
      <td></td>
      <td>Show help.</td>
    </tr>
    <tr>
      <td>--exit</td>
      <td>-e</td>
      <td>Exits the process with error code 1 when at least one error was found.</td>
    </tr>
    <tr>
      <td>--separator</td>
      <td>-s</td>
      <td>Separates files in different comparison groups using a separator string.
      <br /><br />
      For example, assume the files <code>user-en.json, user-nl.json, register-en.json, register-nl.json</code>; to split these files in two comparison groups "user" and "register" you can run <code>comparejson -s="-" ./*.json</code>.</td>
    </tr>
    <tr>
      <td>--group-by</td>
      <td>-g</td>
      <td>Separates files in different comparison groups using a regular expression. Only files within the same group are compared to one another.
      <br /><br />
      For example, assume the files <code>user-en.json, user-nl.json, register-en.json, register-nl.json</code>; to split these files in two comparison groups "user" and "register" you can run <code>comparejson -g="(.+)\-.[^\/]+.*" ./*.json</code>. Please note that this particular example can be achieved easier using the <code>--separator</code> option.</td>
    </tr>
    <tr>
      <td>--ignore-ungrouped</td>
      <td>-i</td>
      <td>When using <code>--group-by</code> or <code>--separator</code> all files not matching any group will be ignored by default. To change this behaviour and group all unmatched groups in a single group use <code>-i=false</code>.</td>
    </tr>
    <tr>
      <td>--suppress-errors</td>
      <td>-se</td>
      <td>Suppresses errors for files that match the given regex. The keys found in this file will be used as part of the comparison</td>
    </tr>
  </tbody>
</table>