brief-core 0.3.0

Compiler library for the Brief markup language: lexer, parser, AST, HTML/LLM emitters, formatter, and Markdown-to-Brief converter.
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use crate::shortcode::{Registry, Shortcode};
use serde::Deserialize;
use std::collections::BTreeMap;
use std::path::Path;

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Eq)]
pub struct Config {
    #[serde(default)]
    pub project: Project,
    #[serde(default)]
    pub compile: Compile,
    #[serde(default)]
    pub shortcodes: BTreeMap<String, Shortcode>,
    #[serde(default)]
    pub hooks: Hooks,
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Eq)]
pub struct Project {
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub version: String,
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Eq)]
pub struct Compile {
    #[serde(default)]
    pub strict_heading_levels: bool,
    #[serde(default)]
    pub default_target: Option<String>,
    #[serde(default)]
    pub llm: LlmCompile,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Eq)]
pub struct LlmCompile {
    /// Master switch. When false, code blocks are emitted verbatim regardless
    /// of language tag or `@minify` attribute.
    #[serde(default = "default_minify_code_blocks")]
    pub minify_code_blocks: bool,
    /// Allowlist of language tags eligible for minification. Tags are
    /// matched case-insensitively. Defaults to the v0.2 set.
    #[serde(default = "default_minify_languages")]
    pub minify_languages: Vec<String>,
    /// Whether to keep the surrounding ```lang fence around minified code.
    /// True (default) preserves the structural cue for the consumer LLM.
    #[serde(default = "default_preserve_code_fences")]
    pub preserve_code_fences: bool,
}

impl Default for LlmCompile {
    fn default() -> Self {
        LlmCompile {
            minify_code_blocks: default_minify_code_blocks(),
            minify_languages: default_minify_languages(),
            preserve_code_fences: default_preserve_code_fences(),
        }
    }
}

fn default_minify_code_blocks() -> bool {
    true
}
fn default_minify_languages() -> Vec<String> {
    // v0.3 ships minifiers for JSON/JSONL plus the C-family + SQL set.
    // Aliases are listed explicitly so a user pruning the list by tag name
    // doesn't accidentally lose a language.
    vec![
        "json".into(),
        "jsonl".into(),
        "rust".into(),
        "rs".into(),
        "c".into(),
        "h".into(),
        "cpp".into(),
        "c++".into(),
        "cc".into(),
        "cxx".into(),
        "hpp".into(),
        "hxx".into(),
        "java".into(),
        "go".into(),
        "javascript".into(),
        "js".into(),
        "typescript".into(),
        "ts".into(),
        "sql".into(),
    ]
}
fn default_preserve_code_fences() -> bool {
    true
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Eq)]
pub struct Hooks {
    #[serde(default)]
    pub before_compile: Vec<String>,
    #[serde(default)]
    pub after_compile: Vec<String>,
}

pub fn load(path: &Path) -> Result<Config, String> {
    let text = std::fs::read_to_string(path).map_err(|e| e.to_string())?;
    toml::from_str(&text).map_err(|e| e.to_string())
}

pub fn registry_from(cfg: &Config) -> Registry {
    let mut reg = Registry::with_builtins();
    reg.extend(cfg.shortcodes.clone());
    reg
}