rename check command to doctor

CHANGELOG.md

@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Replaced `log` by [`tracing`](https://crates.io/crates/tracing) for better log management.
 - Renamed `folder.filter` to `folder.filters` in order to match lib types.
 - Renamed `envelope.filter` to `envelope.filters` in order to match lib types.
+- Renamed `check` command to `doctor`.
 
 ## [0.1.0] - 2024-04-10
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "neverest"
-description = "CLI to synchronize and backup emails"
+description = "CLI to synchronize, backup and restore emails"
 version = "0.1.0"
 authors = ["soywod <[email protected]>"]
 edition = "2021"

src/account/command/check_up.rs → src/account/command/doctor.rs

@@ -1,4 +1,4 @@
-//! # Check up account command
+//! # Doctor account command
 //!
 //! This module contains the [`clap`] command for checking up left and
 //! right backends integrity of a given account.
@@ -26,15 +26,15 @@ use crate::{
 /// the configuration is valid, if backend can be created and if
 /// sessions work as expected.
 #[derive(Debug, Parser)]
-pub struct CheckUpAccountCommand {
+pub struct DoctorAccountCommand {
     #[command(flatten)]
     pub account: OptionalAccountNameArg,
 }
 
-impl CheckUpAccountCommand {
+impl DoctorAccountCommand {
     #[instrument(skip_all)]
     pub async fn execute(self, printer: &mut impl Printer, config: &Config) -> Result<()> {
-        info!("executing check up account command");
+        info!("executing doctor account command");
 
         let (name, config) = config.into_account_config(self.account.name.as_deref())?;
         printer.print_log(format!("Checking `{name}` account integrity…"))?;

src/account/command/mod.rs

@@ -5,6 +5,6 @@
 //! [`configure`] to configure secrets of a given account, and
 //! [`sync`] to synchronize two backends of a given account.
 
-pub mod check_up;
 pub mod configure;
+pub mod doctor;
 pub mod sync;

src/cli.rs

@@ -5,7 +5,7 @@ use tracing_subscriber::filter::LevelFilter;
 
 use crate::{
     account::command::{
-        check_up::CheckUpAccountCommand, configure::ConfigureAccountCommand,
+        configure::ConfigureAccountCommand, doctor::DoctorAccountCommand,
         sync::SynchronizeAccountCommand,
     },
     completion::command::GenerateCompletionCommand,
@@ -121,8 +121,8 @@ impl Cli {
 
 #[derive(Subcommand, Debug)]
 pub enum NeverestCommand {
-    #[command(alias = "check-up", alias = "checkup")]
-    Check(CheckUpAccountCommand),
+    #[command(alias = "check-up", alias = "checkup", visible_alias = "check")]
+    Doctor(DoctorAccountCommand),
 
     #[command(alias = "cfg")]
     Configure(ConfigureAccountCommand),
@@ -142,7 +142,7 @@ pub enum NeverestCommand {
 impl NeverestCommand {
     pub async fn execute(self, printer: &mut impl Printer, config_paths: &[PathBuf]) -> Result<()> {
         match self {
-            Self::Check(cmd) => {
+            Self::Doctor(cmd) => {
                 let config = Config::from_paths_or_default(config_paths).await?;
                 cmd.execute(printer, &config).await
             }