Gabriel Kaszewski
051d19d878
clean architecture refactor, performance, resilience, DX/UX architecture: - 13 crates with proper domain/application/infrastructure layers - domain crate: newtypes, ports (Plugin, AppLauncher), constants - kernel: pure orchestrator - shared UI state machine (k-launcher-ui-core) - merged plugin-api into domain as ports module - granular file structure (no monolithic lib.rs) - all tests extracted to tests/ directories features: - frecency boost in search results - empty query shows top frecent apps - append-only frecency log with configurable compaction - config-driven styling (all colors, sizes, debounce) - configurable terminal emulator, external plugin timeout - log rotation with max_log_files - loading indicator, descriptive placeholder text - graceful shutdown via iced::exit() + Plugin::shutdown() - --version flag, panic hook, signal handling (SIGINT/SIGTERM) - SpawnInTerminal in external plugin protocol performance: - ~1500 -> ~50 heap allocs per keystroke - reused Matcher, Pattern, char buffer across entries - Arc<str> for shared result fields - pre-filter before fuzzy matching - partial sort for top frecent IDs - cached lowercase names in entries resilience: - parking_lot (no mutex poisoning) - thiserror hierarchy (PluginError, ConfigError, AppError) - all silent error swallowing replaced with tracing::warn - config parse errors logged quality: - named constants (no magic strings/numbers) - named types (no anonymous tuples) - Rgba newtype with validation - domain newtype validation (debug_assert non-empty) - man page, LICENSE (MIT), PKGBUILD, example config - plugin development guide updated - make check (fmt + clippy + test), make dev (RUST_LOG=debug) style: format code for better readability in tests and function signatures fix: update build_entries function signature to ignore frecency parameter fix(review): bugs, arch violations, design smells P1 bugs: - unix_launcher: shell_split respects quoted args (was split_whitespace) - plugin-host: 5s timeout on external plugin search - ui: handle engine init panic, wire error state - ui-egui: read window config instead of always using defaults - plugin-url: use OpenPath action instead of SpawnProcess+xdg-open Architecture: - remove WindowConfig (mirror of WindowCfg); use WindowCfg directly - remove on_select closure from SearchResult (domain leakage) - remove LaunchAction::Custom; add Plugin::on_selected + SearchEngine::on_selected - apps: record frecency via on_selected instead of embedded closure Design smells: - frecency: extract decay_factor helper, write outside mutex - apps: remove cfg(test) cache_path hack; add new_for_test ctor - apps: stable ResultId using name+exec to prevent collision - files: stable ResultId using full path instead of index - plugin-host: remove k-launcher-os-bridge dep (WindowConfig gone) Update iced dependency in Cargo.toml to disable default features and add additional ones feat(app): enhance engine initialization with EngineHandle and update run function signature feat: production hardening (panic isolation, file logging, apps cache) - Kernel::search wraps each plugin in catch_unwind; panics are logged and return [] - init_logging() adds daily rolling file at ~/.local/share/k-launcher/logs/ - AppsPlugin caches entries to ~/.cache/k-launcher/apps.bin via bincode; stale-while-revalidate on subsequent launches - 57 tests pass refactor: remove client module and associated show command logic fix(app): format code for clarity in update function chore: update .gitignore and enhance README with compositor setup instructions chore(docs): remove unused screenshot file feature/prod-ready (#1) Reviewed-on: #1 fix(calc): remove ambiguous log alias, use ln/log2/log10 explicitly fix(calc): fix log/ln naming, cache math context, strengthen sin(pi) test feat(calc): add math functions (sqrt, sin, cos, etc.) and pi/e constants refactor(calc): rename preprocess, extend underscore test assertions feat(calc): strip underscore digit separators feat: update dependencies for improved compatibility and performance feat: add plugin-url for URL handling and open in browser functionality feat: add support for external plugins and enhance plugin management feat: add Makefile for build, run, and installation commands feat: add required features for k-launcher-egui and update dependencies feat: update README and add documentation for installation, configuration, usage, and plugin development feat: enhance configuration management and UI styling, remove unused theme module feat: add k-launcher-config crate for configuration management and integrate with existing components feat: add k-launcher-ui-egui crate for enhanced UI - Introduced a new crate `k-launcher-ui-egui` to provide a graphical user interface using eframe and egui. - Updated the workspace configuration in `Cargo.toml` to include the new crate. - Implemented the main application logic in `src/app.rs`, handling search functionality and user interactions. - Created a library entry point in `src/lib.rs` to expose the `run` function for launching the UI. - Modified the `k-launcher` crate to include a new binary target for the egui-based launcher. - Added a new main file `src/main_egui.rs` to initialize and run the egui UI with the existing kernel and launcher components. feat: implement OS bridge and enhance app launcher functionality feat: add FilesPlugin for file searching and integrate into KLauncher feat: implement frecency tracking for app usage and enhance search functionality feat: add CmdPlugin for executing terminal commands and update workspace configuration refactor: update dependencies and improve keyboard event handling in KLauncherApp refactor: simplify theme usage and enhance AppsPlugin structure feat: restructure k-launcher workspace and add core functionality - Updated Cargo.toml to include a new k-launcher crate and reorganized workspace members. - Introduced a README.md file detailing the project philosophy, architecture, and technical specifications. - Implemented a new Kernel struct in k-launcher-kernel for managing plugins and search functionality. - Created a Plugin trait for plugins to implement, allowing for asynchronous search operations. - Developed k-launcher-ui with an Iced-based UI for user interaction, including search input and result display. - Added AppsPlugin and CalcPlugin to handle application launching and basic calculations, respectively. - Established a theme module for UI styling, focusing on an Aero aesthetic. - Removed unnecessary main.rs files from plugin crates, streamlining the project structure. Initialize k-launcher project structure with multiple crates and basic configurations
90 lines
3.4 KiB
Markdown
90 lines
3.4 KiB
Markdown
# Configuration
|
||
|
||
Config file: `~/.config/k-launcher/config.toml`
|
||
|
||
The file is optional — all fields have defaults and missing sections fall back to defaults automatically. If the file exists but has a parse error, a warning is logged and defaults are used.
|
||
|
||
See [config.example.toml](../config.example.toml) for a ready-to-copy template with all options.
|
||
|
||
## Sections
|
||
|
||
### [window]
|
||
|
||
| Field | Type | Default | Description |
|
||
|---|---|---|---|
|
||
| `width` | float | `600.0` | Window width in pixels |
|
||
| `height` | float | `400.0` | Window height in pixels |
|
||
| `decorations` | bool | `false` | Show window title bar |
|
||
| `transparent` | bool | `true` | Enable background transparency |
|
||
| `resizable` | bool | `false` | Allow manual resizing |
|
||
|
||
### [appearance]
|
||
|
||
| Field | Type | Default | Description |
|
||
|---|---|---|---|
|
||
| `background_rgba` | [R,G,B,A] | `[20, 20, 30, 0.9]` | Main background color |
|
||
| `border_rgba` | [R,G,B,A] | `[229, 125, 33, 1.0]` | Border/accent color |
|
||
| `border_width` | float | `1.0` | Border thickness |
|
||
| `border_radius` | float | `8.0` | Window corner radius |
|
||
| `search_font_size` | float | `18.0` | Search input font size |
|
||
| `title_size` | float | `15.0` | Result title font size |
|
||
| `desc_size` | float | `12.0` | Result description font size |
|
||
| `row_radius` | float | `4.0` | Result row corner radius |
|
||
| `placeholder` | string | `"Search apps, ..."` | Search input placeholder |
|
||
| `selected_row_rgba` | [R,G,B,A] | `[229, 125, 33, 1.0]` | Selected result background |
|
||
| `unselected_row_rgba` | [R,G,B,A] | `[255, 255, 255, 0.07]` | Unselected result background |
|
||
| `description_rgba` | [R,G,B,A] | `[210, 215, 230, 1.0]` | Description text color |
|
||
| `no_results_rgba` | [R,G,B,A] | `[180, 180, 200, 0.5]` | "No results" text color |
|
||
| `error_rgba` | [R,G,B,A] | `[255, 80, 80, 1.0]` | Error text color |
|
||
| `icon_size` | float | `24.0` | App icon size in pixels |
|
||
|
||
#### RGBA format
|
||
|
||
Colors use `[R, G, B, A]` arrays where R/G/B are 0–255 (as floats) and A is 0.0–1.0 (opacity). Values are clamped to valid ranges.
|
||
|
||
### [search]
|
||
|
||
| Field | Type | Default | Description |
|
||
|---|---|---|---|
|
||
| `max_results` | integer | `8` | Maximum results shown |
|
||
| `debounce_ms` | integer | `50` | Milliseconds to wait after last keystroke before searching |
|
||
| `frecency_compact_threshold` | integer | `50` | Frecency log entries before compacting to snapshot |
|
||
|
||
### [plugins]
|
||
|
||
| Field | Type | Default | Description |
|
||
|---|---|---|---|
|
||
| `calc` | bool | `true` | Calculator plugin |
|
||
| `cmd` | bool | `true` | Shell command plugin |
|
||
| `files` | bool | `true` | File browser plugin |
|
||
| `apps` | bool | `true` | Application search plugin |
|
||
|
||
### [[plugins.external]]
|
||
|
||
Repeatable block for external plugins.
|
||
|
||
| Field | Type | Default | Description |
|
||
|---|---|---|---|
|
||
| `name` | string | required | Plugin display name |
|
||
| `path` | string | required | Path to plugin executable |
|
||
| `args` | string[] | `[]` | Arguments to pass |
|
||
| `timeout_secs` | integer | `5` | Search timeout per query |
|
||
|
||
### [logging]
|
||
|
||
| Field | Type | Default | Description |
|
||
|---|---|---|---|
|
||
| `max_log_files` | integer | `7` | Daily log files to keep |
|
||
|
||
Logs are stored in `~/.local/share/k-launcher/logs/`.
|
||
|
||
### [terminal]
|
||
|
||
| Field | Type | Default | Description |
|
||
|---|---|---|---|
|
||
| `cmd` | string | auto-detect | Terminal emulator for `>` commands |
|
||
|
||
If unset, detected from `$TERM_CMD`, `$TERMINAL`, or PATH (foot, kitty, alacritty, wezterm, konsole, xterm).
|
||
|
||
Example: `cmd = "kitty -e"`
|