broccoli-compass-compiler

0.0.6 verified Fri May 01 auth: no javascript deprecated

Broccoli plugin to compile Sass/SCSS files using the Compass framework. Version 0.0.6 is the latest release, but the package is no longer maintained. It wraps the `compass compile` command, requiring Ruby and Compass to be installed. Use broccoli-sass or broccoli-eyeglass for modern alternatives.

Common errors

error Error: Compass was unable to find a project root directory ↓

cause Missing config.rb in source directory

fix

Ensure config.rb exists in each CSS source directory

error Error: spawn compass ENOENT ↓

cause Compass binary not found in PATH

fix

Install Compass: gem install compass

Warnings

gotcha Requires Ruby and Compass gem installed globally. Not a pure Node.js solution. ↓

fix Install Ruby and `gem install compass`. Alternatively use broccoli-sass (node-sass) or broccoli-eyeglass.

deprecated Package is unmaintained since 2015. No updates or bug fixes. ↓

fix Migrate to broccoli-sass (C++) or broccoli-eyeglass (JS-based with libsass).

Install

npm install broccoli-compass-compiler

yarn add broccoli-compass-compiler

pnpm add broccoli-compass-compiler

Imports

compileCompass

wrong

import compileCompass from 'broccoli-compass-compiler'

correct

const compileCompass = require('broccoli-compass-compiler')

CJS only; no ES module support.

default

wrong

const compileCompass = require('broccoli-compass-compiler').default

correct

const compileCompass = require('broccoli-compass-compiler')

No default export; module exports the function directly.

type

wrong

import compileCompass from 'broccoli-compass-compiler'

correct

const compileCompass: (paths: string[], options?: object) => any = require('broccoli-compass-compiler')

No TypeScript types; manually declare module or use @ts-ignore.

Quickstart

Basic usage: compile Sass with Compass using Broccoli, output compressed CSS.

const compileCompass = require('broccoli-compass-compiler');
const tree = compileCompass(['app/styles'], {
  outputStyle: 'compressed'
});
// Export tree for Broccoli pipeline
module.exports = tree;