stylelint-no-px
v2.0.0
Published
A stylelint custom rule to ensure using rem instead of px
Downloads
21,324
Maintainers
Readme
stylelint-no-px
A stylelint custom rule to ensure rem instead of px.
If you are using rem
(instead of px
) as 1px solution or for other purposes, you should need a stylelint rule to enforce using rem. Thats it.
width: 10px; // error
border: 1px solid #eee; // ok
Installation
npm install stylelint-no-px --save-dev
Usage
Add it to your stylelint config
// .stylelintrc
{
"plugins": [
"stylelint-no-px"
],
"rules": {
// ...
"meowtec/no-px": [true, { "ignore": ["1px"] }],
// or just:
"meowtec/no-px": true,
// ...
}
}
Options
ignore: Item[]
ignore value check.
Valid value of Item: propertyName
| '1px'
| '${propertyName} 1px'
ignoreFunctions: string[]
Ignore check for functions.
remSize: number
Specify a base size for converting px to rem. If this option is provided, the plugin will automatically convert pixel values to rem using the provided base size.
example(1) (the default options)
// all 1px is ok
"meowtec/no-px": [true, { "ignore": ["1px"] }],
@padding-base: 20px; // error
.foo {
border-top: 1px solid #ccc; // ok
padding: 10px; // error
height: 1px; // ok
padding: @padding-base * 2;
}
example(2)
// - all `1px` or `font` is ok
// - rem(Npx) is ok
"meowtec/no-px": [true, { "ignore": ["1px", "font"], "ignoreFunctions": ["rem"] }],
.foo {
border-top: 1px solid #ccc; // ok
height: 1px; // ok
font-size: 24px; // ok
padding: 10px; // error
width: calc(100% - 10px); // error
font-size: rem(10px); // ok
}
example(3)
// only `border + 1px` is ok
"meowtec/no-px": [true, { "ignore": ["border 1px"] }],
.foo {
border-top: 1px solid #ccc; // ok
height: 1px; // error
}
example(4)
// only `border + 1px` is ok
"meowtec/no-px": [true, { "ignore": ["1px"], "remSize": 16 }],
.foo {
height: 16px; // error, auto converts to 1rem
}