arborium-nginx

Crates.ioarborium-nginx
lib.rsarborium-nginx
version2.12.4
created_at2025-12-04 22:19:06.548174+00
updated_at2026-01-18 11:09:28.09278+00
descriptionnginx grammar for arborium (tree-sitter bindings)
homepagehttps://github.com/bearcove/arborium
repositoryhttps://github.com/bearcove/arborium
max_upload_size
id1967186
size239,247
Amos Wenger (fasterthanlime)

documentation

https://docs.rs/arborium-nginx

README

arborium-nginx

Part of Arborium crates.io docs.rs license

nginx grammar for tree-sitter.

Configuration language for the nginx web server; official reference at nginx.org.

Inventor Igor Sysoev
Year 2004

Usage

use arborium_nginx::language;
use tree_sitter_patched_arborium::Parser;

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

let source_code = "/* your nginx 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 = ["nginx"] }

Or use this crate directly:

[dependencies]
arborium-nginx = "*"

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 nginx.

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

Repository https://gitlab.com/joncoole/tree-sitter-nginx
Commit f6d13cf6281b25f2ce342a49a41a10a0381e00f0
License GPL-3.0

To regenerate after upstream updates:

cargo xtask gen --name nginx

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): GPL-3.0 (from upstream grammar)
  • Arborium glue code: MIT OR Apache-2.0

Contributing

Commit count: 402

cargo fmt