diff options
Diffstat (limited to 'node_modules/clean-css/README.md')
| -rw-r--r-- | node_modules/clean-css/README.md | 53 |
1 files changed, 49 insertions, 4 deletions
diff --git a/node_modules/clean-css/README.md b/node_modules/clean-css/README.md index b240f4381..3f7965b4a 100644 --- a/node_modules/clean-css/README.md +++ b/node_modules/clean-css/README.md @@ -9,7 +9,7 @@ [](https://travis-ci.org/jakubpawlowicz/clean-css) [](https://ci.appveyor.com/project/jakubpawlowicz/clean-css/branch/master) [](https://david-dm.org/jakubpawlowicz/clean-css) -[](https://www.npmjs.com/package/clean-css) +[](https://npmcharts.com/compare/clean-css?minimal=true) [](https://twitter.com/cleancss) clean-css is a fast and efficient CSS optimizer for [Node.js](http://nodejs.org/) platform and [any modern browser](https://jakubpawlowicz.github.io/clean-css). @@ -23,6 +23,7 @@ According to [tests](http://goalsmashers.github.io/css-minification-benchmark/) - [Use](#use) * [Important: 4.0 breaking changes](#important-40-breaking-changes) * [What's new in version 4.1](#whats-new-in-version-41) + * [What's new in version 4.2](#whats-new-in-version-42) * [Constructor options](#constructor-options) * [Compatibility modes](#compatibility-modes) * [Fetch option](#fetch-option) @@ -40,6 +41,7 @@ According to [tests](http://goalsmashers.github.io/css-minification-benchmark/) * [How to process remote `@import`s correctly?](#how-to-process-remote-imports-correctly) * [How to apply arbitrary transformations to CSS properties?](#how-to-apply-arbitrary-transformations-to-css-properties) * [How to specify a custom rounding precision?](#how-to-specify-a-custom-rounding-precision) + * [How to keep a CSS fragment intact?](#how-to-keep-a-css-fragment-intact) * [How to preserve a comment block?](#how-to-preserve-a-comment-block) * [How to rebase relative image URLs?](#how-to-rebase-relative-image-urls) * [How to work with source maps?](#how-to-work-with-source-maps) @@ -59,7 +61,7 @@ clean-css requires Node.js 4.0+ (tested on Linux, OS X, and Windows) # Install ``` -npm install clean-css +npm install --save-dev clean-css ``` # Use @@ -112,6 +114,16 @@ clean-css 4.1 introduces the following changes / features: * `removeUnusedAtRules` level 2 optimization controlling removal of unused `@counter-style`, `@font-face`, `@keyframes`, and `@namespace` at rules; * the [web interface](https://jakubpawlowicz.github.io/clean-css) gets an improved settings panel with "reset to defaults", instant option changes, and settings being persisted across sessions. +## What's new in version 4.2 + +clean-css 4.2 introduces the following changes / features: + +* Adds `process` method for compatibility with optimize-css-assets-webpack-plugin; +* new `transition` property optimizer; +* preserves any CSS content between `/* clean-css ignore:start */` and `/* clean-css ignore:end */` comments; +* allows filtering based on selector in `transform` callback, see [example](#how-to-apply-arbitrary-transformations-to-css-properties); +* adds configurable line breaks via `format: { breakWith: 'lf' }` option. + ## Constructor options clean-css constructor accepts a hash as a parameter with the following options available: @@ -253,6 +265,7 @@ new CleanCSS({ beforeBlockEnds: false, // controls if a line break comes before a block ends; defaults to `false` betweenSelectors: false // controls if a line break comes between selectors; defaults to `false` }, + breakWith: '\n', // controls the new line character, can be `'\r\n'` or `'\n'` (aliased as `'windows'` and `'unix'` or `'crlf'` and `'lf'`); defaults to system one, so former on Windows and latter on Unix indentBy: 0, // controls number of characters to indent with; defaults to `0` indentWith: 'space', // controls a character to indent with, can be `'space'` or `'tab'`; defaults to `'space'` spaces: { // controls where to insert spaces @@ -356,6 +369,7 @@ new CleanCSS({ tidyAtRules: true, // controls at-rules (e.g. `@charset`, `@import`) optimizing; defaults to `true` tidyBlockScopes: true, // controls block scopes (e.g. `@media`) optimizing; defaults to `true` tidySelectors: true, // controls selectors optimizing; defaults to `true`, + semicolonAfterLastProperty: false, // controls removing trailing semicolons in rule; defaults to `false` - means remove transform: function () {} // defines a callback for fine-grained property optimization; defaults to no-op } } @@ -437,7 +451,7 @@ console.log(output.warnings); // a list of warnings raised console.log(output.stats.originalSize); // original content size after import inlining console.log(output.stats.minifiedSize); // optimized content size console.log(output.stats.timeSpent); // time spent on optimizations in milliseconds -console.log(output.stats.efficiency); // a ratio of output size to input size (e.g. 25% if content was reduced from 100 bytes to 75 bytes) +console.log(output.stats.efficiency); // `(originalSize - minifiedSize) / originalSize`, e.g. 0.25 if size is reduced from 100 bytes to 75 bytes ``` The `minify` method also accepts an input source map, e.g. @@ -523,7 +537,7 @@ var source = '.block{background-image:url(/path/to/image.png)}'; var output = new CleanCSS({ level: { 1: { - transform: function (propertyName, propertyValue) { + transform: function (propertyName, propertyValue, selector /* `selector` available since 4.2.0-pre */) { if (propertyName == 'background-image' && propertyValue.indexOf('/path/to') > -1) { return propertyValue.replace('/path/to', '../valid/path/to'); } @@ -553,6 +567,36 @@ new CleanCSS({ which sets all units rounding precision to 3 digits except `px` unit precision of 5 digits. +## How to keep a CSS fragment intact? + +Note: available in the current master, to be released in 4.2.0. + +Wrap the CSS fragment in special comments which instruct clean-css to preserve it, e.g. + +```css +.block-1 { + color: red +} +/* clean-css ignore:start */ +.block-special { + color: transparent +} +/* clean-css ignore:end */ +.block-2 { + margin: 0 +} +``` + +Optimizing this CSS will result in the following output: + +```css +.block-1{color:red} +.block-special { + color: transparent +} +.block-2{margin:0} +``` + ## How to preserve a comment block? Use the `/*!` notation instead of the standard one `/*`: @@ -702,6 +746,7 @@ Sorted alphabetically by GitHub handle: * [@alexlamsl](https://github.com/alexlamsl) (Alex Lam S.L.) for testing early clean-css 4 versions, reporting bugs, and suggesting numerous improvements. * [@altschuler](https://github.com/altschuler) (Simon Altschuler) for fixing `@import` processing inside comments; * [@ben-eb](https://github.com/ben-eb) (Ben Briggs) for sharing ideas about CSS optimizations; +* [@davisjam](https://github.com/davisjam) (Jamie Davis) for disclosing ReDOS vulnerabilities; * [@facelessuser](https://github.com/facelessuser) (Isaac) for pointing out a flaw in clean-css' stateless mode; * [@grandrath](https://github.com/grandrath) (Martin Grandrath) for improving `minify` method source traversal in ES6; * [@jmalonzo](https://github.com/jmalonzo) (Jan Michael Alonzo) for a patch removing node.js' old `sys` package; |