# Builders

> Assets builders: css, js, sprites.

Latest version **2.0.0** (published 2016-10-30) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2.0.0 |
| Published | 2016-10-30 |
| First published | 2016-10-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12.7 |
| Dependencies | 11 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Roman Kazakov |
| Maintainers | rc21 |

## Links

- npm: https://www.npmjs.com/package/Builders
- Repository: https://github.com/rc21net/builders
- Issues: https://github.com/rc21net/builders/issues
- npm.io page: https://npm.io/package/Builders

## Dependencies (11)

- [nib](https://npm.io/package/nib.md) *
- [less](https://npm.io/package/less.md) *
- [async](https://npm.io/package/async.md) *
- [stylus](https://npm.io/package/stylus.md) *
- [clean-css](https://npm.io/package/clean-css.md) *
- [node-sass](https://npm.io/package/node-sass.md) *
- [uglify-js](https://npm.io/package/uglify-js.md) *
- [LiveScript](https://npm.io/package/LiveScript.md) *
- [underscore](https://npm.io/package/underscore.md) *
- [spritesmith](https://npm.io/package/spritesmith.md) *
- [coffee-script](https://npm.io/package/coffee-script.md) *

## Recent versions

- 2.0.0 (latest) — 2016-10-30

## README

# Builders

## Bundler

### bundler.config.json

    {
        "scannedRootDirectories": [
            "../css",
            "../js"
        ],
        "defaultOptions": {
            "folder": "recursive",
            "force": true,
            "forceCss": true
        },
        "bundles": [{
            "name": "main.css",
            "path": "../css",
            "options": {
                "folder": "recursive",
                "force": true
            },
            "files": [
                "/raw/jquery-1.11.1.min.js"
                "/raw/jquery-migrate-1.2.1.min.js"
                "/raw/jquery.validate.js"
                "/raw/layout.init.js"
            ]
        }]
    }

### .bundle file

    #options folder:recursive,force
    /raw/jquery-1.11.1.min.js
    /raw/jquery-migrate-1.2.1.min.js
    /raw/jquery.validate.js
    /raw/layout.init.js

The currently available options are:

  - **folder** - Used as a trigger to transform all files in the folder with this bundle file. If the `recursive` value
    is used, a seek will search recursively from this root transforming all files in all folders searched.
    When the `folder` option is used, the `nobundle` option is automatically set. When the `folder` option is used,
    listing files in the bundle file does nothing.
  - **force** - `true|false` Turn on force compilation of assets even if assets have not been modified. Default `false`.
  - **forceCss** - `true|false` Turn on force mode for css bundles. Default `false`.
    It may be useful to turn on this option because css assets (css, sass, less etc.) may include other aseets
    by `@import` rule and bundler can not watch this imported assets. May be used only as `defaultOptions`.

## Spriter

### spriter.config.json

    {
        "outputDir": 		"../images/sprites/ (required)",
        "outputDirForCss":	"/images/sprites/ (required)",
        "inputPath": 		"../images/sprites/raw/ (required)",
        "sassPath": 		"../css/raw/vars-n-mixins/_sprites.scss (required)",
        "padding":			"int (optional, default - 2)",
        "algorithm":		"binary-tree (default) | top-down | left-right | diagonal | alt-diagonal (see https://github.com/Ensighten/spritesmith#algorithms)"
    }

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