chore(cli): prepare for publishing

Author: ckrenslehner

Cargo.lock

@@ -15,10 +15,7 @@ bpaf = { version = "0.9", features = ["derive"] }
 env_logger = "0.11.5"
 indicatif = "0.17.9"
 indicatif-log-bridge = "0.2.3"
-stm32cubeprogrammer = { path = "../stm32cubeprogrammer", features = [
-    "serde",
-    "validations",
-] }
+stm32cubeprogrammer = { version = "0.1.0", features = ["serde", "validations"] }
 dotenvy.workspace = true
 log.workspace = true
 anyhow = "1.0.94"

stm32cubeprogrammer-cli/Cargo.toml

@@ -11,7 +11,6 @@ This CLI aims to provide a simple interface for setting up stm32 targets.
 - Resetting target
 
 All commands above can be combined in a single command line invocation by chaining them.
-
 If you need other commands, feel free to open an issue or a pull request. :smile:
 
 ## Example usage:
@@ -26,7 +25,7 @@ You can also pass the directory to the STM32CubeProgrammer installation using th
 ```sh
 STM32_CUBE_PROGRAMMER_DIR=`installation_dir` stm32cubeprogrammer-cli reset
 ```
-You can chain the different supported commands.
+You can chain multiple commands together.
 ```sh
 STM32_CUBE_PROGRAMMER_DIR=`installation_dir` stm32cubeprogrammer-cli unprotect reset flash-hex `path_to_hex_file` protect
 ```
@@ -36,10 +35,14 @@ Use the `--list` flag to list available probes.
 stm32cubeprogrammer-cli --stm32-cube-programmer-dir `installation_dir` --list
 ```
 
-Use `--help` to see all available options.
+Use `--help` to see all supported commands and options (or see [`crate::parse::Options`])
 ```sh
 stm32cubeprogrammer-cli --help
 ```
+## CLI output
+The CLI outputs a JSON object (see [`crate::output::Output`]) which contains information about the selected probe, general information about the target, and the output of each command.
+The output is printed to stdout.
+
 ## Requirements
 There needs to be a Stm32CubeProgrammer installation on your system. The crates are tested using Stm32CubeProgrammer version 2.18.0.
 

stm32cubeprogrammer-cli/README.md

@@ -9,7 +9,6 @@
 //! - Resetting target
 //!
 //! All commands above can be combined in a single command line invocation by chaining them.
-//!
 //! If you need other commands, feel free to open an issue or a pull request. :smile:
 //!
 //! # Example usage:
@@ -24,7 +23,7 @@
 //! ```sh
 //! STM32_CUBE_PROGRAMMER_DIR=`installation_dir` stm32cubeprogrammer-cli reset
 //! ```
-//! You can chain the different supported commands.
+//! You can chain multiple commands together.
 //! ```sh
 //! STM32_CUBE_PROGRAMMER_DIR=`installation_dir` stm32cubeprogrammer-cli unprotect reset flash-hex `path_to_hex_file` protect
 //! ```
@@ -34,10 +33,14 @@
 //! stm32cubeprogrammer-cli --stm32-cube-programmer-dir `installation_dir` --list
 //! ```
 //!
-//! Use `--help` to see all available options.
+//! Use `--help` to see all supported commands and options (or see [`crate::parse::Options`])
 //! ```sh
 //! stm32cubeprogrammer-cli --help
 //! ```
+//! # CLI output
+//! The CLI outputs a JSON object (see [`crate::output::Output`]) which contains information about the selected probe, general information about the target, and the output of each command.
+//! The output is printed to stdout.
+//!
 //! # Requirements
 //! There needs to be a Stm32CubeProgrammer installation on your system. The crates are tested using Stm32CubeProgrammer version 2.18.0.
 //!
@@ -264,7 +267,7 @@ fn main_inner() -> Result<crate::output::Output, anyhow::Error> {
     if options
         .target_commands
         .iter()
-        .any(|command| matches!(command, parse::TargetCommand::UpdateBleStack(_)))
+        .any(|command| matches!(command, parse::TargetCommand::BleUpdate(_)))
         && !programmer_connection
             .connection()?
             .general_information()
@@ -310,7 +313,7 @@ fn main_inner() -> Result<crate::output::Output, anyhow::Error> {
 
                 output::CommandOutput::FlashHex { file }
             }
-            parse::TargetCommand::UpdateBleStack(ble_stack_info) => {
+            parse::TargetCommand::BleUpdate(ble_stack_info) => {
                 log::info!("Update BLE stack: {}", ble_stack_info);
 
                 display_handler
@@ -363,7 +366,7 @@ fn main_inner() -> Result<crate::output::Output, anyhow::Error> {
                         .unwrap_or(output::BleStackUpdated::NotUpdated),
                 }
             }
-            parse::TargetCommand::BleStackInfo { compare } => {
+            parse::TargetCommand::BleInfo { compare } => {
                 display_handler
                     .lock()
                     .unwrap()

stm32cubeprogrammer-cli/src/main.rs

@@ -4,13 +4,13 @@ use std::env::ArgsOs;
 #[derive(Debug, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Output {
-    schema_version: String,
-    args: String,
-    cube_programmer_dir: std::path::PathBuf,
-    connected_probes: Option<Vec<stm32cubeprogrammer::probe::Serial>>,
-    selected_probe: Option<stm32cubeprogrammer::probe::Serial>,
-    general_information: Option<stm32cubeprogrammer::api_types::GeneralInformation>,
-    command_output: Option<Vec<CommandOutput>>,
+    pub schema_version: String,
+    pub args: String,
+    pub cube_programmer_dir: std::path::PathBuf,
+    pub connected_probes: Option<Vec<stm32cubeprogrammer::probe::Serial>>,
+    pub selected_probe: Option<stm32cubeprogrammer::probe::Serial>,
+    pub general_information: Option<stm32cubeprogrammer::api_types::GeneralInformation>,
+    pub command_output: Option<Vec<CommandOutput>>,
 }
 
 impl Output {

stm32cubeprogrammer-cli/src/output.rs

@@ -2,7 +2,7 @@ use bpaf::*;
 use stm32cubeprogrammer::utility::HexAddress;
 
 #[derive(Debug, Clone, Bpaf)]
-#[bpaf(options)]
+#[bpaf(options, version)]
 /// Overall arguments for CLI
 /// Note: Be careful with duplicate short or long flag names in the subcommands and the parent struct
 pub struct Options {
@@ -58,11 +58,11 @@ pub enum TargetCommand {
 
     #[bpaf(command, adjacent)]
     /// Update the BLE stack on the target
-    UpdateBleStack(#[bpaf(external(ble_stack_info))] BleStackInfo),
+    BleUpdate(#[bpaf(external(ble_stack_info))] BleStackInfo),
 
-    /// Read BLE stack information
+    /// Read BLE stack information from the target and optionally compare the target version with a given version
     #[bpaf(command, adjacent)]
-    BleStackInfo {
+    BleInfo {
         #[bpaf(long, fallback(None))]
         /// The flash address in format 0x123 or 0X123 where file should be written
         compare: Option<stm32cubeprogrammer::fus::Version>,
@@ -235,24 +235,13 @@ mod test {
 
     #[test]
     fn parse_multi() {
+        std::env::set_var("STM32_CUBE_PROGRAMMER_DIR", "some/dir");
+
+        let command =
+            "unprotect ble-update --file stack.bin --address 0x123 flash-bin --file app.bin --address 0x456 protect reset";
+
         let value = options()
-            .run_inner(&[
-                "--stm32-cube-programmer-dir",
-                "some/dir",
-                "unprotect",
-                "update-ble-stack",
-                "--file",
-                "stack.bin",
-                "--address",
-                "0x123",
-                "flash-bin",
-                "--file",
-                "app.bin",
-                "--address",
-                "0x456",
-                "protect",
-                "reset",
-            ])
+            .run_inner(command.split(' ').collect::<Vec<_>>().as_slice())
             .unwrap();
 
         println!("{:?}", value);
@@ -261,7 +250,7 @@ mod test {
             value.target_commands,
             vec![
                 TargetCommand::Unprotect,
-                TargetCommand::UpdateBleStack(BleStackInfo {
+                TargetCommand::BleUpdate(BleStackInfo {
                     file: std::path::PathBuf::from("stack.bin"),
                     address: HexAddress(0x123),
                     version: None,