prusov-code/json-yaml-comparator

A simple PHP library and command-line utility for comparing JSON and YAML files with multiple output formats

1 2025-10-16 00:21 UTC

Requires

• docopt/docopt: ^1.0
• funct/funct: ^1.6
• symfony/var-dumper: ^7.3
• symfony/yaml: ^7.3

Requires (Dev)

• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^12.4
• squizlabs/php_codesniffer: ^4.0

MIT

• prusov-code

• yaml
• json
• diff
• comparator

README

About project

A powerful PHP library and command-line utility for comparing JSON and YAML files with multiple output formats.

Code quality

Prerequisites

• Linux, Macos, WSL
• PHP >= 8.2.0
• Composer >= 2.8.5
• Make
• Git

Installation

Composer

composer require prusov-code/json-yaml-comparator

Standalone

git clone https://github.com/prusov-code/json-yaml-comparator.git

cd json-yaml-comparator

make install

./bin/compare files/file1_nested.json files/file2_nested.yml

Usage as a library

# src/index.php
require_once __DIR__ . '/../vendor/autoload.php';
use function PrusovCode\JsonYamlComparator\compare;

$pathToFile1 = __DIR__ . '/../files/file1_nested.json'; # You can use absolute or relative path
$pathToFile2 = __DIR__ . '/../files/file2_nested.yml';
$outputFormat = 'stylish'; # Available formats: stylish (default format), plain, json

echo compare($pathToFile1, $pathToFile2, $outputFormat);

Usage examples

Compare two JSON files, stylish output

Compare two YAML files, plain output

Compare JSON and YAML files, json output