Merge #212: feat(pretty-format): add pretty flag to format outputs in a tabular form

94012c6 feat(pretty-fmt): update README for `pretty` flag (Vihiga Tyonum)
1cadf63 feat(pretty-fmt): add cli-table to format output (Vihiga Tyonum)

Pull request description:

  Fixes #193

  <!-- You can erase any parts of this template not applicable to your Pull Request. -->

  ### Description

  This PR adds a top level flag `--pretty` to format output in a tabular form to enhance readability for users.

  <!-- Describe the purpose of this PR, what's being adding and/or fixed -->

  ### Notes to the reviewers

  <!-- In this section you can include notes directed to the reviewers, like explaining why some parts
  of the PR were done in a specific way -->

  ## Changelog notice
  - Add `--pretty` top level flag for formatting commands output in a tabular format

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk-cli/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

  #### New Features:

  * [ ] I've added tests for the new feature
  * [x] I've added docs for the new feature
  * [x] I've updated `CHANGELOG.md`

Top commit has no ACKs.

Tree-SHA512: 61dee251b2f3615ae013c31bcd484db7315ddab103a1668f8ca20d34337042bcc8ad48c5014029db5fecb6b5573c2c3ac9a2521e31678d851191841733bceafc

Author: tvpeter

CHANGELOG.md

@@ -6,6 +6,7 @@ page. See [DEVELOPMENT_CYCLE.md](DEVELOPMENT_CYCLE.md) for more details.
 ## [Unreleased]
 
 - Removed MSRV and bumped Rust Edition to 2024
+- Add `--pretty` top level flag for formatting commands output in a tabular format
 
 ## [1.0.0]
 

Cargo.lock

@@ -20,6 +20,7 @@ log = "0.4"
 serde_json = "1.0"
 thiserror = "2.0.11"
 tokio = { version = "1", features = ["full"] }
+cli-table = "0.5.0"
 
 # Optional dependencies
 bdk_bitcoind_rpc = { version = "0.20.0", optional = true }

Cargo.toml

@@ -193,3 +193,12 @@ Note: You can modify the `Justfile` to reflect your nodes' configuration values.
    cargo run --features rpc -- wallet -u "127.0.0.1:18443" -c rpc -a user:password sync
    cargo run --features rpc -- wallet -u "127.0.0.1:18443" -c rpc -a user:password balance
    ```
+
+## Formatting Responses using `--pretty` flag
+
+You can optionally return outputs of commands in  human-readable, tabular format instead of `JSON`. To enable this option, simply add the `--pretty` flag as a top level flag. For instance, you wallet's balance in a pretty format, you can run:
+
+```shell
+cargo run --pretty -n signet wallet -w {wallet_name} -d sqlite balance
+```
+This is available for wallet, key, repl and compile features. When ommitted, outputs default to `JSON`.

README.md

@@ -51,6 +51,9 @@ pub struct CliOpts {
     /// Default value : ~/.bdk-bitcoin
     #[arg(env = "DATADIR", short = 'd', long = "datadir")]
     pub datadir: Option<std::path::PathBuf>,
+    /// Output results in pretty format (instead of JSON).
+    #[arg(long = "pretty")]
+    pub pretty: bool,
     /// Top level cli sub-commands.
     #[command(subcommand)]
     pub subcommand: CliSubCommand,