https://github.com/gmmorris/json-highlight-writer

A writer for json-rust object which supports highlighting slices when printing JSON objects
https://github.com/gmmorris/json-highlight-writer

Last synced: about 2 months ago
JSON representation

A writer for json-rust object which supports highlighting slices when printing JSON objects

• Host: GitHub
• URL: https://github.com/gmmorris/json-highlight-writer
• Owner: gmmorris
• License: apache-2.0
• Created: 2019-05-01T21:34:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-05-03T08:07:49.000Z (over 5 years ago)
• Last Synced: 2024-10-12T14:42:22.294Z (3 months ago)
• Language: Rust
• Size: 104 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# json-highlight-writer

A writer for [json-rust](https://github.com/maciejhirsz/json-rust) object which supports highlighting slices when printing JSON objects

## Usage

There are three public functions:

### highlight

_highlight_ takes a JSON object and a vector of slices you wish to highlight.

```rust

use colored::*;

use json::*;

use json_highlight_writer::{highlight_with_colors, highlight, highlight_with_colors_and_remainder};

let res = object!{

    "code" => 200,

    "success" => true,

    "payload" => object!{

        "features" => array![

            "awesome",

            "easyAPI",

            "lowLearningCurve"

        ]

    }

};

println!("{:#}", highlight(&res, vec![&res["code"], &res["payload"]["features"]]));

```

This code will print out the entire JSON structure with the code field and array of features highlighted in red.

![Single Color Matches](../master/assets/single.png?raw=true)

### highlight_with_colors

_highlight_with_colors_ takes a JSON object, a vector of slices you wish to highlight and a vector of colors to cycle through when matching slices.

```rust

println!("{:#}", highlight_with_colors(&res, vec![&res["code"], &res["payload"]["features"]], vec![Color::Red, Color::Green]));

println!("{:#}", highlight_with_colors(&res, vec![&res["payload"], &res["payload"]["features"]], vec![Color::Red, Color::Green]));

```

This code will print out the entire JSON structure twice, with the slices highlighted in red, the green.

Note the inner color highlighting which is used to display matching slices in different colors if a matched slice resides inside of another matched slice.

![Multiple Color Matches](../master/assets/multiple.png?raw=true)

If there are more slices than there are specified colors the highlighting will cycle back through the vector.

```rust

println!("{:#}", highlight_with_colors(&res, vec![&res["code"], &res["payload"], &res["payload"]["features"]], vec![Color::Red, Color::Green]));

```

![Overlapping Matches](../master/assets/overlap.png?raw=true)

### highlight_with_colors_and_remainder

_highlight_with_colors_and_remainder_ is similar, except it can also take a color for the _remainder_, that is, the parts of the JSON that don't overlap with the slice.

```rust

println!("{:#}", highlight_with_colors_and_remainder(&res, vec![&res["code"], &res["payload"], &res["payload"]["features"]], Some(vec![Color::Red, Color::Green]), Some(Color::White)));

```