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,97 @@
# selector-class-pattern
Specify a pattern for class selectors.
```css
.foo, #bar.baz span, #hoo[disabled] { color: pink; }
/** ↑ ↑
* These class selectors */
```
This rule ignores non-ouputting Less mixin definitions and called Less mixins.
## Options
`regex|string`
A string will be translated into a RegExp — `new RegExp(yourString)` so *be sure to escape properly*.
The selector value *after `.`* will be checked. No need to include `.` in your pattern.
Given the string:
```js
"foo-[a-z]+"
```
The following patterns are considered warnings:
```css
.foop {}
```
```css
.foo-BAR {}
```
```css
div > #zing + .foo-BAR {}
```
The following patterns are *not* considered warnings:
```css
.foo-bar {}
```
```css
div > #zing + .foo-bar {}
```
```css
#foop {}
```
```css
[foo='bar'] {}
```
```less
.foop() {}
```
```less
.foo-bar {
.foop;
}
```
## Optional secondary options
### `resolveNestedSelectors: true | false` (default: `false`)
This option will resolve nested selectors with `&` interpolation.
For example, with `true`.
Given the string:
```js
"^[A-Z]+$"
```
The following patterns are considered warnings:
```css
.A {
&__B {} /* resolved to ".A__B" */
}
```
The following patterns are *not* considered warnings:
```css
.A {
&B {} /* resolved to ".AB" */
}
```

View File

@@ -0,0 +1,114 @@
"use strict"
const isKeyframeSelector = require("../../utils/isKeyframeSelector")
const isStandardSyntaxRule = require("../../utils/isStandardSyntaxRule")
const isStandardSyntaxSelector = require("../../utils/isStandardSyntaxSelector")
const parseSelector = require("../../utils/parseSelector")
const report = require("../../utils/report")
const ruleMessages = require("../../utils/ruleMessages")
const validateOptions = require("../../utils/validateOptions")
const _ = require("lodash")
const resolveNestedSelector = require("postcss-resolve-nested-selector")
const ruleName = "selector-class-pattern"
const messages = ruleMessages(ruleName, {
expected: selectorValue => `Expected class selector ".${selectorValue}" to match specified pattern`,
})
const rule = function (pattern, options) {
return (root, result) => {
const validOptions = validateOptions(result, ruleName, {
actual: pattern,
possible: [
_.isRegExp,
_.isString,
],
}, {
actual: options,
possible: {
resolveNestedSelectors: _.isBoolean,
},
optional: true,
})
if (!validOptions) {
return
}
const shouldResolveNestedSelectors = _.get(options, "resolveNestedSelectors")
const normalizedPattern = _.isString(pattern) ? new RegExp(pattern) : pattern
root.walkRules(rule => {
const selector = rule.selector,
selectors = rule.selectors
if (!isStandardSyntaxRule(rule)) {
return
}
if (!isStandardSyntaxSelector(selector)) {
return
}
if (selectors.some(s => isKeyframeSelector(s))) {
return
}
// Only bother resolving selectors that have an interpolating &
if (shouldResolveNestedSelectors && hasInterpolatingAmpersand(selector)) {
resolveNestedSelector(selector, rule).forEach(selector => {
if (!isStandardSyntaxSelector(selector)) {
return
}
parseSelector(selector, result, rule, s => checkSelector(s, rule))
})
} else {
parseSelector(selector, result, rule, s => checkSelector(s, rule))
}
})
function checkSelector(fullSelector, rule) {
fullSelector.walkClasses(classNode => {
const value = classNode.value,
sourceIndex = classNode.sourceIndex
if (normalizedPattern.test(value)) {
return
}
report({
result,
ruleName,
message: messages.expected(value),
node: rule,
index: sourceIndex,
})
})
}
}
}
// An "interpolating ampersand" means an "&" used to interpolate
// within another simple selector, rather than an "&" that
// stands on its own as a simple selector
function hasInterpolatingAmpersand(selector) {
for (let i = 0, l = selector.length; i < l; i++) {
if (selector[i] !== "&") {
continue
}
if (!_.isUndefined(selector[i - 1]) && !isCombinator(selector[i - 1])) {
return true
}
if (!_.isUndefined(selector[i + 1]) && !isCombinator(selector[i + 1])) {
return true
}
}
return false
}
function isCombinator(x) {
return (/[\s+>~]/.test(x)
)
}
rule.ruleName = ruleName
rule.messages = messages
module.exports = rule