31 releases (breaking)

new 0.37.0 May 22, 2024
0.36.0 Mar 14, 2024
0.33.1 Dec 30, 2023
0.31.0 Oct 12, 2023
0.20.1 Mar 30, 2023

#1 in #gitoxide

Download history 134255/week @ 2024-02-02 131456/week @ 2024-02-09 129918/week @ 2024-02-16 133142/week @ 2024-02-23 141296/week @ 2024-03-01 136522/week @ 2024-03-08 153213/week @ 2024-03-15 154699/week @ 2024-03-22 145691/week @ 2024-03-29 140174/week @ 2024-04-05 143447/week @ 2024-04-12 137785/week @ 2024-04-19 113672/week @ 2024-04-26 114109/week @ 2024-05-03 121968/week @ 2024-05-10 93651/week @ 2024-05-17

462,383 downloads per month
Used in 188 crates (8 directly)

MIT/Apache

730KB
14K SLoC

gix-config

gix-config is a library for interacting with git-config files.

This crate intents to be a performant Rust implementation for reading and writing git-config files. It exposes tiers of abstractions, from simple config value wrappers to a high level reader and writer.

The highlight of this crate is the zero-copy parser. We employ techniques to avoid copying where necessary, and reads that do not need normalization are guaranteed to be zero-copy. Higher level abstractions maintain this guarantee, and utilizes acceleration structures for increased performance.

Currently, this is not a binary. While we do intent to have a drop-in replacement for the git config sub-command, we're currently missing system-level abstractions to do so.

Contributing

Contributions are always welcome!

Code quality

This repository enables pedantic, cargo, and nursery clippy lints. Make sure to run cargo clean && cargo clippy (the clean stage is very important!) to ensure your code is linted.

Testing

Since this is a performance oriented crate, in addition to well tested code via cargo test, we also perform benchmarks to measure notable gains or losses in performance. We use criterion so benches can be run via cargo bench after installing it via cargo install cargo-criterion.

Changes to parsing code may include a request to fuzz to ensure that it cannot panic on inputs. This can be done by executing cargo +nightly fuzz run parse after installing the fuzz sub-command via cargo install cargo-fuzz.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in gix-config by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~7–18MB
~259K SLoC