diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2018-02-20 10:02:14 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2018-07-06 11:46:12 +0200 |
commit | dea71670c059ab4d5a42bd22503f18c087dd22d4 (patch) | |
tree | 52889fd27a2d316fad5a04c0f2fe2198491c6cd1 /hugolib/prune_resources.go | |
parent | a5d0a57e6bdab583134a68c035aac9b3007f006a (diff) |
Add Hugo Piper with SCSS support and much more
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
Diffstat (limited to 'hugolib/prune_resources.go')
-rw-r--r-- | hugolib/prune_resources.go | 96 |
1 files changed, 63 insertions, 33 deletions
diff --git a/hugolib/prune_resources.go b/hugolib/prune_resources.go index e9d2bf96e..28802c6f2 100644 --- a/hugolib/prune_resources.go +++ b/hugolib/prune_resources.go @@ -19,23 +19,29 @@ import ( "os" "strings" + "github.com/gohugoio/hugo/helpers" + "github.com/spf13/afero" ) // GC requires a build first. func (h *HugoSites) GC() (int, error) { s := h.Sites[0] - fs := h.PathSpec.BaseFs.ResourcesFs + fs := h.PathSpec.BaseFs.Resources.Fs - imageCacheDir := s.resourceSpec.GenImagePath + imageCacheDir := s.ResourceSpec.GenImagePath if len(imageCacheDir) < 10 { panic("invalid image cache") } + assetsCacheDir := s.ResourceSpec.GenAssetsPath + if len(assetsCacheDir) < 10 { + panic("invalid assets cache") + } - isInUse := func(filename string) bool { + isImageInUse := func(filename string) bool { key := strings.TrimPrefix(filename, imageCacheDir) for _, site := range h.Sites { - if site.resourceSpec.IsInCache(key) { + if site.ResourceSpec.IsInImageCache(key) { return true } } @@ -43,44 +49,68 @@ func (h *HugoSites) GC() (int, error) { return false } - counter := 0 - - err := afero.Walk(fs, imageCacheDir, func(path string, info os.FileInfo, err error) error { - if info == nil { - return nil + isAssetInUse := func(filename string) bool { + key := strings.TrimPrefix(filename, assetsCacheDir) + // These assets are stored in tuplets with an added extension to the key. + key = strings.TrimSuffix(key, helpers.Ext(key)) + for _, site := range h.Sites { + if site.ResourceSpec.ResourceCache.Contains(key) { + return true + } } - if !strings.HasPrefix(path, imageCacheDir) { - return fmt.Errorf("Invalid state, walk outside of resource dir: %q", path) - } + return false + } - if info.IsDir() { - f, err := fs.Open(path) - if err != nil { + walker := func(dirname string, inUse func(filename string) bool) (int, error) { + counter := 0 + err := afero.Walk(fs, dirname, func(path string, info os.FileInfo, err error) error { + if info == nil { return nil } - defer f.Close() - _, err = f.Readdirnames(1) - if err == io.EOF { - // Empty dir. - s.Fs.Source.Remove(path) + + if !strings.HasPrefix(path, dirname) { + return fmt.Errorf("Invalid state, walk outside of resource dir: %q", path) } - return nil - } + if info.IsDir() { + f, err := fs.Open(path) + if err != nil { + return nil + } + defer f.Close() + _, err = f.Readdirnames(1) + if err == io.EOF { + // Empty dir. + s.Fs.Source.Remove(path) + } - inUse := isInUse(path) - if !inUse { - err := fs.Remove(path) - if err != nil && !os.IsNotExist(err) { - s.Log.ERROR.Printf("Failed to remove %q: %s", path, err) - } else { - counter++ + return nil } - } - return nil - }) - return counter, err + inUse := inUse(path) + if !inUse { + err := fs.Remove(path) + if err != nil && !os.IsNotExist(err) { + s.Log.ERROR.Printf("Failed to remove %q: %s", path, err) + } else { + counter++ + } + } + return nil + }) + + return counter, err + } + + imageCounter, err1 := walker(imageCacheDir, isImageInUse) + assetsCounter, err2 := walker(assetsCacheDir, isAssetInUse) + totalCount := imageCounter + assetsCounter + + if err1 != nil { + return totalCount, err1 + } + + return totalCount, err2 } |