UNPKG

1.64 kBMarkdownView Raw
1scss-bundle
2===========
3[![NPM version](http://img.shields.io/npm/v/scss-bundle.svg)](https://www.npmjs.com/package/scss-bundle) [![dependencies Status](https://david-dm.org/quatrocode/scss-bundle/status.svg)](https://david-dm.org/quatrocode/scss-bundle) [![devDependencies Status](https://david-dm.org/quatrocode/scss-bundle/dev-status.svg)](https://david-dm.org/quatrocode/scss-bundle?type=dev)
4
5## Get started
6If you want to use `scss-bundle` globally
7```sh
8$ npm install scss-bundle -g
9```
10
11## Features
12- Bundles all SCSS imports into a single file.
13
14## Usage
15```sh
16$ scss-bundle -h
17```
18
19### Examples
20_Using config:_
21```sh
22$ scss-bundle -c scss-bundle.config.json
23```
24_Without config:_
25
26If you want to use `scss-bundle` without configuration file, `entry` and `dest` arguments are required.
27```sh
28$ scss-bundle -e ./src/main.scss -d bundled.scss
29```
30
31## Config example
32```json
33{
34 "entry": "./src/main.scss",
35 "dest": "bundled.scss"
36}
37```
38
39| Argument | Type | Description | Values | Default |
40|-----------|--------|--------------------------------------------------| | |
41| entry<sup>`*`</sup> | string | Main entry file where to start bundling. | | |
42| dest<sup>`*`</sup> | string | Destination file when bundling is done. | | |
43| verbosity | string choices | Destination file when bundling is done. | None, Errors, Verbose | Verbose |
44
45`*` - Required
46
47## License
48Released under the [AGPL-3.0 license](LICENSE).