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,153 @@
# block-opening-brace-newline-before
Require a newline or disallow whitespace before the opening brace of blocks.
```css
a
{ color: pink; }
/** ↑
* The newline before this brace */
```
Refer to [the FAQ](../../../docs/user-guide/faq.md#how-do-i-disallow-single-line-blocks) for more information on using this rule with [`block-opening-brace-newline-after`](../block-opening-brace-newline-after/README.md) to disallow single-line rules.
## Options
`string`: `"always"|"always-single-line"|"never-single-line"|"always-multi-line"|"never-multi-line"`
### `"always"`
There *must always* be a newline before the opening brace.
The following patterns are considered warnings:
```css
a{ color: pink; }
```
```css
a{ color: pink;
}
```
The following patterns are *not* considered warnings:
```css
a
{ color: pink; }
```
```css
a
{
color: pink; }
```
```css
a /* foo */
{
color: pink;
}
```
### `"always-single-line"`
There *must always* be a newline before the opening brace in single-line blocks.
The following patterns are considered warnings:
```css
a{ color: pink; }
```
The following patterns are *not* considered warnings:
```css
a
{ color: pink; }
```
```css
a{
color: pink; }
```
### `"never-single-line"`
There *must never* be whitespace before the opening brace in single-line blocks.
The following patterns are considered warnings:
```css
a { color: pink; }
```
The following patterns are *not* considered warnings:
```css
a{ color: pink; }
```
```css
a {
color: pink; }
```
### `"always-multi-line"`
There *must always* be a newline before the opening brace in multi-line blocks.
The following patterns are considered warnings:
```css
a{
color: pink; }
```
```css
a {
color: pink; }
```
The following patterns are *not* considered warnings:
```css
a{ color: pink; }
```
```css
a { color: pink; }
```
```css
a
{ color: pink; }
```
```css
a
{
color: pink; }
```
### `"never-multi-line"`
There *must never* be whitespace before the opening brace in multi-line blocks.
The following patterns are considered warnings:
```css
a {
color: pink; }
```
The following patterns are *not* considered warnings:
```css
a { color: pink; }
```
```css
a{
color: pink;}
```

View File

@@ -0,0 +1,81 @@
"use strict"
const beforeBlockString = require("../../utils/beforeBlockString")
const blockString = require("../../utils/blockString")
const hasBlock = require("../../utils/hasBlock")
const hasEmptyBlock = require("../../utils/hasEmptyBlock")
const report = require("../../utils/report")
const ruleMessages = require("../../utils/ruleMessages")
const validateOptions = require("../../utils/validateOptions")
const whitespaceChecker = require("../../utils/whitespaceChecker")
const ruleName = "block-opening-brace-newline-before"
const messages = ruleMessages(ruleName, {
expectedBefore: () => "Expected newline before \"{\"",
expectedBeforeSingleLine: () => "Expected newline before \"{\" of a single-line block",
rejectedBeforeSingleLine: () => "Unexpected whitespace before \"{\" of a single-line block",
expectedBeforeMultiLine: () => "Expected newline before \"{\" of a multi-line block",
rejectedBeforeMultiLine: () => "Unexpected whitespace before \"{\" of a multi-line block",
})
const rule = function (expectation) {
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",
],
})
if (!validOptions) {
return
}
// Check both kinds of statement: rules and at-rules
root.walkRules(check)
root.walkAtRules(check)
function check(statement) {
// Return early if blockless or has an empty block
if (
!hasBlock(statement)
|| hasEmptyBlock(statement)
) {
return
}
const source = beforeBlockString(statement)
const beforeBraceNoRaw = beforeBlockString(statement, { noRawBefore: true })
let index = beforeBraceNoRaw.length - 1
if (beforeBraceNoRaw[index - 1] === "\r") {
index -= 1
}
checker.beforeAllowingIndentation({
lineCheckStr: blockString(statement),
source,
index: source.length,
err: m => {
report({
message: m,
node: statement,
index,
result,
ruleName,
})
},
})
}
}
}
rule.ruleName = ruleName
rule.messages = messages
module.exports = rule