feat: logging (#14)

Author: robin-thoene

.gitignore

@@ -1 +1,2 @@
 /target/
+/*log.txt

.vscode/launch.json

@@ -5,7 +5,7 @@
       "type": "lldb",
       "request": "launch",
       "name": "Debug",
-      "program": "${workspaceFolder}/target/debug/wiretui-bin",
+      "program": "${workspaceFolder}/target/debug/wiretui",
       "preLaunchTask": "build:wiretui",
       "console": "externalTerminal"
     }

Cargo.lock

@@ -1,8 +1,16 @@
 [workspace]
 resolver = "3"
-members = ["src-libs/*", "src-bin/*"]
+members = ["crates/*"]
 
 [workspace.package]
 version = "0.0.0"
 authors = ["robin-thoene"]
 license = "MIT"
+
+[workspace.dependencies]
+env_logger = "0.11.8"
+log = "0.4.28"
+crossterm = "0.29.0"
+ratatui = "0.29.0"
+zbus = "5.12.0"
+serde = "1.0.228"

Cargo.toml

@@ -45,3 +45,23 @@ cargo deny check
 
 This project contains a debugger configuration using [.vscode files](./.vscode/). Those can be
 used in Neovim as well (see example [here](https://github.com/robin-thoene/dotfiles/blob/f388381f49d4b79e2755e18929d2462d198bd30d/.config/nvim/lua/plugins/nvim_dap.lua#L98)).
+
+## Logging
+
+This application uses the **log** crate in combination with the **env_logger** crate to set the
+log level. By default the logs are written to a file, which is overridden every time you run the
+application.
+
+You can see it's current content with
+
+```shell
+cat ~/.local/state/wiretui/log.txt
+```
+
+To override the log level when running the application use
+
+```shell
+RUST_LOG=debug cargo run
+```
+
+Valid log level are `trace`, `debug`, `info`, `warn` and `error`.

README.md

@@ -11,7 +11,8 @@ license.workspace = true
 application = { path = "../application" }
 domain = { path = "../domain" }
 ports = { path = "../ports" }
-crossterm = "0.29.0"
-ratatui = "0.29.0"
-zbus = "5.12.0"
-serde = "1.0.228"
+crossterm = { workspace = true }
+ratatui = { workspace = true }
+zbus = { workspace = true }
+serde = { workspace = true }
+log = { workspace = true }