Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

css-declaration-sorter

Package Overview
Dependencies
0
Maintainers
1
Versions
36
Issues
File Explorer

Advanced tools

css-declaration-sorter

Sorts CSS declarations fast and automatically in a certain order.

    6.3.1latest

Version published
Maintainers
1
Weekly downloads
8,234,277
decreased by-21.45%

Weekly downloads

Changelog

Source

[6.3.1] - 2022-09-02

Fixed

  • Logical border properties moving with keepOverrides.

Readme

Source
CSS declaration sorter logo

CSS Declaration Sorter

LGTM Grade npm

A Node.js module and PostCSS plugin to sort CSS, SCSS or Less declarations based on their property names. Ensuring styling is organized, more consistent and in order... The goal of this package is to sort the source code of a project in the build process or to decrease the distributed CSS gzipped size.

Check out the Prettier plugin for usage with a variety of file formats.

Niceness

  • Up-to-date CSS properties fetched from the MDN Compatibility Data project.
  • Choose your wanted order or provide your own.
  • Nested rules sorting support.
  • SCSS and Less support when combined with either postcss-scss or postcss-less.
  • Thought-out sorting orders out of the box, approved by their authors.

Alphabetical example

Input:

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

Output:

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

Built-in sorting orders

  • Alphabetical
    alphabetical
    Default, order in a simple alphabetical manner from a - z.

  • SMACSS
    smacss
    Order from most important, flow affecting properties, to least important properties.

    1. Box
    2. Border
    3. Background
    4. Text
    5. Other
  • Concentric CSS
    concentric-css
    Order properties applying outside the box model, moving inward to intrinsic changes.

    1. Positioning
    2. Visibility
    3. Box model
    4. Dimensions
    5. Text

Usage

Following the PostCSS plugin guidelines, this package depends on PostCSS as a peer dependency:
npm install postcss 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, the postcss-cli package is a required dependency.

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

Sorting all files in a directory with SCSS syntax using postcss-scss by overwriting:
postcss ./src/**/*.scss --syntax postcss-scss --use css-declaration-sorter --replace --no-map

Sorting all files in the directory with SCSS syntax and SMACSS order by overwriting, using package.json configuration:

"postcss": { "syntax": "postcss-scss", "map": false, "plugins": { "css-declaration-sorter": { "order": "smacss" } } }

postcss ./src/**/*.scss --replace --config package.json

Vanilla JS

import postcss from 'postcss'; import { cssDeclarationSorter } from 'css-declaration-sorter'; postcss([cssDeclarationSorter({ order: 'smacss' })]) .process('a { color: hyperblue; display: block; }', { from: undefined }) .then(result => console.log( result.css === 'a { display: block; color: hyperblue; }' ));

View more usage examples in combination with other tools.


API

cssDeclarationSorter({ order, keepOverrides })

order

Type: string or function
Default: alphabetical
Options: alphabetical, smacss, concentric-css

Provide the name of one of the built-in sort orders or a comparison function that is passed to (Array.sort). This function receives two declaration names and is expected to return -1, 0 or 1 depending on the wanted order.

keepOverrides

Type: Boolean
Default: false

To prevent breaking legacy CSS where shorthand declarations override longhand declarations (also taking into account vendor prefixes) this option can enabled. For example animation-name: some; animation: greeting; will be kept in this order when keepOverrides is true.

Keywords

FAQs

What is css-declaration-sorter?

Sorts CSS declarations fast and automatically in a certain order.

Is css-declaration-sorter popular?

The npm package css-declaration-sorter receives a total of 6,857,785 weekly downloads. As such, css-declaration-sorter popularity was classified as popular.

Is css-declaration-sorter well maintained?

We found that css-declaration-sorter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 02 Sep 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc