readme

# CSS Declaration Sorter

A Node.js module and PostCSS plugin to sort CSS declarations based on their property names. Ensuring the CSS is organized, more consistent and in order... Besides, sorted CSS is smaller when gzipped because there will be more similar strings. The intention of this module is to sort the source CSS code of a project in the build process. Check out the Atom package for individual usage.

## Alphabetical example

Input:

body {
display: block;
animation: none;
color: #C55;
border: 0;
}

Output:

body {
animation: none;
border: 0;
color: #C55;
display: block;
}

## Niceness

- Up-to-date CSS properties fetched from the MDN Web Platform.
- Sort using your own defined order.
- Nested rules sorting support.
- Less and SCSS support when combined with either postcss-scss or postcss-less.
- Thought-out sorting orders out of the box, approved by their authors.

## Sorting orders

- Alphabetically
  `alphabetically`
  Default, ordering in a simple alphabetical manner from a - z.
- SMACSS
  `smacss`
  Ordering from most important, flow affecting properties, to least important properties.
  - Box
  - Border
  - Background
  - Text
  - Other
- Concentric CSS
  `concentric-css`
  Starts outside the box model, moves inward.
  - Positioning
  - Visibility
  - Box model
  - Dimensions
  - Text
- Custom order
  Provide your own order by passing the location of a JSON file containing an array.

## Usage

`npm install css-declaration-sorter --save-dev`

### CLI

This module does not include its own CLI but works with the official PostCSS CLI. To use the examples below, install `postcss-cli` or prefix with `npx`.

Piping out result from file:
`postcss input.css --use css-declaration-sorter | cat`

Sorting multiple files by overwriting:
`postcss *.css --use css-declaration-sorter --replace --no-map`

### Vanilla JS

const fs = require('fs');
const postcss = require('postcss');
const cssDeclarationSorter = require('css-declaration-sorter');
postcss([cssDeclarationSorter({order: 'smacss'})])
.process(fs.readFileSync('some.css'))
.then(function (result) {
fs.writeFileSync('some.css', result.css);
});

### Gulp

const gulp = require('gulp');
const gulpPostcss = require('gulp-postcss');
const cssDeclarationSorter = require('css-declaration-sorter');
gulp.task('css', function () {
return gulp.src('some.css')
.pipe(gulpPostcss([cssDeclarationSorter({order: 'smacss'})]))
.pipe(gulp.dest('./'));
});

See PostCSS documentation for more examples and other environments.