-
Notifications
You must be signed in to change notification settings - Fork 3
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.
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
[#226] Change error message formatting #307
base: master
Are you sure you want to change the base?
Conversation
Generated by 🚫 Danger |
4c2306b
to
be889c2
Compare
be889c2
to
7189218
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some changes look a bit subjective, but I can't say I'm strongly against anything, so let me approve. @Martoon-00 may review this week, let's give him a chance as well.
Looks good, I see why these changes are reasonable and agree. One concern: after merging error message for every single reference into one block, discrepancies in indentation became more apparent:
Maybe these are worth changing to look uniform. WDYT? |
Agreed, I'll try to change the phrasing further to avoid this issue. |
0934d6e
to
3d5eab1
Compare
I've pushed a change, @Martoon-00 would you be so kind to take another look? This time indentation should be consistent. Also I've modified the scanner so that all positions include the filename. |
69f6e3f
to
5dab3a9
Compare
Problem: multiple issues with the CLI output 1. In the --help output, metavars GLOB_PATTERN and REPOSITORY_TYPE used spaces instead of underscores. Variables typically don't contain spaces in their names, so it looked confusing. 2. Incorrect or unintuitive coloring of the output. For example, filenames were dim even though they're important and should stand out, the report of success wasn't green, error messages weren't red, etc. 3. Excessive indentation and empty lines that made it difficult to visually parse the error report. Also the use of the exotic '➥' character that looks bad in many font configurations. 4. Filenames and line numbers were far apart, making it impossible to Ctrl+Click to jump to the source of the error. 5. In case of connection failure, the output was too verbose and platform-dependent. Solution: 1. Include the filename in positions returned by the scanner. 2. Adjust the pretty-printing functions and update test output. 3. Extend VerifyError with a constructor for connection failures.
5dab3a9
to
5dd0139
Compare
Description
Problem: multiple issues with the CLI output
--help
output, metavarsGLOB_PATTERN
andREPOSITORY_TYPE
used spaces instead of underscores. Variables typically don't contain spaces in their names, so it looked confusing.➥
character that looks bad in many font configurations.Solution:
VerifyError
with a constructor for connection failures.Related issue(s)
Fixes #226.
✅ Checklist
Related changes (conditional)
Tests
silently reappearing again.
Documentation
Public contracts
of Public Contracts policy.
and
Stylistic guide (mandatory)
✓ Release Checklist
package.yaml
.under the "Unreleased" section to a new section for this release version.
vX.Y.Z
.xrefcheck-action
.