# scss-composer

> Composes SCSS main file based on configuration

Latest version **0.1.1** (published 2016-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install scss-composer
pnpm add scss-composer
yarn add scss-composer
bun add scss-composer
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2016-04-25 |
| First published | 2016-04-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Niclas Sahlin |
| Maintainers | niclassahlin |

## Links

- npm: https://www.npmjs.com/package/scss-composer
- Repository: https://github.com/jointrine/scss-composer
- Issues: https://github.com/jointrine/scss-composer/issues
- npm.io page: https://npm.io/package/scss-composer

## Dependencies (4)

- [glob](https://npm.io/package/glob.md) ^7.0.3
- [vinyl](https://npm.io/package/vinyl.md) ^1.1.1
- [through2](https://npm.io/package/through2.md) ^2.0.1
- [vinyl-fs](https://npm.io/package/vinyl-fs.md) ^2.4.3

## Recent versions

- 0.1.1 (latest) — 2016-04-25
- 0.1.0 — 2016-04-23

## README

# SCSS Composer
Dynamically composes a root SCSS file based on glob patterns in a configuration file.

Only works with Gulp for now, but commandline support is planned as well.

## Installation

`npm install --save-dev scss-compose`

## Usage

Start by creating a config file where you can define your SCSS modules. The format is JSON.

``` json
// scss-config.json
{
  "modules": {
    "common": [
      "css/config/**/*.scss",
      "css/common/**/*.scss"
    ],
    "main": [
      "css/config/**/*.scss",
      "css/components/**/*.scss",
      "css/pages/**/*.scss"
    ]
  }
}
```

As you can see, the config file can declare multiple modules (here `common` and `main`) that will be created as separate root files.

When you have the config file, use it in your gulp task for SCSS.

``` javascript
// gulpfile.js
var gulp = require("gulp");
var sass = require("gulp-sass");
var composer = require("scss-composer");

gulp.task("build:css", () => {
  return gulp.src("scss-config.json")
    .pipe(composer())
    .pipe(sass())
    .pipe(gulp.dest("dist"));
});
```

This will result in two files, `dist/common.css` and `dist/main.css`, that has included all files that matched the respective file globs. 

# License
MIT

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