Crate arborium_wit

Crate arborium_wit 

Source
Expand description

THIS FILE IS GENERATED FROM xtask/templates/lib.stpl.rs; DO NOT EDIT MANUALLY

§arborium-wit

Part of Arborium crates.io docs.rs license

WIT grammar for tree-sitter.

WebAssembly Interface Types - an interface definition language for the WebAssembly Component Model; spec and docs at component-model.bytecodealliance.org.

InventorBytecode Alliance
Year2021

§Usage

use arborium_wit::language;
use tree_sitter_patched_arborium::Parser;

let mut parser = Parser::new();
parser.set_language(&language()).expect("Error loading wit grammar");

let source_code = "/* your wit code here */";
let tree = parser.parse(source_code, None).unwrap();
println!("{}", tree.root_node().to_sexp());

For most use cases, prefer the main arborium crate:

[dependencies]
arborium = { version = "*", features = ["wit"] }

Or use this crate directly:

[dependencies]
arborium-wit = "*"

§About Arborium

This crate is part of Arborium, a collection of tree-sitter grammars packaged as Rust crates, maintained by Amos Wenger.

This crate packages a parser.c file generated by the tree-sitter CLI. It exports a language() function returning the tree-sitter Language for wit.

Why separate crates? Tree-sitter parsers can be large (some exceed 1MB of generated C). Splitting languages into separate crates means you only compile what you need, and parallel/incremental builds are more effective.

§Build Requirements

  • Rust: MSRV is 1.85.0 (Rust 2024 edition)
  • C compiler: This crate compiles C code via the cc crate

§Supported Targets

  • All major platforms: Linux, macOS, Windows
  • WebAssembly: wasm32-unknown-unknown (with custom sysroot)

§Upstream Grammar

Repositorybytecodealliance/tree-sitter-wit
Commita80c1f47baa5bfb13e2b5f49aa5304e3dab94948
LicenseApache-2.0 WITH LLVM-exception

To regenerate after upstream updates:

cargo xtask gen --name wit

Found a grammar bug? Please report it to the upstream repository.

§Safety

This crate uses unsafe for FFI bindings to the tree-sitter C library. The unsafe surface is minimal and limited to what tree-sitter requires. The generated parser code is produced by tree-sitter’s own code generator.

§Versioning

Crate versions track Arborium releases, not upstream grammar versions. The upstream commit is recorded above. A major version bump occurs when grammar changes affect node names or structure (breaking for query consumers).

§License

  • Generated parser code (parser.c): Apache-2.0 WITH LLVM-exception (from upstream grammar)
  • Arborium glue code: MIT OR Apache-2.0

§Contributing

Constants§

HIGHLIGHTS_QUERY
The highlights query for wit.
INJECTIONS_QUERY
The injections query for wit.
LOCALS_QUERY
The locals query for wit (empty - no locals available).

Functions§

language
Returns the wit tree-sitter LanguageFn.