@spectrum-css/bundle-builder/README.md

The Spectrum CSS top-level builder

# @spectrum-css/bundle-builder

> Build system for Spectrum CSS bundle packages

This package builds a bundle packages with the versions of components specific in your the bundle's `package.json`.

## Docs

See the [docs generation documentation](docs/README.md) for details on documentation generation.

## Site

See the [site generation documentation](site/README.md) for details on site generation as well as editing and updating the site.

## Usage

Install the package:

```
npm install --save-dev @spectrum-css/bundle-builder
```

Create a `gulpfile.js` with the following:

```js
module.exports = require("@spectrum-css/bundle-builder");
```

Add the following scripts to `package.json`:

```json
{
	"scripts": {
		"build": "gulp build",
		"prepack": "gulp prePack",
		"postpublish": "gulp postPublish"
	}
}
```

Then you can use the commands below inside of your project to build and release a Spectrum CSS bundle package.

## CLI

The following tasks are available:

- `gulp clean` - Clean everything
- `gulp build` - Build every component, generate the documentation site, generate individual docs for each component
- `gulp buildLite` - Build only the custom properties for every component, generate the documentation site
- `gulp buildHeavy` - Build all CSS for every component, generate the documentation site
- `gulp dev` - Perform a lite build, start a server, and watch for changes
- `gulp devHeavy` - Perform a heavy build, start a server, and watch for changes.
- `gulp watch` - If a build as already been performed, start a server and watch for changes
- `gulp release` - Perform a release

Build output appears in the `dist/` folder.