From bb3ff26161c86a03e59de27b9d555dfa64d2313d Mon Sep 17 00:00:00 2001 From: Alexander Mohr Date: Thu, 5 Jun 2025 20:19:24 +0200 Subject: [PATCH] document missing support for x and y offset --- README.md | 24 +++++++++++------------- worf/src/lib/config.rs | 38 ++++++++++++++------------------------ 2 files changed, 25 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 4c5ad1d..05223d1 100644 --- a/README.md +++ b/README.md @@ -133,26 +133,24 @@ The possibilities are endless! Here are some powerful examples of what you can b ### ⚠️ Breaking Changes -| Area | Change | -|--------------|----------------------------------| -| **Runtime** | Behavior differences | -| **Themes** | GTK4 vs GTK3 differences | -| **Config** | TOML format (quoted strings) | -| **Colors** | Color files not supported | -| **Options** | line_wrap` → `line-wrap` | -| **API** | Rust library only | -| **Booleans** | Explicit `true`/`false` required | +- Runtime behaviour is not guaranteed to be the same and won't ever be, this includes error messages and themes. +- Themes in general are mostly compatible. Worf is using the same entity ids, because worf is build on GTK4 instead of GTK3 there will be differences in the look and feel. +- Configuration files are not 100% compatible, Worf is using toml files instead, for most part this only means strings have to be quoted +- Color files are not supported +- line_wrap is now called line-wrap +- Wofi has a C-API, that is not and won't be supported, but Worf can be used as a rust library. +- Most boolean options now need true or false as argument, as Worf is using the same struct for config and command line arguments and this is the only way to merge both data sources +- Removed x,y offset and global coords as GTK4 does not support this anymore, similar results can be achieved with `--location` +- Removed copy_exec as we are not executing a binary to copy data into the clipboard -### 🗑️ Removed Features - -#### Command Line Arguments +#### Removed Command Line Arguments - `mode` → Use `show` instead - `dmenu` → Use `show` instead - `D` → Arguments = config now - `dark` → Auto-detected from theme - `filter-rate` → No longer needed, Worf is fast enough -#### Configuration Options +#### Removed configuration Options - `stylesheet` → Use `style` instead - `color`/`colors` → Use GTK4 CSS instead diff --git a/worf/src/lib/config.rs b/worf/src/lib/config.rs index 9adaaa2..6adf1ed 100644 --- a/worf/src/lib/config.rs +++ b/worf/src/lib/config.rs @@ -230,12 +230,6 @@ pub struct Config { #[clap(short = 'p', long = "prompt")] prompt: Option, - #[clap(short = 'x', long = "xoffset")] - xoffset: Option, // todo support this - - #[clap(short = 'y', long = "yoffset")] - yoffset: Option, // todo support this - /// If true a normal window instead of a layer shell will be used #[clap(short = 'n', long = "normal-window")] #[serde(default = "default_false")] @@ -263,7 +257,7 @@ pub struct Config { /// * terminator /// /// Must be configured including the needed arguments to launch something - /// i.e. 'kitty -c' + /// i.e. '--term "kitty -c"' #[clap(short = 't', long = "term")] term: Option, @@ -349,25 +343,23 @@ pub struct Config { #[clap(long = "image-size")] image_size: Option, - key_up: Option, // todo support this - key_down: Option, // todo support this - key_left: Option, // todo support this - key_right: Option, // todo support this - key_forward: Option, // todo support this - key_backward: Option, // todo support this - key_submit: Option, // todo support this - key_exit: Option, // todo support this - key_pgup: Option, // todo support this - key_pgdn: Option, // todo support this - key_expand: Option, // todo support this - key_hide_search: Option, // todo support this - key_copy: Option, // todo support this + // key_up: Option, // todo support this + // key_down: Option, // todo support this + // key_left: Option, // todo support this + // key_right: Option, // todo support this + // key_forward: Option, // todo support this + // key_backward: Option, // todo support this + // key_submit: Option, // todo support this + // key_exit: Option, // todo support this + // key_pgup: Option, // todo support this + // key_pgdn: Option, // todo support this + // key_expand: Option, // todo support this + // key_hide_search: Option, // todo support this + // key_copy: Option, // todo support this // todo re-add this // #[serde(flatten)] // key_custom: Option>, - global_coords: Option, // todo support this - /// If set to `true` the search field willOption<> be hidden. #[clap(long = "hide-search")] hide_search: Option, @@ -389,8 +381,6 @@ pub struct Config { #[clap(long = "layer")] layer: Option, - copy_exec: Option, // todo support this - /// If set to `true` single click instead of double click will select /// Defaults to `false` #[clap(long = "single-click")]