https://github.com/shinnn/clean-css-promise

Promisified version of clean-css
https://github.com/shinnn/clean-css-promise

async clean-css css javascript minification nodejs optimization promise style wrapper

Last synced: 26 days ago
JSON representation

Promisified version of clean-css

• Host: GitHub
• URL: https://github.com/shinnn/clean-css-promise
• Owner: shinnn
• License: isc
• Created: 2015-10-06T07:06:36.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-05-06T12:30:43.000Z (over 3 years ago)
• Last Synced: 2024-09-21T13:13:43.203Z (about 2 months ago)
• Topics: async, clean-css, css, javascript, minification, nodejs, optimization, promise, style, wrapper
• Language: JavaScript
• Homepage: https://github.com/jakubpawlowicz/clean-css
• Size: 101 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# clean-css-promise

[![npm version](https://img.shields.io/npm/v/clean-css-promise.svg)](https://www.npmjs.com/package/clean-css-promise)

[![Github Actions](https://action-badges.now.sh/shinnn/clean-css-promise)](https://wdp9fww0r9.execute-api.us-west-2.amazonaws.com/production/results/shinnn/clean-css-promise)

[![codecov](https://codecov.io/gh/shinnn/clean-css-promise/branch/master/graph/badge.svg)](https://codecov.io/gh/shinnn/clean-css-promise)

[clean-css](https://github.com/jakubpawlowicz/clean-css) with the default [Promise](https://developer.mozilla.org/docs/Mozilla/JavaScript_code_modules/Promise.jsm/Promise) interface and some improvements

```javascript

const CleanCssPromise = require('clean-css-promise');

(async () => {

  const {styles} = await new CleanCssPromise().minify(`

p {

  color: #ff0000;

}

b {

  /* nothing */

}

`); //=> 'p{color:red}'

})();

```

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).

```

npm install clean-css-promise

```

## API

```javascript

const CleanCssPromise = require('clean-css-promise');

```

### class CleanCssPromise([*options*])

*options*: `Object` ([clean-css constructor options](https://github.com/jakubpawlowicz/clean-css#constructor-options))  

Almost the same the original `clean-css`, except for:

* [`returnPromise` option](https://github.com/jakubpawlowicz/clean-css#promise-interface) is enabled by default, and cannot be disabled.

* [*onRejected*](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/then#Parameters) function receives an `Error` instead of an `Array`.

* All problems that clean-css considers as *warnings*, for example broken CSS syntax, are regarded as *errors*.

```javascript

const CleanCssPromise = require('clean-css-promise');

new CleanCssPromise({})

.minify('@import url(/foo);}')

.catch(err => {

  err.message;

  /*=> `2 errors found while optimizing CSS with clean-css:

  1. Ignoring local @import of "/foo" as resource is missing.

  2. Invalid character(s) '?' at 1:18. Ignoring.

clean-css dangerously ignores these errors but clean-css-promise doesn't, because it's much more reasonable to update the CSS to fix all problems than to pretend that you didn't see the errors.` */

});

```

## License

[ISC License](./LICENSE) © 2017 - 2019 Watanabe Shinnosuke