mirror of https://github.com/curbengh/hexo-yam
Merge pull request #17 from curbengh/options
feat: enable plugin by default and update options naming
This commit is contained in:
curbengh
GitHub
commit
9cb977e2d2
77
README.md
77
README.md
|
|
@ -1,4 +1,4 @@
|
|||
# Hexo-yam
|
||||
# hexo-yam
|
||||
|
||||
[](https://www.npmjs.com/package/hexo-yam)
|
||||
[](https://travis-ci.com/curbengh/hexo-yam)
|
||||
|
|
@ -6,29 +6,45 @@
|
|||
[](https://snyk.io/test/npm/hexo-yam)
|
||||
[](https://greenkeeper.io/)
|
||||
|
||||
---
|
||||
|
||||
Yet Another Minifier for Hexo. Minify and compress HTML, JS, CSS and SVG. XML, JSON and [many more](https://github.com/curbengh/hexo-yam/blob/ba77db0094a7c07ea9f70f010bfc15541d4105ca/index.js#L64) are also compressed. Support gzip and [brotli](https://en.wikipedia.org/wiki/Brotli) [compressions](https://en.wikipedia.org/wiki/HTTP_compression).
|
||||
|
||||
This project is based on [hexo-neat](https://github.com/rozbo/hexo-neat). Existing options are the same, so you can use this as a drop-in replacement.
|
||||
## Version 3
|
||||
In v3 onwards, this plugin is enabled by default. Most [options](#options) have changed and they are now under `minify:` option.
|
||||
|
||||
*Note:* See [HTTP Compression](#http-compression) section below for more info on using brotli.
|
||||
Example:
|
||||
|
||||
```
|
||||
neat_svg:
|
||||
plugins: [{cleanupIDs: false}]
|
||||
```
|
||||
|
||||
needs to be updated to
|
||||
|
||||
```
|
||||
minify:
|
||||
svg:
|
||||
plugins: [{cleanupIDs: false}]
|
||||
```
|
||||
|
||||
## Installation
|
||||
``` bash
|
||||
$ npm install hexo-yam --save
|
||||
```
|
||||
|
||||
## Usage
|
||||
To enable this plugin, insert the following to `_config.yml`:
|
||||
``` yaml
|
||||
neat_enable: true
|
||||
```
|
||||
For further customization, see below.
|
||||
|
||||
## Options
|
||||
|
||||
``` yaml
|
||||
neat_html:
|
||||
minify:
|
||||
enable: true
|
||||
```
|
||||
|
||||
- **enable** - Enable the plugin. Defaults to `true`.
|
||||
|
||||
---
|
||||
|
||||
``` yaml
|
||||
minify:
|
||||
html:
|
||||
enable: true
|
||||
exclude:
|
||||
```
|
||||
|
|
@ -43,10 +59,11 @@ neat_html:
|
|||
|
||||
For more options, see [HTMLMinifier](https://github.com/kangax/html-minifier).
|
||||
|
||||
----------
|
||||
---
|
||||
|
||||
``` yaml
|
||||
neat_css:
|
||||
minify:
|
||||
css:
|
||||
enable: true
|
||||
exclude:
|
||||
- '*.min.css'
|
||||
|
|
@ -55,14 +72,15 @@ neat_css:
|
|||
- **logger** - Verbose output. Defaults to `false`.
|
||||
- **exclude** - Exclude files. Support wildcard pattern.
|
||||
- **level** - Optimization level. Defaults to `2`.
|
||||
- **globOptions** - See [`neat_html`](#options).
|
||||
- **globOptions** - See [`html:`](#options).
|
||||
|
||||
For more options, see [clean-css](https://github.com/jakubpawlowicz/clean-css).
|
||||
|
||||
----------
|
||||
---
|
||||
|
||||
``` yaml
|
||||
neat_js:
|
||||
minify:
|
||||
js:
|
||||
enable: true
|
||||
exclude:
|
||||
- '*.min.js'
|
||||
|
|
@ -74,14 +92,15 @@ neat_js:
|
|||
- **mangle** - Mangle variable names. Defaults to `true`. Pass an object to specify [mangle options](https://github.com/terser-js/terser#mangle-options).
|
||||
- **output** - Output options.
|
||||
- To retain comments, `output: {comments: true}`.
|
||||
- **globOptions** - See [`neat_html`](#options).
|
||||
- **globOptions** - See [`html:`](#options).
|
||||
|
||||
For more options, see [Terser](https://github.com/terser-js/terser).
|
||||
|
||||
----------
|
||||
---
|
||||
|
||||
``` yaml
|
||||
neat_svg:
|
||||
minify:
|
||||
svg:
|
||||
enable: true
|
||||
include:
|
||||
- '*.svg'
|
||||
|
|
@ -93,14 +112,15 @@ neat_svg:
|
|||
- Exclude `*.min.svg` by default.
|
||||
- **plugins** - Plugin options.
|
||||
- To retain comments, `plugins: [{removeComments: false}]`.
|
||||
- **globOptions** - See [`neat_html`](#options).
|
||||
- **globOptions** - See [`html:`](#options).
|
||||
|
||||
For more options, see [svgo](https://github.com/svg/svgo).
|
||||
|
||||
----------
|
||||
---
|
||||
|
||||
``` yaml
|
||||
neat_gzip:
|
||||
minify:
|
||||
gzip:
|
||||
enable: true
|
||||
include:
|
||||
- '*.html'
|
||||
|
|
@ -120,12 +140,13 @@ neat_gzip:
|
|||
- **include** - Include files. Support wildcard pattern.
|
||||
- Support one-liner, `include: ['*.html','*.css','*.js']`.
|
||||
- Must include asterisk and single quotes. `.html` is invalid. `'*.html'` is valid.
|
||||
- **globOptions** - See [`neat_html`](#options).
|
||||
- **globOptions** - See [`html:`](#options).
|
||||
|
||||
----------
|
||||
---
|
||||
|
||||
``` yaml
|
||||
neat_brotli:
|
||||
minify:
|
||||
brotli:
|
||||
enable: true
|
||||
include:
|
||||
- '*.html'
|
||||
|
|
@ -143,7 +164,7 @@ neat_brotli:
|
|||
- **enable** - Enable the plugin. Defaults to `true`.
|
||||
- **logger** - Verbose output. Defaults to `false`.
|
||||
- **include** - Include files. Support wildcard pattern.
|
||||
- **globOptions** - See [`neat_html`](#options).
|
||||
- **globOptions** - See [`html:`](#options).
|
||||
|
||||
## HTTP Compression
|
||||
While most modern web browsers [support Brotli](https://www.caniuse.com/#feat=brotli), you also need to consider whether the web/app server, hosting platform, reverse proxy or CDN (whichever relevant to you) support it.
|
||||
|
|
|
|||
36
index.js
36
index.js
|
|
@ -1,9 +1,11 @@
|
|||
/* global hexo */
|
||||
'use strict'
|
||||
|
||||
if (hexo.config.neat_enable === true) {
|
||||
// HTML minifier
|
||||
hexo.config.neat_html = Object.assign({
|
||||
hexo.config.minify = Object.assign({
|
||||
enable: true
|
||||
}, hexo.config.minify)
|
||||
|
||||
hexo.config.minify.html = Object.assign({
|
||||
enable: true,
|
||||
logger: false,
|
||||
exclude: [],
|
||||
|
|
@ -18,19 +20,17 @@ if (hexo.config.neat_enable === true) {
|
|||
minifyJS: true,
|
||||
minifyCSS: true,
|
||||
globOptions: { basename: true }
|
||||
}, hexo.config.neat_html)
|
||||
}, hexo.config.minify.html)
|
||||
|
||||
// CSS minifier
|
||||
hexo.config.neat_css = Object.assign({
|
||||
hexo.config.minify.css = Object.assign({
|
||||
enable: true,
|
||||
logger: false,
|
||||
exclude: ['*.min.css'],
|
||||
level: 2,
|
||||
globOptions: { basename: true }
|
||||
}, hexo.config.neat_css)
|
||||
}, hexo.config.minify.css)
|
||||
|
||||
// Javascript minifier
|
||||
hexo.config.neat_js = Object.assign({
|
||||
hexo.config.minify.js = Object.assign({
|
||||
enable: true,
|
||||
logger: false,
|
||||
exclude: ['*.min.js'],
|
||||
|
|
@ -38,33 +38,31 @@ if (hexo.config.neat_enable === true) {
|
|||
mangle: true,
|
||||
output: {},
|
||||
globOptions: { basename: true }
|
||||
}, hexo.config.neat_js)
|
||||
}, hexo.config.minify.js)
|
||||
|
||||
// SVG minifier
|
||||
hexo.config.neat_svg = Object.assign({
|
||||
hexo.config.minify.svg = Object.assign({
|
||||
enable: true,
|
||||
logger: false,
|
||||
include: ['*.svg', '!*.min.svg'],
|
||||
plugins: [],
|
||||
globOptions: { basename: true }
|
||||
}, hexo.config.neat_svg)
|
||||
}, hexo.config.minify.svg)
|
||||
|
||||
// gzip compression
|
||||
hexo.config.neat_gzip = Object.assign({
|
||||
hexo.config.minify.gzip = Object.assign({
|
||||
enable: true,
|
||||
logger: false,
|
||||
include: ['*.html', '*.css', '*.js', '*.txt', '*.ttf', '*.atom', '*.stl', '*.xml', '*.svg', '*.eot', '*.json'],
|
||||
globOptions: { basename: true }
|
||||
}, hexo.config.neat_gzip)
|
||||
}, hexo.config.minify.gzip)
|
||||
|
||||
// brotli compression
|
||||
hexo.config.neat_brotli = Object.assign({
|
||||
hexo.config.minify.brotli = Object.assign({
|
||||
enable: true,
|
||||
logger: false,
|
||||
include: ['*.html', '*.css', '*.js', '*.txt', '*.ttf', '*.atom', '*.stl', '*.xml', '*.svg', '*.eot', '*.json'],
|
||||
globOptions: { basename: true }
|
||||
}, hexo.config.neat_brotli)
|
||||
}, hexo.config.minify.brotli)
|
||||
|
||||
if (hexo.config.minify.enable === true) {
|
||||
const filter = require('./lib/filter')
|
||||
hexo.extend.filter.register('after_render:html', filter.logicHtml)
|
||||
hexo.extend.filter.register('after_render:css', filter.logicCss)
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ function isMatch (path, patterns, options) {
|
|||
|
||||
function logicHtml (str, data) {
|
||||
const hexo = this
|
||||
const options = hexo.config.neat_html
|
||||
const options = hexo.config.minify.html
|
||||
// Return if disabled.
|
||||
if (options.enable === false) return
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ function logicHtml (str, data) {
|
|||
|
||||
function logicCss (str, data) {
|
||||
const hexo = this
|
||||
const options = hexo.config.neat_css
|
||||
const options = hexo.config.minify.css
|
||||
if (options.enable === false) return
|
||||
|
||||
const path = data.path
|
||||
|
|
@ -72,7 +72,7 @@ function logicCss (str, data) {
|
|||
|
||||
function logicJs (str, data) {
|
||||
const hexo = this
|
||||
const options = hexo.config.neat_js
|
||||
const options = hexo.config.minify.js
|
||||
if (options.enable === false) return
|
||||
|
||||
const path = data.path
|
||||
|
|
@ -103,7 +103,7 @@ function logicJs (str, data) {
|
|||
|
||||
function logicSvg () {
|
||||
const hexo = this
|
||||
const options = hexo.config.neat_svg
|
||||
const options = hexo.config.minify.svg
|
||||
// Return if disabled.
|
||||
if (options.enable === false) return
|
||||
|
||||
|
|
@ -145,7 +145,7 @@ function logicSvg () {
|
|||
|
||||
function logicGzip () {
|
||||
const hexo = this
|
||||
const options = hexo.config.neat_gzip
|
||||
const options = hexo.config.minify.gzip
|
||||
// Return if disabled.
|
||||
if (options.enable === false) return
|
||||
|
||||
|
|
@ -191,7 +191,7 @@ function logicGzip () {
|
|||
|
||||
function logicBrotli () {
|
||||
const hexo = this
|
||||
const options = hexo.config.neat_brotli
|
||||
const options = hexo.config.minify.brotli
|
||||
// Return if disabled.
|
||||
if (options.enable === false) return
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "hexo-yam",
|
||||
"description": "Yet Another Minifier. Minify and compress html, js, css and svg",
|
||||
"version": "2.2.1",
|
||||
"version": "3.0.0",
|
||||
"readme": "README.md",
|
||||
"main": "index.js",
|
||||
"directories": {
|
||||
|
|
|
|||
Loading…
Reference in New Issue