-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
188 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# no-unknown-properties | ||
|
||
Disallow unknown properties. | ||
|
||
## Background | ||
|
||
CSS rules may contain any number of properties consisting of a name and a value. As long as the property name is valid CSS, it will parse correctly, even if the property won't be recognized by a web browser. For example: | ||
|
||
```css | ||
a { | ||
ccolor: black; | ||
} | ||
``` | ||
|
||
Here, `ccolor` is a syntactically valid identifier even though it will be ignored by browsers. Such errors are often caused by typos. | ||
|
||
## Rule Details | ||
|
||
This rule warns when it finds a CSS property that isn't part of the CSS specification and aren't custom properties (beginning with `--` and in `--my-color`). The property data is provided via the [CSSTree](https://github.com/csstree/csstree) project. | ||
|
||
Examples of incorrect code: | ||
|
||
```css | ||
a { | ||
ccolor: black; | ||
} | ||
|
||
body { | ||
bg: red; | ||
} | ||
``` | ||
|
||
## When Not to Use It | ||
|
||
If you aren't concerned with unknown properties, you can safely disable this rule. | ||
|
||
## Prior Art | ||
|
||
- [`known-properties`](https://github.com/CSSLint/csslint/wiki/Require-use-of-known-properties) | ||
- [`property-no-unknown`](https://stylelint.io/user-guide/rules/property-no-unknown) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
/** | ||
* @fileoverview Rule to prevent the use of unknown properties in CSS. | ||
* @author Nicholas C. Zakas | ||
*/ | ||
|
||
//----------------------------------------------------------------------------- | ||
// Imports | ||
//----------------------------------------------------------------------------- | ||
|
||
import data from "css-tree/definition-syntax-data"; | ||
|
||
//----------------------------------------------------------------------------- | ||
// Helpers | ||
//----------------------------------------------------------------------------- | ||
|
||
const knownProperties = new Set(Object.keys(data.properties)); | ||
|
||
//----------------------------------------------------------------------------- | ||
// Rule Definition | ||
//----------------------------------------------------------------------------- | ||
|
||
export default { | ||
meta: { | ||
type: "problem", | ||
|
||
docs: { | ||
description: "Disallow empty blocks.", | ||
recommended: true, | ||
}, | ||
|
||
messages: { | ||
unknownProperty: "Unknown property '{{property}}' found.", | ||
}, | ||
}, | ||
|
||
create(context) { | ||
return { | ||
Declaration(node) { | ||
if ( | ||
!node.property.startsWith("--") && | ||
!knownProperties.has(node.property) | ||
) { | ||
const loc = node.loc; | ||
|
||
context.report({ | ||
loc: { | ||
start: loc.start, | ||
end: { | ||
line: loc.start.line, | ||
column: loc.start.column + node.property.length, | ||
}, | ||
}, | ||
messageId: "unknownProperty", | ||
data: { | ||
property: node.property, | ||
}, | ||
}); | ||
} | ||
}, | ||
}; | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
/** | ||
* @fileoverview Tests for no-unknown-properties rule. | ||
* @author Nicholas C. Zakas | ||
*/ | ||
|
||
//------------------------------------------------------------------------------ | ||
// Imports | ||
//------------------------------------------------------------------------------ | ||
|
||
import rule from "../../src/rules/no-unknown-properties.js"; | ||
import css from "../../src/index.js"; | ||
import { RuleTester } from "eslint"; | ||
|
||
//------------------------------------------------------------------------------ | ||
// Tests | ||
//------------------------------------------------------------------------------ | ||
|
||
const ruleTester = new RuleTester({ | ||
plugins: { | ||
css, | ||
}, | ||
language: "css/css", | ||
}); | ||
|
||
ruleTester.run("no-unknown-properties", rule, { | ||
valid: [ | ||
"a { color: red; }", | ||
"a { color: red; background-color: blue; }", | ||
"a { color: red; transition: none; }", | ||
"body { --custom-property: red; }", | ||
], | ||
invalid: [ | ||
{ | ||
code: "a { foo: bar }", | ||
errors: [ | ||
{ | ||
messageId: "unknownProperty", | ||
data: { property: "foo" }, | ||
line: 1, | ||
column: 5, | ||
endLine: 1, | ||
endColumn: 8, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: "a { color: red; -moz-transition: bar }", | ||
errors: [ | ||
{ | ||
messageId: "unknownProperty", | ||
data: { property: "-moz-transition" }, | ||
line: 1, | ||
column: 17, | ||
endLine: 1, | ||
endColumn: 32, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: "a { my-color: red; -webkit-transition: bar }", | ||
errors: [ | ||
{ | ||
messageId: "unknownProperty", | ||
data: { property: "my-color" }, | ||
line: 1, | ||
column: 5, | ||
endLine: 1, | ||
endColumn: 13, | ||
}, | ||
{ | ||
messageId: "unknownProperty", | ||
data: { property: "-webkit-transition" }, | ||
line: 1, | ||
column: 20, | ||
endLine: 1, | ||
endColumn: 38, | ||
}, | ||
], | ||
}, | ||
], | ||
}); |