Include documentation in printed config files (#41)

* Start work on printing toml config with comments

* WIP: toml_config: extract default values for fields

* WIP: toml_config: handle single-level nested structs

* WIP: toml_config: improve comment handling, std type trait impls

* WIP: toml_config: add Private trait, improve comment handling, clean up

* toml_config: fix default value bug; improve tests

* Use toml_config in all applicable crates; add toml_config enum support

* toml_config: improve comments

* toml_config_derive: support enum comments

* Improve config comments for udp, cli_helpers, common

* Improve config comments

* Add tests for Config struct TomlConfig implementations

* Improve Config comments

* Improve Config comments

* ws, http: add config comments for tls cert and private key lines

* small fixes to toml_config and toml_config_derive

* Run cargo fmt

* Fix typo in several config comments

* Update README

* Update README
This commit is contained in:
Joakim Frostegård 2021-12-26 11:33:27 +01:00 committed by GitHub
parent d694785244
commit a208775104
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
28 changed files with 581 additions and 92 deletions

29
Cargo.lock generated
View file

@ -62,6 +62,7 @@ dependencies = [
"serde",
"simplelog",
"toml",
"toml_config",
]
[[package]]
@ -80,6 +81,7 @@ dependencies = [
"privdrop",
"rand",
"serde",
"toml_config",
]
[[package]]
@ -109,6 +111,7 @@ dependencies = [
"signal-hook",
"slab",
"smartstring",
"toml_config",
]
[[package]]
@ -130,6 +133,7 @@ dependencies = [
"rand_distr",
"rustls",
"serde",
"toml_config",
]
[[package]]
@ -179,6 +183,7 @@ dependencies = [
"slab",
"socket2 0.4.2",
"tinytemplate",
"toml_config",
]
[[package]]
@ -196,6 +201,7 @@ dependencies = [
"rand",
"rand_distr",
"serde",
"toml_config",
]
[[package]]
@ -215,6 +221,7 @@ dependencies = [
"rand_distr",
"serde",
"socket2 0.4.2",
"toml_config",
]
[[package]]
@ -259,6 +266,7 @@ dependencies = [
"signal-hook",
"slab",
"socket2 0.4.2",
"toml_config",
"tungstenite",
]
@ -284,6 +292,7 @@ dependencies = [
"rustls",
"serde",
"serde_json",
"toml_config",
"tungstenite",
]
@ -2066,6 +2075,26 @@ dependencies = [
"serde",
]
[[package]]
name = "toml_config"
version = "0.1.0"
dependencies = [
"quickcheck",
"quickcheck_macros",
"serde",
"toml",
"toml_config_derive",
]
[[package]]
name = "toml_config_derive"
version = "0.1.0"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "tracing"
version = "0.1.29"