servius/sukr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(architecture): update module count and tree-house code example

Browse Source 
- Fix module count: 12 → 13 (add escape.rs)
- Add escape.rs to module responsibilities table
- Update code example from old HighlightConfiguration API
  to current tree-house LanguageConfig pattern

Reflects tree-house migration and API coherence audit findings.
This commit is contained in:
Timothy DeHerrera
2026-02-05 15:09:12 -07:00
parent c60c7851a8
commit 899f904160
1 changed files with 25 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/content/architecture.md
View File

@@ -5,7 +5,7 @@ weight: 5
toc: true toc: true
--- ---
Sukr is a 12-module static site compiler. Every feature that would typically require client-side JavaScript is moved to build-time. Sukr is a 13-module static site compiler. Every feature that would typically require client-side JavaScript is moved to build-time.
## Pipeline Overview ## Pipeline Overview
@@ -37,6 +37,7 @@ flowchart LR
| `template_engine.rs` | Tera template loading and rendering | | `template_engine.rs` | Tera template loading and rendering |
| `feed.rs` | Atom feed generation | | `feed.rs` | Atom feed generation |
| `sitemap.rs` | XML sitemap generation | | `sitemap.rs` | XML sitemap generation |
| `escape.rs` | HTML/XML text escaping utilities |
| `error.rs` | Structured error types with source chaining | | `error.rs` | Structured error types with source chaining |
## The Interception Pattern ## The Interception Pattern
@@ -78,19 +79,31 @@ The result: **zero bytes of JavaScript** in the output. Pages load instantly, wo
## Static Configuration Pattern ## Static Configuration Pattern
Tree-sitter grammars are expensive to initialize. Sukr uses `LazyLock` to create each language configuration exactly once: Tree-sitter grammars are expensive to initialize. Sukr uses [tree-house](https://github.com/helix-editor/tree-house) (Helix editor's Tree-sitter integration) with `LazyLock` to create language configurations exactly once:
```rust ```rust
static RUST_CONFIG: LazyLock<HighlightConfiguration> = LazyLock::new(|| { /// Create a LanguageConfig for a language with embedded queries.
let mut config = HighlightConfiguration::new( fn make_config(
tree_sitter_rust::LANGUAGE.into(), grammar: Grammar,
"rust", highlights: &str,
tree_sitter_rust::HIGHLIGHTS_QUERY, injections: &str,
"", locals: &str,
).expect("query should be valid"); ) -> Option<LanguageConfig> {
config.configure(HIGHLIGHT_NAMES); LanguageConfig::new(grammar, highlights, injections, locals).ok()
config }
});
// Register Rust with embedded Helix queries
if let Ok(grammar) = Grammar::try_from(tree_sitter_rust::LANGUAGE)
&& let Some(config) = make_config(
grammar,
include_str!("../queries/rust/highlights.scm"),
include_str!("../queries/rust/injections.scm"),
include_str!("../queries/rust/locals.scm"),
)
{
config.configure(resolve_scope);
configs.insert(Language::Rust, config);
}
``` ```
This pattern ensures O(1) lookup per language regardless of how many code blocks exist in the site. This pattern ensures O(1) lookup per language regardless of how many code blocks exist in the site.