test: long (--help) help message and default values l10n

Author: Sk7Str1p3

locales/build.rs

@@ -66,45 +66,45 @@ pub fn generate_consts(out: &String) -> Result<(), Box<dyn std::error::Error>> {
     for key in &keys {
         let parts: Vec<&str> = key.split('-').collect();
         let const_name = parts.last().unwrap().to_uppercase();
-        
+
         let mut current = &mut root;
-        
+
         // Проходим по всем частям пути (кроме последней)
         for part in parts.iter().take(parts.len() - 1) {
             current = current
                 .submodules
                 .entry(part.to_string())
                 .or_insert_with(Module::default);
         }
-        
+
         // Добавляем константу
         current.constants.push((const_name, key.clone()));
     }
 
     // Рекурсивная генерация кода
     fn generate_tree(module: &Module) -> proc_macro2::TokenStream {
         let mut items = Vec::new();
-        
+
         // Добавляем константы текущего модуля
         for (const_name, const_value) in &module.constants {
             let const_ident = format_ident!("{}", const_name);
             items.push(quote! {
                 pub const #const_ident: &str = #const_value;
             });
         }
-        
+
         // Добавляем подмодули
         for (mod_name, submodule) in &module.submodules {
             let mod_ident = format_ident!("{}", mod_name);
             let submodule_code = generate_tree(submodule);
-            
+
             items.push(quote! {
                 pub mod #mod_ident {
                     #submodule_code
                 }
             });
         }
-        
+
         quote! { #(#items)* }
     }
 

locales/en-US/cli.ftl

@@ -4,7 +4,10 @@ cli-usage-header = Usage
 cli-arguments-header = Arguments
 cli-arguments-input = Run as if onefetch was started in <input> instead of the current working directory
 cli-options-header = Options
-cli-options-help = Print help (see more with '--help', see a summary with '-h')
+cli-options-help = Print help { $short ->
+    [true] (see more with '--help')
+    *[false] (see a summary with '-h')
+}
 cli-options-version = Print version
 
 # Value name
@@ -28,10 +31,23 @@ cli-value-shell = SHELL
 cli-info-heading = INFO
 cli-info-disabled_fields = Allows you to disable FIELD(s) from appearing in the output
 cli-info-no_title = Hides the title
-cli-info-number_of_authors = Maximum NUM of authors to be shown
-cli-info-number_of_languages = Maximum NUM of languages to be shown
-cli-info-number_of_file_churns = Maximum NUM of file churns to be shown
-cli-info-churn_pool_size = 
+cli-info-number_of_authors-short = Maximum NUM of authors to be shown (default: {$def})
+cli-info-number_of_authors-long = 
+    Maximum NUM of authors to be shown 
+    
+    (default: {$def})
+cli-info-number_of_languages-short = Maximum NUM of languages to be shown (default: {$def})
+cli-info-number_of_languages-long = 
+    Maximum NUM of languages to be shown 
+
+    (default: {$def})
+cli-info-number_of_file_churns-short = Maximum NUM of file churns to be shown (default: {$def})
+cli-info-number_of_file_churns-long = 
+    Maximum NUM of file churns to be shown 
+    
+    (default: {$def})
+cli-info-churn_pool_size-short = Minimum NUM of commits from HEAD used to compute the churn summary
+cli-info-churn_pool_size-long =
     Minimum NUM of commits from HEAD used to compute the churn summary
 
     By default, the actual value is non-deterministic due to time-based computation
@@ -43,7 +59,12 @@ cli-info-email = Show the email address of each author
 cli-info-http_url = Display repository URL as HTTP
 cli-info-hide_token = Hide token in repository URL
 cli-info-include_hidden = Count hidden files and directories
-cli-info-type = Filters output by language type
+cli-info-tipe-short = Filters output by language type (default: ${def}) (possible values: {$pos})
+cli-info-tipe-long = 
+    Filters output by language type 
+    
+    (default: ${def}) 
+    (possible values: {$pos})
 
 # TEXT FORMATTING
 cli-text-heading = TEXT FORMATTING

locales/ru-RU/cli.ftl

@@ -4,7 +4,10 @@ cli-usage-header = Использование
 cli-arguments-header = Аргументы
 cli-arguments-input = Запустить так, как будто onefetch был запущен в <ввод> вместо текущего рабочего каталога
 cli-options-header = Опции
-cli-options-help = Показать помощь (подробнее с '--help', кратко с '-h')
+cli-options-help = Показать помощь { $short ->
+    [true] (подробнее с '--help')
+    *[false] (кратко с '-h')
+}
 cli-options-version = Показать версию
 
 # Value name
@@ -28,10 +31,23 @@ cli-value-shell = ОБОЛОЧКА
 cli-info-heading = ИНФОРМАЦИЯ
 cli-info-disabled_fields = Позволяет отключить отображение ПОЛЯ(ПОЛЕЙ) в выводе
 cli-info-no_title = Скрывает заголовок
-cli-info-number_of_authors = Максимальное КОЛ-ВО авторов для отображения
-cli-info-number_of_languages = Максимальное КОЛ-ВО языков для отображения
-cli-info-number_of_file-churns = Максимальное КОЛ-ВО изменений файлов для отображения
-cli-info-churn_pool_size = 
+cli-info-number_of_authors-short = Максимальное КОЛ-ВО авторов для отображения (по умолчанию: {$def})
+cli-info-number_of_authors-long = 
+    Максимальное КОЛ-ВО авторов для отображения 
+    
+    (по умолчанию: {$def})
+cli-info-number_of_languages-short = Максимальное КОЛ-ВО языков для отображения (по умолчанию: {$def})
+cli-info-number_of_languages-long = 
+    Максимальное КОЛ-ВО языков для отображения 
+
+    (по умолчанию: {$def})
+cli-info-number_of_file_churns-short = Максимальное КОЛ-ВО изменений файлов для отображения (по умолчанию: {$def})
+cli-info-number_of_file_churns-long = 
+    Максимальное КОЛ-ВО изменений файлов для отображения 
+    
+    (по умолчанию: {$def})
+cli-info-churn_pool_size-short = Минимальное КОЛ-ВО коммитов от HEAD, используемых для вычисления сводки изменений
+cli-info-churn_pool_size-long = 
     Минимальное КОЛ-ВО коммитов от HEAD, используемых для вычисления сводки изменений
 
     По умолчанию фактическое значение недетерминировано из-за вычислений на основе времени
@@ -43,7 +59,12 @@ cli-info-email = Показать адрес электронной почты 
 cli-info-http_url = Отображать URL репозитория как HTTP
 cli-info-hide_token = Скрыть токен в URL репозитория
 cli-info-include_hidden = Учитывать скрытые файлы и каталоги
-cli-info-type = Фильтровать вывод по типу языка
+cli-info-tipe-short = Фильтровать вывод по типу языка (по умолчанию: {$def}) (возможные значения: {$pos})
+cli-info-tipe-long = 
+    Фильтровать вывод по типу языка
+
+    (по умолчанию: {$def}) 
+    (возможные значения: {$pos})
 
 # TEXT FORMATTING
 cli-text-heading = ФОРМАТИРОВАНИЕ ТЕКСТА

src/cli.rs

@@ -1,10 +1,11 @@
-use crate::tr;
+use crate::i18n::locale_keys::cli::*;
 use crate::info::langs::language::{Language, LanguageType};
 use crate::info::utils::info_field::InfoType;
+use crate::tr;
 use crate::ui::printer::SerializationFormat;
 use anyhow::Result;
-use clap::builder::{PossibleValuesParser, Styles};
 use clap::builder::TypedValueParser as _;
+use clap::builder::{PossibleValuesParser, Styles};
 use clap::{value_parser, Args, Command, Parser, ValueHint};
 use clap_complete::{generate, Generator, Shell};
 use num_format::CustomFormat;
@@ -17,11 +18,27 @@ use std::io;
 use std::path::PathBuf;
 use std::str::FromStr;
 use strum::IntoEnumIterator;
-use crate::i18n::locale_keys::cli::*;
 
 const COLOR_RESOLUTIONS: [&str; 5] = ["16", "32", "64", "128", "256"];
 pub const NO_BOTS_DEFAULT_REGEX_PATTERN: &str = r"(?:-|\s)[Bb]ot$|\[[Bb]ot\]";
 
+// TODO: check if short help requested more efficiently
+use std::sync::LazyLock;
+static IS_SHORT: LazyLock<bool> = LazyLock::new(|| {
+    let args = std::env::args();
+    let mut v = false;
+    for value in args {
+        if value == "-h" {
+            v = true;
+            break;
+        } else if value == "--help" {
+            break;
+        } else {
+        }
+    }
+    v
+});
+
 #[derive(Clone, Debug, Parser, PartialEq, Eq)]
 #[command(
     about = tr!(ABOUT),
@@ -33,7 +50,7 @@ pub const NO_BOTS_DEFAULT_REGEX_PATTERN: &str = r"(?:-|\s)[Bb]ot$|\[[Bb]ot\]";
         \n{}{}:{} {{usage}}
         \n{{all-args}}{{after-help}}\
         ", 
-        Styles::default().get_usage().render(), 
+        Styles::default().get_usage().render(),
         tr!(usage::HEADER),
         Styles::default().get_usage().render_reset()
     ),
@@ -43,25 +60,25 @@ pub const NO_BOTS_DEFAULT_REGEX_PATTERN: &str = r"(?:-|\s)[Bb]ot$|\[[Bb]ot\]";
 pub struct CliOptions {
     #[arg(
         default_value = ".", 
-        hide_default_value = true, 
+        hide_default_value = true,
         value_hint = ValueHint::DirPath,
         help = tr!(arguments::INPUT),
         value_name = tr!(value::INPUT)
     )]
     pub input: PathBuf,
     #[arg(
-        action = clap::ArgAction::Help,
+        action = if *IS_SHORT { clap::ArgAction::HelpShort } else { clap::ArgAction::HelpLong },
         long,
-        short, 
-        help = tr!(options::HELP),
+        short,
+        help = tr!(options::HELP, short => &*IS_SHORT),
         help_heading = tr!(options::HEADER)
     )]
     pub help: Option<bool>,
     #[arg(
         action = clap::ArgAction::Version,
-        long, 
-        short = 'V', 
-        help = tr!(options::VERSION), 
+        long,
+        short = 'V',
+        help = tr!(options::VERSION),
         help_heading = tr!(options::HEADER)
     )]
     pub version: Option<bool>,
@@ -96,13 +113,32 @@ pub struct InfoCliOptions {
     pub disabled_fields: Vec<InfoType>,
     #[arg(long, help = tr!(info::NO_TITLE))]
     pub no_title: bool,
-    #[arg(long, default_value_t = 3usize, value_name = tr!(value::NUM), help = tr!(info::NUMBER_OF_AUTHORS))]
+    #[arg(long, default_value_t = 3usize, value_name = tr!(value::NUM), hide_default_value = true)]
+    #[arg(
+        help = tr!(info::number_of_authors::SHORT, def => 3),
+        long_help = tr!(info::number_of_authors::LONG, def => 3),
+        hide_default_value = true
+    )]
     pub number_of_authors: usize,
-    #[arg(long, default_value_t = 6usize, value_name = tr!(value::NUM), help = tr!(info::NUMBER_OF_LANGUAGES))]
+    #[arg(long, default_value_t = 6usize, value_name = tr!(value::NUM))]
+    #[arg(
+        help = tr!(info::number_of_languages::SHORT, def => 6),
+        long_help = tr!(info::number_of_languages::LONG, def => 6),
+        hide_default_value = true
+    )]
     pub number_of_languages: usize,
-    #[arg(long, default_value_t = 3usize, value_name = tr!(value::NUM), help = tr!(info::NUMBER_OF_FILE_CHURNS))]
+    #[arg(long, default_value_t = 3usize, value_name = tr!(value::NUM))]
+    #[arg(
+        help = tr!(info::number_of_file_churns::SHORT, def => 3),
+        long_help = tr!(info::number_of_file_churns::LONG, def => 3),
+        hide_default_value = true
+    )]
     pub number_of_file_churns: usize,
-    #[arg(long, value_name = tr!(value::NUM), help = tr!(info::CHURN_POOL_SIZE))]
+    #[arg(long, value_name = tr!(value::NUM))]
+    #[arg(
+        help = tr!(info::churn_pool_size::SHORT),
+        long_help = tr!(info::churn_pool_size::LONG)
+    )]
     pub churn_pool_size: Option<usize>,
     #[arg(long, short, num_args = 1.., help = tr!(info::EXCLUDE), value_name = tr!(value::EXCLUDE))]
     pub exclude: Vec<String>,
@@ -132,7 +168,12 @@ pub struct InfoCliOptions {
         default_values = &["programming", "markup"],
         short = 'T',
         value_enum,
-        help = tr!(info::TYPE)
+    )]
+    #[arg(
+        help = tr!(info::tipe::SHORT, def => "programming, markup", pos => "programming, markup, prose, data"),
+        long_help = tr!(info::tipe::LONG, def => "programming, markup", pos => "programming, markup, prose, data"),
+        hide_default_value = true,
+        hide_possible_values = true,
     )]
     pub r#type: Vec<LanguageType>,
 }
@@ -165,7 +206,7 @@ pub struct AsciiCliOptions {
 }
 
 #[derive(Clone, Debug, Args, PartialEq, Eq)]
-#[command(next_help_heading = image::HEADING)]
+#[command(next_help_heading = tr!(image::HEADING))]
 pub struct ImageCliOptions {
     #[arg(long, short, value_name = tr!(value::IMAGE), value_hint = ValueHint::FilePath, help = tr!(image::IMAGE))]
     pub image: Option<PathBuf>,
@@ -177,7 +218,7 @@ pub struct ImageCliOptions {
         requires = "image",
         default_value_t = 16usize,
         value_parser = PossibleValuesParser::new(COLOR_RESOLUTIONS)
-            .map(|s| s.parse::<usize>().unwrap()), 
+            .map(|s| s.parse::<usize>().unwrap()),
         help = tr!(image::COLOR_RESOLUTION)
     )]
     pub color_resolution: usize,
@@ -186,7 +227,6 @@ pub struct ImageCliOptions {
 #[derive(Clone, Debug, Args, PartialEq, Eq)]
 #[command(next_help_heading = tr!(text::HEADING))]
 pub struct TextForamttingCliOptions {
-
     #[arg(
         long,
         short,

src/lib.rs

@@ -1,5 +1,5 @@
 // Lib is present to allow for benchmarks and integration tests
 pub mod cli;
+pub mod i18n;
 pub mod info;
 pub mod ui;
-pub mod i18n;

src/main.rs

@@ -17,10 +17,12 @@ fn main() -> Result<()> {
     #[cfg(windows)]
     enable_ansi_support::enable_ansi_support()?;
 
-    let cli_options = cli::CliOptions::try_parse().map_err(|e| {
-        let e = e.apply::<ClapI18nRichFormatter>();
-        e.exit()
-    }).unwrap();
+    let cli_options = cli::CliOptions::try_parse()
+        .map_err(|e| {
+            let e = e.apply::<ClapI18nRichFormatter>();
+            e.exit()
+        })
+        .unwrap();
 
     if cli_options.other.languages {
         return cli::print_supported_languages();