starred/komorebi
1
0
Fork 0
mirror of https://github.com/LGUG2Z/komorebi.git synced 2026-04-24 09:38:32 +02:00
Code Issues 87 Packages Projects Releases 10 Wiki Activity

feat(docs): update schema.json + mkdocs cli pages

Browse Source
This commit is contained in:
LGUG2Z
2024-04-04 14:34:56 -07:00
parent c05e9ea089
commit f2c4dadcde
13 changed files with 497 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/cli/float-rule.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe float-rule <IDENTIFIER> <ID>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/identify-border-overflow-application.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe identify-border-overflow-application <IDENTIFIER> <ID>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/identify-layered-application.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe identify-layered-application <IDENTIFIER> <ID>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/identify-object-name-change-application.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe identify-object-name-change-application <IDENTIFIER> <ID>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/identify-tray-application.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe identify-tray-application <IDENTIFIER> <ID>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/initial-named-workspace-rule.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/initial-workspace-rule.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPA
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/manage-rule.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe manage-rule <IDENTIFIER> <ID>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/named-workspace-rule.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/remove-title-bar.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe remove-title-bar <IDENTIFIER> <ID>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

2
docs/cli/workspace-rule.md
View File

@@ -7,7 +7,7 @@ Usage: komorebic.exe workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
Arguments: Arguments:
<IDENTIFIER> <IDENTIFIER>
[possible values: exe, class, title] [possible values: exe, class, title, path]
<ID> <ID>
Identifier as a string Identifier as a string

4
justfile
View File

@@ -51,10 +51,6 @@ docgen:
komorebic docgen komorebic docgen
Get-ChildItem -Path "docs/cli" -Recurse -File | ForEach-Object { (Get-Content $_.FullName) -replace 'Usage: ', 'Usage: komorebic.exe ' | Set-Content $_.FullName } Get-ChildItem -Path "docs/cli" -Recurse -File | ForEach-Object { (Get-Content $_.FullName) -replace 'Usage: ', 'Usage: komorebic.exe ' | Set-Content $_.FullName }
exampledocs:
cp whkdrc.sample docs/whkdrc.sample
cp komorebi.example.json docs/komorebi.example.json
schemagen: schemagen:
komorebic static-config-schema > schema.json komorebic static-config-schema > schema.json
generate-schema-doc .\schema.json --config template_name=js_offline --config minify=false .\static-config-docs\ generate-schema-doc .\schema.json --config template_name=js_offline --config minify=false .\static-config-docs\

656
schema.json
View File

@@ -133,6 +133,32 @@
} }
} }
}, },
"active_window_border_style": {
"description": "Active window border style (default: System)",
"oneOf": [
{
"description": "Use the system border style",
"type": "string",
"enum": [
"System"
]
},
{
"description": "Use the Windows 11-style rounded borders",
"type": "string",
"enum": [
"Rounded"
]
},
{
"description": "Use the Windows 10-style square borders",
"type": "string",
"enum": [
"Square"
]
}
]
},
"app_specific_configuration_path": { "app_specific_configuration_path": {
"description": "Path to applications.yaml from komorebi-application-specific-configurations (default: None)", "description": "Path to applications.yaml from komorebi-application-specific-configurations (default: None)",
"type": "string" "type": "string"
@@ -146,36 +172,83 @@
"description": "Identify border overflow applications", "description": "Identify border overflow applications",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "anyOf": [
"required": [ {
"id", "type": "object",
"kind" "required": [
], "id",
"properties": { "kind"
"id": { ],
"type": "string" "properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"Exe",
"Class",
"Title",
"Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}, },
"kind": { {
"type": "string", "type": "array",
"enum": [ "items": {
"Exe", "type": "object",
"Class", "required": [
"Title", "id",
"Path" "kind"
] ],
}, "properties": {
"matching_strategy": { "id": {
"type": "string", "type": "string"
"enum": [ },
"Legacy", "kind": {
"Equals", "type": "string",
"StartsWith", "enum": [
"EndsWith", "Exe",
"Contains", "Class",
"Regex" "Title",
] "Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}
} }
} ]
} }
}, },
"border_width": { "border_width": {
@@ -223,36 +296,83 @@
"description": "Individual window floating rules", "description": "Individual window floating rules",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "anyOf": [
"required": [ {
"id", "type": "object",
"kind" "required": [
], "id",
"properties": { "kind"
"id": { ],
"type": "string" "properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"Exe",
"Class",
"Title",
"Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}, },
"kind": { {
"type": "string", "type": "array",
"enum": [ "items": {
"Exe", "type": "object",
"Class", "required": [
"Title", "id",
"Path" "kind"
] ],
}, "properties": {
"matching_strategy": { "id": {
"type": "string", "type": "string"
"enum": [ },
"Legacy", "kind": {
"Equals", "type": "string",
"StartsWith", "enum": [
"EndsWith", "Exe",
"Contains", "Class",
"Regex" "Title",
] "Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}
} }
} ]
} }
}, },
"focus_follows_mouse": { "focus_follows_mouse": {
@@ -342,72 +462,166 @@
"description": "Identify applications that have the WS_EX_LAYERED extended window style", "description": "Identify applications that have the WS_EX_LAYERED extended window style",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "anyOf": [
"required": [ {
"id", "type": "object",
"kind" "required": [
], "id",
"properties": { "kind"
"id": { ],
"type": "string" "properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"Exe",
"Class",
"Title",
"Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}, },
"kind": { {
"type": "string", "type": "array",
"enum": [ "items": {
"Exe", "type": "object",
"Class", "required": [
"Title", "id",
"Path" "kind"
] ],
}, "properties": {
"matching_strategy": { "id": {
"type": "string", "type": "string"
"enum": [ },
"Legacy", "kind": {
"Equals", "type": "string",
"StartsWith", "enum": [
"EndsWith", "Exe",
"Contains", "Class",
"Regex" "Title",
] "Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}
} }
} ]
} }
}, },
"manage_rules": { "manage_rules": {
"description": "Individual window force-manage rules", "description": "Individual window force-manage rules",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "anyOf": [
"required": [ {
"id", "type": "object",
"kind" "required": [
], "id",
"properties": { "kind"
"id": { ],
"type": "string" "properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"Exe",
"Class",
"Title",
"Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}, },
"kind": { {
"type": "string", "type": "array",
"enum": [ "items": {
"Exe", "type": "object",
"Class", "required": [
"Title", "id",
"Path" "kind"
] ],
}, "properties": {
"matching_strategy": { "id": {
"type": "string", "type": "string"
"enum": [ },
"Legacy", "kind": {
"Equals", "type": "string",
"StartsWith", "enum": [
"EndsWith", "Exe",
"Contains", "Class",
"Regex" "Title",
] "Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}
} }
} ]
} }
}, },
"monitor_index_preferences": { "monitor_index_preferences": {
@@ -541,7 +755,11 @@
"StartsWith", "StartsWith",
"EndsWith", "EndsWith",
"Contains", "Contains",
"Regex" "Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
] ]
} }
} }
@@ -615,7 +833,11 @@
"StartsWith", "StartsWith",
"EndsWith", "EndsWith",
"Contains", "Contains",
"Regex" "Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
] ]
} }
} }
@@ -635,36 +857,83 @@
"description": "Identify applications that send EVENT_OBJECT_NAMECHANGE on launch (very rare)", "description": "Identify applications that send EVENT_OBJECT_NAMECHANGE on launch (very rare)",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "anyOf": [
"required": [ {
"id", "type": "object",
"kind" "required": [
], "id",
"properties": { "kind"
"id": { ],
"type": "string" "properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"Exe",
"Class",
"Title",
"Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}, },
"kind": { {
"type": "string", "type": "array",
"enum": [ "items": {
"Exe", "type": "object",
"Class", "required": [
"Title", "id",
"Path" "kind"
] ],
}, "properties": {
"matching_strategy": { "id": {
"type": "string", "type": "string"
"enum": [ },
"Legacy", "kind": {
"Equals", "type": "string",
"StartsWith", "enum": [
"EndsWith", "Exe",
"Contains", "Class",
"Regex" "Title",
] "Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}
} }
} ]
} }
}, },
"resize_delta": { "resize_delta": {
@@ -813,36 +1082,83 @@
"description": "Identify tray and multi-window applications", "description": "Identify tray and multi-window applications",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "anyOf": [
"required": [ {
"id", "type": "object",
"kind" "required": [
], "id",
"properties": { "kind"
"id": { ],
"type": "string" "properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"Exe",
"Class",
"Title",
"Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}, },
"kind": { {
"type": "string", "type": "array",
"enum": [ "items": {
"Exe", "type": "object",
"Class", "required": [
"Title", "id",
"Path" "kind"
] ],
}, "properties": {
"matching_strategy": { "id": {
"type": "string", "type": "string"
"enum": [ },
"Legacy", "kind": {
"Equals", "type": "string",
"StartsWith", "enum": [
"EndsWith", "Exe",
"Contains", "Class",
"Regex" "Title",
] "Path"
]
},
"matching_strategy": {
"type": "string",
"enum": [
"Legacy",
"Equals",
"StartsWith",
"EndsWith",
"Contains",
"Regex",
"DoesNotEndWith",
"DoesNotStartWith",
"DoesNotEqual",
"DoesNotContain"
]
}
}
}
} }
} ]
} }
}, },
"unmanaged_window_operation_behaviour": { "unmanaged_window_operation_behaviour": {