Initial commit

This commit is contained in:
Patrick Marsceill
2017-03-09 13:16:08 -05:00
commit b7b0d0d7bf
4147 changed files with 401224 additions and 0 deletions

View File

@@ -0,0 +1,174 @@
# block-closing-brace-newline-after
Require a newline or disallow whitespace after the closing brace of blocks.
```css
a { color: pink; }
a { color: red; }
/** ↑
* The newline after this brace */
```
This rule allows an end-of-line comment separated from the closing brace by spaces, as long as the comment contains no newlines. For example,
```css
a {
color: pink;
} /* end-of-line comment */
```
This rule allows a trailing semicolon after the closing brace of a block. For example,
```css
:root {
--toolbar-theme: {
background-color: hsl(120, 70%, 95%);
};
/* ↑
* This semicolon */
}
```
## Options
`string`: `"always"|"always-single-line"|"never-single-line"|"always-multi-line"|"never-multi-line"`
### `"always"`
There *must always* be a newline after the closing brace.
The following patterns are considered warnings:
```css
a { color: pink; }b { color: red; }
```
```css
a { color: pink;
} b { color: red; }
```
The following patterns are *not* considered warnings:
```css
a { color: pink; }
b { color: red; }
```
### `"always-single-line"`
There *must always* be a newline after the closing brace in single-line blocks.
The following patterns are considered warnings:
```css
a { color: pink; } b { color: red; }
```
The following patterns are *not* considered warnings:
```css
a { color: pink;
} b { color: red; }
```
```css
a { color: pink; }
b { color: red; }
```
### `"never-single-line"`
There *must never* be whitespace after the closing brace in single-line blocks.
The following patterns are considered warnings:
```css
a { color: pink; } b { color: red; }
```
The following patterns are *not* considered warnings:
```css
a { color: pink; }b { color: red; }
```
```css
a { color: pink;
} b { color: red; }
```
### `"always-multi-line"`
There *must always* be a newline after the closing brace in multi-line blocks.
The following patterns are considered warnings:
```css
a { color: pink;
}b { color: red; }
```
The following patterns are *not* considered warnings:
```css
a { color: pink; }b { color: red; }
```
```css
a { color: pink;
}
b { color: red; }
```
### `"never-multi-line"`
There *must never* be whitespace after the closing brace in multi-line blocks.
The following patterns are considered warnings:
```css
a { color: pink;
} b { color: red; }
```
The following patterns are *not* considered warnings:
```css
a { color: pink; } b { color: red; }
```
```css
a { color: pink;
}b { color: red; }
```
## Optional secondary options
### `ignoreAtRules: ["/regex/", "non-regex"]`
Ignore specified at-rules.
For example, with `"always"` or `"always-multi-line"`.
Given:
```js
["if", "else"]
```
The following patterns are *not* considered warnings:
```css
@if ($var) {
color: pink;
} @else if ($var2) {
color: red;
} @else {
color: blue;
}
```
```css
@if ($var) { color: pink; } @else { color: blue; }
```

View File

@@ -0,0 +1,110 @@
"use strict"
const _ = require("lodash")
const blockString = require("../../utils/blockString")
const hasBlock = require("../../utils/hasBlock")
const optionsMatches = require("../../utils/optionsMatches")
const rawNodeString = require("../../utils/rawNodeString")
const report = require("../../utils/report")
const ruleMessages = require("../../utils/ruleMessages")
const validateOptions = require("../../utils/validateOptions")
const whitespaceChecker = require("../../utils/whitespaceChecker")
const ruleName = "block-closing-brace-newline-after"
const messages = ruleMessages(ruleName, {
expectedAfter: () => "Expected newline after \"}\"",
expectedAfterSingleLine: () => "Expected newline after \"}\" of a single-line block",
rejectedAfterSingleLine: () => "Unexpected whitespace after \"}\" of a single-line block",
expectedAfterMultiLine: () => "Expected newline after \"}\" of a multi-line block",
rejectedAfterMultiLine: () => "Unexpected whitespace after \"}\" of a multi-line block",
})
const rule = function (expectation, options) {
const checker = whitespaceChecker("newline", expectation, messages)
return (root, result) => {
const validOptions = validateOptions(result, ruleName, {
actual: expectation,
possible: [
"always",
"always-single-line",
"never-single-line",
"always-multi-line",
"never-multi-line",
],
}, {
actual: options,
possible: {
ignoreAtRules: [_.isString],
},
optional: true,
})
if (!validOptions) {
return
}
// Check both kinds of statements: rules and at-rules
root.walkRules(check)
root.walkAtRules(check)
function check(statement) {
if (!hasBlock(statement)) {
return
}
if (optionsMatches(options, "ignoreAtRules", statement.name)) {
return
}
const nextNode = statement.next()
if (!nextNode) {
return
}
// Allow an end-of-line comment x spaces after the brace
const nextNodeIsSingleLineComment = nextNode.type === "comment"
&& !/[^ ]/.test((nextNode.raws.before || ""))
&& nextNode.toString().indexOf("\n") === -1
const nodeToCheck = nextNodeIsSingleLineComment
? nextNode.next()
: nextNode
if (!nodeToCheck) {
return
}
let reportIndex = statement.toString().length
let source = rawNodeString(nodeToCheck)
// Skip a semicolon at the beginning, if any
if (
source
&& source[0] === ";"
) {
source = source.slice(1)
reportIndex++
}
// Only check one after, because there might be other
// spaces handled by the indentation rule
checker.afterOneOnly({
source,
index: -1,
lineCheckStr: blockString(statement),
err: msg => {
report({
message: msg,
node: statement,
index: reportIndex,
result,
ruleName,
})
},
})
}
}
}
rule.ruleName = ruleName
rule.messages = messages
module.exports = rule