zalo 0.2.35

A code highlighter giving the same output as VSCode
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! A syntax highlighting library using TextMate grammars and themes and producing the same
//! output as VSCode.
//!
//! # Example
//!
//! ```ignore
//! use zalo::{HighlightOptions, HtmlRenderer, Options, Registry, ThemeVariant};
//!
//! // Using the `dump` feature and loading the prebuilt assets
//! let registry = Registry::load_from_file("builtin.msgpack")?;
//! let code = "let x = 42;";
//!
//! let options = HighlightOptions::new("javascript", ThemeVariant::Single("catppuccin-frappe"));
//! let highlighted = registry.highlight(code, options)?;
//!
//! let render_options = Options {
//!     show_line_numbers: true,
//!     ..Default::default()
//! };
//! let html = HtmlRenderer::default().render(&highlighted, &render_options);
//! ```

#![deny(missing_docs)]

mod error;
mod grammars;
mod registry;
mod scope;
mod themes;

mod highlight;
mod markdown_fence;
mod renderers;
mod tokenizer;

mod customization;

pub use error::Error;
pub use highlight::HighlightedText;
pub use markdown_fence::{ParsedFence, parse_markdown_fence};
pub use registry::{HighlightOptions, HighlightedCode, PLAIN_GRAMMAR_NAME, Registry};
pub use renderers::{RenderOptions, html::HtmlRenderer, terminal::TerminalRenderer};
pub use themes::{Color, CompiledTheme, FontStyle, Style, ThemeVariant};

/// The CSS needed for the line number gutter to display properly
pub const ZALO_CSS: &str = r#".z-l {
  display: inline-block;
  min-height: 1lh;
  width: 100%;
}
.z-ln {
  display: inline-block;
  user-select: none;
  margin-right: 0.4em;
  padding: 0.4em;
  min-width: 3ch;
  text-align: right;
  opacity: 0.8;
}
"#;

#[cfg(test)]
pub(crate) mod test_utils {
    use crate::Registry;
    use std::fs;

    pub fn get_registry() -> Registry {
        let mut registry = Registry::default();
        for entry in fs::read_dir("grammars-themes/packages/tm-grammars/grammars").unwrap() {
            let path = entry.unwrap().path();
            registry.add_grammar_from_path(path).unwrap();
        }
        registry.link_grammars();
        registry
            .add_theme_from_path("grammars-themes/packages/tm-themes/themes/vitesse-black.json")
            .unwrap();
        registry
    }
}