Uppercase only the first rune of CLI error messages#206
Closed
yummybomb wants to merge 1 commit into
Closed
Conversation
fang's default ErrorText transform title-cases the entire first word,
which mangles errors that start with a path or identifier ("/tmp/out.gz
already exists" rendered as "/Tmp/Out.gz already exists"). Replace the
transform with one that uppercases only the first rune, preserving
sentence casing for lowercase errors while leaving paths and flags
untouched.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
fang's default
ErrorTextstyle applies atitleFirstWordtransform that runscases.Titleover the first whitespace-delimited word of an error message.cases.Titlecapitalizes after every unicode word boundary inside the token (/and-included), so any error that begins with a path or identifier gets mangled:This replaces the transform in our error handler with one that uppercases only the first rune of the message:
unknown flag: --foo→Unknown flag: --foo(sentence casing preserved)/tmp/out.jsonl.gz already exists→ unchanged--start must be before --end→ unchangedTest plan
go test ./cmd(includes newTestUpperFirstunit test)go vet ./...kernel browsers --bogus-flagrendersUnknown flag: --bogus-flag