mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
dea71670c0
Before this commit, you would have to use page bundles to do image processing etc. in Hugo.
This commit adds
* A new `/assets` top-level project or theme dir (configurable via `assetDir`)
* A new template func, `resources.Get` which can be used to "get a resource" that can be further processed.
This means that you can now do this in your templates (or shortcodes):
```bash
{{ $sunset := (resources.Get "images/sunset.jpg").Fill "300x200" }}
```
This also adds a new `extended` build tag that enables powerful SCSS/SASS support with source maps. To compile this from source, you will also need a C compiler installed:
```
HUGO_BUILD_TAGS=extended mage install
```
Note that you can use output of the SCSS processing later in a non-SCSSS-enabled Hugo.
The `SCSS` processor is a _Resource transformation step_ and it can be chained with the many others in a pipeline:
```bash
{{ $css := resources.Get "styles.scss" | resources.ToCSS | resources.PostCSS | resources.Minify | resources.Fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
The transformation funcs above have aliases, so it can be shortened to:
```bash
{{ $css := resources.Get "styles.scss" | toCSS | postCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
A quick tip would be to avoid the fingerprinting part, and possibly also the not-superfast `postCSS` when you're doing development, as it allows Hugo to be smarter about the rebuilding.
Documentation will follow, but have a look at the demo repo in https://github.com/bep/hugo-sass-test
New functions to create `Resource` objects:
* `resources.Get` (see above)
* `resources.FromString`: Create a Resource from a string.
New `Resource` transformation funcs:
* `resources.ToCSS`: Compile `SCSS` or `SASS` into `CSS`.
* `resources.PostCSS`: Process your CSS with PostCSS. Config file support (project or theme or passed as an option).
* `resources.Minify`: Currently supports `css`, `js`, `json`, `html`, `svg`, `xml`.
* `resources.Fingerprint`: Creates a fingerprinted version of the given Resource with Subresource Integrity..
* `resources.Concat`: Concatenates a list of Resource objects. Think of this as a poor man's bundler.
* `resources.ExecuteAsTemplate`: Parses and executes the given Resource and data context (e.g. .Site) as a Go template.
Fixes #4381
Fixes #4903
Fixes #4858
141 lines
4.8 KiB
Go
141 lines
4.8 KiB
Go
// 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 hugolib
|
|
|
|
import (
|
|
"path/filepath"
|
|
"runtime"
|
|
"testing"
|
|
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
const pageWithAlias = `---
|
|
title: Has Alias
|
|
aliases: ["foo/bar/"]
|
|
---
|
|
For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke.
|
|
`
|
|
|
|
const pageWithAliasMultipleOutputs = `---
|
|
title: Has Alias for HTML and AMP
|
|
aliases: ["foo/bar/"]
|
|
outputs: ["HTML", "AMP", "JSON"]
|
|
---
|
|
For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke.
|
|
`
|
|
|
|
const basicTemplate = "<html><body>{{.Content}}</body></html>"
|
|
const aliasTemplate = "<html><body>ALIASTEMPLATE</body></html>"
|
|
|
|
func TestAlias(t *testing.T) {
|
|
t.Parallel()
|
|
assert := require.New(t)
|
|
|
|
b := newTestSitesBuilder(t)
|
|
b.WithSimpleConfigFile().WithContent("page.md", pageWithAlias)
|
|
b.CreateSites().Build(BuildCfg{})
|
|
|
|
assert.Equal(1, len(b.H.Sites))
|
|
require.Len(t, b.H.Sites[0].RegularPages, 1)
|
|
|
|
// the real page
|
|
b.AssertFileContent("public/page/index.html", "For some moments the old man")
|
|
// the alias redirector
|
|
b.AssertFileContent("public/foo/bar/index.html", "<meta http-equiv=\"refresh\" content=\"0; ")
|
|
}
|
|
|
|
func TestAliasMultipleOutputFormats(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
assert := require.New(t)
|
|
|
|
b := newTestSitesBuilder(t)
|
|
b.WithSimpleConfigFile().WithContent("page.md", pageWithAliasMultipleOutputs)
|
|
|
|
b.WithTemplates(
|
|
"_default/single.html", basicTemplate,
|
|
"_default/single.amp.html", basicTemplate,
|
|
"_default/single.json", basicTemplate)
|
|
|
|
b.CreateSites().Build(BuildCfg{})
|
|
|
|
// the real pages
|
|
b.AssertFileContent("public/page/index.html", "For some moments the old man")
|
|
b.AssertFileContent("public/amp/page/index.html", "For some moments the old man")
|
|
b.AssertFileContent("public/page/index.json", "For some moments the old man")
|
|
|
|
// the alias redirectors
|
|
b.AssertFileContent("public/foo/bar/index.html", "<meta http-equiv=\"refresh\" content=\"0; ")
|
|
b.AssertFileContent("public/foo/bar/amp/index.html", "<meta http-equiv=\"refresh\" content=\"0; ")
|
|
assert.False(b.CheckExists("public/foo/bar/index.json"))
|
|
}
|
|
|
|
func TestAliasTemplate(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
b := newTestSitesBuilder(t)
|
|
b.WithSimpleConfigFile().WithContent("page.md", pageWithAlias).WithTemplatesAdded("alias.html", aliasTemplate)
|
|
|
|
b.CreateSites().Build(BuildCfg{})
|
|
|
|
// the real page
|
|
b.AssertFileContent("public/page/index.html", "For some moments the old man")
|
|
// the alias redirector
|
|
b.AssertFileContent("public/foo/bar/index.html", "ALIASTEMPLATE")
|
|
}
|
|
|
|
func TestTargetPathHTMLRedirectAlias(t *testing.T) {
|
|
h := newAliasHandler(nil, loggers.NewErrorLogger(), false)
|
|
|
|
errIsNilForThisOS := runtime.GOOS != "windows"
|
|
|
|
tests := []struct {
|
|
value string
|
|
expected string
|
|
errIsNil bool
|
|
}{
|
|
{"", "", false},
|
|
{"s", filepath.FromSlash("s/index.html"), true},
|
|
{"/", "", false},
|
|
{"alias 1", filepath.FromSlash("alias 1/index.html"), true},
|
|
{"alias 2/", filepath.FromSlash("alias 2/index.html"), true},
|
|
{"alias 3.html", "alias 3.html", true},
|
|
{"alias4.html", "alias4.html", true},
|
|
{"/alias 5.html", "alias 5.html", true},
|
|
{"/трям.html", "трям.html", true},
|
|
{"../../../../tmp/passwd", "", false},
|
|
{"/foo/../../../../tmp/passwd", filepath.FromSlash("tmp/passwd/index.html"), true},
|
|
{"foo/../../../../tmp/passwd", "", false},
|
|
{"C:\\Windows", filepath.FromSlash("C:\\Windows/index.html"), errIsNilForThisOS},
|
|
{"/trailing-space /", filepath.FromSlash("trailing-space /index.html"), errIsNilForThisOS},
|
|
{"/trailing-period./", filepath.FromSlash("trailing-period./index.html"), errIsNilForThisOS},
|
|
{"/tab\tseparated/", filepath.FromSlash("tab\tseparated/index.html"), errIsNilForThisOS},
|
|
{"/chrome/?p=help&ctx=keyboard#topic=3227046", filepath.FromSlash("chrome/?p=help&ctx=keyboard#topic=3227046/index.html"), errIsNilForThisOS},
|
|
{"/LPT1/Printer/", filepath.FromSlash("LPT1/Printer/index.html"), errIsNilForThisOS},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
path, err := h.targetPathAlias(test.value)
|
|
if (err == nil) != test.errIsNil {
|
|
t.Errorf("Expected err == nil => %t, got: %t. err: %s", test.errIsNil, err == nil, err)
|
|
continue
|
|
}
|
|
if err == nil && path != test.expected {
|
|
t.Errorf("Expected: \"%s\", got: \"%s\"", test.expected, path)
|
|
}
|
|
}
|
|
}
|