arborium-test-harness

Test harness for arborium grammar crates.

This crate provides utilities for testing tree-sitter grammars and their highlight queries.

Usage

In your grammar crate's test module:

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_grammar() {
        arborium_test_harness::test_grammar(
            language(),
            "rust",
            HIGHLIGHTS_QUERY,
            INJECTIONS_QUERY,
            LOCALS_QUERY,
            env!("CARGO_MANIFEST_DIR"),
        );
    }
}

What it tests

The test_grammar function:

Validates queries - Ensures highlights.scm, injections.scm, and locals.scm compile without errors
Finds samples - Looks for sample files defined in arborium.kdl
Tests highlighting - Highlights each sample and verifies at least one highlight is produced

Sample files

Sample files are defined in your crate's arborium.kdl:

sample {
    path "samples/example.rs"
}

Highlight names

The harness configures tree-sitter with the standard arborium highlight names:

attribute, boolean, comment, comment.documentation
constant, constant.builtin, constructor, constructor.builtin
escape, function, function.builtin, keyword
markup, markup.bold, markup.heading, markup.italic, markup.link, etc.
module, number, operator, property, property.builtin
punctuation, punctuation.bracket, punctuation.delimiter, punctuation.special
string, string.escape, string.regexp, string.special
tag, type, type.builtin
variable, variable.builtin, variable.member, variable.parameter

License