Generate config docs from code

LemmyNet · Sep 20, 2021 · 5169eb8 · 5169eb8
1 parent 1e7f3a4
commit 5169eb8
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 7 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -63,6 +63,7 @@ activitystreams = "0.7.0-alpha.11"
 actix-rt = { version = "2.2.0", default-features = false }
 serde_json = { version = "1.0.66", features = ["preserve_order"] }
 clokwerk = "0.3.5"
+doku = { git = "https://github.com/anixe/doku", branch = "issue/1" }
 
 [dev-dependencies.cargo-husky]
 version = "1.5.0"

diff --git a/crates/utils/Cargo.toml b/crates/utils/Cargo.toml
@@ -39,3 +39,4 @@ jsonwebtoken = "7.2.0"
 deser-hjson = "1.0.2"
 smart-default = "0.6.0"
 webpage = { version = "1.3.0", default-features = false, features = ["serde"] }
+doku = { git = "https://github.com/anixe/doku", branch = "issue/1" }
diff --git a/crates/utils/src/settings/structs.rs b/crates/utils/src/settings/structs.rs
@@ -1,7 +1,8 @@
+use doku::prelude::*;
 use serde::Deserialize;
 use std::net::{IpAddr, Ipv4Addr};
 
-#[derive(Debug, Deserialize, Clone, SmartDefault)]
+#[derive(Debug, Deserialize, Clone, SmartDefault, Doku)]
 #[serde(default)]
 pub struct Settings {
   #[serde(default)]
@@ -19,6 +20,7 @@ pub struct Settings {
   #[default("unset")]
   pub hostname: String,
   #[default(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)))]
+  #[doku(as = "String")]
   pub bind: IpAddr,
   #[default(8536)]
   pub port: u16,
@@ -34,7 +36,7 @@ pub struct Settings {
   pub actor_name_max_length: usize,
 }
 
-#[derive(Debug, Deserialize, Clone, SmartDefault)]
+#[derive(Debug, Deserialize, Clone, SmartDefault, Doku)]
 #[serde(default)]
 pub struct CaptchaConfig {
   #[default(false)]
@@ -43,7 +45,7 @@ pub struct CaptchaConfig {
   pub difficulty: String,
 }
 
-#[derive(Debug, Deserialize, Clone, SmartDefault)]
+#[derive(Debug, Deserialize, Clone, SmartDefault, Doku)]
 #[serde(default)]
 pub struct DatabaseConfig {
   #[default("lemmy")]
@@ -60,7 +62,7 @@ pub struct DatabaseConfig {
   pub pool_size: u32,
 }
 
-#[derive(Debug, Deserialize, Clone)]
+#[derive(Debug, Deserialize, Clone, Doku)]
 pub struct EmailConfig {
   pub smtp_server: String,
   pub smtp_login: Option<String>,
@@ -69,7 +71,7 @@ pub struct EmailConfig {
   pub use_tls: bool,
 }
 
-#[derive(Debug, Deserialize, Clone, SmartDefault)]
+#[derive(Debug, Deserialize, Clone, SmartDefault, Doku)]
 #[serde(default)]
 pub struct FederationConfig {
   #[default(false)]
@@ -82,7 +84,7 @@ pub struct FederationConfig {
   pub strict_allowlist: bool,
 }
 
-#[derive(Debug, Deserialize, Clone, SmartDefault)]
+#[derive(Debug, Deserialize, Clone, SmartDefault, Doku)]
 #[serde(default)]
 pub struct RateLimitConfig {
   #[default(180)]
@@ -103,7 +105,7 @@ pub struct RateLimitConfig {
   pub image_per_second: i32,
 }
 
-#[derive(Debug, Deserialize, Clone, SmartDefault)]
+#[derive(Debug, Deserialize, Clone, SmartDefault, Doku)]
 pub struct SetupConfig {
   pub admin_username: String,
   pub admin_password: String,

diff --git a/src/main.rs b/src/main.rs
@@ -28,6 +28,7 @@ embed_migrations!();
 
 #[actix_web::main]
 async fn main() -> Result<(), LemmyError> {
+  println!("{}", doku::to_json_val(&Settings::default()));
   env_logger::init();
   let settings = Settings::get();