72 lines
1.8 KiB
Markdown
72 lines
1.8 KiB
Markdown
# itconfig
|
||
[](https://travis-ci.org/icetemple/itconfig-rs)
|
||
[](https://docs.rs/itconfig)
|
||
[](https://crates.io/crates/itconfig)
|
||
[](https://gitter.im/icetemple/itconfig-rs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
|
||
Easy build a configs from environment variables and use it in globally.
|
||
|
||
We recommend you start with the [documentation].
|
||
|
||
|
||
## Example usage
|
||
|
||
```rust
|
||
#[macro_use] extern crate itconfig;
|
||
use std::env;
|
||
//use dotenv::dotenv;
|
||
|
||
config! {
|
||
DEBUG: bool => true,
|
||
HOST: String => "127.0.0.1".to_string(),
|
||
|
||
NAMESPACE {
|
||
#[env_name = "MY_CUSTOM_NAME"]
|
||
FOO: bool,
|
||
|
||
BAR: i32 => 10,
|
||
|
||
#[cfg(feature = "feature")]
|
||
#[env_name = "POSTGRES_CONNECTION_STRING"]
|
||
DATABASE_URL: String
|
||
}
|
||
}
|
||
|
||
fn main () {
|
||
// dotenv().ok();
|
||
env::set_var("MY_CUSTOM_NAME", "t");
|
||
|
||
cfg::init();
|
||
assert_eq(cfg::HOST(), String::from("127.0.0.1"));
|
||
assert_eq(cfg::NAMESPACE::FOO(), true);
|
||
}
|
||
```
|
||
|
||
## Running tests
|
||
|
||
```bash
|
||
cargo test
|
||
```
|
||
|
||
|
||
## Roadmap
|
||
|
||
* [x] Add namespace for variables
|
||
* [x] Custom env name
|
||
* [x] Support feature config and other meta directives
|
||
* [ ] Add default value to env if env is not found
|
||
* [ ] Concat env variables to one variable
|
||
|
||
|
||
## License
|
||
|
||
[MIT] © [Ice Temple](https://github.com/icetemple)
|
||
|
||
|
||
## Contributors
|
||
|
||
[pleshevskiy](https://github.com/pleshevskiy) (Dmitriy Pleshevskiy) – creator, maintainer.
|
||
|
||
|
||
[documentation]: https://docs.rs/itconfig
|
||
[MIT]: https://github.com/icetemple/itconfig-rs/blob/master/LICENSE
|