strips/jaarg
2
0
Fork 0
mirror of https://github.com/gay-pizza/jaarg.git synced 2025-12-19 07:20:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Restrict scope of automatic usage hint in standard error writer, so the default behaviour is less spammy

Browse Source
This commit is contained in:
a dinosaur
2025-11-06 02:29:06 +11:00
parent e26f4c933b
commit 304e12bd8e
1 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
jaarg/src/help.rs
View File

@@ -209,18 +209,21 @@ impl<ID> core::fmt::Display for StandardErrorUsageWriter<'_, ID> {
// Write error
writeln!(f, "{name}: {error}", name=self.0.program_name, error = self.0.error)?;
// Write usage
writeln!(f, "{}", StandardShortUsageWriter::new(HelpWriterContext {
options: self.0.options,
program_name: self.0.program_name
}))?;
// Provide usage hint for missing required arguments
if matches!(self.0.error, ParseError::RequiredPositional(_) | ParseError::RequiredParameter(_)) {
// Write short usage
writeln!(f, "{}", StandardShortUsageWriter::new(HelpWriterContext {
options: self.0.options,
program_name: self.0.program_name
}))?;
// Write full help instruction if a
if let Some(help_option) = self.0.options.help_option() {
writeln!(f, "Run '{name} {help}' to view all available options.",
name = self.0.program_name,
// Prefer long name, but otherwise any name is fine
help = help_option.first_long_name().unwrap_or(help_option.first_name()))?;
// Write full help instruction if available
if let Some(help_option) = self.0.options.help_option() {
writeln!(f, "Run '{name} {help}' to view all available options.",
name = self.0.program_name,
// Prefer long name, but otherwise any name is fine
help = help_option.first_long_name().unwrap_or(help_option.first_name()))?;
}
}
Ok(())
}