7 releases (breaking)

✓ Uses Rust 2018 edition

0.6.0 Apr 5, 2019
0.5.0 Mar 31, 2019
0.4.1 Feb 5, 2019
0.3.0 Jan 16, 2019
0.1.0 Nov 29, 2018

#37 in Command-line interface

Download history 262/week @ 2019-01-21 214/week @ 2019-01-28 342/week @ 2019-02-04 266/week @ 2019-02-11 226/week @ 2019-02-18 225/week @ 2019-02-25 252/week @ 2019-03-04 262/week @ 2019-03-11 180/week @ 2019-03-18 332/week @ 2019-03-25 583/week @ 2019-04-01 311/week @ 2019-04-08 329/week @ 2019-04-15 467/week @ 2019-04-22 320/week @ 2019-04-29

1,157 downloads per month
Used in 9 crates (7 directly)

Apache-2.0/MIT

1MB
1.5K SLoC

prettyprint

Documentation Build Status

Syntax highlighting library with batteries included.

Quick start

Screenshot

The above output was created with the following code:

let printer = PrettyPrinter::default()
    .language("rust")
    .build()?;

printer.file("fixtures/fib.rs")?;

Note that prettyprint is a builder and can be customized. For example, if you don't like the grid or the header, you can disable those:

let printer = PrettyPrinter::default()
    .header(false)
    .grid(false)
    .language("ruby")
    .build()?;

let example = r#"
def fib(n)        
    return 1 if n <= 1
    fib(n-1) + fib(n-2)
end
"#;
printer.string_with_header(example, "fib.rb")?;

"What!? It can also print strings, Matthias? That's insane."
It's true. You're welcome.

Installation

Add this to your Cargo.toml:

prettyprint = "*"

But why?

syntect is a great package for highlighting text.
When writing a command-line tool that prints text however, you might be looking for some additional functionality.

  • Line numbers
  • More built-in color-themes
  • Automatic pagination
  • Proper terminal handling
  • Showing non-printable characters
  • File headers
  • Windows support

prettyprint offers all of this in one crate (thanks to bat).

Known limitations

  • Doesn't run on no-std targets. I don't plan to support those.

Credits

prettyprint is simply a fork of bat, with some functionality stripped out and bundled up as a library. I built it, because I needed it for cargo-inspect. All credits go to the original authors.

Dependencies

~10MB
~168K SLoC