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,75 @@
# declaration-property-unit-whitelist
Specify a whitelist of allowed property and unit pairs within declarations.
```css
a { width: 100px; }
/** ↑ ↑
* These properties and these units */
```
## Options
`object`: `{
"unprefixed-property-name": ["array", "of", "units"]
}`
If a property name is surrounded with `"/"` (e.g. `"/^animation/"`), it is interpreted as a regular expression. This allows, for example, easy targeting of shorthands: `/^animation/` will match `animation`, `animation-duration`, `animation-timing-function`, etc.
Given:
```js
{
"font-size": ["em", "px"],
"/^animation/": ["s"],
"line-height": []
}
```
The following patterns are considered warnings:
```css
a { font-size: 1.2rem; }
```
```css
a { animation: animation-name 500ms ease; }
```
```css
a { -webkit-animation: animation-name 500ms ease; }
```
```css
a { animation-duration: 500ms; }
```
```css
a { line-height: 13px; }
```
The following patterns are *not* considered warnings:
```css
a { font-size: 1em; }
```
```css
a { height: 100px; }
```
```css
a { animation: animation-name 5s ease; }
```
```css
a { -webkit-animation: animation-name 5s ease; }
```
```css
a { animation-duration: 5s; }
```
```css
a { line-height: 1; }
```

View File

@@ -0,0 +1,70 @@
"use strict"
const declarationValueIndex = require("../../utils/declarationValueIndex")
const getUnitFromValueNode = require("../../utils/getUnitFromValueNode")
const matchesStringOrRegExp = require("../../utils/matchesStringOrRegExp")
const report = require("../../utils/report")
const ruleMessages = require("../../utils/ruleMessages")
const validateOptions = require("../../utils/validateOptions")
const _ = require("lodash")
const valueParser = require("postcss-value-parser")
const postcss = require("postcss")
const ruleName = "declaration-property-unit-whitelist"
const messages = ruleMessages(ruleName, {
rejected: (property, unit) => `Unexpected unit "${unit}" for property "${property}"`,
})
const rule = function (whitelist) {
return (root, result) => {
const validOptions = validateOptions(result, ruleName, {
actual: whitelist,
possible: [_.isObject],
})
if (!validOptions) {
return
}
root.walkDecls(decl => {
const prop = decl.prop,
value = decl.value
const unprefixedProp = postcss.vendor.unprefixed(prop)
const propWhitelist = _.find(whitelist, (list, propIdentifier) => matchesStringOrRegExp(unprefixedProp, propIdentifier))
if (!propWhitelist) {
return
}
valueParser(value).walk(function (node) {
// Ignore wrong units within `url` function
if (node.type === "function" && node.value.toLowerCase() === "url") {
return false
}
if (node.type === "string") {
return
}
const unit = getUnitFromValueNode(node)
if (!unit || (unit && propWhitelist.indexOf(unit.toLowerCase())) !== -1) {
return
}
report({
message: messages.rejected(prop, unit),
node: decl,
index: declarationValueIndex(decl) + node.sourceIndex,
result,
ruleName,
})
})
})
}
}
rule.ruleName = ruleName
rule.messages = messages
module.exports = rule