syntect-tui
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 HighlightLines;
use SyntaxSet;
use ;
use LinesWithEndings;
use into_span;
let ps = load_defaults_newlines;
let ts = load_defaults;
let syntax = ps.find_syntax_by_extension.unwrap;
let mut h = new;
let s = "pub struct Wow { hi: u64 }\nfn blah() -> u64 {}";
for line in from
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: