240 lines
6.4 KiB
Markdown
Raw Normal View History

2020-05-19 11:43:42 +03:00
# PostCSS Sorting [![Build Status][ci-img]][ci] [![npm version][npm-version-img]][npm] [![npm downloads last month][npm-downloads-img]][npm]
[PostCSS] plugin to keep rules and at-rules content in order.
Also available as [Sublime Text], [Atom], [VS Code], and [Emacs] plugin.
Lint and autofix style sheets order with [stylelint-order].
## Features
* Sorts rules and at-rules content.
* Sorts properties.
* Sorts at-rules by different options.
* Groups properties, custom properties, dollar variables, nested rules, nested at-rules.
* Supports CSS, SCSS (using [postcss-scss]), HTML (with [postcss-html]), CSS-in-JS (with [postcss-jsx]), [PreCSS] and most likely any other syntax added by other PostCSS plugins.
## Installation
```bash
$ npm install postcss-sorting
```
## Options
The plugin has no default options. Everything is disabled by default.
- [`order`](./lib/order/README.md): Specify the order of content within declaration blocks.
- [`properties-order`](./lib/properties-order/README.md): Specify the order of properties within declaration blocks.
- [`unspecified-properties-position`](./lib/properties-order/unspecified-properties-position.md): Specify position for properties not specified in `properties-order`.
- `throw-validate-errors`: Throw config validation errors instead of just 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.
```css
a {
top: 5px; /* shared-line comment belongs to `top` */
/* comment belongs to `bottom` */
/* comment belongs to `bottom` */
bottom: 15px; /* shared-line comment belongs to `bottom` */
}
```
### Ignored at-rules
Some at-rules, like [control](https://sass-lang.com/documentation/file.SASS_REFERENCE.html#control_directives__expressions) and [function](https://sass-lang.com/documentation/file.SASS_REFERENCE.html#function_directives) directives in Sass, are ignored. It means rules won't touch content inside these at-rules, as doing so could change or break functionality.
### CSS-in-JS
Plugin will ignore rules, which have template literal interpolation, to avoid breaking logic:
```js
const Component = styled.div`
/* The following properties WILL NOT be sorted, because interpolation is on properties level */
z-index: 1;
top: 1px;
${props => props.great && 'color: red'};
position: absolute;
display: block;
div {
/* The following properties WILL be sorted, because interpolation for property value only */
z-index: 2;
position: static;
top: ${2 + 10}px;
display: inline-block;
}
`;
```
## Migration from `2.x`
Remove all `*-empty-line-before` and `clean-empty-lines` options. Use [stylelint] with `--fix` option instead.
`properties-order` doesn't support property groups. Convert it to simple array. Use [stylelint-order] with `--fix` option for empty line before property groups.
Config for `2.x`:
```json
{
"properties-order": [
{
"properties": [
"margin",
"padding"
]
},
{
"emptyLineBefore": true,
"properties": [
"border",
"background"
]
}
]
}
```
Config for `3.x`:
```json
{
"properties-order": [
"margin",
"padding",
"border",
"background"
]
}
```
## Usage
See [PostCSS] docs for examples for your environment.
### Text editor
This plugin available as [Sublime Text], [Atom], [VS Code], and [Emacs] plugin.
### Gulp
Add [Gulp PostCSS] and PostCSS Sorting to your build tool:
```bash
npm install gulp-postcss postcss-sorting --save-dev
```
Enable PostCSS Sorting within your Gulpfile:
```js
var postcss = require('gulp-postcss');
var sorting = require('postcss-sorting');
gulp.task('css', function () {
return gulp.src('./css/src/*.css').pipe(
postcss([
sorting({ /* options */ })
])
).pipe(
gulp.dest('./css/src')
);
});
```
### Grunt
Add [Grunt PostCSS] and PostCSS Sorting to your build tool:
```bash
npm install grunt-postcss postcss-sorting --save-dev
```
Enable PostCSS Sorting within your Gruntfile:
```js
grunt.loadNpmTasks('grunt-postcss');
grunt.initConfig({
postcss: {
options: {
processors: [
require('postcss-sorting')({ /* options */ })
]
},
dist: {
src: 'css/*.css'
}
}
});
```
### Command Line
Add [postcss-cli](https://github.com/postcss/postcss-cli) and PostCSS Sorting to your project:
```bash
npm install postcss-cli postcss-sorting --save-dev
```
Create an appropriate `postcss.config.js` like this example:
```js
module.exports = (ctx) => ({
plugins: {
'postcss-sorting': {
'order': [
'custom-properties',
'dollar-variables',
'declarations',
'at-rules',
'rules'
],
'properties-order': 'alphabetical',
'unspecified-properties-position': 'bottom'
}
}
})
```
Or, simply add the `'postcss-sorting'` section to your existing postcss-cli configuration file. Next, execute:
```bash
postcss -c postcss.config.js --no-map -r your_css_file.css
```
For more information and options, please consult the [postcss-cli docs](https://github.com/postcss/postcss-cli/blob/master/README.md).
## Related tools
[stylelint] and [stylelint-order] help lint style sheets and let you know if style sheet order is correct. Also, they could autofix style sheets.
I recommend [Prettier] for formatting style sheets.
[ci-img]: https://travis-ci.org/hudochenkov/postcss-sorting.svg
[ci]: https://travis-ci.org/hudochenkov/postcss-sorting
[npm-version-img]: https://img.shields.io/npm/v/postcss-sorting.svg
[npm-downloads-img]: https://img.shields.io/npm/dm/postcss-sorting.svg
[npm]: https://www.npmjs.com/package/postcss-sorting
[PostCSS]: https://github.com/postcss/postcss
[Sublime Text]: https://github.com/hudochenkov/sublime-postcss-sorting
[Atom]: https://github.com/lysyi3m/atom-postcss-sorting
[VS Code]: https://github.com/mrmlnc/vscode-postcss-sorting
[Emacs]: https://github.com/P233/postcss-sorting.el
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
[PreCSS]: https://github.com/jonathantneal/precss
[postcss-scss]: https://github.com/postcss/postcss-scss
[postcss-html]: https://github.com/gucong3000/postcss-html
[postcss-jsx]: https://github.com/gucong3000/postcss-jsx
[Prettier]: https://prettier.io/
[stylelint]: https://stylelint.io/
[stylelint-order]: https://github.com/hudochenkov/stylelint-order