# broccoli-compass

> Sass-compass plugin for Broccoli

Latest version **0.2.4** (published 2015-02-01) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install broccoli-compass
pnpm add broccoli-compass
yarn add broccoli-compass
bun add broccoli-compass
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2015-02-01 |
| First published | 2014-04-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 1 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Aboubakr GASMI |
| Maintainers | g13013 |
| Keywords | broccoli-plugin, broccoli, compass, compiler |

## Links

- npm: https://www.npmjs.com/package/broccoli-compass
- Repository: https://github.com/g13013/broccoli-compass
- Issues: https://github.com/g13013/broccoli-compass/issues
- npm.io page: https://npm.io/package/broccoli-compass

## Dependencies (8)

- [rsvp](https://npm.io/package/rsvp.md) ^3.0.9
- [dargs](https://npm.io/package/dargs.md) ^0.1.0
- [merge](https://npm.io/package/merge.md) ^1.1.3
- [mkdirp](https://npm.io/package/mkdirp.md) ~0.3.5
- [rimraf](https://npm.io/package/rimraf.md) ^2.2.8
- [quick-temp](https://npm.io/package/quick-temp.md) ^0.1.2
- [broccoli-writer](https://npm.io/package/broccoli-writer.md) ~0.1.1
- [symlink-or-copy](https://npm.io/package/symlink-or-copy.md) ^1.0.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.2.4 (latest) — 2015-02-01
- 0.2.3 — 2014-11-07
- 0.2.2 — 2014-11-06
- 0.2.1 — 2014-11-04
- 0.2.0 — 2014-11-04
- 0.1.2 — 2014-11-04
- 0.1.1 — 2014-09-11
- 0.1.0 — 2014-09-01
- 0.0.9 — 2014-08-13
- 0.0.8 — 2014-08-10
- 0.0.7 — 2014-06-23
- 0.0.6 — 2014-06-23
- 0.0.5 — 2014-06-03
- 0.0.4 — 2014-06-01
- 0.0.3 — 2014-04-24
- … 2 more at https://npm.io/package/broccoli-compass/versions

## README

# broccoli-compass [![Build Status](https://travis-ci.org/g13013/broccoli-compass.svg?branch=master)](https://travis-ci.org/g13013/broccoli-compass) [![Code Climate](https://codeclimate.com/github/g13013/broccoli-compass/badges/gpa.svg)](https://codeclimate.com/github/g13013/broccoli-compass)

Compiles compass project using [compass](https://github.com/chriseppstein/compass), so you need to have compass installed on your machine.

## Installation

```bash
npm install --save-dev broccoli-compass
```

## Tests

```bash
npm install
npm test
```

## Usage

Note: The API might change in subsequent 0.x versions.

```js
var compileSass = require('broccoli-compass');
var compassTree = compileSass(tree, {
    outputStyle: 'expanded'
  });
```
if `files` is omitted the entire folder will be compiled.

##### Plugin Options

* **compassCommand**: Command to execute compass. Default to `compass`.
* **ignoreErrors**: If set to `true`, Broccoli will only print the error instead of raising an exception. Default to `false`
* **cleanOutput** (slower): if `true`, css files will be processed to extract the list of images and fonts to be copied, instead the destination folder will contain all files. Default to `false`
* **exclude** [DEPRECATED]: deprecated in favor of `cleanOutput` option.

##### Compass Options

Please refer to the [compass configuration](http://compass-style.org/help/documentation/configuration-reference/) for more details about the available options


## Credits
* [Aboubakr Gasmi](https://github.com/g13013)
* All the contributors.

##License
[MIT](https://github.com/g13013/broccoli-compass/blob/master/LICENSE.md)

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