Giter Club home page Giter Club logo

gendiff's Introduction

gendiff

Actions Status Node CI Maintainability Test Coverage

The tool compares two configuration files and shows a difference. It supports JSON and YAML files and shows result in several text output formats.

This is my studying project at Hexlet School.

Getting Started

Install

  1. Clone the repo
git clone https://github.com/faciledictu/frontend-project-lvl2.git
  1. Install dependencies
make install
  1. If you want to compare files from CLI, make links
make link

Usage

CLI executable

gendiff [options] <filepath1> <filepath2>

Options:
  -V, --version        output the version number
  -f, --format <type>  output format (default: "stylish")
  -h, --help           display help for command

Javascipt module

genDiff(filepath1, filepath2)
genDiff(filepath1, filepath2, format)

Options:

  • filepath1, filepath2

    Strings to be used as file paths

  • format (optional) โ€” output format:

    • stylish (default): shows the changes as a tree
    • plain shows a list of changes
    • json returns a JSON string

Examples

Comparing two JSON files

asciicast

Comparing two YAML files

asciicast

Formatters

Stylish

asciicast

Plain

asciicast

JSON

asciicast

gendiff's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.