mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 07:42:05 -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
208 lines
4.5 KiB
Go
208 lines
4.5 KiB
Go
// Copyright 2017-present 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 (
|
|
"fmt"
|
|
"math"
|
|
"runtime"
|
|
|
|
// Use this until errgroup gets ported to context
|
|
// See https://github.com/golang/go/issues/19781
|
|
"golang.org/x/net/context"
|
|
"golang.org/x/sync/errgroup"
|
|
)
|
|
|
|
type siteContentProcessor struct {
|
|
site *Site
|
|
|
|
handleContent contentHandler
|
|
|
|
ctx context.Context
|
|
|
|
// The input file bundles.
|
|
fileBundlesChan chan *bundleDir
|
|
|
|
// The input file singles.
|
|
fileSinglesChan chan *fileInfo
|
|
|
|
// These assets should be just copied to destination.
|
|
fileAssetsChan chan []pathLangFile
|
|
|
|
numWorkers int
|
|
|
|
// The output Pages
|
|
pagesChan chan *Page
|
|
|
|
// Used for partial rebuilds (aka. live reload)
|
|
// Will signal replacement of pages in the site collection.
|
|
partialBuild bool
|
|
}
|
|
|
|
func (s *siteContentProcessor) processBundle(b *bundleDir) {
|
|
select {
|
|
case s.fileBundlesChan <- b:
|
|
case <-s.ctx.Done():
|
|
}
|
|
}
|
|
|
|
func (s *siteContentProcessor) processSingle(fi *fileInfo) {
|
|
select {
|
|
case s.fileSinglesChan <- fi:
|
|
case <-s.ctx.Done():
|
|
}
|
|
}
|
|
|
|
func (s *siteContentProcessor) processAssets(assets []pathLangFile) {
|
|
select {
|
|
case s.fileAssetsChan <- assets:
|
|
case <-s.ctx.Done():
|
|
}
|
|
}
|
|
|
|
func newSiteContentProcessor(ctx context.Context, partialBuild bool, s *Site) *siteContentProcessor {
|
|
numWorkers := 12
|
|
if n := runtime.NumCPU() * 3; n > numWorkers {
|
|
numWorkers = n
|
|
}
|
|
|
|
numWorkers = int(math.Ceil(float64(numWorkers) / float64(len(s.owner.Sites))))
|
|
|
|
return &siteContentProcessor{
|
|
ctx: ctx,
|
|
partialBuild: partialBuild,
|
|
site: s,
|
|
handleContent: newHandlerChain(s),
|
|
fileBundlesChan: make(chan *bundleDir, numWorkers),
|
|
fileSinglesChan: make(chan *fileInfo, numWorkers),
|
|
fileAssetsChan: make(chan []pathLangFile, numWorkers),
|
|
numWorkers: numWorkers,
|
|
pagesChan: make(chan *Page, numWorkers),
|
|
}
|
|
}
|
|
|
|
func (s *siteContentProcessor) closeInput() {
|
|
close(s.fileSinglesChan)
|
|
close(s.fileBundlesChan)
|
|
close(s.fileAssetsChan)
|
|
}
|
|
|
|
func (s *siteContentProcessor) process(ctx context.Context) error {
|
|
g1, ctx := errgroup.WithContext(ctx)
|
|
g2, ctx := errgroup.WithContext(ctx)
|
|
|
|
// There can be only one of these per site.
|
|
g1.Go(func() error {
|
|
for p := range s.pagesChan {
|
|
if p.s != s.site {
|
|
panic(fmt.Sprintf("invalid page site: %v vs %v", p.s, s))
|
|
}
|
|
|
|
if s.partialBuild {
|
|
s.site.replacePage(p)
|
|
} else {
|
|
s.site.addPage(p)
|
|
}
|
|
}
|
|
return nil
|
|
})
|
|
|
|
for i := 0; i < s.numWorkers; i++ {
|
|
g2.Go(func() error {
|
|
for {
|
|
select {
|
|
case f, ok := <-s.fileSinglesChan:
|
|
if !ok {
|
|
return nil
|
|
}
|
|
err := s.readAndConvertContentFile(f)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
case <-ctx.Done():
|
|
return ctx.Err()
|
|
}
|
|
}
|
|
})
|
|
|
|
g2.Go(func() error {
|
|
for {
|
|
select {
|
|
case files, ok := <-s.fileAssetsChan:
|
|
if !ok {
|
|
return nil
|
|
}
|
|
for _, file := range files {
|
|
f, err := s.site.BaseFs.Content.Fs.Open(file.Filename())
|
|
if err != nil {
|
|
return fmt.Errorf("failed to open assets file: %s", err)
|
|
}
|
|
err = s.site.publish(&s.site.PathSpec.ProcessingStats.Files, file.Path(), f)
|
|
f.Close()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
case <-ctx.Done():
|
|
return ctx.Err()
|
|
}
|
|
}
|
|
})
|
|
|
|
g2.Go(func() error {
|
|
for {
|
|
select {
|
|
case bundle, ok := <-s.fileBundlesChan:
|
|
if !ok {
|
|
return nil
|
|
}
|
|
err := s.readAndConvertContentBundle(bundle)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
case <-ctx.Done():
|
|
return ctx.Err()
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
err := g2.Wait()
|
|
|
|
close(s.pagesChan)
|
|
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := g1.Wait(); err != nil {
|
|
return err
|
|
}
|
|
|
|
s.site.rawAllPages.Sort()
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
func (s *siteContentProcessor) readAndConvertContentFile(file *fileInfo) error {
|
|
ctx := &handlerContext{source: file, pages: s.pagesChan}
|
|
return s.handleContent(ctx).err
|
|
}
|
|
|
|
func (s *siteContentProcessor) readAndConvertContentBundle(bundle *bundleDir) error {
|
|
ctx := &handlerContext{bundle: bundle, pages: s.pagesChan}
|
|
return s.handleContent(ctx).err
|
|
}
|