This repository has been archived on 2024-07-25. You can view files and clone it, but cannot push or open issues or pull requests.
enve/itconfig/README.md

79 lines
1.6 KiB
Markdown
Raw Normal View History

2019-12-22 13:13:29 +03:00
# itconfig
2019-12-23 09:49:57 +03:00
Easy build a configs from environment variables and use it in globally.
2019-12-22 13:13:29 +03:00
We recommend you start with the [documentation].
## Example usage
```rust
#[macro_use] extern crate itconfig;
use std::env;
//use dotenv::dotenv;
2019-12-22 13:13:29 +03:00
config! {
2019-12-24 19:37:55 +03:00
DEBUG: bool => true,
2020-01-07 22:36:50 +03:00
HOST: String => "127.0.0.1",
2019-12-25 11:03:33 +03:00
2020-01-07 16:17:48 +03:00
DATABASE_URL < (
"postgres://",
POSTGRES_USERNAME => "user",
":",
POSTGRES_PASSWORD => "pass",
"@",
POSTGRES_HOST => "localhost:5432",
"/",
POSTGRES_DB => "test",
),
2019-12-25 11:03:33 +03:00
NAMESPACE {
#[env_name = "MY_CUSTOM_NAME"]
FOO: bool,
2019-12-25 11:03:33 +03:00
BAR: i32 => 10,
2019-12-27 23:57:13 +03:00
#[cfg(feature = "feature")]
#[env_name = "POSTGRES_CONNECTION_STRING"]
DATABASE_URL: String
2019-12-25 11:03:33 +03:00
}
2019-12-22 13:13:29 +03:00
}
fn main () {
2019-12-24 19:37:55 +03:00
// dotenv().ok();
env::set_var("MY_CUSTOM_NAME", "t");
2019-12-22 13:13:29 +03:00
cfg::init();
2020-01-07 16:17:48 +03:00
assert_eq!(cfg::HOST(), String::from("127.0.0.1"));
assert_eq!(cfg::DATABASE_URL(), String::from("postgres://user:pass@localhost:5432/test"));
assert_eq!(cfg::NAMESPACE::FOO(), true);
2019-12-22 13:13:29 +03:00
}
```
2019-12-24 19:37:55 +03:00
## Roadmap
2019-12-25 11:04:13 +03:00
* [x] Add namespace for variables
* [x] Custom env name
2019-12-27 23:57:13 +03:00
* [x] Support feature config and other meta directives
* [x] Add default value to env if env is not found
2020-01-07 16:17:48 +03:00
* [x] Concat env variables to one variable
2020-01-10 08:23:06 +03:00
* [ ] Add nested namespaces
* [ ] Support array type
* [ ] Support hashmap type
* [ ] Support custom env type
2019-12-24 19:37:55 +03:00
## License
[MIT] © [Ice Temple](https://github.com/icetemple)
## Contributors
[pleshevskiy](https://github.com/pleshevskiy) (Dmitriy Pleshevskiy) creator, maintainer.
2019-12-22 13:13:29 +03:00
[documentation]: https://docs.rs/itconfig