From 795ffdfa33d2f60b9b8510aa77082efc59d192a7 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Wed, 24 Sep 2025 15:18:04 -0700 Subject: [PATCH] docs(schema): add schemars feature + schemagen cmds Starting to think about documentation and adding in commands to generate JSON schemas for the ApplicationSpecificConfiguration, SocketSchema and StaticConfig. schemars 0.8 > 0.9 has way too many breaking changes for me to care about right now, let around 0.8 > 1.0. I'm happy being pinned on 0.8 for now. --- Cargo.lock | 85 +++++++++++++++++------- Cargo.toml | 7 +- komorebi-client/Cargo.toml | 4 ++ komorebi-client/src/lib.rs | 2 + komorebi/Cargo.toml | 9 ++- komorebi/src/core/arrangement.rs | 1 + komorebi/src/core/asc.rs | 3 + komorebi/src/core/config_generation.rs | 7 ++ komorebi/src/core/cycle_direction.rs | 1 + komorebi/src/core/default_layout.rs | 3 + komorebi/src/core/mod.rs | 16 ++++- komorebi/src/core/operation_direction.rs | 1 + komorebi/src/core/pathext.rs | 20 +++--- komorebi/src/core/rect.rs | 1 + komorebi/src/process_command.rs | 40 ++++++++++- komorebi/src/static_config.rs | 4 ++ komorebi/src/window.rs | 2 + komorebic/Cargo.toml | 6 ++ komorebic/src/main.rs | 49 +++++++++++--- 19 files changed, 210 insertions(+), 51 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 0db6d5a4..f923e733 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -362,12 +362,12 @@ dependencies = [ [[package]] name = "deranged" -version = "0.5.3" +version = "0.5.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d630bccd429a5bb5a64b5e94f693bfc48c9f8566418fda4c494cc94f911f87cc" +checksum = "a41953f86f8a05768a6cda24def994fd2f424b04ec5c719cf89989779f199071" dependencies = [ "powerfmt", - "serde", + "serde_core", ] [[package]] @@ -1049,9 +1049,9 @@ dependencies = [ [[package]] name = "js-sys" -version = "0.3.80" +version = "0.3.81" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "852f13bec5eba4ba9afbeb93fd7c13fe56147f055939ae21c43a29a0ecb2702e" +checksum = "ec48937a97411dcb524a265206ccd4c90bb711fca92b2792c407f268825b9305" dependencies = [ "once_cell", "wasm-bindgen", @@ -1080,6 +1080,7 @@ dependencies = [ "quick-xml 0.38.3", "quickxml_to_serde", "regex", + "schemars 0.8.22", "serde", "serde_json_lenient", "serde_with", @@ -1113,6 +1114,8 @@ dependencies = [ "lazy_static", "pastey", "reqwest", + "schemars 0.8.22", + "serde_json_lenient", "shadow-rs", "sysinfo", ] @@ -1145,9 +1148,9 @@ checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" [[package]] name = "libc" -version = "0.2.175" +version = "0.2.176" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6a82ae493e598baaea5209805c49bbf2ea7de956d50d7da0da1164f9c6d28543" +checksum = "58f929b4d672ea937a23a1ab494143d968337a5f47e56d0815df1e0890ddf174" [[package]] name = "libgit2-sys" @@ -2021,6 +2024,18 @@ dependencies = [ "windows-sys 0.61.0", ] +[[package]] +name = "schemars" +version = "0.8.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3fbf2ae1b8bc8e02df939598064d22402220cd5bbcca1c76f7d6a310974d5615" +dependencies = [ + "dyn-clone", + "schemars_derive", + "serde", + "serde_json", +] + [[package]] name = "schemars" version = "0.9.0" @@ -2045,6 +2060,18 @@ dependencies = [ "serde_json", ] +[[package]] +name = "schemars_derive" +version = "0.8.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32e265784ad618884abaea0600a9adf15393368d840e0222d101a072f3f7534d" +dependencies = [ + "proc-macro2", + "quote", + "serde_derive_internals", + "syn", +] + [[package]] name = "scopeguard" version = "1.2.0" @@ -2104,6 +2131,17 @@ dependencies = [ "syn", ] +[[package]] +name = "serde_derive_internals" +version = "0.29.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "18d26a20a969b9e3fdf2fc2d9f21eda6c40e2de84c9408bb5d3b05d499aae711" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + [[package]] name = "serde_json" version = "1.0.145" @@ -2152,6 +2190,7 @@ dependencies = [ "hex", "indexmap 1.9.3", "indexmap 2.11.4", + "schemars 0.8.22", "schemars 0.9.0", "schemars 1.0.4", "serde", @@ -2330,9 +2369,9 @@ dependencies = [ [[package]] name = "tempfile" -version = "3.22.0" +version = "3.23.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "84fa4d11fadde498443cca10fd3ac23c951f0dc59e080e9f4b93d4df4e4eea53" +checksum = "2d31c77bdf42a745371d260a26ca7163f1e0924b64afa0b688e61b5a9fa02f16" dependencies = [ "fastrand", "getrandom 0.3.3", @@ -2752,9 +2791,9 @@ dependencies = [ [[package]] name = "wasm-bindgen" -version = "0.2.103" +version = "0.2.104" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ab10a69fbd0a177f5f649ad4d8d3305499c42bab9aef2f7ff592d0ec8f833819" +checksum = "c1da10c01ae9f1ae40cbfac0bac3b1e724b320abfcf52229f80b547c0d250e2d" dependencies = [ "cfg-if", "once_cell", @@ -2765,9 +2804,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-backend" -version = "0.2.103" +version = "0.2.104" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0bb702423545a6007bbc368fde243ba47ca275e549c8a28617f56f6ba53b1d1c" +checksum = "671c9a5a66f49d8a47345ab942e2cb93c7d1d0339065d4f8139c486121b43b19" dependencies = [ "bumpalo", "log", @@ -2779,9 +2818,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-futures" -version = "0.4.53" +version = "0.4.54" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a0b221ff421256839509adbb55998214a70d829d3a28c69b4a6672e9d2a42f67" +checksum = "7e038d41e478cc73bae0ff9b36c60cff1c98b8f38f8d7e8061e79ee63608ac5c" dependencies = [ "cfg-if", "js-sys", @@ -2792,9 +2831,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro" -version = "0.2.103" +version = "0.2.104" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fc65f4f411d91494355917b605e1480033152658d71f722a90647f56a70c88a0" +checksum = "7ca60477e4c59f5f2986c50191cd972e3a50d8a95603bc9434501cf156a9a119" dependencies = [ "quote", "wasm-bindgen-macro-support", @@ -2802,9 +2841,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro-support" -version = "0.2.103" +version = "0.2.104" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ffc003a991398a8ee604a401e194b6b3a39677b3173d6e74495eb51b82e99a32" +checksum = "9f07d2f20d4da7b26400c9f4a0511e6e0345b040694e8a75bd41d578fa4421d7" dependencies = [ "proc-macro2", "quote", @@ -2815,18 +2854,18 @@ dependencies = [ [[package]] name = "wasm-bindgen-shared" -version = "0.2.103" +version = "0.2.104" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "293c37f4efa430ca14db3721dfbe48d8c33308096bd44d80ebaa775ab71ba1cf" +checksum = "bad67dc8b2a1a6e5448428adec4c3e84c43e561d8c9ee8a9e5aabeb193ec41d1" dependencies = [ "unicode-ident", ] [[package]] name = "web-sys" -version = "0.3.80" +version = "0.3.81" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fbe734895e869dc429d78c4b433f8d17d95f8d05317440b4fad5ab2d33e596dc" +checksum = "9367c417a924a74cae129e6a2ae3b47fabb1f8995595ab474029da749a8be120" dependencies = [ "js-sys", "wasm-bindgen", diff --git a/Cargo.toml b/Cargo.toml index 4167c6d1..a9a94344 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,15 +8,16 @@ members = [ [workspace.dependencies] -clap = { version = "4", features = ["derive", "wrap_help"] } -chrono-tz = "0.10" chrono = "0.4" +chrono-tz = "0.10" +clap = { version = "4", features = ["derive", "wrap_help"] } color-eyre = "0.6" dirs = "6" lazy_static = "1" pastey = "0.1" +schemars = "0.8" serde = { version = "1", features = ["derive"] } serde_json = { package = "serde_json_lenient", version = "0.2" } shadow-rs = "1" sysinfo = "0.37" -thiserror = "2" \ No newline at end of file +thiserror = "2" diff --git a/komorebi-client/Cargo.toml b/komorebi-client/Cargo.toml index 6853093c..3799e2df 100644 --- a/komorebi-client/Cargo.toml +++ b/komorebi-client/Cargo.toml @@ -6,3 +6,7 @@ edition = "2024" [dependencies] komorebi = { path = "../komorebi", default-features = false } serde_json = { workspace = true } + +[features] +default = ["schemars"] +schemars = ["komorebi/default"] diff --git a/komorebi-client/src/lib.rs b/komorebi-client/src/lib.rs index abd04df0..7cb3365a 100644 --- a/komorebi-client/src/lib.rs +++ b/komorebi-client/src/lib.rs @@ -6,12 +6,14 @@ pub use komorebi::core::Sizing; pub use komorebi::core::SocketMessage; pub use komorebi::core::StateQuery; pub use komorebi::core::arrangement::Axis; +pub use komorebi::core::asc::ApplicationSpecificConfiguration; pub use komorebi::core::cycle_direction::CycleDirection; pub use komorebi::core::default_layout::DefaultLayout; pub use komorebi::core::operation_direction::OperationDirection; pub use komorebi::core::pathext::PathExt; pub use komorebi::core::pathext::replace_env_in_path; pub use komorebi::core::rect::Rect; +pub use komorebi::static_config::StaticConfig; use std::borrow::Borrow; use std::io::BufReader; use std::io::Read; diff --git a/komorebi/Cargo.toml b/komorebi/Cargo.toml index 3a0f1062..f314114f 100644 --- a/komorebi/Cargo.toml +++ b/komorebi/Cargo.toml @@ -25,9 +25,10 @@ quick-xml = { version = "0.38", features = ["serialize"] } # forked to patch in serde_json_lenient and update some old dependencies quickxml_to_serde = { git = "https://github.com/LGUG2Z/quickxml_to_serde.git", version = "0.6.1" } regex = "1" +schemars = { workspace = true, optional = true } serde = { workspace = true } serde_json = { workspace = true } -serde_with = "3" +serde_with = { version = "3", features = ["schemars_0_8"] } shadow-rs = { workspace = true } strum = { version = "0.27", features = ["derive"] } sysinfo = { workspace = true } @@ -37,4 +38,8 @@ tracing-appender = "0.2" tracing-subscriber = { version = "0.3", features = ["env-filter"] } [build-dependencies] -shadow-rs = { workspace = true } \ No newline at end of file +shadow-rs = { workspace = true } + +[features] +default = ["schemars"] +schemars = ["dep:schemars"] diff --git a/komorebi/src/core/arrangement.rs b/komorebi/src/core/arrangement.rs index 60a67ae0..6f9c9410 100644 --- a/komorebi/src/core/arrangement.rs +++ b/komorebi/src/core/arrangement.rs @@ -570,6 +570,7 @@ impl Arrangement for DefaultLayout { } #[derive(Clone, Copy, Debug, Serialize, Deserialize, Display, EnumString, ValueEnum, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum Axis { Horizontal, Vertical, diff --git a/komorebi/src/core/asc.rs b/komorebi/src/core/asc.rs index dd4e1414..51f39245 100644 --- a/komorebi/src/core/asc.rs +++ b/komorebi/src/core/asc.rs @@ -10,9 +10,11 @@ use std::ops::DerefMut; use std::path::PathBuf; #[derive(Clone, Debug, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct ApplicationSpecificConfiguration(pub BTreeMap); #[derive(Clone, Debug, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] #[serde(untagged)] pub enum AscApplicationRulesOrSchema { AscApplicationRules(AscApplicationRules), @@ -46,6 +48,7 @@ impl ApplicationSpecificConfiguration { /// Rules that determine how an application is handled #[derive(Clone, Debug, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct AscApplicationRules { /// Rules to ignore specific windows #[serde(skip_serializing_if = "Option::is_none")] diff --git a/komorebi/src/core/config_generation.rs b/komorebi/src/core/config_generation.rs index 3dfbe2fd..ceb3aa70 100644 --- a/komorebi/src/core/config_generation.rs +++ b/komorebi/src/core/config_generation.rs @@ -7,6 +7,7 @@ use strum::EnumString; use super::ApplicationIdentifier; #[derive(Clone, Copy, Debug, Serialize, Deserialize, Display, EnumString, ValueEnum)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] #[strum(serialize_all = "snake_case")] #[serde(rename_all = "snake_case")] pub enum ApplicationOptions { @@ -18,6 +19,7 @@ pub enum ApplicationOptions { } #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] #[serde(untagged)] pub enum MatchingRule { Simple(IdWithIdentifier), @@ -25,6 +27,7 @@ pub enum MatchingRule { } #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct WorkspaceMatchingRule { pub monitor_index: usize, pub workspace_index: usize, @@ -33,6 +36,7 @@ pub struct WorkspaceMatchingRule { } #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct IdWithIdentifier { pub kind: ApplicationIdentifier, pub id: String, @@ -41,6 +45,7 @@ pub struct IdWithIdentifier { } #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize, Display)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum MatchingStrategy { Legacy, Equals, @@ -55,6 +60,7 @@ pub enum MatchingStrategy { } #[derive(Clone, Debug, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct IdWithIdentifierAndComment { pub kind: ApplicationIdentifier, pub id: String, @@ -75,6 +81,7 @@ impl From for IdWithIdentifier { } #[derive(Clone, Debug, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct ApplicationConfiguration { pub name: String, pub identifier: IdWithIdentifier, diff --git a/komorebi/src/core/cycle_direction.rs b/komorebi/src/core/cycle_direction.rs index bf820bdb..e75dec60 100644 --- a/komorebi/src/core/cycle_direction.rs +++ b/komorebi/src/core/cycle_direction.rs @@ -7,6 +7,7 @@ use strum::Display; use strum::EnumString; #[derive(Clone, Copy, Debug, Serialize, Deserialize, Display, EnumString, ValueEnum)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum CycleDirection { Previous, Next, diff --git a/komorebi/src/core/default_layout.rs b/komorebi/src/core/default_layout.rs index ff85705d..aa71fbf5 100644 --- a/komorebi/src/core/default_layout.rs +++ b/komorebi/src/core/default_layout.rs @@ -10,6 +10,7 @@ use strum::EnumString; #[derive( Clone, Copy, Debug, Serialize, Deserialize, Eq, PartialEq, Display, EnumString, ValueEnum, )] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum DefaultLayout { BSP, Columns, @@ -24,12 +25,14 @@ pub enum DefaultLayout { } #[derive(Clone, Copy, Debug, Serialize, Deserialize, Eq, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct LayoutOptions { /// Options related to the Scrolling layout pub scrolling: Option, } #[derive(Clone, Copy, Debug, Serialize, Deserialize, Eq, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct ScrollingLayoutOptions { /// Desired number of visible columns (default: 3) pub columns: usize, diff --git a/komorebi/src/core/mod.rs b/komorebi/src/core/mod.rs index 3db62d89..ef3dc96f 100644 --- a/komorebi/src/core/mod.rs +++ b/komorebi/src/core/mod.rs @@ -28,6 +28,7 @@ pub mod rect; #[derive( Clone, Copy, Debug, Default, PartialEq, Serialize, Deserialize, Display, EnumString, ValueEnum, )] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum OperationBehaviour { /// Process komorebic commands on temporarily unmanaged/floated windows #[default] @@ -37,6 +38,7 @@ pub enum OperationBehaviour { } #[derive(Clone, Copy, Debug, Serialize, Deserialize, Display, EnumString, ValueEnum)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum Sizing { Increase, Decrease, @@ -86,6 +88,7 @@ pub struct WindowManagementBehaviour { #[derive( Clone, Copy, Debug, Default, Serialize, Deserialize, Display, EnumString, ValueEnum, PartialEq, )] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum WindowContainerBehaviour { /// Create a new container for each new window #[default] @@ -97,6 +100,7 @@ pub enum WindowContainerBehaviour { #[derive( Clone, Copy, Debug, Default, Serialize, Deserialize, Display, EnumString, ValueEnum, PartialEq, )] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum FloatingLayerBehaviour { /// Tile new windows (unless they match a float rule or float override is active) #[default] @@ -108,6 +112,7 @@ pub enum FloatingLayerBehaviour { #[derive( Clone, Copy, Debug, Default, Serialize, Deserialize, Display, EnumString, ValueEnum, PartialEq, )] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum Placement { /// Does not change the size or position of the window #[default] @@ -146,6 +151,7 @@ impl Placement { #[derive( Clone, Copy, Debug, Default, PartialEq, Serialize, Deserialize, Display, EnumString, ValueEnum, )] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum MoveBehaviour { /// Swap the window container with the window container at the edge of the adjacent monitor #[default] @@ -159,6 +165,7 @@ pub enum MoveBehaviour { #[derive( Clone, Copy, Debug, Default, Serialize, Deserialize, Display, EnumString, ValueEnum, PartialEq, )] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum CrossBoundaryBehaviour { /// Attempt to perform actions across a workspace boundary Workspace, @@ -170,6 +177,7 @@ pub enum CrossBoundaryBehaviour { #[derive( Copy, Clone, Debug, Eq, PartialEq, Serialize, Deserialize, Display, EnumString, ValueEnum, )] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum ApplicationIdentifier { #[serde(alias = "exe")] Exe, @@ -182,6 +190,7 @@ pub enum ApplicationIdentifier { } #[derive(Copy, Clone, Debug, Serialize, Deserialize, Display, EnumString, ValueEnum)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum StateQuery { FocusedMonitorIndex, FocusedWorkspaceIndex, @@ -196,6 +205,7 @@ pub enum StateQuery { // serde_as must be before derive #[serde_with::serde_as] #[derive(Clone, Debug, Serialize, Deserialize, Display)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] #[serde(tag = "type", content = "content")] pub enum SocketMessage { // Window / Container Commands @@ -385,10 +395,10 @@ pub enum SocketMessage { // RemoveSubscriberSocket(String), // AddSubscriberPipe(String), // RemoveSubscriberPipe(String), - // ApplicationSpecificConfigurationSchema, + ApplicationSpecificConfigurationSchema, // NotificationSchema, - // SocketSchema, - // StaticConfigSchema, + SocketSchema, + StaticConfigSchema, // GenerateStaticConfig, // DebugWindow(isize), } diff --git a/komorebi/src/core/operation_direction.rs b/komorebi/src/core/operation_direction.rs index dd526271..bb9d68eb 100644 --- a/komorebi/src/core/operation_direction.rs +++ b/komorebi/src/core/operation_direction.rs @@ -6,6 +6,7 @@ use serde::Serialize; use std::num::NonZeroUsize; #[derive(Clone, Copy, Debug, Serialize, Deserialize, ValueEnum)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum OperationDirection { Left, Right, diff --git a/komorebi/src/core/pathext.rs b/komorebi/src/core/pathext.rs index ec8c3adc..ad383677 100644 --- a/komorebi/src/core/pathext.rs +++ b/komorebi/src/core/pathext.rs @@ -123,16 +123,16 @@ impl<'de> serde_with::DeserializeAs<'de, PathBuf> for ResolvedPathBuf { } } -// #[cfg(feature = "schemars")] -// impl serde_with::schemars_0_8::JsonSchemaAs for ResolvedPathBuf { -// fn schema_name() -> String { -// "PathBuf".to_owned() -// } -// -// fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema { -// ::json_schema(gen) -// } -// } +#[cfg(feature = "schemars")] +impl serde_with::schemars_0_8::JsonSchemaAs for ResolvedPathBuf { + fn schema_name() -> String { + "PathBuf".to_string() + } + + fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::schema::Schema { + ::json_schema(generator) + } +} /// Custom deserializer for [`Option>`] that uses /// [`PathExt::replace_env`] to resolve environment variables in the paths. diff --git a/komorebi/src/core/rect.rs b/komorebi/src/core/rect.rs index f46fbfba..67cc33ec 100644 --- a/komorebi/src/core/rect.rs +++ b/komorebi/src/core/rect.rs @@ -8,6 +8,7 @@ use serde::Deserialize; use serde::Serialize; #[derive(Debug, Default, Copy, Clone, Serialize, Deserialize, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct Rect { pub left: i32, pub top: i32, diff --git a/komorebi/src/process_command.rs b/komorebi/src/process_command.rs index bcef2259..643ffd5b 100644 --- a/komorebi/src/process_command.rs +++ b/komorebi/src/process_command.rs @@ -10,6 +10,7 @@ use crate::core::SocketMessage; use crate::core::StateQuery; use crate::core::WindowContainerBehaviour; use crate::core::arrangement::Axis; +use crate::core::asc::ApplicationSpecificConfiguration; use crate::core::config_generation::IdWithIdentifier; use crate::core::config_generation::MatchingRule; use crate::core::config_generation::MatchingStrategy; @@ -24,6 +25,7 @@ use crate::monitor::Monitor; use crate::monitor::MonitorInformation; use crate::state::GlobalState; use crate::state::State; +use crate::static_config::StaticConfig; use crate::window::AdhocWindow; use crate::window_manager::WindowManager; use crate::workspace::Workspace; @@ -1402,6 +1404,40 @@ impl WindowManager { SocketMessage::UnmanagedWindowOperationBehaviour(behaviour) => { self.unmanaged_window_operation_behaviour = behaviour; } + SocketMessage::ApplicationSpecificConfigurationSchema => { + #[cfg(feature = "schemars")] + { + let asc = schemars::schema_for!(Vec); + let schema = serde_json::to_string_pretty(&asc)?; + + reply.write_all(schema.as_bytes())?; + } + } + SocketMessage::SocketSchema => { + #[cfg(feature = "schemars")] + { + let socket_message = schemars::schema_for!(SocketMessage); + let schema = serde_json::to_string_pretty(&socket_message)?; + + reply.write_all(schema.as_bytes())?; + } + } + SocketMessage::StaticConfigSchema => { + #[cfg(feature = "schemars")] + { + let settings = schemars::r#gen::SchemaSettings::default().with(|s| { + s.option_nullable = false; + s.option_add_null_type = false; + s.inline_subschemas = true; + }); + + let generator = settings.into_generator(); + let socket_message = generator.into_root_schema_for::(); + let schema = serde_json::to_string_pretty(&socket_message)?; + + reply.write_all(schema.as_bytes())?; + } + } } self.update_known_window_ids(); @@ -1471,8 +1507,8 @@ pub fn read_commands_uds( if wm.is_paused { return match message { SocketMessage::TogglePause - // | SocketMessage::State - // | SocketMessage::GlobalState + | SocketMessage::State + | SocketMessage::GlobalState // | SocketMessage::Stop => Ok(wm.process_command(message, &mut stream)?), _ => { diff --git a/komorebi/src/static_config.rs b/komorebi/src/static_config.rs index ddf188b7..72ba23fa 100644 --- a/komorebi/src/static_config.rs +++ b/komorebi/src/static_config.rs @@ -132,6 +132,7 @@ use std::sync::atomic::Ordering; // serde_as must be before derive #[serde_with::serde_as] #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct WorkspaceConfig { /// Name pub name: String, @@ -268,6 +269,7 @@ impl From<&Workspace> for WorkspaceConfig { } #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub struct MonitorConfig { /// Workspace configurations pub workspaces: Vec, @@ -335,6 +337,7 @@ impl From<&Monitor> for MonitorConfig { #[serde_with::serde_as] #[derive(Clone, Debug, Serialize, Deserialize, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] #[serde(untagged)] pub enum AppSpecificConfigurationPath { /// A single applications.json file @@ -345,6 +348,7 @@ pub enum AppSpecificConfigurationPath { #[serde_with::serde_as] #[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] /// The `komorebi.json` static configuration file reference for `v0.1.39` pub struct StaticConfig { // /// DISCOURAGED: Minimum width for a window to be eligible for tiling diff --git a/komorebi/src/window.rs b/komorebi/src/window.rs index f9f4d908..260c6b98 100644 --- a/komorebi/src/window.rs +++ b/komorebi/src/window.rs @@ -860,6 +860,7 @@ impl From<&CFDictionary> for WindowBounds { } #[derive(Copy, Clone, Debug, Display, EnumString, Serialize, Deserialize, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] #[serde(untagged)] pub enum AspectRatio { /// A predefined aspect ratio @@ -875,6 +876,7 @@ impl Default for AspectRatio { } #[derive(Copy, Clone, Debug, Default, Display, EnumString, Serialize, Deserialize, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] pub enum PredefinedAspectRatio { /// 21:9 Ultrawide, diff --git a/komorebic/Cargo.toml b/komorebic/Cargo.toml index c54fbd8f..289980d5 100644 --- a/komorebic/Cargo.toml +++ b/komorebic/Cargo.toml @@ -15,6 +15,8 @@ fs-tail = "0.1" lazy_static = { workspace = true } pastey = { workspace = true } reqwest = { version = "0.12", features = ["blocking"] } +schemars = { workspace = true, optional = true } +serde_json = { workspace = true } shadow-rs = { workspace = true } sysinfo = { workspace = true } @@ -22,5 +24,9 @@ sysinfo = { workspace = true } reqwest = { version = "0.12", features = ["blocking"] } shadow-rs = { workspace = true } +[features] +default = ["schemars"] +schemars = ["dep:schemars", "komorebi-client/default"] + [lints.rust] unexpected_cfgs = { level = "warn", check-cfg = ['cfg(FALSE)'] } diff --git a/komorebic/src/main.rs b/komorebic/src/main.rs index de382fed..143b6031 100644 --- a/komorebic/src/main.rs +++ b/komorebic/src/main.rs @@ -6,6 +6,7 @@ use clap::ValueEnum; use color_eyre::eyre; use fs_tail::TailedFile; use komorebi_client::ApplicationIdentifier; +use komorebi_client::ApplicationSpecificConfiguration; use komorebi_client::Axis; use komorebi_client::CycleDirection; use komorebi_client::DefaultLayout; @@ -17,6 +18,7 @@ use komorebi_client::Rect; use komorebi_client::Sizing; use komorebi_client::SocketMessage; use komorebi_client::StateQuery; +use komorebi_client::StaticConfig; use komorebi_client::replace_env_in_path; use komorebi_client::send_message; use komorebi_client::send_query; @@ -1071,15 +1073,15 @@ enum SubCommand { /// Fetch the latest version of applications.json from komorebi-application-specific-configuration #[clap(alias = "fetch-asc")] FetchAppSpecificConfiguration, - // /// Generate a JSON Schema for applications.json - // #[clap(alias = "asc-schema")] - // ApplicationSpecificConfigurationSchema, - // /// Generate a JSON Schema of subscription notifications + /// Generate a JSON Schema for applications.json + #[clap(alias = "asc-schema")] + ApplicationSpecificConfigurationSchema, + /// Generate a JSON Schema of subscription notifications // NotificationSchema, - // /// Generate a JSON Schema of socket messages - // SocketSchema, - // /// Generate a JSON Schema of the static configuration file - // StaticConfigSchema, + /// Generate a JSON Schema of socket messages + SocketSchema, + /// Generate a JSON Schema of the static configuration file + StaticConfigSchema, // /// Generates a static configuration JSON file based on the current window manager state // GenerateStaticConfig, // /// Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi @@ -1690,6 +1692,37 @@ fn main() -> eyre::Result<()> { SubCommand::MouseFollowsFocus(arg) => { send_message(&SocketMessage::MouseFollowsFocus(arg.boolean_state.into()))?; } + SubCommand::ApplicationSpecificConfigurationSchema => { + #[cfg(feature = "schemars")] + { + let asc = schemars::schema_for!(ApplicationSpecificConfiguration); + let schema = serde_json::to_string_pretty(&asc)?; + println!("{schema}"); + } + } + SubCommand::SocketSchema => { + #[cfg(feature = "schemars")] + { + let socket_message = schemars::schema_for!(SocketMessage); + let schema = serde_json::to_string_pretty(&socket_message)?; + println!("{schema}"); + } + } + SubCommand::StaticConfigSchema => { + #[cfg(feature = "schemars")] + { + let settings = schemars::r#gen::SchemaSettings::default().with(|s| { + s.option_nullable = false; + s.option_add_null_type = false; + s.inline_subschemas = true; + }); + + let generator = settings.into_generator(); + let socket_message = generator.into_root_schema_for::(); + let schema = serde_json::to_string_pretty(&socket_message)?; + println!("{schema}"); + } + } } Ok(())