docs(schema): ensure all public-facing bar config opts have docstrings

Cargo.lock

@@ -642,7 +642,7 @@ dependencies = [
 [[package]]
 name = "base16-egui-themes"
 version = "0.1.0"
-source = "git+https://github.com/LGUG2Z/base16-egui-themes?rev=adfed118ab1408f134fd7d8a549ccfe47b99d752#adfed118ab1408f134fd7d8a549ccfe47b99d752"
+source = "git+https://github.com/LGUG2Z/base16-egui-themes?rev=b9e26b31f7a0e7ed239b14e5317e95d1bdc544bd#b9e26b31f7a0e7ed239b14e5317e95d1bdc544bd"
 dependencies = [
  "egui",
  "schemars 1.1.0",

check_schema_docs.py

@@ -0,0 +1,371 @@
+#!/usr/bin/env python3
+"""
+Check schema.json and schema.bar.json for missing docstrings and map them to Rust source files.
+
+This script analyzes the generated JSON schemas and identifies:
+1. Type definitions ($defs) missing top-level descriptions
+2. Enum variants missing descriptions (in oneOf/anyOf)
+3. Struct properties missing descriptions
+4. Top-level schema properties missing descriptions
+
+For each missing docstring, it attempts to find the corresponding Rust source
+file and line number where the docstring should be added.
+"""
+
+import json
+import re
+import sys
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Optional
+
+
+@dataclass
+class MissingDoc:
+    type_name: str
+    kind: str  # "type", "variant", "property"
+    item_name: Optional[str]  # variant or property name
+    rust_file: Optional[str] = None
+    rust_line: Optional[int] = None
+
+    def __str__(self):
+        location = ""
+        if self.rust_file and self.rust_line:
+            location = f" -> {self.rust_file}:{self.rust_line}"
+        elif self.rust_file:
+            location = f" -> {self.rust_file}"
+
+        if self.kind == "type":
+            return f"[TYPE] {self.type_name}{location}"
+        elif self.kind == "variant":
+            return f"[VARIANT] {self.type_name}::{self.item_name}{location}"
+        else:
+            return f"[PROPERTY] {self.type_name}.{self.item_name}{location}"
+
+
+@dataclass
+class SchemaConfig:
+    """Configuration for a schema to check."""
+
+    schema_file: str
+    search_paths: list[str]
+    display_name: str
+
+
+def find_rust_definition(
+    type_name: str, item_name: Optional[str], kind: str, search_paths: list[Path]
+) -> tuple[Optional[str], Optional[int]]:
+    """Find the Rust file and line number for a type/variant/property definition."""
+
+    if kind == "type":
+        patterns = [
+            rf"pub\s+enum\s+{type_name}\b",
+            rf"pub\s+struct\s+{type_name}\b",
+        ]
+    elif kind == "variant":
+        patterns = [
+            rf"^\s*{re.escape(item_name)}\s*[,\(\{{]",
+            rf"^\s*{re.escape(item_name)}\s*$",
+            rf"^\s*#\[.*\]\s*\n\s*{re.escape(item_name)}\b",
+        ]
+    else:  # property
+        patterns = [rf"pub\s+{re.escape(item_name)}\s*:"]
+
+    for search_path in search_paths:
+        for rust_file in search_path.rglob("*.rs"):
+            try:
+                content = rust_file.read_text()
+                lines = content.split("\n")
+
+                if kind == "type":
+                    for pattern in patterns:
+                        for i, line in enumerate(lines):
+                            if re.search(pattern, line):
+                                return str(rust_file), i + 1
+
+                elif kind in ("variant", "property"):
+                    parent_pattern = rf"pub\s+(?:enum|struct)\s+{type_name}\b"
+                    in_type = False
+                    brace_count = 0
+                    found_open_brace = False
+
+                    for i, line in enumerate(lines):
+                        if re.search(parent_pattern, line):
+                            in_type = True
+                            brace_count = 0
+                            found_open_brace = False
+
+                        if in_type:
+                            if "{" in line:
+                                found_open_brace = True
+                            brace_count += line.count("{") - line.count("}")
+
+                            for pattern in patterns:
+                                if re.search(pattern, line):
+                                    return str(rust_file), i + 1
+
+                            if found_open_brace and brace_count <= 0:
+                                in_type = False
+            except Exception:
+                continue
+
+    return None, None
+
+
+def check_type_description(type_name: str, type_def: dict) -> list[MissingDoc]:
+    """Check if a type definition has proper documentation."""
+    missing = []
+    has_top_description = "description" in type_def
+
+    # Always check for top-level type description first
+    # (except for types that are purely references or have special handling)
+    needs_type_description = True
+
+    # Check oneOf variants (tagged enums with variant descriptions)
+    if "oneOf" in type_def:
+        # oneOf types should have a top-level description
+        if not has_top_description:
+            missing.append(MissingDoc(type_name, "type", None, None, None))
+
+        for variant in type_def["oneOf"]:
+            # Case 1: Simple const variant (e.g., {"const": "Swap", "description": "..."})
+            variant_name = variant.get("const") or variant.get("title")
+            if variant_name and "description" not in variant:
+                missing.append(
+                    MissingDoc(type_name, "variant", str(variant_name), None, None)
+                )
+
+            # Case 2: String enum inside oneOf (e.g., {"type": "string", "enum": [...]})
+            # These variants don't have individual descriptions in the schema
+            if "enum" in variant and variant.get("type") == "string":
+                for enum_variant in variant["enum"]:
+                    missing.append(
+                        MissingDoc(type_name, "variant", str(enum_variant), None, None)
+                    )
+
+            # Case 3: Object variant with properties (e.g., CubicBezier)
+            if "properties" in variant and "description" not in variant:
+                for prop_name in variant.get("required", []):
+                    missing.append(
+                        MissingDoc(type_name, "variant", str(prop_name), None, None)
+                    )
+
+    # Check anyOf variants - check each variant individually
+    elif "anyOf" in type_def:
+        # anyOf types should have a top-level description
+        if not has_top_description:
+            missing.append(MissingDoc(type_name, "type", None, None, None))
+
+        # Check each variant for description (skip pure $ref and null types)
+        for variant in type_def["anyOf"]:
+            # Skip null type variants (used for Option<T>)
+            if variant.get("type") == "null":
+                continue
+            # Skip pure $ref variants (the referenced type is checked separately)
+            if "$ref" in variant and len(variant) == 1:
+                continue
+            # Skip $ref variants that have a description
+            if "$ref" in variant and "description" in variant:
+                continue
+            # Variant with $ref but no description
+            if "$ref" in variant and "description" not in variant:
+                # Extract the type name from the $ref
+                ref_name = variant["$ref"].split("/")[-1]
+                missing.append(MissingDoc(type_name, "variant", ref_name, None, None))
+            # Non-ref variant without description
+            elif "description" not in variant and "$ref" not in variant:
+                # Try to identify the variant by its type or const
+                variant_id = variant.get("const") or variant.get("type") or "unknown"
+                missing.append(
+                    MissingDoc(type_name, "variant", str(variant_id), None, None)
+                )
+
+    # Check simple string enums (no oneOf means no variant descriptions possible in schema)
+    elif "enum" in type_def:
+        if not has_top_description:
+            missing.append(MissingDoc(type_name, "type", None, None, None))
+        # Each enum variant needs a docstring - these can't have descriptions in simple enum format
+        for variant in type_def["enum"]:
+            missing.append(MissingDoc(type_name, "variant", str(variant), None, None))
+
+    # Check struct properties
+    elif "properties" in type_def:
+        # Structs should always have a top-level description
+        if not has_top_description:
+            missing.append(MissingDoc(type_name, "type", None, None, None))
+
+        for prop_name, prop_def in type_def["properties"].items():
+            if "description" not in prop_def:
+                missing.append(MissingDoc(type_name, "property", prop_name, None, None))
+
+    # Simple type without description (like PathBuf, Hex)
+    elif not has_top_description:
+        # Only flag if it has a concrete type (not just a $ref)
+        if type_def.get("type") is not None:
+            missing.append(MissingDoc(type_name, "type", None, None, None))
+
+    return missing
+
+
+def check_top_level_properties(schema: dict, root_type_name: str) -> list[MissingDoc]:
+    """Check top-level schema properties for missing descriptions."""
+    missing = []
+    properties = schema.get("properties", {})
+
+    for prop_name, prop_def in properties.items():
+        if "description" not in prop_def:
+            missing.append(
+                MissingDoc(root_type_name, "property", prop_name, None, None)
+            )
+
+    return missing
+
+
+def check_schema(
+    schema_path: Path,
+    search_paths: list[Path],
+    project_root: Path,
+    display_name: str,
+) -> tuple[list[MissingDoc], int]:
+    """Check a single schema file and return missing docs and exit code."""
+    if not schema_path.exists():
+        print(f"Error: {schema_path.name} not found at {schema_path}")
+        return [], 1
+
+    with open(schema_path) as f:
+        schema = json.load(f)
+
+    all_missing: list[MissingDoc] = []
+
+    # Check top-level schema properties
+    root_type_name = schema.get("title", "Root")
+    all_missing.extend(check_top_level_properties(schema, root_type_name))
+
+    # Check all type definitions
+    for type_name, type_def in sorted(schema.get("$defs", {}).items()):
+        # Skip PerAnimationPrefixConfig2/3 as they're generated variants
+        if (
+            type_name.startswith("PerAnimationPrefixConfig")
+            and type_name != "PerAnimationPrefixConfig"
+        ):
+            continue
+        all_missing.extend(check_type_description(type_name, type_def))
+
+    # Find Rust source locations
+    print(f"Scanning Rust source files for {display_name}...", file=sys.stderr)
+    for doc in all_missing:
+        doc.rust_file, doc.rust_line = find_rust_definition(
+            doc.type_name, doc.item_name, doc.kind, search_paths
+        )
+        if doc.rust_file:
+            try:
+                doc.rust_file = str(Path(doc.rust_file).relative_to(project_root))
+            except ValueError:
+                pass
+
+    return all_missing, 0
+
+
+def print_results(all_missing: list[MissingDoc], display_name: str) -> None:
+    """Print the results for a schema check."""
+    # Group by file
+    by_file: dict[str, list[MissingDoc]] = {}
+    external: list[MissingDoc] = []
+
+    for doc in all_missing:
+        if doc.rust_file:
+            by_file.setdefault(doc.rust_file, []).append(doc)
+        else:
+            external.append(doc)
+
+    # Print summary
+    print("\n" + "=" * 70)
+    print(f"MISSING DOCSTRINGS IN SCHEMA ({display_name})")
+    print("=" * 70)
+
+    type_count = sum(1 for d in all_missing if d.kind == "type")
+    variant_count = sum(1 for d in all_missing if d.kind == "variant")
+    prop_count = sum(1 for d in all_missing if d.kind == "property")
+
+    print(f"\nTotal: {len(all_missing)} missing docstrings")
+    print(f"  - {type_count} types")
+    print(f"  - {variant_count} variants")
+    print(f"  - {prop_count} properties")
+
+    # Print by file
+    for rust_file in sorted(by_file.keys()):
+        docs = sorted(by_file[rust_file], key=lambda d: d.rust_line or 0)
+        print(f"\n{rust_file}:")
+        print("-" * len(rust_file))
+        for doc in docs:
+            print(f"  {doc}")
+
+    # Print external items (types not found in source)
+    if external:
+        print(f"\nExternal/Unknown location:")
+        print("-" * 25)
+        for doc in external:
+            print(f"  {doc}")
+
+    print("\n" + "=" * 70)
+
+
+def main():
+    script_dir = Path(__file__).parent
+    project_root = script_dir.parent
+
+    # Define schemas to check with their respective search paths
+    schemas = [
+        SchemaConfig(
+            schema_file="schema.json",
+            search_paths=["komorebi/src", "komorebi-themes/src"],
+            display_name="komorebi",
+        ),
+        SchemaConfig(
+            schema_file="schema.bar.json",
+            search_paths=["komorebi-bar/src", "komorebi-themes/src"],
+            display_name="komorebi-bar",
+        ),
+    ]
+
+    total_missing = 0
+    has_errors = False
+
+    for schema_config in schemas:
+        schema_path = project_root / schema_config.schema_file
+        search_paths = [
+            project_root / p
+            for p in schema_config.search_paths
+            if (project_root / p).exists()
+        ]
+
+        missing, error_code = check_schema(
+            schema_path,
+            search_paths,
+            project_root,
+            schema_config.display_name,
+        )
+
+        if error_code != 0:
+            has_errors = True
+            continue
+
+        print_results(missing, schema_config.display_name)
+        total_missing += len(missing)
+
+    # Print combined summary
+    if len(schemas) > 1:
+        print("\n" + "=" * 70)
+        print("COMBINED SUMMARY")
+        print("=" * 70)
+        print(f"Total missing docstrings across all schemas: {total_missing}")
+        print("=" * 70)
+
+    if has_errors:
+        return 1
+
+    return 1 if total_missing > 0 else 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

komorebi-bar/src/config.rs

@@ -163,6 +163,7 @@ impl KomobarConfig {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Position configuration
 pub struct PositionConfig {
     /// The desired starting position of the bar (0,0 = top left of the screen)
     #[serde(alias = "position")]
@@ -174,6 +175,7 @@ pub struct PositionConfig {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Frame configuration
 pub struct FrameConfig {
     /// Margin inside the painted frame
     pub inner_margin: Position,
@@ -182,6 +184,7 @@ pub struct FrameConfig {
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[serde(untagged)]
+/// Monitor configuration or monitor index
 pub enum MonitorConfigOrIndex {
     /// The monitor index where you want the bar to show
     Index(usize),
@@ -191,6 +194,7 @@ pub enum MonitorConfigOrIndex {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Monitor configuration
 pub struct MonitorConfig {
     /// Komorebi monitor index of the monitor on which to render the bar
     pub index: usize,
@@ -208,9 +212,13 @@ pub type Margin = SpacingKind;
 // `Grouped` needs to come last, otherwise serde might mistaken an `IndividualSpacingConfig` for a
 // `GroupedSpacingConfig` with both `vertical` and `horizontal` set to `None` ignoring the
 // individual values.
+/// Spacing kind
 pub enum SpacingKind {
+    /// Spacing applied to all sides
     All(f32),
+    /// Individual spacing applied to each side
     Individual(IndividualSpacingConfig),
+    /// Grouped vertical and horizontal spacing
     Grouped(GroupedSpacingConfig),
 }
 
@@ -255,25 +263,36 @@ impl SpacingKind {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Grouped vertical and horizontal spacing
 pub struct GroupedSpacingConfig {
+    /// Vertical grouped spacing
     pub vertical: Option<GroupedSpacingOptions>,
+    /// Horizontal grouped spacing
     pub horizontal: Option<GroupedSpacingOptions>,
 }
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[serde(untagged)]
+/// Grouped spacing options
 pub enum GroupedSpacingOptions {
+    /// Symmetrical grouped spacing
     Symmetrical(f32),
+    /// Split grouped spacing
     Split(f32, f32),
 }
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Individual spacing configuration
 pub struct IndividualSpacingConfig {
+    /// Spacing for the top
     pub top: f32,
+    /// Spacing for the bottom
     pub bottom: f32,
+    /// Spacing for the left
     pub left: f32,
+    /// Spacing for the right
     pub right: f32,
 }
 
@@ -353,6 +372,7 @@ pub fn get_individual_spacing(
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[serde(untagged)]
+/// Mouse message
 pub enum MouseMessage {
     /// Send a message to the komorebi client.
     /// By default, a batch of messages are sent in the following order:
@@ -397,6 +417,7 @@ pub enum MouseMessage {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Komorebi socket mouse message
 pub struct KomorebiMouseMessage {
     /// Send the FocusMonitorAtCursor message
     #[cfg_attr(feature = "schemars", schemars(extend("default" = defaults::FOCUS_MONITOR_AT_CURSOR)))]
@@ -410,6 +431,7 @@ pub struct KomorebiMouseMessage {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Mouse configuration
 pub struct MouseConfig {
     /// Command to send on primary/left double button click
     pub on_primary_double_click: Option<MouseMessage>,
@@ -517,6 +539,7 @@ impl KomobarConfig {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Position
 pub struct Position {
     /// X coordinate
     pub x: f32,
@@ -545,29 +568,39 @@ impl From<Position> for Pos2 {
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[serde(tag = "palette")]
+/// Komorebi bar theme
 pub enum KomobarTheme {
-    /// A theme from catppuccin-egui
+    /// Theme from catppuccin-egui
     Catppuccin {
         /// Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin)
         name: komorebi_themes::Catppuccin,
+        /// Accent colour
         accent: Option<komorebi_themes::CatppuccinValue>,
+        /// Auto select fill colour
         auto_select_fill: Option<komorebi_themes::CatppuccinValue>,
+        /// Auto select text colour
         auto_select_text: Option<komorebi_themes::CatppuccinValue>,
     },
-    /// A theme from base16-egui-themes
+    /// Theme from base16-egui-themes
     Base16 {
         /// Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/)
         name: komorebi_themes::Base16,
+        /// Accent colour
         accent: Option<komorebi_themes::Base16Value>,
+        /// Auto select fill colour
         auto_select_fill: Option<komorebi_themes::Base16Value>,
+        /// Auto select text colour
         auto_select_text: Option<komorebi_themes::Base16Value>,
     },
-    /// A custom Base16 theme
+    /// Custom Base16 theme
     Custom {
         /// Colours of the custom Base16 theme palette
         colours: Box<komorebi_themes::Base16ColourPalette>,
+        /// Accent colour
         accent: Option<komorebi_themes::Base16Value>,
+        /// Auto select fill colour
         auto_select_fill: Option<komorebi_themes::Base16Value>,
+        /// Auto select text colour
         auto_select_text: Option<komorebi_themes::Base16Value>,
     },
 }
@@ -607,6 +640,7 @@ impl From<KomorebiTheme> for KomobarTheme {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Label prefix
 pub enum LabelPrefix {
     /// Show no prefix
     None,
@@ -620,6 +654,7 @@ pub enum LabelPrefix {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Display format
 pub enum DisplayFormat {
     /// Show only icon
     Icon,

komorebi-bar/src/render.rs

@@ -27,6 +27,7 @@ static SHOW_KOMOREBI_LAYOUT_OPTIONS: AtomicUsize = AtomicUsize::new(0);
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[serde(tag = "kind")]
+/// Grouping
 pub enum Grouping {
     /// No grouping is applied
     None,
@@ -39,6 +40,7 @@ pub enum Grouping {
 }
 
 #[derive(Clone)]
+/// Render configuration
 pub struct RenderConfig {
     /// Komorebi monitor index of the monitor on which to render the bar
     pub monitor_idx: usize,
@@ -356,6 +358,7 @@ impl RenderConfig {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Grouping configuration
 pub struct GroupingConfig {
     /// Styles for the grouping
     pub style: Option<GroupingStyle>,
@@ -367,7 +370,9 @@ pub struct GroupingConfig {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Grouping Style
 pub enum GroupingStyle {
+    /// Default
     #[serde(alias = "CtByte")]
     Default,
     /// A shadow is added under the default group. (blur: 4, offset: x-1 y-1, spread: 3)
@@ -389,6 +394,7 @@ pub enum GroupingStyle {
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[serde(untagged)]
+/// Rounding configuration
 pub enum RoundingConfig {
     /// All 4 corners are the same    
     Same(f32),

komorebi-bar/src/widgets/applications.rs

@@ -34,6 +34,7 @@ const MIN_LAUNCH_INTERVAL: Duration = Duration::from_millis(800);
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Applications widget configuration
 pub struct ApplicationsConfig {
     /// Enables or disables the applications widget.
     pub enable: bool,
@@ -51,6 +52,7 @@ pub struct ApplicationsConfig {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Application button configuration
 pub struct AppConfig {
     /// Whether to enable this application button (optional).
     /// Inherits from the global `Applications` setting if omitted.
@@ -72,6 +74,7 @@ pub struct AppConfig {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Default)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Applications widget display format
 pub enum ApplicationsDisplayFormat {
     /// Show only the application icon.
     #[default]

komorebi-bar/src/widgets/battery.rs

@@ -23,6 +23,7 @@ mod defaults {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Battery widget configuration
 pub struct BatteryConfig {
     /// Enable the Battery widget
     pub enable: bool,

komorebi-bar/src/widgets/cpu.rs

@@ -22,6 +22,7 @@ mod defaults {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// CPU widget configuration
 pub struct CpuConfig {
     /// Enable the Cpu widget
     pub enable: bool,

komorebi-bar/src/widgets/date.rs

@@ -62,6 +62,7 @@ impl CustomModifiers {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Date widget configuration
 pub struct DateConfig {
     /// Enable the Date widget
     pub enable: bool,
@@ -104,6 +105,7 @@ impl From<DateConfig> for Date {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Date widget format
 pub enum DateFormat {
     /// Month/Date/Year format (09/08/24)
     MonthDateYear,

komorebi-bar/src/widgets/keyboard.rs

@@ -28,6 +28,7 @@ mod defaults {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Keyboard widget configuration
 pub struct KeyboardConfig {
     /// Enable the Input widget
     pub enable: bool,

komorebi-bar/src/widgets/komorebi.rs

@@ -49,6 +49,7 @@ use std::sync::atomic::Ordering;
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Komorebi widget configuration
 pub struct KomorebiConfig {
     /// Configure the Workspaces widget
     pub workspaces: Option<KomorebiWorkspacesConfig>,
@@ -67,6 +68,7 @@ pub struct KomorebiConfig {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Komorebi widget workspaces configuration
 pub struct KomorebiWorkspacesConfig {
     /// Enable the Komorebi Workspaces widget
     pub enable: bool,
@@ -78,6 +80,7 @@ pub struct KomorebiWorkspacesConfig {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Komorebi widget layout configuration
 pub struct KomorebiLayoutConfig {
     /// Enable the Komorebi Layout widget
     pub enable: bool,
@@ -89,6 +92,7 @@ pub struct KomorebiLayoutConfig {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Komorebi widget workspace layer configuration
 pub struct KomorebiWorkspaceLayerConfig {
     /// Enable the Komorebi Workspace Layer widget
     pub enable: bool,
@@ -100,6 +104,7 @@ pub struct KomorebiWorkspaceLayerConfig {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Komorebi widget focused container configuration
 pub struct KomorebiFocusedContainerConfig {
     /// Enable the Komorebi Focused Container widget
     pub enable: bool,
@@ -112,6 +117,7 @@ pub struct KomorebiFocusedContainerConfig {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Komorebi widget locked container configuration
 pub struct KomorebiLockedContainerConfig {
     /// Enable the Komorebi Locked Container widget
     pub enable: bool,
@@ -123,6 +129,7 @@ pub struct KomorebiLockedContainerConfig {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Komorebi widget configuration switcher configuration
 pub struct KomorebiConfigurationSwitcherConfig {
     /// Enable the Komorebi Configurations widget
     pub enable: bool,

komorebi-bar/src/widgets/komorebi_layout.rs

@@ -26,11 +26,17 @@ use std::fmt::Formatter;
 #[derive(Copy, Clone, Debug, Serialize, PartialEq)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[serde(untagged)]
+/// Komorebi layout kind
 pub enum KomorebiLayout {
+    /// Predefined layout
     Default(komorebi_client::DefaultLayout),
+    /// Monocle mode
     Monocle,
+    /// Floating layer
     Floating,
+    /// Paused
     Paused,
+    /// Custom layout
     Custom,
 }
 

komorebi-bar/src/widgets/media.rs

@@ -17,6 +17,7 @@ use windows::Media::Control::GlobalSystemMediaTransportControlsSessionManager;
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Media widget configuration
 pub struct MediaConfig {
     /// Enable the Media widget
     pub enable: bool,

komorebi-bar/src/widgets/memory.rs

@@ -22,6 +22,7 @@ mod defaults {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Memory widget configuration
 pub struct MemoryConfig {
     /// Enable the Memory widget
     pub enable: bool,

komorebi-bar/src/widgets/network.rs

@@ -30,6 +30,7 @@ mod defaults {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Network widget configuration
 pub struct NetworkConfig {
     /// Enable the Network widget
     pub enable: bool,
@@ -55,6 +56,7 @@ pub struct NetworkConfig {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Network select configuration
 pub struct NetworkSelectConfig {
     /// Select the total received data when it's over this value
     pub total_received_over: Option<u64>,

komorebi-bar/src/widgets/storage.rs

@@ -24,6 +24,7 @@ mod defaults {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Storage widget configuration
 pub struct StorageConfig {
     /// Enable the Storage widget
     pub enable: bool,

komorebi-bar/src/widgets/time.rs

@@ -72,6 +72,7 @@ lazy_static! {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Time widget configuration
 pub struct TimeConfig {
     /// Enable the Time widget
     pub enable: bool,
@@ -119,6 +120,7 @@ impl From<TimeConfig> for Time {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Time format
 pub enum TimeFormat {
     /// Twelve-hour format (with seconds)
     TwelveHour,

komorebi-bar/src/widgets/update.rs

@@ -20,6 +20,7 @@ mod defaults {
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Update widget configuration
 pub struct UpdateConfig {
     /// Enable the Update widget
     pub enable: bool,

komorebi-bar/src/widgets/widget.rs

@@ -34,18 +34,31 @@ pub trait BarWidget {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
+/// Widget configuration
 pub enum WidgetConfig {
+    /// Applications widget configuration
     Applications(ApplicationsConfig),
+    /// Battery widget configuration
     Battery(BatteryConfig),
+    /// CPU widget configuration
     Cpu(CpuConfig),
+    /// Date widget configuration
     Date(DateConfig),
+    /// Keyboard widget configuration
     Keyboard(KeyboardConfig),
+    /// Komorebi widget configuration
     Komorebi(KomorebiConfig),
+    /// Media widget configuration
     Media(MediaConfig),
+    /// Memory widget configuration
     Memory(MemoryConfig),
+    /// Network widget configuration
     Network(NetworkConfig),
+    /// Storage widget configuration
     Storage(StorageConfig),
+    /// Time widget configuration
     Time(TimeConfig),
+    /// Update widget configuration
     Update(UpdateConfig),
 }
 

komorebi-themes/Cargo.toml

@@ -4,7 +4,7 @@ version = "0.1.40"
 edition = "2024"
 
 [dependencies]
-base16-egui-themes = { git = "https://github.com/LGUG2Z/base16-egui-themes", rev = "adfed118ab1408f134fd7d8a549ccfe47b99d752" }
+base16-egui-themes = { git = "https://github.com/LGUG2Z/base16-egui-themes", rev = "b9e26b31f7a0e7ed239b14e5317e95d1bdc544bd" }
 #catppuccin-egui = { version = "5", default-features = false, features = ["egui32"] }
 catppuccin-egui = { git = "https://github.com/LGUG2Z/catppuccin-egui", rev = "b2f95cbf441d1dd99f3c955ef10dcb84ce23c20a", default-features = false, features = ["egui33"] }
 eframe = { workspace = true }

komorebi/src/core/default_layout.rs

@@ -80,13 +80,13 @@ pub enum DefaultLayout {
     ///
     /// ```
     /// +-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+
-    ///|     |     |   |   |   |   |   |   |   |   |   |   |   |   |
-    ///|     |     |   |   |   |   |   |   |   |   |   |   |   +---+
-    ///+-----+-----+   |   +---+---+   +---+---+---+   +---+---|   |
-    ///|     |     |   |   |   |   |   |   |   |   |   |   |   +---+
-    ///|     |     |   |   |   |   |   |   |   |   |   |   |   |   |
-    ///+-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+
-    ///  4 windows       5 windows       6 windows       7 windows
+    /// |     |     |   |   |   |   |   |   |   |   |   |   |   |   |
+    /// |     |     |   |   |   |   |   |   |   |   |   |   |   +---+
+    /// +-----+-----+   |   +---+---+   +---+---+---+   +---+---|   |
+    /// |     |     |   |   |   |   |   |   |   |   |   |   |   +---+
+    /// |     |     |   |   |   |   |   |   |   |   |   |   |   |   |
+    /// +-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+
+    ///   4 windows       5 windows       6 windows       7 windows
     ///```
     Grid,
     /// Right Main Vertical Stack Layout

komorebi/src/core/pathext.rs

@@ -126,8 +126,11 @@ impl serde_with::schemars_1::JsonSchemaAs<PathBuf> for ResolvedPathBuf {
         std::borrow::Cow::Borrowed("PathBuf")
     }
 
-    fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
-        <PathBuf as schemars::JsonSchema>::json_schema(generator)
+    fn json_schema(_generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
+        schemars::json_schema!({
+            "type": "string",
+            "description": "A file system path. Environment variables like %VAR%, $Env:VAR, or $VAR are automatically resolved."
+        })
     }
 }