Skip to content
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

Use actual nbsp character instead of HTML entity when avoiding wrapping rule names in rules list #172

Merged
merged 1 commit into from
Oct 27, 2022

Conversation

bmish
Copy link
Owner

@bmish bmish commented Oct 26, 2022

Not a bug fix but more like a tweak with no user-facing behavior change.

Avoids excessively-long name column in markdown due to repeated   HTML entity as seen here: https://github.com/sindresorhus/eslint-plugin-unicorn/blob/7d804e3ce8ecb9d51b16d558eeae6dc12a81ec4c/readme.md?plain=1#L53

Non-breaking space character copied from here: https://unicode-table.com/en/00A0/

Idea suggested here: jsx-eslint/eslint-plugin-react#3469 (comment)

This is a follow-up to the original issue for avoiding wrapping rule names: #110.

The only downside I see is that it this non-breaking space can be indistinguishable from a regular space to many readers and could cause confusion. The HTML entity is more clear.

What do you think? Add thumbs up or thumbs down emoji to this PR.

CC: @ljharb @sindresorhus @fisker

@ljharb
Copy link

ljharb commented Oct 26, 2022

LGTM - it makes the raw markdown visually cleaner, and there's no user confusion issue since the doc generator will be creating it.

@bmish bmish merged commit fb307a0 into main Oct 27, 2022
@bmish bmish deleted the nbsp-char-name-col branch October 27, 2022 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants