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:

```rust use sample_config::SampleConfig;

/// Example enum.

[derive(Debug, Default, SampleConfig)]

enum ExampleEnum { /// A. #[default] VariantA, }

/// General documentation isn't used.

[derive(Debug, Default, SampleConfig)]

struct ExampleConfig { /// Some optional string. string: Option, /// Some list of numbers. numbers: Vec, /// Enumeration of values. value: ExampleEnum, }

let instance = ExampleConfig::default(); let yamlfilestring = instance.generatesampleyaml(); std::fs::write("output.yaml", &yamlfilestring).unwrap(); std::fs::remove_file("output.yaml").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.