#configuration #spirit #ux

spirit-cfg-helpers

Helpers for spirit to make interacting with configuration more smooth for the user

6 releases (3 breaking)

0.4.0 Nov 18, 2020
0.3.1 Oct 20, 2020
0.3.0 Oct 19, 2019
0.2.0 Feb 20, 2019
0.1.1 Dec 26, 2018

#772 in Configuration


Used in spirit

Apache-2.0 OR MIT

315KB
3.5K SLoC

Spirit-hyper

Travis Build Status

A helper to add the --help-config and --dump-config options to a spirit-based application. Some more useful helpers around configuration too.

See the docs.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.


lib.rs:

Spirit configuration helpers

These extensions are meant to integrate into the spirit configuration framework. They aim at making the user experience around application's configuration more smooth. Specifically, they allow dumping the configuration collected through all the config files and environment variables and printing help about all the configuration options the application accepts.

Features

By default, all features are turned on. However, it is possible to opt out of some to cut down on dependencies. Specifically:

  • toml and json features enable dumping in the respective formats.
  • cfg-help enables the printing of configuration help.

Dependencies

~5MB
~98K SLoC