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

README: Show which rules have options, and which are fixable #289

Merged
merged 1 commit into from
Oct 22, 2021

Conversation

edg2s
Copy link
Member

@edg2s edg2s commented Oct 22, 2021

No description provided.

@codecov
Copy link

codecov bot commented Oct 22, 2021

Codecov Report

Merging #289 (aacd3cf) into master (dbf3b90) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #289   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          102       102           
  Lines          607       607           
=========================================
  Hits           607       607           

@@ -81,11 +81,14 @@ The following global settings can be used under the `no-jquery` property to conf

## 📖 Rules

Where rules are included in the configs `recommended`, `slim`, `all` or `deprecated-X.X` it is indicated below. Where rules are included with options this is indicated with a `†`.
Rules with options are indicated with ⚙️. Rules which are fixable are indicated with 🔧.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quote this with `s like we do on the next line for †.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dagger is escaped because it becomes part of the config label: slim† and the escaping allows us to show the multi-character label as one graphical item. The emoji don't need this, it would just add a pointless background: 🔧

Copy link
Member Author

@edg2s edg2s Oct 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It also messes up the emoji rendering of the gear: ⚙️ vs ⚙️

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They all look terrible to me (possibly an artefact of me using GItHub dark mode?).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

jdforrester
jdforrester previously approved these changes Oct 22, 2021
@jdforrester jdforrester merged commit abca2a2 into master Oct 22, 2021
@jdforrester jdforrester deleted the rule-list branch October 22, 2021 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants