A hexo plugin to minify/optimize HTML, CSS, JS and images. Supports revisioning of assets.
Branch: master
Clone or download
bhaskarmelkani Merge pull request #46 from hexojs/dependabot/npm_and_yarn/jest-tw-24…
….0.0

Update jest requirement from ^23.6.0 to ^24.0.0
Latest commit 7f55a1a Feb 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__ Merge pull request #27 from ertrzyiks/add-tests-for-exclude-option Oct 12, 2018
lib
.gitignore Updated version to 1.0.0 Jun 27, 2017
.npmignore Render original content when html minifier is disabled May 18, 2018
.travis.yml Add travis.yml Jun 1, 2018
README.md Change link from options to plugins Sep 19, 2018
index.js Add use strict Sep 12, 2017
package.json

README.md

hexo-asset-pipeline

Dependency Status npm version GitHub issues

Asset pipeline for Hexo to support minification and optimization of HTML, CSS, JS and images.

  • Hexo 3.x.x

Installation

$ npm install hexo-asset-pipeline --save

Configuration

Add the following snippet in _config.yml.

Minimal config to enable filters for HTML, CSS, Js and images.

asset_pipeline:
  revisioning:
    enable: true
  clean_css:
    enable: true
  uglify_js:
    enable: true
  imagemin:
    enable: true
  html_minifier:
    enable: true
  • revisioning - Enabling revisioning of assets..
  • clean_css - Adding options for clean-css.
  • uglify_js - Adding options for uglify-js.
  • imagemin - Adding options for imagemin.
  • html_minifier - Adding options for html-minifier.

Components

Following are the modules that are being used to process differnet types of assets.

HTML (html_minifier)

html-minifier is used to minify the HTML files.

Following is the config for html-minifier.

Options

html_minifier:
  enable: true
  ignore_error: false
  exclude:
  • enable - Enable the plugin. Defaults to false.
  • ignore_error - Ignore the error occurred on parsing html
  • exclude: Exclude files

html_minifier defaults

html_minifier:
  ignoreCustomComments: [/^\s*more/]
  removeComments: true
  removeCommentsFromCDATA: true
  collapseWhitespace: true
  collapseBooleanAttributes: true
  removeEmptyAttributes: true
  minifyJS: true
  minifyCSS: true

Note: Check html-minifier for more options.

Javascripts (uglify_js)

uglify-js is used to minify javascripts.

Following is the config for uglify-js.

Options

uglify_js:
  enable: true
  mangle: true
  output:
  compress:
  exclude: 
    - '*.min.js'
  • enable - Enable the plugin. Defaults to false.
  • mangle: Mangle file names
  • output: Output options
  • compress: Compress options
  • exclude: Exclude files

uglify-js defaults

uglify_js:
  mangle: true
  exclude: ['*.min.js']

Note: Check uglify-js for more options.

Stylesheets (clean_css)

clean-css is used to minify stylesheets.

Following is the config for clean-css.

Options

clean_css:
  enable: true
  exclude: 
    - '*.min.css'
  • enable - Enable the plugin. Defaults to false.
  • exclude: Exclude files

clean-css defaults

clean_css:
  exclude: ['*.min.css']

Note: Check clean-css for more options.

Images (imagemin)

imagemin is used to optimize images.

Following is the config for imagemin.

Options

imagemin:
  enable: true
  interlaced: false
  multipass: false
  optimizationLevel: 2
  pngquant: false
  progressive: false
  • enable - Enable the plugin. Defaults to false.
  • interlaced - Interlace gif for progressive rendering. Defaults to false.
  • multipass - Optimize svg multiple times until it’s fully optimized. Defaults to false.
  • optimizationLevel - Select an optimization level between 0 and 7. Defaults to 2.
  • pngquant - Enable imagemin-pngquant plugin. Defaults to false.
  • progressive - Lossless conversion to progressive. Defaults to false.
  • exclude - Exclude specific types of image files, the input value could be gif,jpg, png, or svg. Default to null.

imagemin defaults

imagemin:
  interlaced: false
  multipass: false
  optimizationLevel: 3
  pngquant: false
  progressive: false

Note: Check imagemin plugins for more options.

Revisioning

revisioning:
  enable: true
  keep: true
  exclude: ['robots.txt', '*.json']
  selectors:
    'img[data-orign]':  data-orign
    'img[data-src]': 'data-src'
    'img[src]': 'src'
  • enable - Enable revisioning of assets. Defaults to false.
  • keep - Keep original assets. Defaults to false.
  • exclude - Exclude files from revisioning.
  • selectors - It is used so that custom implementations can be processed. Any attribute matching the key should have the asset url in the value. For instance in above example any element matching to img[data-orign] will have the URL for asset in data-origin attribute, this specific case can be helpful for jquery lazyload implementations.

Revisioning defaults;

revisioning:
  enable: false
  keep: false
  exclude: []
  selectors:
    'img[data-src]': 'data-src'
    'img[src]': 'src'
    'link[rel="apple-touch-icon"]': 'href'
    'link[rel="icon"]': 'href'
    'link[rel="shortcut icon"]': 'href'
    'link[rel="stylesheet"]': 'href'
    'script[src]': 'src'
    'source[src]': 'src'
    'video[poster]': 'poster'

Note: To match paths in exclude option, glob matching is done using minmatch.

TODO

  • Eslint configs
  • Test plugin for relative paths
  • Add option to add CDN