prettyprint

KO | EN

gitlite — search

#javascript #hacktoberfest #golang #android #rust #linux #docker #java #windows #kubernetes #awesome-list #pytorch #mcp #open-source

(★ 201)

Beautifully formatted output for your terminal 🌈

File Explorer

Download Latest Version (.zip)

- - ci.yml
- dependabot.yml
- FUNDING.yml
- - Cabal.sublime-syntax
  - Crystal.sublime-syntax
  - CSV.sublime-syntax
  - Dart.sublime-syntax
  - FSharp.sublime-syntax
  - HTML (Twig).sublime-syntax
  - INI.sublime-syntax
  - Javascript (Babel).sublime-syntax
  - Kotlin.sublime-syntax
  - Nix.sublime-syntax
  - Pikalang.sublime-syntax
  - PowerShell.sublime-syntax
  - Robot.sublime-syntax
  - show-nonprintable.sublime-syntax
  - Swift.sublime-syntax
  - TypeScript.sublime-syntax
  - TypsecriptReact.sublime-syntax
  - VimL.sublime-syntax
- .gitattributes
- .ignore
- create.sh
- JavaDoc.sublime-syntax.patch
- README.md
- screenshot.jpg
- syntaxes.bin
- theme_preview.rs
- themes.bin
- dynamic-config.rs
- load-syntax.rs
- load-theme.rs
- stderr.rs
- fib.rs
- assets.rs
- builder.rs
- decorations.rs
- dirs.rs
- inputfile.rs
- lib.rs
- line_range.rs
- output.rs
- preprocessor.rs
- printer.rs
- style.rs
- syntax_mapping.rs
- terminal.rs
.gitignore
Cargo.toml
LICENSE_APACHE
LICENSE_MIT
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# prettyprint

[![Documentation](https://docs.rs/prettyprint/badge.svg)](https://docs.rs/prettyprint/)
![CI](https://github.com/mre/prettyprint/workflows/CI/badge.svg)

Syntax highlighting library with batteries included.

> :warning: For new projects, you might want to use [`bat`](https://github.com/sharkdp/bat/) instead, 
> which can be used as a [library now](https://github.com/sharkdp/bat/pull/936). 
> `prettyprint` is in maintenance mode, which means it will 
> not see any major updates anymore, but pull requests will still be reviewed and dependencies will 
> be kept up-to-date for the time being. You might want to consider migrating away eventually, though.

## Quick start

![Screenshot](https://raw.githubusercontent.com/mre/prettyprint/master/assets/screenshot.jpg)

The above output was created with the following code:

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

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

Note that `prettyprint` is a [builder](https://github.com/rust-unofficial/patterns/blob/master/patterns/builder.md) and can be customized. For example, if you don't like the grid or the header, you can disable those:

```rust
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`:

```TOML
prettyprint = "*"
```

## But why?

[`syntect`](https://github.com/trishume/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](https://github.com/sharkdp/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`](https://github.com/sharkdp/bat/), with some functionality stripped out and bundled up as a library. 
I built it, because [I needed it](https://github.com/sharkdp/bat/issues/423) for [cargo-inspect](https://github.com/mre/cargo-inspect/).
All credits go to the original authors.

prettyprint

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

prettyprint

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README