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,197 @@
# custom-property-empty-line-before
Require or disallow an empty line before custom properties.
```css
a {
top: 10px;
/* ← */
--foo: pink; /* ↑ */
} /* ↑ */
/** ↑
* This line */
```
## Options
`string`: `"always"|"never"`
### `"always"`
The following patterns are considered warnings:
```css
a {
top: 10px;
--foo: pink;
--bar: red;
}
```
The following patterns are *not* considered warnings:
```css
a {
top: 10px;
--foo: pink;
--bar: red;
}
```
### `"never"`
The following patterns are considered warnings:
```css
a {
top: 10px;
--foo: pink;
--bar: red;
}
```
```css
a {
--foo: pink;
--bar: red;
}
```
The following patterns are *not* considered warnings:
```css
a {
top: 10px;
--foo: pink;
--bar: red;
}
```
```css
a {
--foo: pink;
--bar: red;
}
```
## Optional secondary options
### `except: ["after-comment", "after-custom-property", "first-nested"]`
#### `"after-comment"`
Reverse the primary option for custom properties that come after a comment.
For example, with `"always"`:
The following patterns are considered warnings:
```css
a {
--foo: pink;
/* comment */
--bar: red;
}
```
The following patterns are *not* considered warnings:
```css
a {
--foo: pink;
/* comment */
--bar: red;
}
```
#### `"after-custom-property"`
Reverse the primary option for custom properties that come after another custom property.
For example, with `"always"`:
The following patterns are considered warnings:
```css
a {
--foo: pink;
--bar: red;
}
```
The following patterns are *not* considered warnings:
```css
a {
--foo: pink;
--bar: red;
}
```
#### `"first-nested"`
Reverse the primary option for custom properties that are nested and the first child of their parent node.
For example, with `"always"`:
The following patterns are considered warnings:
```css
a {
--foo: pink;
--bar: red;
}
```
The following patterns are *not* considered warnings:
```css
a {
--foo: pink;
--bar: red;
}
```
### `ignore: ["after-comment", "inside-single-line-block"]`
#### `"after-comment"`
Ignore custom properties that are preceded by comments.
For example, with `"always"`:
The following patterns are *not* considered warnings:
```css
a {
/* comment */
--foo: pink;
}
```
#### `"inside-single-line-block"`
Ignore custom properties that are inside single-line blocks.
For example, with `"always"`:
The following patterns are *not* considered warnings:
```css
a { --foo: pink; --bar: red; }
```

View File

@@ -0,0 +1,124 @@
"use strict"
const blockString = require("../../utils/blockString")
const hasEmptyLine = require("../../utils/hasEmptyLine")
const isCustomProperty = require("../../utils/isCustomProperty")
const isSingleLineString = require("../../utils/isSingleLineString")
const isStandardSyntaxDeclaration = require("../../utils/isStandardSyntaxDeclaration")
const optionsMatches = require("../../utils/optionsMatches")
const report = require("../../utils/report")
const ruleMessages = require("../../utils/ruleMessages")
const validateOptions = require("../../utils/validateOptions")
const ruleName = "custom-property-empty-line-before"
const messages = ruleMessages(ruleName, {
expected: "Expected empty line before custom property",
rejected: "Unexpected empty line before custom property",
})
const rule = function (expectation, options) {
return (root, result) => {
const validOptions = validateOptions(result, ruleName, {
actual: expectation,
possible: [
"always",
"never",
],
}, {
actual: options,
possible: {
except: [
"first-nested",
"after-comment",
"after-custom-property",
],
ignore: [
"after-comment",
"inside-single-line-block",
],
},
optional: true,
})
if (!validOptions) {
return
}
root.walkDecls(decl => {
const prop = decl.prop,
parent = decl.parent
if (!isStandardSyntaxDeclaration(decl)) {
return
}
if (!isCustomProperty(prop)) {
return
}
// Optionally ignore the node if a comment precedes it
if (
optionsMatches(options, "ignore", "after-comment")
&& decl.prev()
&& decl.prev().type === "comment"
) {
return
}
// Optionally ignore nodes inside single-line blocks
if (
optionsMatches(options, "ignore", "inside-single-line-block")
&& isSingleLineString(blockString(parent))
) {
return
}
let expectEmptyLineBefore = expectation === "always" ? true : false
// Optionally reverse the expectation for the first nested node
if (
optionsMatches(options, "except", "first-nested")
&& decl === parent.first
) {
expectEmptyLineBefore = !expectEmptyLineBefore
}
// Optionally reverse the expectation if a comment precedes this node
if (
optionsMatches(options, "except", "after-comment")
&& decl.prev()
&& decl.prev().type === "comment"
) {
expectEmptyLineBefore = !expectEmptyLineBefore
}
// Optionally reverse the expectation if a custom property precedes this node
if (
optionsMatches(options, "except", "after-custom-property")
&& decl.prev()
&& decl.prev().prop
&& isCustomProperty(decl.prev().prop)
) {
expectEmptyLineBefore = !expectEmptyLineBefore
}
const hasEmptyLineBefore = hasEmptyLine(decl.raws.before)
// Return if the expectation is met
if (expectEmptyLineBefore === hasEmptyLineBefore) {
return
}
const message = expectEmptyLineBefore ? messages.expected : messages.rejected
report({
message,
node: decl,
result,
ruleName,
})
})
}
}
rule.ruleName = ruleName
rule.messages = messages
module.exports = rule