aboutsummaryrefslogtreecommitdiffhomepage
path: root/minifiers
diff options
context:
space:
mode:
authorSatowTakeshi <[email protected]>2020-02-29 18:44:05 +0900
committerBjørn Erik Pedersen <[email protected]>2020-03-20 20:35:57 +0100
commit574c2959b8d3338764fa1db102a5e0fd6ed322d9 (patch)
tree185d13348f474d1bb0bb2b0fbfd6bec9d11c8f5e /minifiers
parent99958f90fedec11d749a1397300860aa8e8459c2 (diff)
downloadhugo-574c2959b8d3338764fa1db102a5e0fd6ed322d9.tar.gz
hugo-574c2959b8d3338764fa1db102a5e0fd6ed322d9.zip
Add minify config
Fixes #6750 Updates #6892
Diffstat (limited to 'minifiers')
-rw-r--r--minifiers/config.go111
-rw-r--r--minifiers/config_test.go52
-rw-r--r--minifiers/minifiers.go60
-rw-r--r--minifiers/minifiers_test.go44
4 files changed, 234 insertions, 33 deletions
diff --git a/minifiers/config.go b/minifiers/config.go
new file mode 100644
index 000000000..20d122e9b
--- /dev/null
+++ b/minifiers/config.go
@@ -0,0 +1,111 @@
+// Copyright 2019 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
+
+import (
+ "github.com/gohugoio/hugo/config"
+ "github.com/gohugoio/hugo/docshelper"
+ "github.com/gohugoio/hugo/parser"
+
+ "github.com/mitchellh/mapstructure"
+ "github.com/tdewolff/minify/v2/css"
+ "github.com/tdewolff/minify/v2/html"
+ "github.com/tdewolff/minify/v2/js"
+ "github.com/tdewolff/minify/v2/json"
+ "github.com/tdewolff/minify/v2/svg"
+ "github.com/tdewolff/minify/v2/xml"
+)
+
+var defaultTdewolffConfig = tdewolffConfig{
+ HTML: html.Minifier{
+ KeepDocumentTags: true,
+ KeepConditionalComments: true,
+ KeepEndTags: true,
+ KeepDefaultAttrVals: true,
+ KeepWhitespace: false,
+ // KeepQuotes: false, >= v2.6.2
+ },
+ CSS: css.Minifier{
+ Decimals: -1, // will be deprecated
+ // Precision: 0, // use Precision with >= v2.7.0
+ KeepCSS2: true,
+ },
+ JS: js.Minifier{},
+ JSON: json.Minifier{},
+ SVG: svg.Minifier{
+ Decimals: -1, // will be deprecated
+ // Precision: 0, // use Precision with >= v2.7.0
+ },
+ XML: xml.Minifier{
+ KeepWhitespace: false,
+ },
+}
+
+type tdewolffConfig struct {
+ HTML html.Minifier
+ CSS css.Minifier
+ JS js.Minifier
+ JSON json.Minifier
+ SVG svg.Minifier
+ XML xml.Minifier
+}
+
+type minifiersConfig struct {
+ EnableHTML bool
+ EnableCSS bool
+ EnableJS bool
+ EnableJSON bool
+ EnableSVG bool
+ EnableXML bool
+
+ Tdewolff tdewolffConfig
+}
+
+var defaultConfig = minifiersConfig{
+ EnableHTML: true,
+ EnableCSS: true,
+ EnableJS: true,
+ EnableJSON: true,
+ EnableSVG: true,
+ EnableXML: true,
+
+ Tdewolff: defaultTdewolffConfig,
+}
+
+func decodeConfig(cfg config.Provider) (conf minifiersConfig, err error) {
+ conf = defaultConfig
+
+ m := cfg.GetStringMap("minifiers")
+ if m == nil {
+ return
+ }
+
+ err = mapstructure.WeakDecode(m, &conf)
+
+ if err != nil {
+ return
+ }
+
+ return
+}
+
+func init() {
+ docsProvider := func() map[string]interface{} {
+ docs := make(map[string]interface{})
+ docs["minifiers"] = parser.LowerCaseCamelJSONMarshaller{Value: defaultConfig}
+ return docs
+
+ }
+ docshelper.AddDocProvider("config", docsProvider)
+}
diff --git a/minifiers/config_test.go b/minifiers/config_test.go
new file mode 100644
index 000000000..b4f68f8c7
--- /dev/null
+++ b/minifiers/config_test.go
@@ -0,0 +1,52 @@
+// Copyright 2019 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
+
+import (
+ "fmt"
+ "testing"
+
+ "github.com/spf13/viper"
+
+ qt "github.com/frankban/quicktest"
+)
+
+func TestConfig(t *testing.T) {
+ c := qt.New(t)
+ v := viper.New()
+
+ v.Set("minifiers", map[string]interface{}{
+ "enablexml": false,
+ "tdewolff": map[string]interface{}{
+ "html": map[string]interface{}{
+ "keepwhitespace": false,
+ },
+ },
+ })
+
+ conf, err := decodeConfig(v)
+ fmt.Println(conf)
+
+ c.Assert(err, qt.IsNil)
+
+ // explicitly set value
+ c.Assert(conf.Tdewolff.HTML.KeepWhitespace, qt.Equals, false)
+ // default value
+ c.Assert(conf.Tdewolff.HTML.KeepEndTags, qt.Equals, true)
+ c.Assert(conf.Tdewolff.CSS.KeepCSS2, qt.Equals, true)
+
+ // `enable` flags
+ c.Assert(conf.EnableHTML, qt.Equals, true)
+ c.Assert(conf.EnableXML, qt.Equals, false)
+}
diff --git a/minifiers/minifiers.go b/minifiers/minifiers.go
index 9533ebb69..3feb81601 100644
--- a/minifiers/minifiers.go
+++ b/minifiers/minifiers.go
@@ -20,17 +20,12 @@ 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"
- "github.com/tdewolff/minify/v2/css"
- "github.com/tdewolff/minify/v2/html"
- "github.com/tdewolff/minify/v2/js"
- "github.com/tdewolff/minify/v2/json"
- "github.com/tdewolff/minify/v2/svg"
- "github.com/tdewolff/minify/v2/xml"
)
// Client wraps a minifier.
@@ -62,39 +57,44 @@ func (m Client) Minify(mediatype media.Type, dst io.Writer, src io.Reader) error
// 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) Client {
- m := minify.New()
- htmlMin := &html.Minifier{
- KeepDocumentTags: true,
- KeepConditionalComments: true,
- KeepEndTags: true,
- KeepDefaultAttrVals: true,
- }
+func New(mediaTypes media.Types, outputFormats output.Formats, cfg config.Provider) (Client, error) {
+ conf, err := decodeConfig(cfg)
- cssMin := &css.Minifier{
- Decimals: -1,
- KeepCSS2: true,
+ m := minify.New()
+ if err != nil {
+ return Client{m: m}, err
}
// We use the Type definition of the media types defined in the site if found.
- addMinifier(m, mediaTypes, "css", cssMin)
- addMinifierFunc(m, mediaTypes, "js", js.Minify)
- m.AddFuncRegexp(regexp.MustCompile("^(application|text)/(x-)?(java|ecma)script$"), js.Minify)
- m.AddFuncRegexp(regexp.MustCompile(`^(application|text)/(x-|ld\+)?json$`), json.Minify)
- addMinifierFunc(m, mediaTypes, "json", json.Minify)
- addMinifierFunc(m, mediaTypes, "svg", svg.Minify)
- addMinifierFunc(m, mediaTypes, "xml", xml.Minify)
+ if conf.EnableCSS {
+ addMinifier(m, mediaTypes, "css", &conf.Tdewolff.CSS)
+ }
+ if conf.EnableJS {
+ addMinifier(m, mediaTypes, "js", &conf.Tdewolff.JS)
+ m.AddRegexp(regexp.MustCompile("^(application|text)/(x-)?(java|ecma)script$"), &conf.Tdewolff.JS)
+ }
+ if conf.EnableJSON {
+ addMinifier(m, mediaTypes, "json", &conf.Tdewolff.JSON)
+ m.AddRegexp(regexp.MustCompile(`^(application|text)/(x-|ld\+)?json$`), &conf.Tdewolff.JSON)
+ }
+ if conf.EnableSVG {
+ addMinifier(m, mediaTypes, "svg", &conf.Tdewolff.SVG)
+ }
+ if conf.EnableXML {
+ addMinifier(m, mediaTypes, "xml", &conf.Tdewolff.XML)
+ }
// HTML
- addMinifier(m, mediaTypes, "html", htmlMin)
- for _, of := range outputFormats {
- if of.IsHTML {
- m.Add(of.MediaType.Type(), htmlMin)
+ if conf.EnableHTML {
+ addMinifier(m, mediaTypes, "html", &conf.Tdewolff.HTML)
+ for _, of := range outputFormats {
+ if of.IsHTML {
+ m.Add(of.MediaType.Type(), &conf.Tdewolff.HTML)
+ }
}
}
- return Client{m: m}
-
+ return Client{m: m}, nil
}
func addMinifier(m *minify.M, mt media.Types, suffix string, min minify.Minifier) {
diff --git a/minifiers/minifiers_test.go b/minifiers/minifiers_test.go
index 87e706320..64588f83c 100644
--- a/minifiers/minifiers_test.go
+++ b/minifiers/minifiers_test.go
@@ -23,11 +23,13 @@ import (
qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/output"
+ "github.com/spf13/viper"
)
func TestNew(t *testing.T) {
c := qt.New(t)
- m := New(media.DefaultTypes, output.DefaultFormats)
+ v := viper.New()
+ m, _ := New(media.DefaultTypes, output.DefaultFormats, v)
var rawJS string
var minJS string
@@ -73,9 +75,44 @@ func TestNew(t *testing.T) {
}
+func TestConfiguredMinify(t *testing.T) {
+ c := qt.New(t)
+ v := viper.New()
+ v.Set("minifiers", map[string]interface{}{
+ "enablexml": false,
+ "tdewolff": map[string]interface{}{
+ "html": map[string]interface{}{
+ "keepwhitespace": true,
+ },
+ },
+ })
+ m, _ := New(media.DefaultTypes, output.DefaultFormats, v)
+
+ for _, test := range []struct {
+ tp media.Type
+ rawString string
+ expectedMinString string
+ errorExpected bool
+ }{
+ {media.HTMLType, "<hello> Hugo! </hello>", "<hello> Hugo! </hello>", false}, // configured minifier
+ {media.CSSType, " body { color: blue; } ", "body{color:blue}", false}, // default minifier
+ {media.XMLType, " <hello> Hugo! </hello> ", "", true}, // disable Xml minificatin
+ } {
+ var b bytes.Buffer
+ if !test.errorExpected {
+ c.Assert(m.Minify(test.tp, &b, strings.NewReader(test.rawString)), qt.IsNil)
+ c.Assert(b.String(), qt.Equals, test.expectedMinString)
+ } else {
+ err := m.Minify(test.tp, &b, strings.NewReader(test.rawString))
+ c.Assert(err, qt.ErrorMatches, "minifier does not exist for mimetype")
+ }
+ }
+}
+
func TestJSONRoundTrip(t *testing.T) {
c := qt.New(t)
- m := New(media.DefaultTypes, output.DefaultFormats)
+ v := viper.New()
+ m, _ := New(media.DefaultTypes, output.DefaultFormats, v)
for _, test := range []string{`{
"glossary": {
@@ -113,7 +150,8 @@ func TestJSONRoundTrip(t *testing.T) {
func TestBugs(t *testing.T) {
c := qt.New(t)
- m := New(media.DefaultTypes, output.DefaultFormats)
+ v := viper.New()
+ m, _ := New(media.DefaultTypes, output.DefaultFormats, v)
for _, test := range []struct {
tp media.Type