validate -> check

README.md

@@ -85,12 +85,12 @@ You can also specify the revision to update to, but this feature is for developm
 fishctl config update v1
 ```
 
-### Validate the config files
+### Check the config files
 
-Execute the following command to validate the config files.
+Execute the following command to check if the config files are valid:
 
 ```sh
-fishctl config validate
+fishctl config check
 ```
 
 Please note that some items are only formally checked. Even if the output says it is valid, your settings can be incorrect.
@@ -98,7 +98,7 @@ Please note that some items are only formally checked. Even if the output says i
 This command performs a connection check against the PostgreSQL server and the cache server (Valkey/Redis). You can bypass this check using the `--offline` option:
 
 ```sh
-fishctl config validate --offline
+fishctl config check --offline
 ```
 
 ### Generate VAPID keys for push notifications

fishctl/src/command/config.rs

@@ -1,7 +1,7 @@
 //! `config` subcommand
 
+mod check;
 mod update;
-mod validate;
 
 use crate::config::{Revision, CLIENT_CONFIG_PATH, SERVER_CONFIG_PATH};
 use clap::Subcommand;
@@ -14,15 +14,14 @@ use std::{
 
 #[derive(Subcommand)]
 pub(crate) enum Commands {
-    /// Convert old config files to the new format
-    Update { revision: Option<Revision> },
-
-    /// Validate the config files
-    Validate {
+    /// Check the config files
+    Check {
         #[arg(short, long)]
         /// Do not perform connection checks against database and cache servers
         offline: bool,
     },
+    /// Update the config files to the latest revision (as of this fishctl release)
+    Update { revision: Option<Revision> },
 }
 
 /// Errors that can happen in `config` subcommand
@@ -31,13 +30,13 @@ pub(crate) enum ConfigError {
     #[error(transparent)]
     Update(#[from] update::UpdateError),
     #[error(transparent)]
-    Validate(#[from] validate::ValidationError),
+    Check(#[from] check::CheckError),
 }
 
 pub(super) async fn run(command: Commands, base_dir: &Path) -> Result<(), ConfigError> {
     match command {
         Commands::Update { revision } => update::run(revision, base_dir).await?,
-        Commands::Validate { offline } => validate::run(offline, base_dir).await?,
+        Commands::Check { offline } => check::run(offline, base_dir).await?,
     }
     Ok(())
 }

fishctl/src/command/config/check.rs

@@ -1,4 +1,4 @@
-//! `config validate` subcommand
+//! `config check` subcommand
 
 use super::*;
 use crate::config::{client, server, CLIENT_CONFIG_PATH, SERVER_CONFIG_PATH};
@@ -8,9 +8,9 @@ use sqlx::{postgres::PgConnectOptions, query, ConnectOptions};
 use std::path::Path;
 use validator::Validate;
 
-/// Errors that can happen in `config validate` subcommand
+/// Errors that can happen in `config check` subcommand
 #[derive(thiserror::Error, Debug)]
-pub(crate) enum ValidationError {
+pub(crate) enum CheckError {
     #[error(transparent)]
     ReadFile(#[from] std::io::Error),
     #[error(transparent)]
@@ -27,35 +27,32 @@ pub(crate) enum ValidationError {
     CacheServer,
 }
 
-pub(super) async fn run(
-    bypass_connection_checks: bool,
-    base_dir: &Path,
-) -> Result<(), ValidationError> {
+pub(super) async fn run(bypass_connection_checks: bool, base_dir: &Path) -> Result<(), CheckError> {
     if current_revision(base_dir)?.next().is_some() {
         cprintln!("Please first run `<bold>fishctl config update</>` to update your config files.");
-        return Err(ValidationError::OutOfDate);
+        return Err(CheckError::OutOfDate);
     }
 
-    let server_validation_result = match read_server_config_as::<server::Config>(base_dir) {
+    let server_check_result = match read_server_config_as::<server::Config>(base_dir) {
         Ok(config) => config.validate().map_err(|err| {
             cprintln!("<r!><bold>config/server.toml is invalid.</></>\n{}", err);
-            ValidationError::InvalidConfig
+            CheckError::InvalidConfig
         }),
         Err(ReadError::InvalidFormat(err)) => {
             cprintln!("<r!><bold>config/server.toml is invalid.</></>\n{}", err);
-            Err(ValidationError::InvalidConfig)
+            Err(CheckError::InvalidConfig)
         }
-        Err(ReadError::ReadFile(err)) => Err(ValidationError::ReadFile(err)),
+        Err(ReadError::ReadFile(err)) => Err(CheckError::ReadFile(err)),
     };
 
-    let client_validation_result = match read_client_config_as::<client::Config>(base_dir) {
+    let client_check_result = match read_client_config_as::<client::Config>(base_dir) {
         Ok(config) => config.validate().map_err(|err| {
             cprintln!(
                 "<r!><bold>{} is invalid.</></>\n{}",
                 CLIENT_CONFIG_PATH,
                 err
             );
-            ValidationError::InvalidConfig
+            CheckError::InvalidConfig
         }),
         Err(ReadError::InvalidFormat(err)) => {
             cprintln!(
@@ -63,21 +60,21 @@ pub(super) async fn run(
                 CLIENT_CONFIG_PATH,
                 err
             );
-            Err(ValidationError::InvalidConfig)
+            Err(CheckError::InvalidConfig)
         }
-        Err(ReadError::ReadFile(err)) => Err(ValidationError::ReadFile(err)),
+        Err(ReadError::ReadFile(err)) => Err(CheckError::ReadFile(err)),
     };
 
-    if server_validation_result.is_ok() && client_validation_result.is_ok() {
+    if server_check_result.is_ok() && client_check_result.is_ok() {
         cprintln!(
             "<g!><bold>{} and {} are valid!</></>",
             SERVER_CONFIG_PATH,
             CLIENT_CONFIG_PATH
         );
-        cprintln!("<bold>Note:</> This command only checks the format of the config files, and its result does not guarantee the correctness of the value.");
+        cprintln!("<bold>Note:</> Some items are only checked formally. This result does not guarantee the correctness of your settings.");
     }
 
-    if let Err(err) = server_validation_result.and(client_validation_result) {
+    if let Err(err) = server_check_result.and(client_check_result) {
         return Err(err);
     }
 
@@ -92,7 +89,7 @@ pub(super) async fn run(
     }
 }
 
-async fn check_database_connection(db: server::Database) -> Result<(), ValidationError> {
+async fn check_database_connection(db: server::Database) -> Result<(), CheckError> {
     let mut conn = PgConnectOptions::new()
         .host(&db.host)
         .port(db.port)
@@ -109,7 +106,7 @@ async fn check_database_connection(db: server::Database) -> Result<(), Validatio
 
 async fn check_cache_server_connection(
     cache_server: server::CacheServer,
-) -> Result<(), ValidationError> {
+) -> Result<(), CheckError> {
     let url = {
         let mut params = vec!["redis://".to_owned()];
 
@@ -133,6 +130,6 @@ async fn check_cache_server_connection(
 
     match pong.as_str() {
         "PONG" => Ok(()),
-        _ => Err(ValidationError::CacheServer),
+        _ => Err(CheckError::CacheServer),
     }
 }