Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 2.39 KB

README.md

File metadata and controls

58 lines (41 loc) · 2.39 KB

reshape-minify

npm tests dependencies coverage

A reshape plugin to minify html

Note: This project is in early development, and versioning is a little different. Read this for more details.

Installation

npm install reshape-minify -S

Note: This project is compatible with node v6+ only

Usage

Add it as a plugin to reshape:

const reshape = require('reshape')
const minify = require('reshape-minify')

reshape({ plugins: minify(/* options */) })
  .process(someHtml)
  .then((res) => {
    console.log(res.output(/* locals */))
  })

Options

Options are passed in an object, all are optional.

Name Description Default
collapseWhitespace Removes all extra whitespace true
conservativeCollapse Instead of fully removing excess whitespace, collapses down to a single space false
aggressiveCollapse More aggressive whitespace removal, trims all whitespace from beginning and ends of any text false
removeComments Removes all comments from the html true
minifyCss Minifies any CSS in style tags true
minifyJs Minifies any JS in script tags true
minifySvg Minifies any inline svg true
minifyJson Minifies any json in script tags with */json as the type true

To-Do List

License & Contributing