Include the list of rules used in the readme about stylelint-config-standard HOT 4 CLOSED

Whatever you think is best! I just wanted to raise the question, but defer.

from stylelint-config-standard.

We list all the rules that aren't used within the README - you can use this list to quickly find additional rules to extend the config.

The rules and options used are in JSON here.

Having said that, this is the 2nd request in as many days to document the rules used. As such, @vigneshTheDev would you be willing to contribute a list of rules that also states how each is configured (similar to how the stylelint-config-primer does it.)? I think that would be more useful than just linking through to the rule.

e.g.

At-rule

• at-rule-name-case: At-rules must be in written in lowercase.

Color

• color-hex-case: Hex colors must be written in lowercase.
• color-hex-length: Hex colors must, where available, use shorthand notation.

Declaration

• declaration-empty-line-before: There must be an empty line before each declaration unless the declaration is preceded by a comment, declaration or opening brace, or is inside a single line block. If the declaration is preceded by a comment or declaration then there must be no empty line. If it is preceded by an opening brace or is inside a single line block then it is ignored.

That last one is quite verbose as the secondary option for the rule is configured with four conditionals:

"declaration-empty-line-before": [ "always", {
      "except": [
        "after-declaration",
        "first-nested",
      ],
      "ignore": [
        "after-comment",
        "inside-single-line-block",
      ],
    } ],

from stylelint-config-standard.

@jeddy3 Do you really think this is worth the maintenance? The JSON itself is very legible. Maybe we just need a more clear explanation in the README that "To see the rules that this config uses, please read the config itself."

from stylelint-config-standard.

Do you really think this is worth the maintenance?

I was in two minds about this. I definitely don't think it's worth our time writing the original list, but if someone else wants to contribute it then I think it adds some value (if only if that's being able to click through to a rule's documentation). I think the on going maintenance once the list is done would be pretty minimal, but then again it does add something to our overhead.

"To see the rules that this config uses, please read the config itself."

This works for me. We can try this for now and revisit writing a list later down the line.

from stylelint-config-standard.