# csscomb

> CSS coding style formatter

Latest version **4.3.0** (published 2019-04-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install csscomb
pnpm add csscomb
yarn add csscomb
bun add csscomb
```

Provides the command `csscomb`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.3.0 |
| Published | 2019-04-18 |
| First published | 2013-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 6 |
| Unpacked size | 140.6 KB |
| Known vulnerabilities | 0 (+6 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3333 |
| Author | Mikhail Troshev |
| Maintainers | tonyganch |

## Links

- npm: https://www.npmjs.com/package/csscomb
- Repository: https://github.com/csscomb/csscomb.js
- Homepage: http://csscomb.com/
- Issues: https://github.com/csscomb/csscomb.js/issues
- npm.io page: https://npm.io/package/csscomb

## Dependencies (6)

- [vow](https://npm.io/package/vow.md) 0.4.19
- [vow-fs](https://npm.io/package/vow-fs.md) 0.3.6
- [minimist](https://npm.io/package/minimist.md) 1.2.0
- [minimatch](https://npm.io/package/minimatch.md) 3.0.4
- [gonzales-pe](https://npm.io/package/gonzales-pe.md) 4.2.4
- [@babel/polyfill](https://npm.io/package/@babel/polyfill.md) ^7.4.0

## Recent versions

- 4.3.0 (latest) — 2019-04-18
- 4.2.0 — 2017-06-12
- 4.1.0 — 2017-05-16
- 4.0.1 — 2017-02-28
- 4.0.0 — 2017-02-16
- 4.0.0-alpha — 2016-07-11
- 3.1.8 — 2015-06-28
- 3.1.7 — 2015-06-09
- 3.1.6 — 2015-06-09
- 3.1.5 — 2015-05-27
- 3.1.4 — 2015-05-23
- 3.1.3 — 2015-05-20
- 3.1.2 — 2015-05-20
- 3.1.1 — 2015-05-20
- 3.1.0 — 2015-05-19
- … 30 more at https://npm.io/package/csscomb/versions

## README

# CSScomb [![CSSComb](logo.png)](http://csscomb.com/)
[![Build Status](https://travis-ci.org/csscomb/csscomb.js.svg?branch=master)](http://travis-ci.org/csscomb/csscomb.js)
[![NPM version](https://badge.fury.io/js/csscomb.svg)](http://badge.fury.io/js/csscomb)
[![Dependency Status](https://david-dm.org/csscomb/csscomb.js.svg)](https://david-dm.org/csscomb/csscomb.js)
[![devDependency Status](https://david-dm.org/csscomb/csscomb.js/dev-status.svg)](https://david-dm.org/csscomb/csscomb.js#info=devDependencies)

CSScomb is a coding style formatter for CSS.
You can easily write your own [configuration](doc/configuration.md) to make
your style sheets beautiful and consistent.

The main feature is [sorting properties](doc/options.md#sort-order) in a specific order.
It was inspired by [@miripiruni](https://github.com/miripiruni)'s
[PHP-based tool](https://github.com/csscomb/csscomb) of the same name.
This is the new JavaScript version, based on the powerful CSS parser
[Gonzales PE](https://github.com/tonyganch/gonzales-pe).

## 1. Install

Global installation (for use as a command-line tool):

```bash
npm install csscomb -g
```

Local installation (for use as a command-line tool within current directory):

```bash
npm install csscomb
```

To install as a project dependency (the package will appear in your dependencies):

```bash
npm install csscomb --save
```

To install as a dev dependency (the package will appear in your devDependencies):

```bash
npm install csscomb --save-dev
```

## 2. [Configure](doc/configuration.md)

There are a number of ways to configure CSScomb:

- Use one of [predefined configs](config)
- Put `.csscomb.json` file in the project root.
- Set path to config's file
- Use `*.css` file as a template

## 3. Use

### [Command Line](doc/usage-cli.md)

```bash
csscomb assets/css
```

### [Node.js module](doc/usage-node.md)

```js
var Comb = require('csscomb');
var comb = new Comb('zen');
comb.processPath('assets/css');
```

## 4. Contribute

This project is actively mantained. But anyone and everyone is welcome to contribute.
Please take a moment to review the [guidelines for contributing](CONTRIBUTING.md).

Also you can become a mantainer. To do that please ping
[@tonyganch](https://github.com/tonyganch).

## Authors

[@mishanga](https://github.com/mishanga),
[@tonyganch](https://github.com/tonyganch)

Thanks for assistance and contributions:

[@miripiruni](https://github.com/miripiruni),
[@anton-rudeshko](https://github.com/anton-rudeshko),
[@cvrebert](https://github.com/cvrebert),
[@filtercake](https://github.com/filtercake),
[@ignovak](https://github.com/ignovak),
[@kizu](https://github.com/kizu),
[@lefoy](https://github.com/lefoy),
[@L0stSoul](https://github.com/L0stSoul),
[@mishaberezin](https://github.com/mishaberezin),
[@puzankov](https://github.com/puzankov),
[@schneyra](https://github.com/schneyra),
[@thejameskyle](https://github.com/thejameskyle),
[@vecmezoni](https://github.com/vecmezoni)

## License

This software is released under the terms of the
[MIT license](https://github.com/csscomb/csscomb.js/blob/master/LICENSE).

## Other projects
* https://github.com/senchalabs/cssbeautify
* https://github.com/css/gonzales
* https://github.com/tonyganch/gonzales-pe
* https://github.com/css/csso
* https://github.com/nzakas/parser-lib

---
_Source: https://npm.io/package/csscomb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
