chore(release): v0.1.29

.github/workflows/windows.yaml

@@ -105,7 +105,7 @@ jobs:
       - name: Check GoReleaser
         uses: goreleaser/goreleaser-action@v3
         env:
-          GORELEASER_CURRENT_TAG: v0.1.28
+          GORELEASER_CURRENT_TAG: v0.1.29
         with:
           version: latest
           args: build --skip=validate --clean

README.md

@@ -359,7 +359,7 @@ every `WindowManagerEvent` and `SocketMessage` handled by `komorebi` in a Rust c
 Below is a simple example of how to use `komorebi-client` in a basic Rust application.
 
 ```rust
-// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi", tag = "v0.1.28"}
+// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi", tag = "v0.1.29"}
 
 use anyhow::Result;
 use komorebi_client::Notification;

docs/cli/animation-duration.md

@@ -0,0 +1,16 @@
+# animation-duration
+
+```
+Set the duration for movement animations in ms
+
+Usage: komorebic.exe animation-duration <DURATION>
+
+Arguments:
+  <DURATION>
+          Desired animation durations in ms
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/animation-fps.md

@@ -0,0 +1,16 @@
+# animation-fps
+
+```
+Set the frames per second for movement animations
+
+Usage: komorebic.exe animation-fps <FPS>
+
+Arguments:
+  <FPS>
+          Desired animation frames per second
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/animation-style.md

@@ -0,0 +1,20 @@
+# animation-style
+
+```
+Set the ease function for movement animations
+
+Usage: komorebic.exe animation-style [OPTIONS]
+
+Options:
+  -s, --style <STYLE>
+          Desired ease function for animation
+          
+          [default: linear]
+          [possible values: linear, ease-in-sine, ease-out-sine, ease-in-out-sine, ease-in-quad, ease-out-quad, ease-in-out-quad, ease-in-cubic, ease-in-out-cubic, ease-in-quart,
+          ease-out-quart, ease-in-out-quart, ease-in-quint, ease-out-quint, ease-in-out-quint, ease-in-expo, ease-out-expo, ease-in-out-expo, ease-in-circ, ease-out-circ, ease-in-out-circ,
+          ease-in-back, ease-out-back, ease-in-out-back, ease-in-elastic, ease-out-elastic, ease-in-out-elastic, ease-in-bounce, ease-out-bounce, ease-in-out-bounce]
+
+  -h, --help
+          Print help
+
+```

docs/cli/animation.md

@@ -0,0 +1,16 @@
+# animation
+
+```
+Enable or disable movement animations
+
+Usage: komorebic.exe animation <BOOLEAN_STATE>
+
+Arguments:
+  <BOOLEAN_STATE>
+          [possible values: enable, disable]
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/bar-configuration.md

@@ -0,0 +1,12 @@
+# bar-configuration
+
+```
+Show the path to komorebi.bar.json
+
+Usage: komorebic.exe bar-configuration
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/complete-configuration.md

@@ -1,7 +1,7 @@
 # complete-configuration
 
 ```
-Signal that the final configuration option has been sent
+For legacy komorebi.ahk or komorebi.ps1 configurations, signal that the final configuration option has been sent
 
 Usage: komorebic.exe complete-configuration
 

docs/cli/enable-autostart.md

@@ -18,6 +18,9 @@ Options:
       --ahk
           Enable autostart of ahk
 
+      --bar
+          Enable autostart of komorebi-bar
+
   -h, --help
           Print help
 

docs/cli/focus-stack-window.md

@@ -0,0 +1,16 @@
+# focus-stack-window
+
+```
+Focus the specified window index in the focused stack
+
+Usage: komorebic.exe focus-stack-window <TARGET>
+
+Arguments:
+  <TARGET>
+          Target index (zero-indexed)
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/reload-configuration.md

@@ -1,7 +1,7 @@
 # reload-configuration
 
 ```
-Reload ~/komorebi.ahk (if it exists)
+Reload legacy komorebi.ahk or komorebi.ps1 configurations (if they exist)
 
 Usage: komorebic.exe reload-configuration
 

docs/cli/replace-configuration.md

@@ -0,0 +1,16 @@
+# replace-configuration
+
+```
+Replace the configuration of a running instance of komorebi from a static configuration file
+
+Usage: komorebic.exe replace-configuration <PATH>
+
+Arguments:
+  <PATH>
+          Static configuration JSON file from which the configuration should be loaded
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/start.md

@@ -24,6 +24,9 @@ Options:
       --ahk
           Start autohotkey configuration file
 
+      --bar
+          Start komorebi-bar in a background process
+
   -h, --help
           Print help
 

docs/cli/stop.md

@@ -9,6 +9,9 @@ Options:
       --whkd
           Stop whkd if it is running as a background process
 
+      --bar
+          Stop komorebi-bar if it is running as a background process
+
   -h, --help
           Print help
 

docs/cli/toggle-transparency.md

@@ -0,0 +1,12 @@
+# toggle-transparency
+
+```
+Toggle transparency for unfocused windows
+
+Usage: komorebic.exe toggle-transparency
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/watch-configuration.md

@@ -1,7 +1,7 @@
 # watch-configuration
 
 ```
-Enable or disable watching of ~/komorebi.ahk (if it exists)
+Enable or disable watching of legacy komorebi.ahk or komorebi.ps1 configurations (if they exist)
 
 Usage: komorebic.exe watch-configuration <BOOLEAN_STATE>
 

docs/komorebi.bar.example.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/master/schema.bar.json",
+  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.29/schema.bar.json",
   "monitor": {
     "index": 0,
     "work_area_offset": {

docs/komorebi.example.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.28/schema.json",
+  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.29/schema.json",
   "app_specific_configuration_path": "$Env:USERPROFILE/applications.yaml",
   "window_hiding_behaviour": "Cloak",
   "cross_monitor_move_behaviour": "Insert",

justfile

@@ -42,7 +42,7 @@ deadlock $RUST_LOG="trace":
     cargo +stable run --bin komorebi --locked --features deadlock_detection
 
 docgen:
-    komorebic docgen
+    cargo run --package komorebic -- docgen
     Get-ChildItem -Path "docs/cli" -Recurse -File | ForEach-Object { (Get-Content $_.FullName) -replace 'Usage: ', 'Usage: komorebic.exe ' | Set-Content $_.FullName }
 
 schemagen:

komorebi-bar/src/config.rs

@@ -10,6 +10,7 @@ use serde::Serialize;
 use std::path::PathBuf;
 
 #[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
+/// The `komorebi.bar.json` configuration file reference for `v0.1.29`
 pub struct KomobarConfig {
     /// Viewport options (see: https://docs.rs/egui/latest/egui/viewport/struct.ViewportBuilder.html)
     pub viewport: Option<ViewportConfig>,

komorebi/src/static_config.rs

@@ -246,7 +246,7 @@ impl From<&Monitor> for MonitorConfig {
 }
 
 #[derive(Debug, Serialize, Deserialize, JsonSchema)]
-/// The `komorebi.json` static configuration file reference for `v0.1.28`
+/// The `komorebi.json` static configuration file reference for `v0.1.29`
 pub struct StaticConfig {
     /// DEPRECATED from v0.1.22: no longer required
     #[serde(skip_serializing_if = "Option::is_none")]

komorebic/src/main.rs

@@ -897,6 +897,7 @@ enum SubCommand {
     /// Show the path to komorebi.json
     #[clap(alias = "config")]
     Configuration,
+    /// Show the path to komorebi.bar.json
     #[clap(alias = "bar-config")]
     #[clap(alias = "bconfig")]
     BarConfiguration,
@@ -1281,16 +1282,16 @@ enum SubCommand {
     TransparencyAlpha(TransparencyAlpha),
     /// Toggle transparency for unfocused windows
     ToggleTransparency,
-    /// Enable or disable the window move animation
+    /// Enable or disable movement animations
     #[clap(arg_required_else_help = true)]
     Animation(Animation),
-    /// Set the duration for the window move animation in ms
+    /// Set the duration for movement animations in ms
     #[clap(arg_required_else_help = true)]
     AnimationDuration(AnimationDuration),
-    /// Set the frames per second for the window move animation
+    /// Set the frames per second for movement animations
     #[clap(arg_required_else_help = true)]
     AnimationFps(AnimationFps),
-    /// Set the ease function for the window move animation
+    /// Set the ease function for movement animations
     #[clap(arg_required_else_help = true)]
     AnimationStyle(AnimationStyle),
     /// Enable or disable focus follows mouse for the operating system
@@ -1416,7 +1417,7 @@ fn main() -> Result<()> {
             std::fs::write(WHKD_CONFIG_DIR.join("whkdrc"), whkdrc)?;
 
             println!("Example komorebi.json, komorebi.bar.json, whkdrc and latest applications.yaml files created");
-            println!("You can now run komorebic start --whkd");
+            println!("You can now run komorebic start --whkd --bar");
         }
         SubCommand::EnableAutostart(args) => {
             let mut current_exe = std::env::current_exe().expect("unable to get exec path");

mkdocs.yml

@@ -79,6 +79,7 @@ nav:
       - cli/stop.md
       - cli/check.md
       - cli/configuration.md
+      - cli/bar-configuration.md
       - cli/whkdrc.md
       - cli/state.md
       - cli/global-state.md
@@ -103,12 +104,13 @@ nav:
       - cli/cycle-focus.md
       - cli/cycle-move.md
       - cli/stack.md
+      - cli/unstack.md
+      - cli/cycle-stack.md
+      - cli/focus-stack-window.md
       - cli/stack-all.md
       - cli/unstack-all.md
       - cli/resize-edge.md
       - cli/resize-axis.md
-      - cli/unstack.md
-      - cli/cycle-stack.md
       - cli/move-to-monitor.md
       - cli/cycle-move-to-monitor.md
       - cli/move-to-workspace.md
@@ -179,6 +181,7 @@ nav:
       - cli/restore-windows.md
       - cli/manage.md
       - cli/unmanage.md
+      - cli/replace-configuration.md
       - cli/reload-configuration.md
       - cli/watch-configuration.md
       - cli/complete-configuration.md
@@ -208,6 +211,11 @@ nav:
       - cli/border-implementation.md
       - cli/transparency.md
       - cli/transparency-alpha.md
+      - cli/toggle-transparency.md
+      - cli/animation.md
+      - cli/animation-duration.md
+      - cli/animation-fps.md
+      - cli/animation-style.md
       - cli/focus-follows-mouse.md
       - cli/toggle-focus-follows-mouse.md
       - cli/mouse-follows-focus.md

schema.bar.json

@@ -1,6 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "KomobarConfig",
+  "description": "The `komorebi.bar.json` configuration file reference for `v0.1.29`",
   "type": "object",
   "required": [
     "left_widgets",

schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "StaticConfig",
-  "description": "The `komorebi.json` static configuration file reference for `v0.1.28`",
+  "description": "The `komorebi.json` static configuration file reference for `v0.1.29`",
   "type": "object",
   "properties": {
     "animation": {