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
91 lines
1.9 KiB
Markdown
91 lines
1.9 KiB
Markdown
# k-launcher
|
|
|
|
A lightweight command palette for Linux (Wayland/X11). Fuzzy search, frecency ranking, plugin system. Written in Rust.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
git clone https://github.com/GKaszewski/k-launcher
|
|
cd k-launcher
|
|
make install
|
|
```
|
|
|
|
Or with cargo directly:
|
|
|
|
```bash
|
|
cargo build --release
|
|
cp target/release/k-launcher ~/.local/bin/
|
|
```
|
|
|
|
### Arch Linux (AUR)
|
|
|
|
```bash
|
|
yay -S k-launcher
|
|
```
|
|
|
|
## Usage
|
|
|
|
| Input | What it does | Example |
|
|
|---|---|---|
|
|
| any text | Fuzzy-search installed apps | `firefox` |
|
|
| empty | Show most-used apps (frecency) | |
|
|
| `>` prefix | Run shell command in terminal | `> htop` |
|
|
| `=` or math | Evaluate expression, copy result | `2^10 + 5` |
|
|
| `/` or `~/` | Browse filesystem | `~/Documents` |
|
|
|
|
## Keybinds
|
|
|
|
| Key | Action |
|
|
|---|---|
|
|
| `↑` / `↓` | Navigate results |
|
|
| `Enter` | Launch / copy |
|
|
| `Escape` | Close |
|
|
|
|
## Configuration
|
|
|
|
`~/.config/k-launcher/config.toml` — all fields optional, sensible defaults.
|
|
|
|
See [config.example.toml](config.example.toml) for all available options.
|
|
|
|
## Compositor Setup
|
|
|
|
**Hyprland** (`~/.config/hypr/hyprland.conf`):
|
|
|
|
```
|
|
windowrule = float, ^(k-launcher)$
|
|
windowrule = center, ^(k-launcher)$
|
|
bind = SUPER, Space, exec, k-launcher
|
|
```
|
|
|
|
**Sway** (`~/.config/sway/config`):
|
|
|
|
```
|
|
for_window [app_id="k-launcher"] floating enable, move position center
|
|
bindsym Mod4+space exec k-launcher
|
|
```
|
|
|
|
## Plugins
|
|
|
|
Built-in plugins (calc, apps, shell, files) are enabled by default. External plugins communicate via JSON over stdin/stdout — any language, no recompilation:
|
|
|
|
```toml
|
|
[[plugins.external]]
|
|
name = "my-plugin"
|
|
path = "/path/to/plugin"
|
|
timeout_secs = 5
|
|
```
|
|
|
|
See [Plugin Development](docs/plugin-development.md) for the full protocol.
|
|
|
|
## Docs
|
|
|
|
- [Installation](docs/install.md)
|
|
- [Usage](docs/usage.md)
|
|
- [Configuration](docs/configuration.md)
|
|
- [Plugin Development](docs/plugin-development.md)
|
|
- `man k-launcher`
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|