#syntax-highlighting #syntect #tui #ui #ratatui #translation #layer

syntect-tui

A lightweight translation layer between syntect.rs and tui.rs style types

9 stable releases

3.0.5 Oct 28, 2024
3.0.4 Sep 7, 2024
3.0.3 Jul 25, 2024
3.0.2 Mar 8, 2024
1.0.1 Dec 27, 2022

#125 in Command-line interface

Download history 50/week @ 2024-08-05 46/week @ 2024-08-12 79/week @ 2024-08-19 200/week @ 2024-08-26 272/week @ 2024-09-02 236/week @ 2024-09-09 170/week @ 2024-09-16 162/week @ 2024-09-23 191/week @ 2024-09-30 67/week @ 2024-10-07 60/week @ 2024-10-14 58/week @ 2024-10-21 209/week @ 2024-10-28 57/week @ 2024-11-04 107/week @ 2024-11-11 92/week @ 2024-11-18

471 downloads per month
Used in 7 crates

MIT license

18KB
156 lines

syntect-tui Build Status

A lightweight translation layer between syntect and ratatui style types. If you're building a CLI app with a UI powered by tui.rs and need syntax highlighting, then you may find this crate useful!

Given the limited scope of this crate I do not have plans to extend existing functionality much further. However, I am open to requests and/or contributions, so feel free to fork and submit a pull request.

Getting Started

syntect-tui is available on crates.io. You can install it by adding the following line to your Cargo.toml:

syntect-tui = "3.0"

Docs

For more usage information read the docs

Example Code

Building upon syntect's simple example, here's a snippet that parses some rust code, highlights it using syntect and converts it into ratatui::text::Line ready for rendering in a tui appliction:

use syntect::easy::HighlightLines;
use syntect::parsing::SyntaxSet;
use syntect::highlighting::{ThemeSet, Style};
use syntect::util::LinesWithEndings;
use syntui::into_span;

let ps = SyntaxSet::load_defaults_newlines();
let ts = ThemeSet::load_defaults();
let syntax = ps.find_syntax_by_extension("rs").unwrap();
let mut h = HighlightLines::new(syntax, &ts.themes["base16-ocean.dark"]);
let s = "pub struct Wow { hi: u64 }\nfn blah() -> u64 {}";
for line in LinesWithEndings::from(s) { // LinesWithEndings enables use of newlines mode
    let line_spans: Vec<tui::text::Span> =
        h.highlight_line(line, &ps)
         .unwrap()
         .into_iter()
         .filter_map(|segment| into_span(segment).ok())
         .collect();
    let spans = tui::text::Spans::from(line_spans);
    print!("{:?}", spans);
}

Licence & Acknowledgements

All code is released under the MIT License. Thanks to trishume, fdehau, and the ratatui community for building sytect, tui, and ratatui! Also a big thank you to fellow rustaceans who have contributed to the maintenance of this crate:

Dependencies

~10–19MB
~270K SLoC