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

This commit is contained in:
LGUG2Z
2025-12-27 12:58:46 -08:00
parent a42e809ade
commit 3d8778a7d6
17 changed files with 1680 additions and 322 deletions

View File

@@ -187,43 +187,165 @@
]
},
"AnimationStyle": {
"description": "Mathematical function which describes the rate at which a value changes",
"oneOf": [
{
"description": "Linear",
"type": "string",
"enum": [
"Linear",
"EaseInSine",
"EaseOutSine",
"EaseInOutSine",
"EaseInQuad",
"EaseOutQuad",
"EaseInOutQuad",
"EaseInCubic",
"EaseInOutCubic",
"EaseInQuart",
"EaseOutQuart",
"EaseInOutQuart",
"EaseInQuint",
"EaseOutQuint",
"EaseInOutQuint",
"EaseInExpo",
"EaseOutExpo",
"EaseInOutExpo",
"EaseInCirc",
"EaseOutCirc",
"EaseInOutCirc",
"EaseInBack",
"EaseOutBack",
"EaseInOutBack",
"EaseInElastic",
"EaseOutElastic",
"EaseInOutElastic",
"EaseInBounce",
"EaseOutBounce",
"EaseInOutBounce"
]
"const": "Linear"
},
{
"description": "Ease in sine",
"type": "string",
"const": "EaseInSine"
},
{
"description": "Ease out sine",
"type": "string",
"const": "EaseOutSine"
},
{
"description": "Ease in out sine",
"type": "string",
"const": "EaseInOutSine"
},
{
"description": "Ease in quad",
"type": "string",
"const": "EaseInQuad"
},
{
"description": "Ease out quad",
"type": "string",
"const": "EaseOutQuad"
},
{
"description": "Ease in out quad",
"type": "string",
"const": "EaseInOutQuad"
},
{
"description": "Ease in cubic",
"type": "string",
"const": "EaseInCubic"
},
{
"description": "Ease out cubic",
"type": "string",
"const": "EaseOutCubic"
},
{
"description": "Ease in out cubic",
"type": "string",
"const": "EaseInOutCubic"
},
{
"description": "Ease in quart",
"type": "string",
"const": "EaseInQuart"
},
{
"description": "Ease out quart",
"type": "string",
"const": "EaseOutQuart"
},
{
"description": "Ease in out quart",
"type": "string",
"const": "EaseInOutQuart"
},
{
"description": "Ease in quint",
"type": "string",
"const": "EaseInQuint"
},
{
"description": "Ease out quint",
"type": "string",
"const": "EaseOutQuint"
},
{
"description": "Ease in out quint",
"type": "string",
"const": "EaseInOutQuint"
},
{
"description": "Ease in expo",
"type": "string",
"const": "EaseInExpo"
},
{
"description": "Ease out expo",
"type": "string",
"const": "EaseOutExpo"
},
{
"description": "Ease in out expo",
"type": "string",
"const": "EaseInOutExpo"
},
{
"description": "Ease in circ",
"type": "string",
"const": "EaseInCirc"
},
{
"description": "Ease out circ",
"type": "string",
"const": "EaseOutCirc"
},
{
"description": "Ease in out circ",
"type": "string",
"const": "EaseInOutCirc"
},
{
"description": "Ease in back",
"type": "string",
"const": "EaseInBack"
},
{
"description": "Ease out back",
"type": "string",
"const": "EaseOutBack"
},
{
"description": "Ease in out back",
"type": "string",
"const": "EaseInOutBack"
},
{
"description": "Ease in elastic",
"type": "string",
"const": "EaseInElastic"
},
{
"description": "Ease out elastic",
"type": "string",
"const": "EaseOutElastic"
},
{
"description": "Ease in out elastic",
"type": "string",
"const": "EaseInOutElastic"
},
{
"description": "Ease in bounce",
"type": "string",
"const": "EaseInBounce"
},
{
"description": "Ease out bounce",
"type": "string",
"const": "EaseOutBounce"
},
{
"description": "Ease in out bounce",
"type": "string",
"const": "EaseInOutBounce"
},
{
"description": "Custom Cubic Bézier function",
"type": "object",
"properties": {
"CubicBezier": {
@@ -307,12 +429,28 @@
]
},
"ApplicationIdentifier": {
"type": "string",
"enum": [
"Exe",
"Class",
"Title",
"Path"
"description": "Application identifier",
"oneOf": [
{
"description": "Executable name",
"type": "string",
"const": "Exe"
},
{
"description": "Class",
"type": "string",
"const": "Class"
},
{
"description": "Window title",
"type": "string",
"const": "Title"
},
{
"description": "Executable path",
"type": "string",
"const": "Path"
}
]
},
"ApplicationsConfig": {
@@ -381,11 +519,23 @@
]
},
"Axis": {
"type": "string",
"enum": [
"Horizontal",
"Vertical",
"HorizontalAndVertical"
"description": "Axis on which to perform an operation",
"oneOf": [
{
"description": "Horizontal axis",
"type": "string",
"const": "Horizontal"
},
{
"description": "Vertical axis",
"type": "string",
"const": "Vertical"
},
{
"description": "Both horizontal and vertical axes",
"type": "string",
"const": "HorizontalAndVertical"
}
]
},
"Base16": {
@@ -663,54 +813,71 @@
]
},
"Base16ColourPalette": {
"description": "Base16 colour palette: https://github.com/chriskempson/base16",
"type": "object",
"properties": {
"base_00": {
"description": "Base00",
"$ref": "#/$defs/Colour"
},
"base_01": {
"description": "Base01",
"$ref": "#/$defs/Colour"
},
"base_02": {
"description": "Base02",
"$ref": "#/$defs/Colour"
},
"base_03": {
"description": "Base03",
"$ref": "#/$defs/Colour"
},
"base_04": {
"description": "Base04",
"$ref": "#/$defs/Colour"
},
"base_05": {
"description": "Base05",
"$ref": "#/$defs/Colour"
},
"base_06": {
"description": "Base06",
"$ref": "#/$defs/Colour"
},
"base_07": {
"description": "Base07",
"$ref": "#/$defs/Colour"
},
"base_08": {
"description": "Base08",
"$ref": "#/$defs/Colour"
},
"base_09": {
"description": "Base09",
"$ref": "#/$defs/Colour"
},
"base_0a": {
"description": "Base0A",
"$ref": "#/$defs/Colour"
},
"base_0b": {
"description": "Base0B",
"$ref": "#/$defs/Colour"
},
"base_0c": {
"description": "Base0C",
"$ref": "#/$defs/Colour"
},
"base_0d": {
"description": "Base0D",
"$ref": "#/$defs/Colour"
},
"base_0e": {
"description": "Base0E",
"$ref": "#/$defs/Colour"
},
"base_0f": {
"description": "Base0F",
"$ref": "#/$defs/Colour"
}
},
@@ -734,24 +901,88 @@
]
},
"Base16Value": {
"type": "string",
"enum": [
"Base00",
"Base01",
"Base02",
"Base03",
"Base04",
"Base05",
"Base06",
"Base07",
"Base08",
"Base09",
"Base0A",
"Base0B",
"Base0C",
"Base0D",
"Base0E",
"Base0F"
"description": "Base16 value",
"oneOf": [
{
"description": "Base00",
"type": "string",
"const": "Base00"
},
{
"description": "Base01",
"type": "string",
"const": "Base01"
},
{
"description": "Base02",
"type": "string",
"const": "Base02"
},
{
"description": "Base03",
"type": "string",
"const": "Base03"
},
{
"description": "Base04",
"type": "string",
"const": "Base04"
},
{
"description": "Base05",
"type": "string",
"const": "Base05"
},
{
"description": "Base06",
"type": "string",
"const": "Base06"
},
{
"description": "Base07",
"type": "string",
"const": "Base07"
},
{
"description": "Base08",
"type": "string",
"const": "Base08"
},
{
"description": "Base09",
"type": "string",
"const": "Base09"
},
{
"description": "Base0A",
"type": "string",
"const": "Base0A"
},
{
"description": "Base0B",
"type": "string",
"const": "Base0B"
},
{
"description": "Base0C",
"type": "string",
"const": "Base0C"
},
{
"description": "Base0D",
"type": "string",
"const": "Base0D"
},
{
"description": "Base0E",
"type": "string",
"const": "Base0E"
},
{
"description": "Base0F",
"type": "string",
"const": "Base0F"
}
]
},
"BatteryConfig": {
@@ -805,6 +1036,7 @@
]
},
"BorderImplementation": {
"description": "Border style",
"oneOf": [
{
"description": "Use the adjustable komorebi border implementation",
@@ -819,6 +1051,7 @@
]
},
"BorderStyle": {
"description": "Border style",
"oneOf": [
{
"description": "Use the system border style",
@@ -838,46 +1071,167 @@
]
},
"Catppuccin": {
"type": "string",
"enum": [
"Frappe",
"Latte",
"Macchiato",
"Mocha"
"description": "Catppuccin palette",
"oneOf": [
{
"description": "Frappe",
"type": "string",
"const": "Frappe"
},
{
"description": "Latte",
"type": "string",
"const": "Latte"
},
{
"description": "Macchiato",
"type": "string",
"const": "Macchiato"
},
{
"description": "Mocha",
"type": "string",
"const": "Mocha"
}
]
},
"CatppuccinValue": {
"type": "string",
"enum": [
"Rosewater",
"Flamingo",
"Pink",
"Mauve",
"Red",
"Maroon",
"Peach",
"Yellow",
"Green",
"Teal",
"Sky",
"Sapphire",
"Blue",
"Lavender",
"Text",
"Subtext1",
"Subtext0",
"Overlay2",
"Overlay1",
"Overlay0",
"Surface2",
"Surface1",
"Surface0",
"Base",
"Mantle",
"Crust"
"description": "Catppuccin Value",
"oneOf": [
{
"description": "Rosewater",
"type": "string",
"const": "Rosewater"
},
{
"description": "Flamingo",
"type": "string",
"const": "Flamingo"
},
{
"description": "Pink",
"type": "string",
"const": "Pink"
},
{
"description": "Mauve",
"type": "string",
"const": "Mauve"
},
{
"description": "Red",
"type": "string",
"const": "Red"
},
{
"description": "Maroon",
"type": "string",
"const": "Maroon"
},
{
"description": "Peach",
"type": "string",
"const": "Peach"
},
{
"description": "Yellow",
"type": "string",
"const": "Yellow"
},
{
"description": "Green",
"type": "string",
"const": "Green"
},
{
"description": "Teal",
"type": "string",
"const": "Teal"
},
{
"description": "Sky",
"type": "string",
"const": "Sky"
},
{
"description": "Sapphire",
"type": "string",
"const": "Sapphire"
},
{
"description": "Blue",
"type": "string",
"const": "Blue"
},
{
"description": "Lavender",
"type": "string",
"const": "Lavender"
},
{
"description": "Text",
"type": "string",
"const": "Text"
},
{
"description": "Subtext1",
"type": "string",
"const": "Subtext1"
},
{
"description": "Subtext0",
"type": "string",
"const": "Subtext0"
},
{
"description": "Overlay2",
"type": "string",
"const": "Overlay2"
},
{
"description": "Overlay1",
"type": "string",
"const": "Overlay1"
},
{
"description": "Overlay0",
"type": "string",
"const": "Overlay0"
},
{
"description": "Surface2",
"type": "string",
"const": "Surface2"
},
{
"description": "Surface1",
"type": "string",
"const": "Surface1"
},
{
"description": "Surface0",
"type": "string",
"const": "Surface0"
},
{
"description": "Base",
"type": "string",
"const": "Base"
},
{
"description": "Mantle",
"type": "string",
"const": "Mantle"
},
{
"description": "Crust",
"type": "string",
"const": "Crust"
}
]
},
"Colour": {
"description": "Colour representation",
"anyOf": [
{
"description": "Colour represented as RGB",
@@ -1047,17 +1401,53 @@
]
},
"DefaultLayout": {
"type": "string",
"enum": [
"BSP",
"Columns",
"Rows",
"VerticalStack",
"HorizontalStack",
"UltrawideVerticalStack",
"Grid",
"RightMainVerticalStack",
"Scrolling"
"description": "A predefined komorebi layout",
"oneOf": [
{
"description": "BSP Layout\n\n```\n+-------+-----+\n| | |\n| +--+--+\n| | |--|\n+-------+--+--+\n```",
"type": "string",
"const": "BSP"
},
{
"description": "Columns Layout\n\n```\n+--+--+--+--+\n| | | | |\n| | | | |\n| | | | |\n+--+--+--+--+\n```",
"type": "string",
"const": "Columns"
},
{
"description": "Rows Layout\n\n```\n+-----------+\n|-----------|\n|-----------|\n|-----------|\n+-----------+\n```",
"type": "string",
"const": "Rows"
},
{
"description": "Vertical Stack Layout\n\n```\n+-------+-----+\n| | |\n| +-----+\n| | |\n+-------+-----+\n```",
"type": "string",
"const": "VerticalStack"
},
{
"description": "Horizontal Stack Layout\n\n```\n+------+------+\n| |\n|------+------+\n| | |\n+------+------+\n```",
"type": "string",
"const": "HorizontalStack"
},
{
"description": "Ultrawide Vertical Stack Layout\n\n```\n+-----+-----------+-----+\n| | | |\n| | +-----+\n| | | |\n| | +-----+\n| | | |\n+-----+-----------+-----+\n```",
"type": "string",
"const": "UltrawideVerticalStack"
},
{
"description": "Grid Layout\n\n```\n+-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+\n| | | | | | | | | | | | | | |\n| | | | | | | | | | | | | +---+\n+-----+-----+ | +---+---+ +---+---+---+ +---+---| |\n| | | | | | | | | | | | | +---+\n| | | | | | | | | | | | | | |\n+-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+\n 4 windows 5 windows 6 windows 7 windows\n```",
"type": "string",
"const": "Grid"
},
{
"description": "Right Main Vertical Stack Layout\n\n```\n+-----+-------+\n| | |\n+-----+ |\n| | |\n+-----+-------+\n```",
"type": "string",
"const": "RightMainVerticalStack"
},
{
"description": "Scrolling Layout\n\n```\n+--+--+--+--+--+--+\n| | | |\n| | | |\n| | | |\n+--+--+--+--+--+--+\n```",
"type": "string",
"const": "Scrolling"
}
]
},
"DisplayFormat": {
@@ -1090,14 +1480,15 @@
]
},
"FocusFollowsMouseImplementation": {
"description": "Focus follows mouse implementation",
"oneOf": [
{
"description": "A custom FFM implementation (slightly more CPU-intensive)",
"description": "Custom FFM implementation (slightly more CPU-intensive)",
"type": "string",
"const": "Komorebi"
},
{
"description": "The native (legacy) Windows FFM implementation",
"description": "Native (legacy) Windows FFM implementation",
"type": "string",
"const": "Windows"
}
@@ -1300,10 +1691,12 @@
]
},
"Hex": {
"description": "Colour represented as a Hex string",
"type": "string",
"format": "color-hex"
},
"HidingBehaviour": {
"description": "Window hiding behaviour",
"oneOf": [
{
"description": "END OF LIFE FEATURE: Use the `SW_HIDE` flag to hide windows when switching workspaces (has issues with Electron apps)",
@@ -1764,6 +2157,7 @@
]
},
"KomorebiTheme": {
"description": "Komorebi theme",
"oneOf": [
{
"description": "A theme from catppuccin-egui",
@@ -2492,6 +2886,7 @@
]
},
"MoveBehaviour": {
"description": "Move behaviour when the operation works across a monitor boundary",
"oneOf": [
{
"description": "Swap the window container with the window container at the edge of the adjacent monitor",
@@ -2622,14 +3017,15 @@
}
},
"OperationBehaviour": {
"description": "Operation behaviour for temporarily unmanaged and floating windows",
"oneOf": [
{
"description": "Process komorebic commands on temporarily unmanaged/floated windows",
"description": "Process commands on temporarily unmanaged/floated windows",
"type": "string",
"const": "Op"
},
{
"description": "Ignore komorebic commands on temporarily unmanaged/floated windows",
"description": "Ignore commands on temporarily unmanaged/floated windows",
"type": "string",
"const": "NoOp"
}
@@ -2694,25 +3090,26 @@
}
},
"Rect": {
"description": "Rectangle dimensions",
"type": "object",
"properties": {
"bottom": {
"description": "The bottom point in a Win32 Rect",
"description": "Height of the rectangle (from the top point)",
"type": "integer",
"format": "int32"
},
"left": {
"description": "The left point in a Win32 Rect",
"description": "Left point of the rectangle",
"type": "integer",
"format": "int32"
},
"right": {
"description": "The right point in a Win32 Rect",
"description": "Width of the recentangle (from the left point)",
"type": "integer",
"format": "int32"
},
"top": {
"description": "The top point in a Win32 Rect",
"description": "Top point of the rectangle",
"type": "integer",
"format": "int32"
}
@@ -2725,6 +3122,7 @@
]
},
"Rgb": {
"description": "Colour represented as RGB",
"type": "object",
"properties": {
"b": {
@@ -2772,10 +3170,18 @@
]
},
"Sizing": {
"type": "string",
"enum": [
"Increase",
"Decrease"
"description": "Sizing",
"oneOf": [
{
"description": "Increase",
"type": "string",
"const": "Increase"
},
{
"description": "Decrease",
"type": "string",
"const": "Decrease"
}
]
},
"SocketMessage": {
@@ -6303,18 +6709,38 @@
]
},
"StackbarLabel": {
"type": "string",
"enum": [
"Process",
"Title"
"description": "Starbar label",
"oneOf": [
{
"description": "Process name",
"type": "string",
"const": "Process"
},
{
"description": "Window title",
"type": "string",
"const": "Title"
}
]
},
"StackbarMode": {
"type": "string",
"enum": [
"Always",
"Never",
"OnStack"
"description": "Stackbar mode",
"oneOf": [
{
"description": "Always show",
"type": "string",
"const": "Always"
},
{
"description": "Never show",
"type": "string",
"const": "Never"
},
{
"description": "Show on stack",
"type": "string",
"const": "OnStack"
}
]
},
"StateQuery": {
@@ -6682,14 +7108,38 @@
]
},
"WindowKind": {
"type": "string",
"enum": [
"Single",
"Stack",
"Monocle",
"Unfocused",
"UnfocusedLocked",
"Floating"
"description": "Window kind",
"oneOf": [
{
"description": "Single window",
"type": "string",
"const": "Single"
},
{
"description": "Stack container",
"type": "string",
"const": "Stack"
},
{
"description": "Monocle container",
"type": "string",
"const": "Monocle"
},
{
"description": "Unfocused window",
"type": "string",
"const": "Unfocused"
},
{
"description": "Unfocused locked container",
"type": "string",
"const": "UnfocusedLocked"
},
{
"description": "Floating window",
"type": "string",
"const": "Floating"
}
]
},
"WorkspacesDisplayFormat": {