Standardised messages and docs

[jeddy3]

What do you guys think about standardising the wording within the messages? They've diverged a little bit already.

The "Expected" approach that @davidtheclark's used in declaration-bang-space and in declaration-block-trailing-semicolon LGTM. It seems to be used a lot in eslint as well.

So, the current rules would look something like:

Note: always tending towards "expected" over "unexpected"...

• declaration-colon/bang-space: "Expected single space before "!"" and "Expected no space before "!"
• declaration-block-trailing-semicolon: "Expected a trailing semicolon" and "Expected no trailing semicolon"
• number-leading-zero: "Expected a leading zero for fractional value less than 1" and "Expected no leading zero for fractional value less than 1"

And "unexpected" would be mainly used for *-no-* rules e.g.

• declaration-no-important: "Unexpected !important"
• rule-set-no-single-line: "Unexpected single-line rule-set"

What do you think?

I'm still keen to keep the must always, must never, can, disallow, and enforce language in the documentation as I think it feels nice and clear. e.g. here and here.

Thoughts?

[davidtheclark]

Sounds good. One question: For e.g. number-leading-zero should the negative instead use "unexpected": "Unexpected leading zero for fractional value less than 1"??

[jeddy3]

One question: For e.g. number-leading-zero should the negative instead use "unexpected": "Unexpected leading zero for fractional value less than 1"??

Yeap, I had that same thought just after I clicked "Comment"! :)

That works for me if we make the other "always"|"never" rules consistent too e.g.

• declaration-colon/bang-space: "Expected single space before "!"" and "Unexpected space before "!"
• declaration-block-trailing-semicolon: "Expected a trailing semicolon" and "Unexpected trailing semicolon"
• number-leading-zero: "Expected a leading zero for fractional value less than 1" and "Unexpected leading zero for fractional value less than 1"

When it comes to rules with values other than "always" and "never" I think we should tend towards "expected" over "unexpected" e.g.

url-quotes: "single"|"double"|none

We might need to create multiple rejected messages for each value if we use "unexpected" e.g.

For url-quotes: "single"

We'd need two rejected messages:

• "Unexpected double quotes for URL"
• "Unexpected lack of quotes for URL"

Where as, the "expected" approach would require just one rejected message for each value:

e.g. for url-quotes: "single"

We'd only need:

• "Expected single quotes for URL"

Sound good?

[davidtheclark]

Yes. I think "unexpected" (aka "rejected") is for situations where what's there is not ok but there is not a specific expected alternative. So url-quotes never "rejects" if it's on, because it's always expecting something specific. We're in agreement.

[jeddy3]

We're in agreement.

Good stuff :)

[MoOx]

👍

[jeddy3]

I can do this.