# grunt-json-structure-diff

> Compare JSON files for structure equality, despite the actual content

Latest version **0.0.1** (published 2015-10-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install grunt-json-structure-diff
pnpm add grunt-json-structure-diff
yarn add grunt-json-structure-diff
bun add grunt-json-structure-diff
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2015-10-18 |
| First published | 2015-10-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Filipe Garcia |
| Maintainers | fgarci03 |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-json-structure-diff
- Repository: https://github.com/fgarci03/grunt-json-structure-diff
- Issues: https://github.com/fgarci03/grunt-json-structure-diff/issues
- npm.io page: https://npm.io/package/grunt-json-structure-diff

## Dependencies (1)

- [json-structure-diff](https://npm.io/package/json-structure-diff.md) 0.0.1

## Recent versions

- 0.0.1 (latest) — 2015-10-18
- 0.0.0 — 2015-10-17

## README

# grunt-json-structure-diff

> Compare JSON files for structure equality, despite the actual content

## Important Note
This plugin is on **EARLY** stage of development, is not properly tested, and does not yet allow a number of customizations I planned for it.
Be careful if you use it on your projects! Make sure you provide the exact version you want to use until a (more) stable version is released (from 0.1.0 and after).

## Getting Started
This plugin requires Grunt.

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-json-structure-diff --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-json-structure-diff');
```

## The "json_structure_diff" task

### Overview
In your project's Gruntfile, add a section named `json_structure_diff` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  json_structure_diff: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})
```

This plugin takes a list of folders containing JSON files. The folders MUST have the exact same structure (number of files and file names).
It will then compare each file with their counterparts in the other folders and return an error list if the structures don't match. The
error list is displayed in the Grunt console and is printed into the file pointed to in the configurations.

### Options

#### options.breakOnFail
Type: `Boolean`
Default value: `false`

Whether it should abort the Grunt task on error or not.

#### options.verbose
Type: `Boolean`
Default value: `true`

Whether it should print to the console the error log.

### Usage Examples

#### Default Options
In this example, Grunt will continue to run even if errors are found and they will be printed on the console.

```js
grunt.initConfig({
  json_structure_diff: {
    options: {},
    files: {
      'logs/log.txt': ['src/folderWithJson1', 'src/folderWithJson2']
    }
  },
})
```

#### Custom Options
In this example, if an error is found, Grunt is aborted immediately. No error will be printed on the console

```js
grunt.initConfig({
  json_structure_diff: {
    options: {
      breakOnFail: true,
      verbose: false
    },
    files: {
      'logs/log.txt': ['src/folderWithJson1', 'src/folderWithJson2']
    }
  },
})
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

## License
Copyright (c) 2015 Filipe Garcia. Licensed under the MIT license.

## TODO
+ TESTS!!;
+ Add support for direct file input, instead of folders that need to be in sync;
+ JSDoc.

---
_Source: https://npm.io/package/grunt-json-structure-diff · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._