PostCSS Sorting

PostCSS plugin to keep rules and atrule content in order.

Lint and autofix stylesheet order with stylelint-order.

Features

• Sorts rules and atrule content.
• Sorts properties.
• Sorts atrule by different options.
• Groups properties, custom properties, dollar variables, nested rules, nested atrule.
• Supports CSS, SCSS (using postcss-scss), CSS-in-JS (with @stylelint/postcss-css-in-js), HTML (with postcss-html), and most likely any other syntax added by other PostCSS plugins.

Installation

1npm install --save-dev postcss postcss-sorting

Options

The plugin has no default options. Everything is disabled by default.

• order: Specify the order of content within declaration blocks.
• properties-order: Specify the order of properties within declaration blocks.
• unspecified-properties-position: Specify position for properties not specified in properties-order.
• throw-validate-errors: Throw config validation errors instead of showing and ignoring them. Defaults to false.

Caveats

Handling comments

Comments that are before node and on a separate line linked to that node. Shared-line comments are also linked to that node. Shared-line comments are comments which are located after a node and on the same line as a node.

1a {
2	top: 5px; /* shared-line comment belongs to `top` */
3	/* comment belongs to `bottom` */
4	/* comment belongs to `bottom` */
5	bottom: 15px; /* shared-line comment belongs to `bottom` */
6}

Ignored atrule

Some atrule, like control and function directives in Sass, are ignored. It means rules won't touch content inside these atrule, as doing so could change or break functionality.

CSS-in-JS

Plugin will ignore rules, which have template literal interpolation, to avoid breaking the logic:

1const Component = styled.div`
2	/* The following properties WILL NOT be sorted, because interpolation is on properties level */
3	z-index: 1;
4	top: 1px;
5	${props => props.great && 'color: red'};
6	position: absolute;
7	display: block;
8
9	div {
10		/* The following properties WILL be sorted, because interpolation for property value only */
11		z-index: 2;
12		position: static;
13		top: ${2 + 10}px;
14		display: inline-block;
15	}
16`;

Usage

See PostCSS docs for more examples.

Command Line

Add postcss-cli and PostCSS Sorting to your project:

1npm install postcss postcss-cli postcss-sorting --save-dev

Create a postcss.config.js with PostCSS Sorting configuration:

1module.exports = {
2	plugins: [
3		'postcss-sorting': {
4			order: [
5				'custom-properties',
6				'dollar-variables',
7				'declarations',
8				'atrule',
9				'rules',
10			],
11
12			'properties-order': 'alphabetical',
13
14			'unspecified-properties-position': 'bottom',
15		},
16	],
17};

Or, add the 'postcss-sorting' section to your existing postcss-cli configuration file.

Next execute:

1npx postcss --no-map --replace your-css-file.css

For more information and options, please consult the postcss-cli docs.

Gulp

Add gulp-postcss and PostCSS Sorting to your build tool:

1npm install postcss gulp-postcss postcss-sorting --save-dev

Enable PostCSS Sorting within your Gulpfile:

1let gulp = require('gulp');
2let postcss = require('gulp-postcss');
3let sorting = require('postcss-sorting');
4
5exports['sort-css'] = () => {
6	return gulp
7		.src('./css/src/*.css')
8		.pipe(
9			postcss([
10				sorting({
11					/* options */
12				}),
13			])
14		)
15		.pipe(gulp.dest('./css/src'));
16};

Text editor

This plugin available as Sublime Text, Atom, VS Code, and Emacs plugin. Though, seems all these plugins are not maintained.

Related tools

stylelint and stylelint-order help lint stylesheets and let you know if stylesheet order is correct. Also, they could autofix stylesheets.

I recommend Prettier for formatting stylesheets.