Add native grammar registration and external crate guide#171
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This adds a minimal public API for registering third-party compiled grammars into Arborium's shared
GrammarStore.It also documents the outside-the-repo workflow for packaging an Arborium-compatible grammar crate and includes a full standalone example crate that registers itself into Arborium.
Changes
GrammarStore::insert(...)to the generated store template with explicit normalization and override semanticsHighlighter::with_store(...)and related shared-store flows pick up registered grammarsEXTERNAL_GRAMMAR_CRATES.mdexplaining how to build an Arborium-compatible grammar crate from outside this repoexamples/arborium-example-jsonas a full standalone example crate with a runnable Arborium integration exampleTesting
cargo nextest run --manifest-path /Users/amos/bearcove/arborium/crates/arborium/Cargo.toml --features lang-rustcargo check --manifest-path /Users/amos/bearcove/arborium/examples/arborium-example-json/Cargo.toml --example highlight_with_arboriumcargo run --manifest-path /Users/amos/bearcove/arborium/examples/arborium-example-json/Cargo.toml --example highlight_with_arborium