This repository was archived by the owner on Nov 17, 2020. It is now read-only.
Highlight leading and trailing white space in names #721
Conversation
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
Queue and exchange names, for now. Currently leading and trailing whitespace in names is very difficult to spot as both management UI and CLI tools do not highlight whitespace in names in any way. Names with leading and trailing whitespace are always a mistake and cause confusion. In a recent support case they wasted quite a bit of time.
michaelklishin
changed the title
|
Self-QA'ing and merging as this was demoed to and discussed with the entire team during this week's retro. |
Instead of replacing the entire group of characters with a single block. While at it, highlight all tab spaces separately, even in the middle. Unlike spaces, tabs in the middle of a name were likely used by mistake.
michaelklishin
added a commit
that referenced
this pull request
Jul 21, 2019
…whitespace-in-names Highlight leading and trailing white space in names (cherry picked from commit 93dba6c)
michaelklishin
deleted the
highlight-leading-and-trailing-whitespace-in-names
branch
|
Backported to |
|
Small issue in the exchange details link, fixed in 3c89ba5, backported to |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Proposed Changes
Names with leading and trailing white space are almost always
a mistake and cause confusion. In a recent support
case they wasted quite a bit of time.
Currently leading and trailing white space in names is very difficult to spot as both management UI
and CLI tools do not highlight white space in names in any way.
This introduces highlighting of leading and trailing white space in queue and exchange names.
Only leading and trailing white spaces, new line characters, vertical tabs and other matches of
\sare highlighted, each with a highlighting character. Tabs are highlighted everywhere in the name,including in the middle. This assumes that tabs are only used in names by mistake (unlike spaces).
The highlighting character is chosen to be the
⎵character (Unicode character code:U+23B5) per discussion with the team: it is quite visible on all kinds of screens and would be more obvious than·(U+00B7) and some other options used by developer-oriented tools.Here's an excellent thread that discusses various options.
This screenshot provides a rough idea of what it looks like:
Types of Changes
Checklist
CONTRIBUTING.mddocumentFurther Comments
[#167415546]