Add verbose logging via tracing

.github/workflows/netsukefile-test.yml

@@ -37,6 +37,6 @@ jobs:
               command: "touch generated.txt"
           MANIFEST
       - name: Run Netsuke
-        run: ./target/debug/netsuke build generated.txt
+        run: ./target/debug/netsuke --verbose build generated.txt
       - name: Assert artefact exists
         run: scripts/assert-file-exists.sh generated.txt

Cargo.toml

@@ -13,6 +13,9 @@ thiserror = "1"
 sha2 = "0.10"
 itoa = "1"
 itertools = "0.12"
+tracing = "0.1"
+tracing-subscriber = { version = "0.3", features = ["fmt"] }
+serde_json = "1"
 
 [lints.clippy]
 pedantic = { level = "warn", priority = -1 }

README.md

@@ -158,6 +158,7 @@ You can also pass:
 - `--file` to use an alternate manifest
 - `--directory` to run in a different working dir
 - `-j N` to control parallelism (passed through to Ninja)
+- `-v`, `--verbose` to enable verbose logging
 
 ## 🚧 Status
 

docs/netsuke-design.md

@@ -1369,6 +1369,10 @@ struct Cli { /// Path to the Netsuke manifest file to use.
     #[arg(short, long, value_name = "N")]
     jobs: Option<usize>,
 
+    /// Enable verbose logging output.
+    #[arg(short, long)]
+    verbose: bool,
+
     #[command(subcommand)]
     command: Option<Commands>, }
 
@@ -1513,6 +1517,7 @@ selected for this project and the rationale for their inclusion.
 | Templating | minijinja | High compatibility with Jinja2, minimal dependencies, and supports runtime template loading. |
 | Shell Quoting | shell-quote | A critical security component; provides robust, shell-specific escaping for command arguments. |
 | Error Handling | anyhow + thiserror | An idiomatic and powerful combination for creating rich, contextual, and user-friendly error reports. |
+| Logging | tracing | Structured, levelled diagnostic output for debugging and insight. |
 | Versioning | semver | The standard library for parsing and evaluating Semantic Versioning strings, essential for the `netsuke_version` field. |
 
 ### 9.3 Future Enhancements

src/ast.rs

@@ -18,7 +18,7 @@
 //! ```
 
 use semver::Version;
-use serde::{Deserialize, de::Deserializer};
+use serde::{Deserialize, Serialize, de::Deserializer};
 
 fn deserialize_actions<'de, D>(deserializer: D) -> Result<Vec<Target>, D::Error>
 where
@@ -53,7 +53,7 @@
 /// assert_eq!(manifest.targets.len(), 1);
 /// # Ok(()) }
 /// ```
-#[derive(Debug, Deserialize)]
+#[derive(Debug, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct NetsukeManifest {
     /// Semantic version of the manifest format.
@@ -86,7 +86,7 @@
 /// targets. It may define a command line, a script block, or delegate to another
 /// named rule. Dependencies may be specified as either a single string or a
 /// list of strings.
-#[derive(Debug, Deserialize)]
+#[derive(Debug, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct Rule {
     /// Unique identifier used by targets to reference this rule.
@@ -164,7 +164,7 @@
 /// Targets describe the files produced by a rule and their dependencies.
 /// `phony` targets are always considered out of date, while `always` targets are
 /// regenerated even if their inputs are unchanged.
-#[derive(Debug, Deserialize)]
+#[derive(Debug, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct Target {
     /// Output file or files.
@@ -212,7 +212,7 @@
 ///   - hello
 ///   - world
 /// ```
-#[derive(Debug, Deserialize, Default, Clone, PartialEq)]
+#[derive(Debug, Deserialize, Serialize, Default, Clone, PartialEq)]
 #[serde(untagged)]
 pub enum StringOrList {
     /// No value provided.

src/cli.rs

@@ -36,6 +36,10 @@ pub struct Cli {
     #[arg(short, long, value_name = "N", value_parser = parse_jobs)]
     pub jobs: Option<usize>,
 
+    /// Enable verbose logging output.
+    #[arg(short, long)]
+    pub verbose: bool,
+
     #[command(subcommand)]
     pub command: Option<Commands>,
 }

src/main.rs

@@ -4,9 +4,14 @@
 
 use netsuke::{cli::Cli, runner};
 use std::process::ExitCode;
+use tracing::Level;
+use tracing_subscriber::fmt;
 
 fn main() -> ExitCode {
     let cli = Cli::parse_with_default();
+    if cli.verbose {
+        fmt().with_max_level(Level::DEBUG).init();
+    }
     match runner::run(&cli) {
         Ok(()) => ExitCode::SUCCESS,
         Err(err) => {