README

Description

Utility can generate diff between two files
Can be used as standalone CLI utility or as a library
Supports absolute and relative paths to files
File formats supported:

json
yaml

Output formats supported (see below for examples):

pretty
plain
json

Requirements

PHP 7.4
ext-json extension installed

Installation

Standalone CLI utility

Global installation with composer recomended

$ composer g require ava/gendiff

Then you can run it globally (if you have global composer dir in your $PATH) as CLI program

Usage format is:

$ gendiff [--format <fmt>] <firstFile> <secondFile>

You can always get usage help with

$ gendiff -h

There are usage examples in section below

Library

Composer is recomended to install

$ composer require ava/gendiff

Then you can use it in your project

use function Gendiff\Core\compareFiles;
...
$diff = compareFiles($filepath1, $filepath2);

This will return diff between files in pretty format
You also can pass 3rd argument to change format Formats supported:

pretty
plain
json

Below you can find examples how different formats looks

Usage examples (CLI version)

pretty print format

plain format

json format output

ava / gendiff

Maintainers

Details