https://github.com/alexanderthaller/format_serde_error

Serde error messages for humans.
https://github.com/alexanderthaller/format_serde_error

error formatting rust serde

Last synced: about 2 months ago
JSON representation

Serde error messages for humans.

• Host: GitHub
• URL: https://github.com/alexanderthaller/format_serde_error
• Owner: AlexanderThaller
• Created: 2021-05-27T15:40:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-26T14:09:18.000Z (about 1 year ago)
• Last Synced: 2024-12-14T00:44:03.854Z (about 2 months ago)
• Topics: error, formatting, rust, serde
• Language: Rust
• Homepage: https://crates.io/crates/format_serde_error
• Size: 942 KB
• Stars: 34
• Watchers: 4
• Forks: 8
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# format_serde_error

[![Build Status](https://github.com/AlexanderThaller/format_serde_error/workflows/Rust/badge.svg?branch=main)](https://github.com/AlexanderThaller/format_serde_error/actions?query=workflow%3ARusteain)

[![crates.io](https://img.shields.io/crates/v/format_serde_error.svg)](https://crates.io/crates/format_serde_error)

[![docs.rs](https://docs.rs/format_serde_error/badge.svg)](https://docs.rs/format_serde_error)

Serde error messages for humans.

Format serde errors in a way to make it obvious where the error in the source file was.

!["example serde_json_long output"](resources/example_output/serde_json_long.png)

Add this to your Cargo.toml:

```toml

[dependencies]

format_serde_error = "0.3"

```

Currently [serde_yaml](https://github.com/serde-rs/json),

[serde_json](https://github.com/dtolnay/serde-yaml) and [toml](https://github.com/alexcrichton/toml-rs) are supported. Extending the

library to more data types should be relativly easy as long as the errors

emit a line and column.

Also has a custom error type which supports printing a message with a given

line and column (see [examples/custom.rs](examples/custom.rs)).

Usage Example (from [examples/serde_yaml.rs](examples/serde_yaml.rs)):

```rust

use format_serde_error::SerdeError;

#[derive(Debug, serde::Serialize, serde::Deserialize)]

struct Config {

    values: Vec,

}

fn main() -> Result<(), anyhow::Error> {

    let config_str = "values:

  - 'first'

  - 'second'

  - third:";

    let config = serde_yaml::from_str::(config_str)

        .map_err(|err| SerdeError::new(config_str.to_string(), err))?;

    dbg!(config);

    Ok(())

}

```

The output will be:

```

Error:

   | values:

   |   - 'first'

   |   - 'second'

 4 |   - third:

   |           ^ values[2]: invalid type: map, expected a string at line 4 column 10

```

!["example serde_yaml output"](resources/example_output/serde_yaml.png)

The crate will also shorten long lines if necessary (from

[examples/serde_yaml.rs](examples/serde_yaml.rs)):

```

Error:

   | values:

   |   - 'first'

   |   - 'second'

 4 |   - third: Lorem ipsum dolor sit amet, consectetur adipiscing...

   |           ^ values[2]: invalid type: map, expected a string at line 4 column 10

```

!["example serde_yaml output"](resources/example_output/serde_yaml_long.png)

The amount of context for lines and characters can be controlled globally and

per error. See documentation for how to do that. Adding context and shortening

the lines can also be disabled.

## Crate Features

### `serde_yaml`

*Enabled by default:* yes

Enables support for errors emitted by `serde_yaml`.

### `serde_json`

*Enabled by default:* yes

Enables support for errors emitted by `serde_json`.

### `toml`

*Enabled by default:* yes

Enables support for errors emitted by `toml`.

### `colored`

*Enabled by default:* yes

Enables support for color output to a terminal using the `colored` crate.

### `graphemes_support`

*Enabled by default:* yes

Enables proper support for grapheme cluster when contextualizing long error lines.

## Examples

### serde_json

!["example serde_json output"](resources/example_output/serde_json.png)

### serde_json_long

!["example serde_json_long output"](resources/example_output/serde_json_long.png)

### serde_yaml

!["example serde_yaml output"](resources/example_output/serde_yaml.png)

### serde_yaml_long

!["example serde_yaml_long output"](resources/example_output/serde_yaml_long.png)

### toml

!["example toml"](resources/example_output/toml.png)

### custom

!["example custom output"](resources/example_output/custom.png)

### custom_tabs

!["example custom_tabs output"](resources/example_output/custom_tabs.png)