From 18495471537d97455a48417a3537f2ee6df85891 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Fri, 6 Nov 2026 14:04:33 -0800 Subject: [PATCH] docs(macos): say what Class is on macOS in the schema and the komorebic help The schema and the help of komorebic described the Class identifier as 'Role or subrole'. It is the accessibility subrole of the window, or its role when it has no subrole, and a rule matches either. --- crates/komorebi-config/src/schema.rs | 2 +- crates/komorebi-protocol/src/types.rs | 3 ++- docs/macos/cli/ignore-rule.md | 2 +- docs/macos/cli/initial-named-workspace-rule.md | 2 +- docs/macos/cli/initial-workspace-rule.md | 2 +- docs/macos/cli/manage-rule.md | 2 +- docs/macos/cli/named-workspace-rule.md | 2 +- docs/macos/cli/workspace-rule.md | 2 +- schemas/macos/schema.asc.json | 2 +- schemas/macos/schema.json | 2 +- 10 files changed, 11 insertions(+), 10 deletions(-) diff --git a/crates/komorebi-config/src/schema.rs b/crates/komorebi-config/src/schema.rs index 3330f1a7..cde473c8 100644 --- a/crates/komorebi-config/src/schema.rs +++ b/crates/komorebi-config/src/schema.rs @@ -177,7 +177,7 @@ fn platform_text(platform: Platform) -> &'static [(&'static str, &'static str, & ( "ApplicationIdentifier", "/oneOf/1/description", - "Role or subrole", + "Accessibility subrole or role, such as AXStandardWindow", ), ], } diff --git a/crates/komorebi-protocol/src/types.rs b/crates/komorebi-protocol/src/types.rs index 1b5e1dc0..5071d97d 100644 --- a/crates/komorebi-protocol/src/types.rs +++ b/crates/komorebi-protocol/src/types.rs @@ -98,7 +98,8 @@ pub enum ApplicationIdentifier { Exe, // the description is part of the checked-in schemas, which differ per platform #[cfg_attr(target_os = "windows", doc = " Class")] - #[cfg_attr(not(target_os = "windows"), doc = " Role or subrole")] + #[cfg_attr(target_os = "macos", doc = " Accessibility subrole or role, such as AXStandardWindow")] + #[cfg_attr(not(any(target_os = "windows", target_os = "macos")), doc = " Role or subrole")] #[serde(alias = "class")] Class, #[serde(alias = "title")] diff --git a/docs/macos/cli/ignore-rule.md b/docs/macos/cli/ignore-rule.md index 308bb3f1..c7e02392 100644 --- a/docs/macos/cli/ignore-rule.md +++ b/docs/macos/cli/ignore-rule.md @@ -9,7 +9,7 @@ Arguments: Possible values: - exe: Executable name - - class: Role or subrole + - class: Accessibility subrole or role, such as AXStandardWindow - title: Window title - path: Executable path diff --git a/docs/macos/cli/initial-named-workspace-rule.md b/docs/macos/cli/initial-named-workspace-rule.md index e2fa4cb3..8a182863 100644 --- a/docs/macos/cli/initial-named-workspace-rule.md +++ b/docs/macos/cli/initial-named-workspace-rule.md @@ -9,7 +9,7 @@ Arguments: Possible values: - exe: Executable name - - class: Role or subrole + - class: Accessibility subrole or role, such as AXStandardWindow - title: Window title - path: Executable path diff --git a/docs/macos/cli/initial-workspace-rule.md b/docs/macos/cli/initial-workspace-rule.md index f1ace7c5..f9cc15c8 100644 --- a/docs/macos/cli/initial-workspace-rule.md +++ b/docs/macos/cli/initial-workspace-rule.md @@ -9,7 +9,7 @@ Arguments: Possible values: - exe: Executable name - - class: Role or subrole + - class: Accessibility subrole or role, such as AXStandardWindow - title: Window title - path: Executable path diff --git a/docs/macos/cli/manage-rule.md b/docs/macos/cli/manage-rule.md index 2f7c612a..6358db40 100644 --- a/docs/macos/cli/manage-rule.md +++ b/docs/macos/cli/manage-rule.md @@ -9,7 +9,7 @@ Arguments: Possible values: - exe: Executable name - - class: Role or subrole + - class: Accessibility subrole or role, such as AXStandardWindow - title: Window title - path: Executable path diff --git a/docs/macos/cli/named-workspace-rule.md b/docs/macos/cli/named-workspace-rule.md index e490dbe6..3349d11b 100644 --- a/docs/macos/cli/named-workspace-rule.md +++ b/docs/macos/cli/named-workspace-rule.md @@ -9,7 +9,7 @@ Arguments: Possible values: - exe: Executable name - - class: Role or subrole + - class: Accessibility subrole or role, such as AXStandardWindow - title: Window title - path: Executable path diff --git a/docs/macos/cli/workspace-rule.md b/docs/macos/cli/workspace-rule.md index cdf25a60..7befcf5a 100644 --- a/docs/macos/cli/workspace-rule.md +++ b/docs/macos/cli/workspace-rule.md @@ -9,7 +9,7 @@ Arguments: Possible values: - exe: Executable name - - class: Role or subrole + - class: Accessibility subrole or role, such as AXStandardWindow - title: Window title - path: Executable path diff --git a/schemas/macos/schema.asc.json b/schemas/macos/schema.asc.json index 9d61b986..c9a2b2b9 100644 --- a/schemas/macos/schema.asc.json +++ b/schemas/macos/schema.asc.json @@ -15,7 +15,7 @@ "const": "Exe" }, { - "description": "Role or subrole", + "description": "Accessibility subrole or role, such as AXStandardWindow", "type": "string", "const": "Class" }, diff --git a/schemas/macos/schema.json b/schemas/macos/schema.json index 4ea5755f..26dd62ac 100644 --- a/schemas/macos/schema.json +++ b/schemas/macos/schema.json @@ -618,7 +618,7 @@ "const": "Exe" }, { - "description": "Role or subrole", + "description": "Accessibility subrole or role, such as AXStandardWindow", "type": "string", "const": "Class" },