Sample Config
Automatic generation of sample configs with documentation comments. Just derive the SampleConfig
trait on your config types, create an example object and generate a configuration file using that.
Usage
Example:
use SampleConfig;
/// Example enum.
/// General documentation isn't used.
let instance = default;
let yaml_file_string = instance.generate_sample_yaml;
write.unwrap;
remove_file.unwrap
Please take a look at the tests to see more complicated examples.
Lints
This projects uses a bunch of clippy lints for higher code quality and style.
Install cargo-lints
using cargo install --git https://github.com/FlixCoder/cargo-lints
. The lints are defined in lints.toml
and can be checked by running cargo lints clippy --all-targets --workspace
.