https://github.com/ben-eb/gulp-csso

Minify CSS with CSSO.
https://github.com/ben-eb/gulp-csso

Last synced: 13 days ago
JSON representation

Minify CSS with CSSO.

• Host: GitHub
• URL: https://github.com/ben-eb/gulp-csso
• Owner: ben-eb
• License: mit
• Created: 2013-12-05T22:18:23.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2022-03-25T19:24:18.000Z (over 2 years ago)
• Last Synced: 2024-10-18T08:32:18.694Z (28 days ago)
• Language: JavaScript
• Homepage:
• Size: 72.3 KB
• Stars: 243
• Watchers: 13
• Forks: 26
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# [gulp](https://github.com/gulpjs/gulp)-csso [![Build Status](https://travis-ci.org/ben-eb/gulp-csso.svg?branch=master)](https://travis-ci.org/ben-eb/gulp-csso) [![NPM version](https://badge.fury.io/js/gulp-csso.svg)](http://badge.fury.io/js/gulp-csso) [![Dependency Status](https://img.shields.io/david/ben-eb/gulp-csso.svg)](https://david-dm.org/ben-eb/gulp-csso)

> Minify CSS with [CSSO](https://www.npmjs.com/package/csso).

*If you have any difficulties with the output of this plugin, please use

the [CSSO tracker](https://github.com/css/csso/issues).*

## Install

With [npm](https://www.npmjs.com/package/gulp-csso) do:

```

npm install gulp-csso --save-dev

```

## Example

```js

var gulp = require('gulp');

var csso = require('gulp-csso');

gulp.task('default', function () {

    return gulp.src('./main.css')

        .pipe(csso())

        .pipe(gulp.dest('./out'));

});

gulp.task('development', function () {

    return gulp.src('./main.css')

        .pipe(csso({

            restructure: false,

            sourceMap: true,

            debug: true

        }))

        .pipe(gulp.dest('./out'));

});

```

## API

### csso([options])

#### options

For backwards compatibility it can also be a `boolean`. In this case, the

inverted value is set to `options.restructure`

(e.g. `true` becomes `{restructure: false}`).

##### restructure

Type: `boolean`  

Default: `true`

The default is to use structure minimization for maximum compression.

Pass `false` instead if you want to disable this feature.

##### sourceMap

Type: `boolean`  

Default: depends on input file has a source map or not

Specify this to generate source map; by default a source map is generated only

if the input file has a source map. Pass `true` to ensure that the source map

is generated or `false` to disable this.

Alternatively, you can enable source maps support using [gulp-sourcemaps]:

[gulp-sourcemaps]: https://github.com/floridoo/gulp-sourcemaps

```js

var gulp = require('gulp');

var csso = require('gulp-csso');

var sourcemaps = require('gulp-sourcemaps');

gulp.task('default', function () {

    return gulp.src('main.css')

        .pipe(sourcemaps.init())

        .pipe(csso())

        .pipe(sourcemaps.write('.'))

        .pipe(gulp.dest('./out'));

});

```

##### debug

Type: `boolean`  

Default: `false`

Pass `true` or a positive number (greater number for more details) to get some

debugging information about the minification process.

##### usage

Type: `object`

Default: `null`

Usage data for advanced optimisations (read more in the [CSSO documentation](https://github.com/css/csso#usage-data)).

## Contributing

Pull requests are welcome. If you add functionality, then please add unit tests

to cover it.

## License

MIT © [Ben Briggs](http://beneb.info)