1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
|
// Copyright 2018 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package minifiers contains minifiers mapped to MIME types. This package is used
// in both the resource transformation, i.e. resources.Minify, and in the publishing
// chain.
package minifiers
import (
"io"
"regexp"
"github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/output"
"github.com/gohugoio/hugo/transform"
"github.com/gohugoio/hugo/media"
"github.com/tdewolff/minify/v2"
)
// Client wraps a minifier.
type Client struct {
// Whether output minification is enabled (HTML in /public)
MinifyOutput bool
m *minify.M
}
// Transformer returns a func that can be used in the transformer publishing chain.
// TODO(bep) minify config etc
func (m Client) Transformer(mediatype media.Type) transform.Transformer {
_, params, min := m.m.Match(mediatype.Type)
if min == nil {
// No minifier for this MIME type
return nil
}
return func(ft transform.FromTo) error {
// Note that the source io.Reader will already be buffered, but it implements
// the Bytes() method, which is recognized by the Minify library.
return min.Minify(m.m, ft.To(), ft.From(), params)
}
}
// Minify tries to minify the src into dst given a MIME type.
func (m Client) Minify(mediatype media.Type, dst io.Writer, src io.Reader) error {
return m.m.Minify(mediatype.Type, dst, src)
}
// noopMinifier implements minify.Minifier [1], but doesn't minify content. This means
// that we can avoid missing minifiers for any MIME types in our minify.M, which
// causes minify to return errors, while still allowing minification to be
// disabled for specific types.
//
// [1]: https://pkg.go.dev/github.com/tdewolff/minify#Minifier
type noopMinifier struct{}
// Minify copies r into w without transformation.
func (m noopMinifier) Minify(_ *minify.M, w io.Writer, r io.Reader, _ map[string]string) error {
_, err := io.Copy(w, r)
return err
}
// New creates a new Client with the provided MIME types as the mapping foundation.
// The HTML minifier is also registered for additional HTML types (AMP etc.) in the
// provided list of output formats.
func New(mediaTypes media.Types, outputFormats output.Formats, cfg config.AllProvider) (Client, error) {
conf := cfg.GetConfigSection("minify").(MinifyConfig)
m := minify.New()
// We use the Type definition of the media types defined in the site if found.
addMinifier(m, mediaTypes, "css", getMinifier(conf, "css"))
addMinifier(m, mediaTypes, "js", getMinifier(conf, "js"))
m.AddRegexp(regexp.MustCompile("^(application|text)/(x-)?(java|ecma)script$"), getMinifier(conf, "js"))
addMinifier(m, mediaTypes, "json", getMinifier(conf, "json"))
m.AddRegexp(regexp.MustCompile(`^(application|text)/(x-|(ld|manifest)\+)?json$`), getMinifier(conf, "json"))
addMinifier(m, mediaTypes, "svg", getMinifier(conf, "svg"))
addMinifier(m, mediaTypes, "xml", getMinifier(conf, "xml"))
// HTML
addMinifier(m, mediaTypes, "html", getMinifier(conf, "html"))
for _, of := range outputFormats {
if of.IsHTML {
m.Add(of.MediaType.Type, getMinifier(conf, "html"))
}
}
return Client{m: m, MinifyOutput: conf.MinifyOutput}, nil
}
// getMinifier returns the appropriate minify.MinifierFunc for the MIME
// type suffix s, given the config c.
func getMinifier(c MinifyConfig, s string) minify.Minifier {
switch {
case s == "css" && !c.DisableCSS:
return &c.Tdewolff.CSS
case s == "js" && !c.DisableJS:
return &c.Tdewolff.JS
case s == "json" && !c.DisableJSON:
return &c.Tdewolff.JSON
case s == "svg" && !c.DisableSVG:
return &c.Tdewolff.SVG
case s == "xml" && !c.DisableXML:
return &c.Tdewolff.XML
case s == "html" && !c.DisableHTML:
return &c.Tdewolff.HTML
default:
return noopMinifier{}
}
}
func addMinifier(m *minify.M, mt media.Types, suffix string, min minify.Minifier) {
types := mt.BySuffix(suffix)
for _, t := range types {
m.Add(t.Type, min)
}
}
|