14 KiB
properties-order
Specify the order of properties within declaration blocks.
a {
color: pink;
top: 0;
}
/** ↑
* These properties */
Prefixed properties must always precede the unprefixed version.
This rule ignores variables ($sass, @less, --custom-property).
- Options
- Optional secondary options
- Autofixing caveats
Options
type PrimaryOption = Array<string | Group>;
type Group = {
properties: Array<string>;
emptyLineBefore?: 'always' | 'never' | 'threshold';
noEmptyLineBetween?: boolean;
groupName?: string;
order?: 'flexible';
};
Array of unprefixed property names or group objects. Within an order array, you can include:
- unprefixed property names
- group objects with these properties:
-
properties(array of strings): The properties in this group. -
emptyLineBefore: "always" | "never" | "threshold": Ifalways, this group must be separated from other properties by an empty newline. If emptyLineBefore isnever, the group must have no empty lines separating it from other properties. By default this property isn't set.Rule will check empty lines between properties only. However, shared-line comments ignored by rule. Shared-line comment is a comment on the same line as declaration before this comment.
If
emptyLineBeforespecified, regardless of it's value, the first property in a rule would be forced to not have an empty line before it.For
threshold, refer to theemptyLineMinimumPropertyThresholddocumentation.If this option is not working as expected, make sure you don't have
declaration-empty-line-beforeconfigured in a conflicting way in your Stylelint config or config you're extending (e. g.stylelint-config-standard). -
noEmptyLineBetween: Iftrue, properties within group should not have empty lines between them. -
groupName: An optional name for the group. This will be used in error messages. -
order: "flexible": If property isn't set (the default), the properties in this group must come in the order specified. If"flexible", the properties can be in any order as long as they are grouped correctly.
-
There are some important details to keep in mind:
By default, unlisted properties will be ignored. So if you specify an array and do not include display, that means that the display property can be included before or after any other property. This can be changed with the unspecified option (see below).
Given:
{
"order/properties-order": [
"transform",
"top",
"color"
]
}
The following patterns are considered warnings:
a {
color: pink;
top: 0;
}
a {
-moz-transform: scale(1);
transform: scale(1);
-webkit-transform: scale(1);
}
The following patterns are not considered warnings:
a {
top: 0;
color: pink;
}
a {
-moz-transform: scale(1);
-webkit-transform: scale(1);
transform: scale(1);
}
a {
-webkit-transform: scale(1);
-moz-transform: scale(1);
transform: scale(1);
}
Given:
{
"order/properties-order": [
"padding",
"color",
"padding-top"
]
}
The following patterns are considered warnings:
a {
color: pink;
padding: 1em;
}
a {
padding-top: 1em;
color: pink;
}
The following patterns are not considered warnings:
a {
padding: 1em;
color: pink;
}
a {
color: pink;
padding-top: 1em;
}
Given:
{
"order/properties-order": [
"font-smoothing",
"color"
]
}
Where font-smoothing is the unprefixed version of proprietary browser property -webkit-font-smoothing.
The following patterns are considered warnings:
a {
color: pink;
-webkit-font-smoothing: antialiased;
}
a {
color: pink;
font-smoothing: antialiased;
}
The following patterns are not considered warnings:
a {
-webkit-font-smoothing: antialiased;
color: pink;
}
a {
font-smoothing: antialiased;
color: pink;
}
Given:
{
"order/properties-order": [
"padding",
"padding-top",
"padding-right",
"padding-bottom",
"padding-left",
"color"
]
}
The following patterns are considered warnings:
a {
padding-left: 2em;
padding-top: 1em;
padding: 1em;
color: pink;
}
The following patterns are not considered warnings:
a {
padding-top: 1em;
padding-right: 1em;
padding-bottom: 0.5em;
padding-left: 0.5em;
color: pink;
}
a {
padding: 1em;
padding-right: 2em;
padding-left: 2.5em;
color: pink;
}
Given:
{
"order/properties-order": [
{
"groupName": "dimensions",
"emptyLineBefore": "always",
"properties": [
"height",
"width"
]
},
{
"groupName": "font",
"emptyLineBefore": "always",
"properties": [
"font-size",
"font-weight"
]
}
]
}
The following patterns are considered warnings:
a {
height: 1px;
width: 2px;
font-size: 2px;
font-weight: bold;
}
a {
height: 1px;
width: 2px;
font-weight: bold;
font-size: 2px;
}
a {
width: 2px;
font-size: 2px;
font-weight: bold;
height: 1px;
}
The following patterns are not considered warnings:
a {
height: 1px;
width: 2px;
font-size: 2px;
font-weight: bold;
}
Given:
{
"order/properties-order": [
{
"emptyLineBefore": "never",
"properties": [
"height",
"width"
]
},
{
"emptyLineBefore": "never",
"properties": [
"font-size",
"font-weight"
]
}
]
}
The following patterns are considered warnings:
a {
height: 1px;
width: 2px;
font-size: 2px;
font-weight: bold;
}
a {
height: 1px;
width: 2px;
font-weight: bold;
font-size: 2px;
}
a {
width: 2px;
font-size: 2px;
font-weight: bold;
height: 1px;
}
The following patterns are not considered warnings:
a {
height: 1px;
width: 2px;
font-size: 2px;
font-weight: bold;
}
Given:
{
"order/properties-order": [
{
"emptyLineBefore": "always",
"noEmptyLineBetween": true,
"properties": [
"height",
"width"
]
},
{
"emptyLineBefore": "always",
"noEmptyLineBetween": true,
"properties": [
"font-size",
"font-weight"
]
}
]
}
The following pattern is considered warnings:
a {
height: 1px;
width: 2px;
font-size: 2px;
font-weight: bold;
}
The following patterns is not considered warnings:
a {
height: 1px;
width: 2px;
font-size: 2px;
font-weight: bold;
}
Given:
{
"order/properties-order": [
"height",
"width",
{
"order": "flexible",
"properties": [
"color",
"font-size",
"font-weight"
]
}
]
}
The following patterns are considered warnings:
a {
height: 1px;
font-weight: bold;
width: 2px;
}
a {
width: 2px;
height: 1px;
font-weight: bold;
}
a {
height: 1px;
color: pink;
width: 2px;
font-weight: bold;
}
The following patterns are not considered warnings:
a {
height: 1px;
width: 2px;
color: pink;
font-size: 2px;
font-weight: bold;
}
a {
height: 1px;
width: 2px;
font-size: 2px;
color: pink;
font-weight: bold;
}
Optional secondary options
type SecondaryOptions = {
unspecified?: "top" | "bottom" | "bottomAlphabetical" | "ignore";
emptyLineBeforeUnspecified?: "always" | "never" | "threshold";
emptyLineMinimumPropertyThreshold?: number;
};
unspecified
Value type: "top" | "bottom" | "bottomAlphabetical" | "ignore".
Default value: "ignore".
These options only apply if you've defined your own array of properties.
Default behavior is the same as "ignore": an unspecified property can appear before or after any other property.
With "top", unspecified properties are expected before any specified properties. With "bottom", unspecified properties are expected after any specified properties. With "bottomAlphabetical", unspecified properties are expected after any specified properties, and the unspecified properties are expected to be in alphabetical order. (See properties-alphabetical-order more more details on the alphabetization rules.)
Given:
{
"order/properties-order": [
["color", "background"],
{ "unspecified": "ignore" }
]
}
The following patterns are not considered warnings:
a {
color: pink;
background: orange;
left: 0;
}
a {
left: 0;
color: pink;
background: orange;
}
a {
color: pink;
left: 0;
background: orange;
}
Given:
{
"order/properties-order": [
["color", "background"],
{ "unspecified": "top" }
]
}
The following patterns are considered warnings:
a {
color: pink;
background: orange;
left: 0;
}
a {
color: pink;
left: 0;
background: orange;
}
The following patterns are not considered warnings:
a {
left: 0;
color: pink;
background: orange;
}
Given:
{
"order/properties-order": [
["color", "background"],
{ "unspecified": "bottom" }
]
}
The following patterns are considered warnings:
a {
left: 0;
color: pink;
background: orange;
}
a {
color: pink;
left: 0;
background: orange;
}
The following patterns are not considered warnings:
a {
color: pink;
background: orange;
left: 0;
}
Given:
{
"order/properties-order": [
["composes"],
{ "unspecified": "bottomAlphabetical" }
]
}
The following patterns are considered warnings:
a {
align-items: flex-end;
composes: b;
left: 0;
}
a {
composes: b;
left: 0;
align-items: flex-end;
}
The following patterns are not considered warnings:
a {
composes: b;
align-items: flex-end;
left: 0;
}
emptyLineBeforeUnspecified
Value type: "always" | "never" | "threshold".
Default value: none.
Default behavior does not enforce the presence of an empty line before an unspecified block of properties ("ignore").
If "always", the unspecified group must be separated from other properties by an empty newline.
If "never", the unspecified group must have no empty lines separating it from other properties.
For "threshold", see the emptyLineMinimumPropertyThreshold documentation for more information.
If emptyLineBeforeUnspecified specified, regardless of it's value, if the first property in a rule is target of this option, that property would be forced to not have an empty line before it.
Given:
{
"order/properties-order": [
[
"height",
"width",
],
{
"unspecified": "bottom",
"emptyLineBeforeUnspecified": "always"
}
]
}
The following pattern is considered warnings:
a {
height: 1px;
width: 2px;
color: blue;
}
The following patterns is not considered warnings:
a {
height: 1px;
width: 2px;
color: blue;
}
emptyLineMinimumPropertyThreshold
Value type: number.
Default value: none.
If a group is configured with emptyLineBefore: "threshold", the empty line behaviour toggles based on the number of properties in the rule.
When the configured minimum property threshold is reached, empty lines are inserted. When the number of properties is less than the minimum property threshold, empty lines are removed.
e.g. threshold set to 3, and there are 5 properties in total, then groups set to "threshold" will have an empty line inserted.
The same behaviour is applied to unspecified groups when emptyLineBeforeUnspecified: "threshold"
Given:
{
"order/properties-order": [
[
{
"emptyLineBefore": "threshold",
"properties": ["display"]
},
{
"emptyLineBefore": "threshold",
"properties": ["height", "width"]
},
{
"emptyLineBefore": "always",
"properties": ["border"]
},
{
"emptyLineBefore": "never",
"properties": ["transform"]
},
],
{
"unspecified": "bottom",
"emptyLineBeforeUnspecified": "threshold",
"emptyLineMinimumPropertyThreshold": 4
}
]
}
The following patterns are considered warnings:
a {
display: block;
height: 1px;
width: 2px;
color: blue;
}
a {
display: block;
height: 1px;
width: 2px;
border: 0;
color: blue;
}
a {
display: block;
height: 1px;
width: 2px;
border: 0;
transform: none;
color: blue;
}
The following patterns are not considered warnings:
a {
display: block;
height: 1px;
width: 2px;
}
a {
display: block;
height: 1px;
width: 2px;
border: 0;
}
a {
display: block;
height: 1px;
width: 2px;
border: 0;
transform: none;
}
a {
display: block;
height: 1px;
border: 0;
}
a {
border: 0;
transform: none;
color: blue;
}
a {
display: block;
height: 1px;
width: 2px;
border: 0;
transform: none;
color: blue;
}
Autofixing caveats
Properties will be grouped together, if other node types between them (except comments). They will be grouped with the first found property. E.g.:
/* Before: */
a {
--custom-prop: 10px;
top: 0;
--another-custom-prop: 10px;
bottom: 2px;
}
/* After: */
a {
--custom-prop: 10px;
top: 0;
bottom: 2px;
--another-custom-prop: 10px;
}
If unspecified secondary option was set to ignore, it will be re-set to bottom.