Skip to content

Add ParsableArguments#_errorPrefix to allow a more-customized error prefix than ParsableArguments#_errorLabel #837

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
rgoldberg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add ParsableArguments#_errorPrefix to allow a more-customized error prefix than ParsableArguments#_errorLabel #837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions Sources/ArgumentParser/Parsable Types/ParsableArguments.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,15 @@ public protocol ParsableArguments: Decodable, _SendableMetatype {
mutating func validate() throws

/// The label to use for "Error: ..." messages from this type (experimental).
///
/// Can be ignored if `_errorPrefix`'s is changed.
@available(*, deprecated, message: "Use _errorPrefix instead.")
static var _errorLabel: String { get }

/// The prefix to use for "Error: ..." messages from this type (experimental).
///
/// Defaults to `"\(_errorLabel): "`.
static var _errorPrefix: String { get }
}

/// A type that provides the `ParsableCommand` interface to a `ParsableArguments` type.
Expand Down Expand Up @@ -60,6 +68,13 @@ extension ParsableArguments {
public static var _errorLabel: String {
"Error"
}

/// The prefix to use for "Error: ..." messages from this type (experimental).
///
/// Defaults to `"\(_errorLabel): "`.
public static var _errorPrefix: String {
"\(_errorLabel): "
}
}

// MARK: - API
Expand Down
4 changes: 2 additions & 2 deletions Sources/ArgumentParser/Usage/MessageInfo.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,10 @@ enum MessageInfo {
case .validation(let message, let usage, let help):
let helpMessage = help.isEmpty ? "" : "Help: \(help)\n"
let errorMessage =
message.isEmpty ? "" : "\(args._errorLabel): \(message)\n"
message.isEmpty ? "" : "\(args._errorPrefix)\(message)\n"
return errorMessage + helpMessage + usage
case .other(let message, _):
return message.isEmpty ? "" : "\(args._errorLabel): \(message)"
return message.isEmpty ? "" : "\(args._errorPrefix)\(message)"
}
}

Expand Down