foreachq/gendiff

Structure differences finder

Maintainers

Details

github.com/Foreachq/gendiff

Source

Issues

Installs: 4

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Type:project

v1.1 2022-03-11 14:18 UTC

Requires

Requires (Dev)

proprietary 3401f123423b0c448230d4bdc8e7eb447878d3d7

  • Ilya Golovin <foreachq.woop@gmail.com>

This package is auto-updated.

Last update: 2025-03-11 21:03:15 UTC

README

PHP CI

Gendiff

«Gendiff» — a program that finds the difference between two data structures.

Description

Can be used as a separate CLI application or imported as a php package.

Program gets 2 paths and output format as input and returns structures differences in user defined format.

Utility features:

  • Recursive processing;
  • Support for different input formats: yaml and json;
  • Report generation in the form of plain text, "stylish" and json.

Requirements

  • php 7.4
  • composer 2.*

Installation

Php package

composer require foreachq/gendiff

Cli application

  • Download package
composer create-project foreachq/gendiff
  • Install dependencies
make install

Usage

CLI

# format plain
$ ./gendiff --format 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

# format by default (stylish)
$ ./gendiff filepath1.json filepath2.json

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

$ ./gendiff -h # for help

Php package

use function Differ\Differ\genDiff;

// formats: stylish (default), plain, json
$diff = genDiff($pathToFile1, $pathToFile2, $format);
print_r($diff);

Asciinemas of usage