Merge pull request #1444 from input-output-hk/djo/1439/missing_warn_missing_docs_in_client_cli

Warn missing docs directive missing in Mithril Client Cli

Author: Alenar

.github/workflows/ci.yml

@@ -648,7 +648,9 @@ jobs:
 
       - name: Generate cargo doc
         run: |
-          cargo doc --no-deps -p mithril-stm -p mithril-common -p mithril-aggregator \
+          # Force `--lib` to avoid a collision between the client lib and the client cli binary who share
+          # the same name (we only want to document those anyway)
+          cargo doc --no-deps --lib -p mithril-stm -p mithril-common -p mithril-aggregator \
                     -p mithril-signer -p mithril-client -p mithril-client-cli \
                     --all-features --message-format=json \
                     | clippy-sarif | tee rust-cargo-doc-results.sarif | sarif-fmt

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client-cli"
-version = "0.5.15"
+version = "0.5.16"
 description = "A Mithril Client"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-client-cli/Cargo.toml

@@ -8,8 +8,8 @@ use std::{
     sync::Arc,
 };
 
+use crate::{configuration::ConfigParameters, utils::ExpanderUtils};
 use mithril_client::{ClientBuilder, MessageBuilder};
-use mithril_client_cli::{configuration::ConfigParameters, utils::ExpanderUtils};
 use mithril_common::StdResult;
 
 /// Download and verify a Mithril Stake Distribution information. If the

mithril-client-cli/src/commands/mithril_stake_distribution/download.rs

@@ -4,8 +4,8 @@ use config::{builder::DefaultState, ConfigBuilder};
 use slog_scope::logger;
 use std::{collections::HashMap, sync::Arc};
 
+use crate::configuration::ConfigParameters;
 use mithril_client::ClientBuilder;
-use mithril_client_cli::configuration::ConfigParameters;
 use mithril_common::{test_utils::fake_keys, StdResult};
 
 /// Mithril stake distribution LIST command

mithril-client-cli/src/commands/mithril_stake_distribution/list.rs

@@ -10,16 +10,16 @@ use std::{
     sync::Arc,
 };
 
-use mithril_client::{
-    common::ProtocolMessage, Client, ClientBuilder, MessageBuilder, MithrilCertificate, Snapshot,
-};
-use mithril_client_cli::{
+use crate::{
     configuration::ConfigParameters,
     utils::{
         ExpanderUtils, IndicatifFeedbackReceiver, ProgressOutputType, ProgressPrinter,
         SnapshotUnpacker, SnapshotUtils,
     },
 };
+use mithril_client::{
+    common::ProtocolMessage, Client, ClientBuilder, MessageBuilder, MithrilCertificate, Snapshot,
+};
 use mithril_common::StdResult;
 
 /// Clap command to download the snapshot and verify the certificate.
@@ -59,7 +59,7 @@ impl SnapshotDownloadCommand {
         let progress_output_type = if self.json {
             ProgressOutputType::JsonReporter
         } else {
-            ProgressOutputType::TTY
+            ProgressOutputType::Tty
         };
         let progress_printer = ProgressPrinter::new(progress_output_type, 5);
         let client = ClientBuilder::aggregator(

mithril-client-cli/src/commands/snapshot/download.rs

@@ -4,8 +4,8 @@ use config::{builder::DefaultState, ConfigBuilder};
 use slog_scope::logger;
 use std::{collections::HashMap, sync::Arc};
 
+use crate::configuration::ConfigParameters;
 use mithril_client::ClientBuilder;
-use mithril_client_cli::configuration::ConfigParameters;
 use mithril_common::{test_utils::fake_keys, StdResult};
 
 /// Clap command to list existing snapshots

mithril-client-cli/src/commands/snapshot/list.rs

@@ -5,8 +5,8 @@ use config::{builder::DefaultState, ConfigBuilder};
 use slog_scope::logger;
 use std::{collections::HashMap, sync::Arc};
 
+use crate::{configuration::ConfigParameters, utils::ExpanderUtils};
 use mithril_client::ClientBuilder;
-use mithril_client_cli::{configuration::ConfigParameters, utils::ExpanderUtils};
 use mithril_common::{test_utils::fake_keys, StdResult};
 
 /// Clap command to show a given snapshot

mithril-client-cli/src/commands/snapshot/show.rs

@@ -24,6 +24,7 @@ impl ConfigParameters {
     }
 
     /// Useful constructor for testing
+    #[cfg(test)]
     pub fn build(parameters: &[(&str, &str)]) -> Self {
         let parameters = parameters
             .iter()
@@ -34,6 +35,7 @@ impl ConfigParameters {
     }
 
     /// Add or replace a parameter in the holder
+    #[cfg(test)]
     pub fn add_parameter(&mut self, name: &str, value: &str) -> &mut Self {
         let _ = self.parameters.insert(name.to_string(), value.to_string());
 

mithril-client-cli/src/configuration.rs

@@ -1,2 +1,12 @@
-pub mod configuration;
-pub mod utils;
+#![warn(missing_docs)]
+
+//! A command line interface that uses the [Mithril Client Library](https://mithril.network/doc/manual/developer-docs/nodes/mithril-client-library)
+//! to manipulate Mithril certified types from a Mithril Aggregator:
+//! * Snapshots: List, Show, download and verify
+//! * Mithril Stake Distribution: List, download and verify
+//
+//! You can find more information on how it works reading the [documentation website](https://mithril.network/doc/mithril/mithril-network/client).
+
+pub mod commands;
+mod configuration;
+mod utils;