Skip to content

Commit 83e669a

Browse files
committed
Fix doc of rule "prefer-shorthand-css-notations"
1 parent d97ed0d commit 83e669a

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

eslint-plugin/docs/rules/prefer-shorthand-css-notations.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,26 @@ ultimately conserving time and energy.
1111
By reducing the number of CSS properties, you help to reduce the weight of your application bundle, and therefore its
1212
environmental footprint.
1313

14+
## Options
15+
16+
You can disable specific properties from being scanned if it does not match your needs.
17+
To disable properties you need to modify your .eslintrc.js by adding the following rule configuration:
18+
19+
```js
20+
module.exports = {
21+
...yourConf,
22+
rules: {
23+
"prefer-shorthand-css-notations": [
24+
"warn",
25+
// disable analyze of "animation-*" properties
26+
{ disableProperties: ["animation"] },
27+
],
28+
},
29+
};
30+
```
31+
32+
## Examples
33+
1434
For example, the `font` shorthand consolidates various font-related properties, and the `margin` shorthand streamlines
1535
the definition of margins around a box.
1636

0 commit comments

Comments
 (0)