Add at-rule-semicolon-space-before rule #2388

CAYdenberg · 2017-02-23T20:54:52Z

Which issue, if any, is this issue related to?

Is there anything in the PR that needs further explanation?

skipBasicChecks is set to true in the first set of tests. The check @import "foo.css"; fails this test if the option is set to "always" (obviously).

CAYdenberg · 2017-02-25T14:19:57Z

This is ready for review

jeddy3

This is looking very good, thanks!

Each new rule PR usually contains six files. The missing two in this instance are documentation: example config and the list of rules. Please can you add those.

jeddy3 · 2017-02-26T19:22:46Z

lib/rules/at-rule-semicolon-space-before/README.md

@@ -0,0 +1,45 @@
+# at-rule-semicolon-space-before
+
+Require a single space or disallow whitespace before the semicolons of regular (non-nested) at-rules.


"Require a single space or disallow whitespace after the semicolons of at-rules."

There doesn't appear to be anything in the rule that avoids checking nested at-rules. Let's continue to check all at-rules to keep it consistent with at-rule-semicolon-newline-after, and just update this line in the docs.

I think I'm failing lingo. I was trying to talk about at-rules like this one:

@font-face { font-family: "MyFont"; src: url("myfont.woff2") format("woff2"); }

(I got the terminology from CSS Tricks)

These at rules are ignored because of the call to hasBlock, as is the case for at-rule-semicolon-newline-after.

Should I amend this to say "at-rules without declaration blocks" or some such?

I was trying to talk about at-rules like this one

Oh I see where you're coming from.

In the @font-face case those semi-colons belong to the "block of descriptor declarations", and not to the at-rule itself. In stylelint we generally generalise blocks like these as "declaration blocks".

Having said that...

Should I amend this to say "at-rules without declaration blocks" or some such?

... I don't think there's much need to be specific in the rule description as the examples quite clearly illustrate we're talking about semicolons after the likes of @import and @charset. I think "Require a single space or disallow whitespace after the semicolons of at-rules." will suffice here.

jeddy3 · 2017-02-26T19:53:21Z

lib/rules/at-rule-semicolon-space-before/README.md

+@import "components/buttons";
+```
+
+The following pattern is *not* considered a warning:


I'll update the valid and invalid example highlighting) on the website to accept these singular examples.

jeddy3 · 2017-02-26T19:57:26Z

lib/rules/at-rule-semicolon-space-before/__tests__/index.js

+  }, {
+    code: "@import url(http://www.example.com/alocation;withsemicolon) ;",
+  }, {
+    code: "@import /*my styles;*/ \"styles/mystyle\" ;",


Can we get a multi-line accepted example please e.g.

@import url('landscape.css') projection ;

Same for "never".

Addressed in 3a5e1cc

jeddy3 · 2017-02-26T19:57:46Z

lib/rules/at-rule-semicolon-space-before/__tests__/index.js

+    message: messages.expectedBefore(),
+    line: 1,
+    column: 26,
+  } ],


Can we get a multi-line rejected example please e.g.

@import url('landscape.css') projection;

Same for "never".

…into issue_2346

jeddy3

Looking good. Thanks for adding the tests. I've two requests for the doc changes you made. Other than that this LGTM.

jeddy3 · 2017-02-27T21:40:47Z

docs/user-guide/example-config.md

@@ -11,6 +11,7 @@ You might want to learn a little about [how rules are named and how they work to
    "at-rule-empty-line-before": "always"|"never",
    "at-rule-name-case": "lower"|"upper",
    "at-rule-name-newline-after": "always"|"always-multi-line",
+    "at-rule-semicolon-space-before": "always"|"never",


Ordered alphabetically, please.

My bad, got mixed up by the different newline rules. Addressed in e3f998d

jeddy3 · 2017-02-27T21:41:21Z

docs/user-guide/rules.md

@@ -238,6 +238,7 @@ Here are all the rules within stylelint, grouped by the [*thing*](http://apps.wo
 -   [`at-rule-no-unknown`](../../lib/rules/at-rule-no-unknown/README.md): Disallow unknown at-rules.
 -   [`at-rule-no-vendor-prefix`](../../lib/rules/at-rule-no-vendor-prefix/README.md): Disallow vendor prefixes for at-rules.
 -   [`at-rule-semicolon-newline-after`](../../lib/rules/at-rule-semicolon-newline-after/README.md): Require a newline after the semicolon of at-rules.
+-[`at-rule-semicolon-space-before`](../../lib/rules/at-rule-semicolon-space-before/README.md): Require a single space or disallow whitespace before the semicolons of at rules.


You'll need a tab (or two) after the - for it to properly render.

jeddy3 · 2017-02-27T21:52:18Z

lib/rules/at-rule-semicolon-space-before/README.md

@@ -0,0 +1,45 @@
+# at-rule-semicolon-space-before
+
+Require a single space or disallow whitespace before the semicolons of regular (non-nested) at-rules.


I was trying to talk about at-rules like this one

Oh I see where you're coming from.

In the @font-face case those semi-colons belong to the "block of descriptor declarations", and not to the at-rule itself. In stylelint we generally generalise blocks like these as "declaration blocks".

Having said that...

Should I amend this to say "at-rules without declaration blocks" or some such?

... I don't think there's much need to be specific in the rule description as the examples quite clearly illustrate we're talking about semicolons after the likes of @import and @charset. I think "Require a single space or disallow whitespace after the semicolons of at-rules." will suffice here.

jeddy3

Thanks for making the changes. LGTM.

davidtheclark · 2017-02-28T13:17:55Z

Added to Changelog:

Added: at-rule-semicolon-space-before rule rulel (#2388).

CAYdenberg · 2017-02-28T15:55:39Z

Thanks everyone! Can I complement you on building on great OS community? The reviews have all been great, the docs are always clear, the scope of the project is always so well defined. Really great place to contribute.

* Add README for at-rule-semicolon-space-before * Wrote failing tests for at-rule-semicolon-space-before * Add edge case tests * Set up boilerplate for at-rule-semicolon-space-before * Logic there - a few problems * Check carefully column counts * Set skipBasicChecks to true for the 'always' tests * Add at-rule-semicolon-space-before to documentation * Add some more multiline tests * Amend documentation for at-rule-semicolon-space-before

* master: Update CHANGELOG.md Add flow comments annotation to function signatures (#2319) Update CHANGELOG.md Fix custom properties sets followed by comments in no-extra-semicolons (#2396) Fixed: `value-keyword-case` is now ignore counter, counters and attr fucntions. Fix typos (#2412) Fixed: `value-keyword-case` is now ignore counter-reset property. chore(package): update flow-bin to version 0.41.0 chore(package): update eslint to version 3.17.0 Fix the example for Custom Message in docs (#2409) Update CHANGELOG.md Update CHANGELOG.md Add at-rule-semicolon-space-before rule (#2388) Update CHANGELOG.md Print out filenames/globs when files do not exist (#2328) Tests: improved tests for `no-missing-end-of-source-newline` rule. (#2384) Update stylelint-disable-reason changelog entry (#2393) Add min rules chore(package): update flow-bin to version 0.40.0 (#2390) chore: Update `remark-*` modules (#2391)

CAYdenberg added 4 commits February 23, 2017 12:13

Add README for at-rule-semicolon-space-before

d45b201

Wrote failing tests for at-rule-semicolon-space-before

1735431

Add edge case tests

215658b

Set up boilerplate for at-rule-semicolon-space-before

2456b5d

jeddy3 added PR: review needed and removed PR: review needed labels Feb 24, 2017

jeddy3 changed the title ~~Issue 2346~~ Add at-rule-semicolon-space-before rule Feb 24, 2017

CAYdenberg and others added 3 commits February 24, 2017 17:10

Logic there - a few problems

04346c3

Check carefully column counts

68f853e

Set skipBasicChecks to true for the 'always' tests

a99d9f6

hudochenkov added the PR: review needed label Feb 25, 2017

jeddy3 requested changes Feb 26, 2017

View reviewed changes

jeddy3 added PR: review accepted and removed PR: review needed labels Feb 26, 2017

jeddy3 mentioned this pull request Feb 27, 2017

Account for singular valid and invalid examples stylelint/stylelint.io#34

Merged

CAYdenberg added 3 commits February 27, 2017 10:44

Add at-rule-semicolon-space-before to documentation

851d146

Merge branch 'issue_2346' of https://github.com/CAYdenberg/stylelint …

7033b2a

…into issue_2346

Add some more multiline tests

3a5e1cc

jeddy3 requested changes Feb 27, 2017

View reviewed changes

Amend documentation for at-rule-semicolon-space-before

e3f998d

jeddy3 added PR: review needed and removed PR: needs revision labels Feb 28, 2017

jeddy3 approved these changes Feb 28, 2017

View reviewed changes

davidtheclark merged commit 9c7c38a into stylelint:master Feb 28, 2017

jeddy3 added PR: review accepted and removed PR: review needed labels Feb 28, 2017

CAYdenberg deleted the issue_2346 branch February 28, 2017 15:52

hudochenkov mentioned this pull request Mar 1, 2017

Add at-rule-semicolon-space-before rule #2346

Closed

renovate-bot mentioned this pull request Apr 1, 2017

Update dependency stylelint to version 7.10.1 singapore/lint-condo#268

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add at-rule-semicolon-space-before rule #2388

Add at-rule-semicolon-space-before rule #2388

CAYdenberg commented Feb 23, 2017 •

edited

Loading

CAYdenberg commented Feb 25, 2017

jeddy3 left a comment •

edited

Loading

jeddy3 Feb 26, 2017 •

edited

Loading

CAYdenberg Feb 27, 2017 •

edited

Loading

jeddy3 Feb 27, 2017

jeddy3 Feb 26, 2017

CAYdenberg Feb 27, 2017

jeddy3 Feb 26, 2017

CAYdenberg Feb 27, 2017

jeddy3 Feb 26, 2017

jeddy3 left a comment

jeddy3 Feb 27, 2017

CAYdenberg Feb 27, 2017

jeddy3 Feb 27, 2017

jeddy3 Feb 27, 2017

jeddy3 left a comment

davidtheclark commented Feb 28, 2017

CAYdenberg commented Feb 28, 2017

		@@ -0,0 +1,45 @@
		# at-rule-semicolon-space-before

		Require a single space or disallow whitespace before the semicolons of regular (non-nested) at-rules.

Add at-rule-semicolon-space-before rule #2388

Add at-rule-semicolon-space-before rule #2388

Conversation

CAYdenberg commented Feb 23, 2017 • edited Loading

CAYdenberg commented Feb 25, 2017

jeddy3 left a comment • edited Loading

Choose a reason for hiding this comment

jeddy3 Feb 26, 2017 • edited Loading

Choose a reason for hiding this comment

CAYdenberg Feb 27, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeddy3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeddy3 left a comment

Choose a reason for hiding this comment

davidtheclark commented Feb 28, 2017

CAYdenberg commented Feb 28, 2017

CAYdenberg commented Feb 23, 2017 •

edited

Loading

jeddy3 left a comment •

edited

Loading

jeddy3 Feb 26, 2017 •

edited

Loading

CAYdenberg Feb 27, 2017 •

edited

Loading