# recess

> A simple, attractive code quality tool for CSS built on top of LESS

Latest version **1.1.9** (published 2013-07-04) · 0 weekly downloads

## Install

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

Provides the command `recess`.

## 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 | 1.1.9 |
| Published | 2013-07-04 |
| First published | 2012-04-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.4.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2164 |
| Author | Jacob Thornton |
| Maintainers | fat, jonschlinkert |
| Keywords | css, lint |

## Links

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

## Dependencies (5)

- [less](https://npm.io/package/less.md) ~1.3.0
- [nopt](https://npm.io/package/nopt.md) >= 1.0.10
- [watch](https://npm.io/package/watch.md) >= 0.5.1
- [colors](https://npm.io/package/colors.md) >= 0.3.0
- [underscore](https://npm.io/package/underscore.md) >= 1.2.1

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.1.9 (latest) — 2013-07-04
- 1.1.8 — 2013-06-14
- 1.1.7 — 2013-06-14
- 1.1.6 — 2012-08-19
- 1.1.5 — 2012-08-19
- 1.1.4 — 2012-07-13
- 1.1.3 — 2012-07-11
- 1.1.1 — 2012-07-11
- 1.1.0 — 2012-07-11
- 1.0.4 — 2012-04-26
- 1.0.3 — 2012-04-20
- 1.0.2 — 2012-04-18
- 1.0.1 — 2012-04-18
- 1.0.0 — 2012-04-17
- 0.1.0 — 2012-04-17

## README

RECESS [![Build Status](https://secure.travis-ci.org/twitter/recess.png)](http://travis-ci.org/twitter/recess)
======

Developed at Twitter to support our internal styleguide, RECESS is a simple, attractive code quality tool for CSS built on top of LESS.

Incorporate it into your development process as a linter, or integrate it directly into your build system as a compiler, RECESS will keep your source looking clean and super manageable.


GENERAL USE
-----------

```CLI
$ recess [path] [options]
```

OPTIONS
-------

- --compile - compiles your code and outputs it to the terminal. Fixes white space and sort order. Can compile css or less.
- --compress - compress your compiled code.
- --config - accepts a path, which specifies a json config object
- --format <format> - control the output format of errors:
  - --format text - the default format, shows errors and context
  - --format compact - show errors one-error-per-line, useful for IDE integration
- --noSummary - don't output the summary block for each file
- --includePath - accepts an additional directory path to look for `@import`:ed LESS files in.
- --stripColors - removes color from output (useful when logging)
- --watch - watch filesystem for changes, useful when compiling Less projects
- --noIDs - doesn't complain about using IDs in your stylesheets
- --noJSPrefix - doesn't complain about styling `.js-` prefixed classnames
- --noOverqualifying - doesn't complain about overqualified selectors (ie: `div#foo.bar`)
- --noUnderscores - doesn't complain about using underscores in your class names
- --noUniversalSelectors - doesn't complain about using the universal `*` selector
- --prefixWhitespace - adds whitespace prefix to line up vender prefixed properties
- --strictPropertyOrder - doesn't looking into your property ordering
- --zeroUnits - doesn't complain if you add units to values of 0


EXAMPLES
--------

Lint all css files

```CLI
$ recess *.css
```

Lint file, ignore styling of IDs

```CLI
$ recess ./bootstrap.css --noIds false
```

Lint file with compact output and no color

```CLI
$ recess ./bootstrap.css --format compact --stripColors
```

Compile and compress .less file, then output it to a new file

```CLI
$ recess ./bootstrap.less --compress > ./bootstrap-production.css
```

Watch a directory for changes and auto compile a css file from the changes. *experimental*

```CLI
$ recess input.less:ouput.css --watch watch/this/dir/for/changes
```

Watch a single file for changes and auto compile a css file from the changes. *experimental*

```CLI
$ recess input.less:ouput.css --watch
```

PROGRAMMATIC API
----------------

Recess provides a pretty simple programmatic api.

```JS
var recess = require('recess')
```

Once you've required recess, just pass it a `path` (or array of paths) and an optional `options` object and an optional `callback`:

```js
recess(['../fat.css', '../twitter.css'], { compile: true }, callback)
```

The following options (and defaults) are available in the programatic api:

- compile: false
- compress: false
- includePath: []
- noIDs: true
- noJSPrefix: true
- noOverqualifying: true
- noUnderscores: true
- noUniversalSelectors: true
- prefixWhitespace: true
- strictPropertyOrder: true
- stripColors: false
- zeroUnits: true

The callback is fired when each instance has finished processessing an input. The callback is passed an array of of instances (one for each path). The instances have a bunch of useful things on them like the raw data and an array of output strings.

When compiling, access the compiled source through the output property:

```js
var recess = require('recess')

recess('./js/fat.css', { compile: true }, function (err, obj) {
  if (err) throw err
  console.log(
  	obj // recess instance for fat.css
  , obj.output // array of loggable content
  , obj.errors // array of failed lint rules
  )
})
```

INSTALLATION
------------

To install recess you need both node and npm installed.

```CLI
$ npm install recess -g
```

AUTHORS
------------

+ **Jacob Thornton**: https://twitter.com/fat

LICENSE
------------

Copyright 2012 Twitter, Inc.

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

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