Skip to content

A slightly more customizable implementation of HelpFormatter #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

A slightly more customizable implementation of HelpFormatter #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d05aca1
added a customizable helpMessage String val to the interface HelpForm…
kikulacho92 Oct 7, 2025
512ffad
I have added a new String immutable property in HelpFormatter to make…
kikulacho92 Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/kotlin/com/xenomachina/argparser/ArgParser.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ class ArgParser(
if (helpFormatter != null) {
option<Unit>("-h", "--help",
errorName = "HELP", // This should never be used, but we need to say something
help = "show this help message and exit") {
help = helpFormatter.helpMessage) { //now this message is customizable
throw ShowHelpException(helpFormatter, delegates.toList())
}.default(Unit).registerRoot()
}
Expand Down
2 changes: 2 additions & 0 deletions src/main/kotlin/com/xenomachina/argparser/DefaultHelpFormatter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ class DefaultHelpFormatter(
val indent = " "
val indentWidth = indent.codePointWidth()

override value helpMessage = "show this help message and exit"

override fun format(
programName: String?,
columns: Int,
Expand Down
5 changes: 5 additions & 0 deletions src/main/kotlin/com/xenomachina/argparser/HelpFormatter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ package com.xenomachina.argparser
* Formats help for an [ArgParser].
*/
interface HelpFormatter {

/**
* The help message added automatically with the options -h, --help
*/
val helpMessage: String
/**
* Formats a help message.
*
Expand Down