diff --git a/.circleci/config.yml b/.circleci/config.yml
index 544f820d33a..6fd9ede58e0 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -1,51 +1,114 @@
+parameters:
+
+# v2: 11m.
defaults: &defaults
+ resource_class: large
docker:
- - image: bepsays/ci-goreleaser:1.1800.300
- environment:
- CGO_ENABLED: "0"
-
+ - image: bepsays/ci-hugoreleaser:1.22000.20100
+environment: &buildenv
+ GOMODCACHE: /root/project/gomodcache
version: 2
jobs:
- build:
- <<: *defaults
+ prepare_release:
+ <<: *defaults
+ environment: &buildenv
+ GOMODCACHE: /root/project/gomodcache
steps:
- - checkout:
+ - &remote-docker
+ setup_remote_docker:
+ version: 20.10.14
+ - checkout:
path: hugo
+ - &git-config
+ run:
+ command: |
+ git config --global user.email "bjorn.erik.pedersen+hugoreleaser@gmail.com"
+ git config --global user.name "hugoreleaser"
- run:
- command: |
- git clone git@github.com:gohugoio/hugoDocs.git
- cd hugo
- go mod download
- sleep 5
- go mod verify
- - persist_to_workspace:
- root: .
- paths: .
- release:
- <<: *defaults
+ command: |
+ cd hugo
+ go mod download
+ go run -tags release main.go release --step 1
+ - save_cache:
+ key: git-sha-{{ .Revision }}
+ paths:
+ - hugo
+ - gomodcache
+ build_container1:
+ <<: [*defaults]
+ environment:
+ <<: [*buildenv]
steps:
- - attach_workspace:
- at: /root/project
+ - &restore-cache
+ restore_cache:
+ key: git-sha-{{ .Revision }}
- run:
- command: |
- cd hugo
- git config --global user.email "bjorn.erik.pedersen+hugoreleaser@gmail.com"
- git config --global user.name "hugoreleaser"
- go run -tags release main.go release -r ${CIRCLE_BRANCH}
-
+ no_output_timeout: 20m
+ command: |
+ mkdir -p /tmp/files/dist1
+ cd hugo
+ hugoreleaser build -paths "builds/container1/**" -workers 3 -dist /tmp/files/dist1 -chunks $CIRCLE_NODE_TOTAL -chunk-index $CIRCLE_NODE_INDEX
+ - &persist-workspace
+ persist_to_workspace:
+ root: /tmp/files
+ paths:
+ - dist1
+ - dist2
+ parallelism: 7
+ build_container2:
+ <<: [*defaults]
+ environment:
+ <<: [*buildenv]
+ docker:
+ - image: bepsays/ci-hugoreleaser-linux-arm64:1.22000.20100
+ steps:
+ - *restore-cache
+ - &attach-workspace
+ attach_workspace:
+ at: /tmp/workspace
+ - run:
+ command: |
+ mkdir -p /tmp/files/dist2
+ cd hugo
+ hugoreleaser build -paths "builds/container2/**" -workers 1 -dist /tmp/files/dist2
+ - *persist-workspace
+ archive_and_release:
+ <<: [*defaults]
+ environment:
+ <<: [*buildenv]
+ steps:
+ - *restore-cache
+ - *attach-workspace
+ - *git-config
+ - run:
+ command: |
+ cp -a /tmp/workspace/dist1/. ./hugo/dist
+ cp -a /tmp/workspace/dist2/. ./hugo/dist
+ - run:
+ command: |
+ cd hugo
+ hugoreleaser archive
+ hugoreleaser release
+ go run -tags release main.go release --step 2
workflows:
version: 2
release:
jobs:
- - build:
+ - prepare_release:
filters:
branches:
only: /release-.*/
- - hold:
- type: approval
+ - build_container1:
+ requires:
+ - prepare_release
+ - build_container2:
requires:
- - build
- - release:
+ - prepare_release
+ - archive_and_release:
context: org-global
requires:
- - hold
+ - build_container1
+ - build_container2
+
+
+
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
index 86cd2cac4a0..53b8adac43c 100644
--- a/.github/workflows/stale.yml
+++ b/.github/workflows/stale.yml
@@ -3,8 +3,13 @@ on:
workflow_dispatch:
schedule:
- cron: '30 1 * * *'
+permissions:
+ contents: read
jobs:
stale:
+ permissions:
+ issues: write
+ pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@08e671be8ac8944d0e132aa71d0ae8ccfb347675
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 1403c4d572a..8a8d02487bb 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -1,30 +1,41 @@
-on: [push, pull_request]
+on:
+ push:
+ branches: [ master ]
+ pull_request:
name: Test
+env:
+ GOPROXY: https://proxy.golang.org
+ GO111MODULE: on
+ DART_SASS_VERSION: 1.56.2
+ DART_SASS_SHA_LINUX: 9e4f455f7b8619959d7878af2862383be58392eb963a14ff87cc512c03701e2a
+ DART_SASS_SHA_MACOS: 5992e979e2c30ec363f8e338822bb2b4443c74232b3340501a76180f5652cb09
+ DART_SASS_SHA_WINDOWS: 8d3d9117c54840e3e6a4919e43acf75ea52f28a64fc87a8e29d80ec72ee36cfb
permissions:
contents: read
jobs:
test:
- env:
- GOPROXY: https://proxy.golang.org
- GO111MODULE: on
strategy:
matrix:
- # Note: We upgraded to Go 1.18 in Hugo v0.95.0
- # Go 1.18 had some breaking changes on the source level which means Hugo cannot be built
- # with older Go versions, but the improvements in Go 1.18 were too good to pass on (e.g. break and continue).
- # Note that you don't need Go (or Go 1.18) to run a pre-built binary.
- go-version: [1.18.x]
+ go-version: [1.19.x,1.20.x]
os: [ubuntu-latest, macos-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
+ - name: Checkout code
+ uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
- name: Install Go
- uses: actions/setup-go@37335c7bb261b353407cff977110895fa0b4f7d8
+ uses: actions/setup-go@268d8c0ca0432bb2cf416faae41297df9d262d7f
with:
go-version: ${{ matrix.go-version }}
+ check-latest: true
+ cache: true
+ cache-dependency-path: |
+ **/go.sum
+ **/go.mod
- name: Install Ruby
- uses: actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526
+ uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4
with:
- ruby-version: '2.7'
+ ruby-version: '2.7'
+ bundler-cache: true #
- name: Install Python
uses: actions/setup-python@3105fb18c05ddd93efea5f9e0bef7a03a6e9e7df
with:
@@ -33,8 +44,6 @@ jobs:
run: go install github.com/magefile/mage@07afc7d24f4d6d6442305d49552f04fbda5ccb3e
- name: Install asciidoctor
uses: reitzig/actions-asciidoctor@7570212ae20b63653481675fb1ff62d1073632b0
- - name: Checkout code
- uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: Install docutils
run: |
pip install docutils
@@ -49,28 +58,33 @@ jobs:
brew install pandoc
- if: matrix.os == 'windows-latest'
run: |
- choco install pandoc
+ Choco-Install -PackageName pandoc
- run: pandoc -v
+ - if: matrix.os == 'windows-latest'
+ run: |
+ Choco-Install -PackageName mingw -ArgumentList "--version","10.2.0","--allow-downgrade"
- if: matrix.os == 'ubuntu-latest'
name: Install dart-sass-embedded Linux
run: |
- curl -LJO https://github.com/sass/dart-sass-embedded/releases/download/1.0.0-beta.6/sass_embedded-1.0.0-beta.6-linux-x64.tar.gz;
- echo "04fc1e5e28d29a4585a701941b6dace56771d94bfbe7f9e4db28d24417ceeec3 sass_embedded-1.0.0-beta.6-linux-x64.tar.gz" | sha256sum -c;
- tar -xvf sass_embedded-1.0.0-beta.6-linux-x64.tar.gz;
+ echo "Install Dart Sass version ${DART_SASS_VERSION} ..."
+ curl -LJO "https://github.com/sass/dart-sass-embedded/releases/download/${DART_SASS_VERSION}/sass_embedded-${DART_SASS_VERSION}-linux-x64.tar.gz";
+ echo "${DART_SASS_SHA_LINUX} sass_embedded-${DART_SASS_VERSION}-linux-x64.tar.gz" | sha256sum -c;
+ tar -xvf "sass_embedded-${DART_SASS_VERSION}-linux-x64.tar.gz";
echo "$GITHUB_WORKSPACE/sass_embedded/" >> $GITHUB_PATH
- if: matrix.os == 'macos-latest'
name: Install dart-sass-embedded MacOS
run: |
- curl -LJO https://github.com/sass/dart-sass-embedded/releases/download/1.0.0-beta.6/sass_embedded-1.0.0-beta.6-macos-x64.tar.gz;
- echo "b3b984675a9b04aa22f6f2302dda4191b507ac2ca124467db2dfe7e58e72fbad sass_embedded-1.0.0-beta.6-macos-x64.tar.gz" | shasum -a 256 -c;
- tar -xvf sass_embedded-1.0.0-beta.6-macos-x64.tar.gz;
+ echo "Install Dart Sass version ${DART_SASS_VERSION} ..."
+ curl -LJO "https://github.com/sass/dart-sass-embedded/releases/download/${DART_SASS_VERSION}/sass_embedded-${DART_SASS_VERSION}-macos-x64.tar.gz";
+ echo "${DART_SASS_SHA_MACOS} sass_embedded-${DART_SASS_VERSION}-macos-x64.tar.gz" | shasum -a 256 -c;
+ tar -xvf "sass_embedded-${DART_SASS_VERSION}-macos-x64.tar.gz";
echo "$GITHUB_WORKSPACE/sass_embedded/" >> $GITHUB_PATH
- if: matrix.os == 'windows-latest'
name: Install dart-sass-embedded Windows
run: |
- curl -LJO https://github.com/sass/dart-sass-embedded/releases/download/1.0.0-beta.6/sass_embedded-1.0.0-beta.6-windows-x64.zip;
- echo "6ae442129dbb3334bc21ef851261da6c0c1b560da790ca2e1350871d00ab816d sass_embedded-1.0.0-beta.6-windows-x64.zip" | sha256sum -c;
- unzip sass_embedded-1.0.0-beta.6-windows-x64.zip;
+ echo "Install Dart Sass version ${env:DART_SASS_VERSION} ..."
+ curl -LJO "https://github.com/sass/dart-sass-embedded/releases/download/${env:DART_SASS_VERSION}/sass_embedded-${env:DART_SASS_VERSION}-windows-x64.zip";
+ Expand-Archive -Path "sass_embedded-${env:DART_SASS_VERSION}-windows-x64.zip" -DestinationPath .;
echo "$env:GITHUB_WORKSPACE/sass_embedded/" | Out-File -FilePath $Env:GITHUB_PATH -Encoding utf-8 -Append
- name: Check
run: |
diff --git a/.gitignore b/.gitignore
index b2aeb914241..00b5b2e8041 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,29 +1,2 @@
-/hugo
-docs/public*
-/.idea
-.vscode/*
-hugo.exe
-*.test
-*.prof
-nohup.out
-cover.out
-*.swp
-*.swo
-.DS_Store
-*~
-vendor/*/
-*.bench
-*.debug
-coverage*.out
-dock.sh
-
-GoBuilds
-dist
-
-hugolib/hugo_stats.json
-resources/sunset.jpg
-
-vendor
-
-.hugo_build.lock
+*.test
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 23de481cd70..06e8a44d909 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
-# Contributing to Hugo
+>**Note:** We would apprecitate if you hold on with any big refactorings (like renaming deprecated Go packages), mainly because of potential for extra merge work for future coming in in the near future.
-**Note March 16th 2022:** We are currently very constrained on human resources to do code reviews, so we currently require any new Pull Requests to be limited to bug fixes closing an existing issue. Also, we have updated to Go 1.18, but we will currently not accept any generic rewrites, "interface{} to any" replacements and similar.
+# Contributing to Hugo
We welcome contributions to Hugo of any kind including documentation, themes,
organization, tutorials, blog posts, bug reports, issues, feature requests,
@@ -52,8 +52,6 @@ Hugo has become a fully featured static site generator, so any new functionality
If it is of some complexity, the contributor is expected to maintain and support the new feature in the future (answer questions on the forum, fix any bugs etc.).
-It is recommended to open up a discussion on the [Hugo Forum](https://discourse.gohugo.io/) to get feedback on your idea before you begin.
-
Any non-trivial code change needs to update an open [issue](https://github.com/gohugoio/hugo/issues). A non-trivial code change without an issue reference with one of the labels `bug` or `enhancement` will not be merged.
Note that we do not accept new features that require [CGO](https://github.com/golang/go/wiki/cgo).
diff --git a/Dockerfile b/Dockerfile
index 885809fabf2..7d09800358b 100755
--- a/Dockerfile
+++ b/Dockerfile
@@ -2,7 +2,7 @@
# Twitter: https://twitter.com/gohugoio
# Website: https://gohugo.io/
-FROM golang:1.18-alpine AS build
+FROM golang:1.19-alpine AS build
# Optionally set HUGO_BUILD_TAGS to "extended" or "nodeploy" when building like so:
# docker build --build-arg HUGO_BUILD_TAGS=extended .
@@ -26,7 +26,7 @@ RUN mage hugo && mage install
# ---
-FROM alpine:3.12
+FROM alpine:3.16
COPY --from=build /go/bin/hugo /usr/bin/hugo
diff --git a/LICENSE b/LICENSE
index 261eeb9e9f8..ad3850b60a3 100644
--- a/LICENSE
+++ b/LICENSE
@@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.
- Copyright [yyyy] [name of copyright owner]
+ Copyright 2022 The Hugo Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/README.md b/README.md
index dc9f3b4457f..5787956028c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-A Fast and Flexible Static Site Generator built with love by [bep](https://github.com/bep), [spf13](https://spf13.com/) and [friends](https://github.com/gohugoio/hugo/graphs/contributors) in [Go][].
+A Fast and Flexible Static Site Generator built with love by [bep](https://github.com/bep), [spf13](https://spf13.com/) and [friends](https://github.com/gohugoio/hugo/graphs/contributors) in [Go](https://go.dev/).
[Website](https://gohugo.io) |
[Forum](https://discourse.gohugo.io) |
@@ -13,9 +13,19 @@ A Fast and Flexible Static Site Generator built with love by [bep](https://githu
[](https://github.com/gohugoio/hugo/actions?query=workflow%3ATest)
[](https://goreportcard.com/report/github.com/gohugoio/hugo)
+* [Overview](#overview)
+* [Banner Sponsors](#banner-sponsors)
+* [Supported Architectures](#supported-architectures)
+* [Choose How to Install](#choose-how-to-install)
+ * [Install Hugo as Your Site Generator (Binary Install)](#install-hugo-as-your-site-generator-binary-install)
+ * [Build and Install the Binary from Source (Using the Go toolchain)](#build-and-install-the-binary-from-source-using-the-go-toolchain)
+* [The Hugo Documentation](#the-hugo-documentation)
+* [Contributing to Hugo](#contributing-code-to-hugo)
+* [Dependencies](#dependencies)
+
## Overview
-Hugo is a static HTML and CSS website generator written in [Go][].
+Hugo is a static HTML and CSS website generator written in [Go](https://go.dev/).
It is optimized for speed, ease of use, and configurability.
Hugo takes a directory with content and templates and renders them into a full HTML website.
@@ -27,7 +37,17 @@ A good rule of thumb is that each piece of content renders in around 1 milliseco
Hugo is designed to work well for any kind of website including blogs, tumbles, and docs.
-#### Supported Architectures
+## Banner Sponsors
+
+
+
+
+
+
+
+
+
+## Supported Architectures
Currently, we provide pre-built Hugo binaries for Windows, Linux, FreeBSD, NetBSD, DragonFly BSD, OpenBSD, macOS (Darwin), and [Android](https://gist.github.com/bep/a0d8a26cf6b4f8bc992729b8e50b480b) for x64, i386 and ARM architectures.
@@ -38,7 +58,6 @@ Hugo may also be compiled from source wherever the Go compiler tool chain can ru
## Choose How to Install
If you want to use Hugo as your site generator, simply install the Hugo binaries.
-The Hugo binaries have no external dependencies.
To contribute to the Hugo source code or documentation, you should [fork the Hugo GitHub project](https://github.com/gohugoio/hugo#fork-destination-box) and clone it to your local machine.
@@ -49,31 +68,24 @@ Building the binaries is an easy task for an experienced `go` getter.
Use the [installation instructions in the Hugo documentation](https://gohugo.io/getting-started/installing/).
-### Build and Install the Binaries from Source (Advanced Install)
+### Build and Install the Binary from Source (Using the Go toolchain)
#### Prerequisite Tools
-* [Git](https://git-scm.com/)
* [Go (we test it with the last 2 major versions; but note that Hugo 0.95.0 only builds with >= Go 1.18.)](https://golang.org/dl/)
#### Fetch from GitHub
-To fetch and build the source from GitHub:
+To fetch, build and install from the Github source:
```bash
-mkdir $HOME/src
-cd $HOME/src
-git clone https://github.com/gohugoio/hugo.git
-cd hugo
-go install
+go install github.com/gohugoio/hugo@latest
```
-**If you are a Windows user, substitute the `$HOME` environment variable above with `%USERPROFILE%`.**
-
If you want to compile with Sass/SCSS support use `--tags extended` and make sure `CGO_ENABLED=1` is set in your go environment. If you don't want to have CGO enabled, you may use the following command to temporarily enable CGO only for hugo compilation:
```bash
-CGO_ENABLED=1 go install --tags extended
+CGO_ENABLED=1 go install --tags extended github.com/gohugoio/hugo@latest
```
## The Hugo Documentation
@@ -83,9 +95,7 @@ The Hugo documentation now lives in its own repository, see https://github.com/g
```bash
git clone git@github.com:gohugoio/hugo.git
```
-## Contributing to Hugo
-
-**Note March 16th 2022:** We are currently very constrained on human resources to do code reviews, so we currently require any new Pull Requests to be limited to bug fixes closing an existing issue. Also, we have updated to Go 1.18, but we will currently not accept any generic rewrites, "interface{} to any" replacements and similar.
+## Contributing code to Hugo
For a complete guide to contributing to Hugo, see the [Contribution Guide](CONTRIBUTING.md).
@@ -96,34 +106,18 @@ helping to manage issues, etc.
The Hugo community and maintainers are [very active](https://github.com/gohugoio/hugo/pulse/monthly) and helpful, and the project benefits greatly from this activity.
-### Asking Support Questions
+## Asking Support Questions
We have an active [discussion forum](https://discourse.gohugo.io) where users and developers can ask questions.
Please don't use the GitHub issue tracker to ask questions.
-### Reporting Issues
+## Reporting Issues
If you believe you have found a defect in Hugo or its documentation, use
the GitHub issue tracker to report the problem to the Hugo maintainers.
If you're not sure if it's a bug or not, start by asking in the [discussion forum](https://discourse.gohugo.io).
When reporting the issue, please provide the version of Hugo in use (`hugo version`).
-### Submitting Patches
-
-The Hugo project welcomes all contributors and contributions regardless of skill or experience level.
-If you are interested in helping with the project, we will help you with your contribution.
-Hugo is a very active project with many contributions happening daily.
-
-We want to create the best possible product for our users and the best contribution experience for our developers,
-we have a set of guidelines which ensure that all contributions are acceptable.
-The guidelines are not intended as a filter or barrier to participation.
-If you are unfamiliar with the contribution process, the Hugo team will help you and teach you how to bring your contribution in accordance with the guidelines.
-
-For a complete guide to contributing code to Hugo, see the [Contribution Guide](CONTRIBUTING.md).
-
-[Go]: https://golang.org/
-[Hugo Documentation]: https://gohugo.io/overview/introduction/
-
## Dependencies
Hugo stands on the shoulder of many great open source libraries.
@@ -245,4 +239,3 @@ google.golang.org/grpc="v1.46.0"
google.golang.org/protobuf="v1.28.0"
gopkg.in/yaml.v2="v2.4.0"
```
-
diff --git a/cache/filecache/filecache.go b/cache/filecache/filecache.go
index 63d939ef690..88a46621881 100644
--- a/cache/filecache/filecache.go
+++ b/cache/filecache/filecache.go
@@ -17,7 +17,6 @@ import (
"bytes"
"errors"
"io"
- "io/ioutil"
"os"
"path/filepath"
"strings"
@@ -207,7 +206,7 @@ func (c *Cache) GetOrCreateBytes(id string, create func() ([]byte, error)) (Item
if r := c.getOrRemove(id); r != nil {
defer r.Close()
- b, err := ioutil.ReadAll(r)
+ b, err := io.ReadAll(r)
return info, b, err
}
@@ -242,14 +241,14 @@ func (c *Cache) GetBytes(id string) (ItemInfo, []byte, error) {
if r := c.getOrRemove(id); r != nil {
defer r.Close()
- b, err := ioutil.ReadAll(r)
+ b, err := io.ReadAll(r)
return info, b, err
}
return info, nil, nil
}
-// Get gets the file with the given id from the cahce, nil if none found.
+// Get gets the file with the given id from the cache, nil if none found.
func (c *Cache) Get(id string) (ItemInfo, io.ReadCloser, error) {
id = cleanID(id)
@@ -314,7 +313,7 @@ func (c *Cache) getString(id string) string {
}
defer f.Close()
- b, _ := ioutil.ReadAll(f)
+ b, _ := io.ReadAll(f)
return string(b)
}
diff --git a/cache/filecache/filecache_pruner.go b/cache/filecache/filecache_pruner.go
index e5e5719725d..b8aa76c150f 100644
--- a/cache/filecache/filecache_pruner.go
+++ b/cache/filecache/filecache_pruner.go
@@ -18,6 +18,7 @@ import (
"io"
"os"
+ "github.com/gohugoio/hugo/common/herrors"
"github.com/gohugoio/hugo/hugofs"
"github.com/spf13/afero"
@@ -36,7 +37,7 @@ func (c Caches) Prune() (int, error) {
counter += count
if err != nil {
- if os.IsNotExist(err) {
+ if herrors.IsNotExist(err) {
continue
}
return counter, fmt.Errorf("failed to prune cache %q: %w", k, err)
@@ -65,18 +66,24 @@ func (c *Cache) Prune(force bool) (int, error) {
if info.IsDir() {
f, err := c.Fs.Open(name)
+
if err != nil {
// This cache dir may not exist.
return nil
}
- defer f.Close()
_, err = f.Readdirnames(1)
+ f.Close()
if err == io.EOF {
// Empty dir.
- err = c.Fs.Remove(name)
+ if name == "." {
+ // e.g. /_gen/images -- keep it even if empty.
+ err = nil
+ } else {
+ err = c.Fs.Remove(name)
+ }
}
- if err != nil && !os.IsNotExist(err) {
+ if err != nil && !herrors.IsNotExist(err) {
return err
}
@@ -97,7 +104,7 @@ func (c *Cache) Prune(force bool) (int, error) {
counter++
}
- if err != nil && !os.IsNotExist(err) {
+ if err != nil && !herrors.IsNotExist(err) {
return err
}
@@ -112,7 +119,7 @@ func (c *Cache) Prune(force bool) (int, error) {
func (c *Cache) pruneRootDir(force bool) (int, error) {
info, err := c.Fs.Stat(c.pruneAllRootDir)
if err != nil {
- if os.IsNotExist(err) {
+ if herrors.IsNotExist(err) {
return 0, nil
}
return 0, err
diff --git a/cache/filecache/filecache_test.go b/cache/filecache/filecache_test.go
index 47b5a7fcf42..6b96a8601e1 100644
--- a/cache/filecache/filecache_test.go
+++ b/cache/filecache/filecache_test.go
@@ -17,8 +17,6 @@ import (
"errors"
"fmt"
"io"
- "io/ioutil"
- "os"
"path/filepath"
"strings"
"sync"
@@ -44,13 +42,8 @@ func TestFileCache(t *testing.T) {
t.Parallel()
c := qt.New(t)
- tempWorkingDir, err := ioutil.TempDir("", "hugo_filecache_test_work")
- c.Assert(err, qt.IsNil)
- defer os.Remove(tempWorkingDir)
-
- tempCacheDir, err := ioutil.TempDir("", "hugo_filecache_test_cache")
- c.Assert(err, qt.IsNil)
- defer os.Remove(tempCacheDir)
+ tempWorkingDir := t.TempDir()
+ tempCacheDir := t.TempDir()
osfs := afero.NewOsFs()
@@ -123,7 +116,7 @@ dir = ":cacheDir/c"
io.Closer
}{
strings.NewReader(s),
- ioutil.NopCloser(nil),
+ io.NopCloser(nil),
}, nil
}
}
@@ -138,7 +131,7 @@ dir = ":cacheDir/c"
c.Assert(err, qt.IsNil)
c.Assert(r, qt.Not(qt.IsNil))
c.Assert(info.Name, qt.Equals, "a")
- b, _ := ioutil.ReadAll(r)
+ b, _ := io.ReadAll(r)
r.Close()
c.Assert(string(b), qt.Equals, "abc")
@@ -154,7 +147,7 @@ dir = ":cacheDir/c"
_, r, err = ca.GetOrCreate("a", rf("bcd"))
c.Assert(err, qt.IsNil)
- b, _ = ioutil.ReadAll(r)
+ b, _ = io.ReadAll(r)
r.Close()
c.Assert(string(b), qt.Equals, "abc")
}
@@ -173,7 +166,7 @@ dir = ":cacheDir/c"
c.Assert(err, qt.IsNil)
c.Assert(r, qt.Not(qt.IsNil))
c.Assert(info.Name, qt.Equals, "mykey")
- b, _ := ioutil.ReadAll(r)
+ b, _ := io.ReadAll(r)
r.Close()
c.Assert(string(b), qt.Equals, "Hugo is great!")
@@ -233,7 +226,7 @@ dir = "/cache/c"
return hugio.ToReadCloser(strings.NewReader(data)), nil
})
c.Assert(err, qt.IsNil)
- b, _ := ioutil.ReadAll(r)
+ b, _ := io.ReadAll(r)
r.Close()
c.Assert(string(b), qt.Equals, data)
// Trigger some expiration.
@@ -260,7 +253,7 @@ func TestFileCacheReadOrCreateErrorInRead(t *testing.T) {
return errors.New("fail")
}
- b, _ := ioutil.ReadAll(r)
+ b, _ := io.ReadAll(r)
result = string(b)
return nil
diff --git a/cache/filecache/integration_test.go b/cache/filecache/integration_test.go
new file mode 100644
index 00000000000..26653fc351e
--- /dev/null
+++ b/cache/filecache/integration_test.go
@@ -0,0 +1,97 @@
+// Copyright 2023 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 filecache_test
+
+import (
+ "path/filepath"
+ "testing"
+ "time"
+
+ qt "github.com/frankban/quicktest"
+ "github.com/gohugoio/hugo/hugolib"
+)
+
+// See issue #10781. That issue wouldn't have been triggered if we kept
+// the empty root directories (e.g. _resources/gen/images).
+// It's still an upstream Go issue that we also need to handle, but
+// this is a test for the first part.
+func TestPruneShouldPreserveEmptyCacheRoots(t *testing.T) {
+ files := `
+-- hugo.toml --
+baseURL = "https://example.com"
+-- content/_index.md --
+---
+title: "Home"
+---
+
+`
+
+ b := hugolib.NewIntegrationTestBuilder(
+ hugolib.IntegrationTestConfig{T: t, TxtarString: files, RunGC: true, NeedsOsFS: true},
+ ).Build()
+
+ _, err := b.H.BaseFs.ResourcesCache.Stat(filepath.Join("_gen", "images"))
+
+ b.Assert(err, qt.IsNil)
+
+}
+
+func TestPruneImages(t *testing.T) {
+ files := `
+-- hugo.toml --
+baseURL = "https://example.com"
+[caches]
+[caches.images]
+maxAge = "200ms"
+dir = ":resourceDir/_gen"
+-- content/_index.md --
+---
+title: "Home"
+---
+-- assets/a/pixel.png --
+iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==
+-- layouts/index.html --
+{{ $img := resources.GetMatch "**.png" }}
+{{ $img = $img.Resize "3x3" }}
+{{ $img.RelPermalink }}
+
+
+
+`
+
+ b := hugolib.NewIntegrationTestBuilder(
+ hugolib.IntegrationTestConfig{T: t, TxtarString: files, RunGC: true, NeedsOsFS: true},
+ ).Build()
+
+ b.Assert(b.GCCount, qt.Equals, 0)
+
+ imagesCacheDir := filepath.Join("_gen", "images")
+ _, err := b.H.BaseFs.ResourcesCache.Stat(imagesCacheDir)
+
+ b.Assert(err, qt.IsNil)
+
+ // TODO(bep) we need a way to test full rebuilds.
+ // For now, just sleep a little so the cache elements expires.
+ time.Sleep(300 * time.Millisecond)
+
+ b.RenameFile("assets/a/pixel.png", "assets/b/pixel2.png").Build()
+ b.Assert(b.GCCount, qt.Equals, 1)
+ // Build it again to GC the empty a dir.
+ b.Build()
+ _, err = b.H.BaseFs.ResourcesCache.Stat(filepath.Join(imagesCacheDir, "a"))
+ b.Assert(err, qt.Not(qt.IsNil))
+ _, err = b.H.BaseFs.ResourcesCache.Stat(imagesCacheDir)
+ b.Assert(err, qt.IsNil)
+
+}
diff --git a/codegen/methods.go b/codegen/methods.go
index 9bc80cc3e25..65a7cc2b752 100644
--- a/codegen/methods.go
+++ b/codegen/methods.go
@@ -452,12 +452,16 @@ func collectMethodsRecursive(pkg string, f []*ast.Field) []string {
}
if ident, ok := m.Type.(*ast.Ident); ok && ident.Obj != nil {
- // Embedded interface
- methodNames = append(
- methodNames,
- collectMethodsRecursive(
- pkg,
- ident.Obj.Decl.(*ast.TypeSpec).Type.(*ast.InterfaceType).Methods.List)...)
+ switch tt := ident.Obj.Decl.(*ast.TypeSpec).Type.(type) {
+ case *ast.InterfaceType:
+ // Embedded interface
+ methodNames = append(
+ methodNames,
+ collectMethodsRecursive(
+ pkg,
+ tt.Methods.List)...)
+ }
+
} else {
// Embedded, but in a different file/package. Return the
// package.Name and deal with that later.
diff --git a/commands/commandeer.go b/commands/commandeer.go
index 5e5e1b3ab97..b77e9e90882 100644
--- a/commands/commandeer.go
+++ b/commands/commandeer.go
@@ -16,7 +16,7 @@ package commands
import (
"errors"
"fmt"
- "io/ioutil"
+ "io"
"net"
"os"
"path/filepath"
@@ -79,8 +79,8 @@ type commandeer struct {
changeDetector *fileChangeDetector
// We need to reuse these on server rebuilds.
- // These 2 will be different if --renderStaticToDisk is set.
publishDirFs afero.Fs
+ publishDirStaticFs afero.Fs
publishDirServerFs afero.Fs
h *hugoBuilderCommon
@@ -170,6 +170,7 @@ func (c *commandeer) Set(key string, value any) {
func (c *commandeer) initFs(fs *hugofs.Fs) error {
c.publishDirFs = fs.PublishDir
+ c.publishDirStaticFs = fs.PublishDirStatic
c.publishDirServerFs = fs.PublishDirServer
c.DepsCfg.Fs = fs
@@ -200,7 +201,7 @@ func newCommandeer(mustHaveConfigFile, failOnInitErr, running bool, h *hugoBuild
rebuildDebouncer = debounce.New(4 * time.Second)
}
- out := ioutil.Discard
+ out := io.Discard
if !h.quiet {
out = os.Stdout
}
@@ -220,7 +221,7 @@ func newCommandeer(mustHaveConfigFile, failOnInitErr, running bool, h *hugoBuild
running: running,
// This will be replaced later, but we need something to log to before the configuration is read.
- logger: loggers.NewLogger(jww.LevelWarn, jww.LevelError, out, ioutil.Discard, running),
+ logger: loggers.NewLogger(jww.LevelWarn, jww.LevelError, out, io.Discard, running),
}
return c, c.loadConfig()
@@ -382,7 +383,7 @@ func (c *commandeer) loadConfig() error {
// Set some commonly used flags
c.doLiveReload = c.running && !c.Cfg.GetBool("disableLiveReload")
- c.fastRenderMode = c.doLiveReload && !c.Cfg.GetBool("disableFastRender")
+ c.fastRenderMode = c.running && !c.Cfg.GetBool("disableFastRender")
c.showErrorInBrowser = c.doLiveReload && !c.Cfg.GetBool("disableBrowserError")
// This is potentially double work, but we need to do this one more time now
@@ -407,6 +408,9 @@ func (c *commandeer) loadConfig() error {
createMemFs := config.GetBool("renderToMemory")
c.renderStaticToDisk = config.GetBool("renderStaticToDisk")
+ // TODO(bep) we/I really need to look at the config set up, but to prevent changing too much
+ // we store away the original.
+ config.Set("publishDirOrig", config.GetString("publishDir"))
if createMemFs {
// Rendering to memoryFS, publish to Root regardless of publishDir.
@@ -426,6 +430,7 @@ func (c *commandeer) loadConfig() error {
if c.publishDirFs != nil {
// Need to reuse the destination on server rebuilds.
fs.PublishDir = c.publishDirFs
+ fs.PublishDirStatic = c.publishDirStaticFs
fs.PublishDirServer = c.publishDirServerFs
} else {
if c.renderStaticToDisk {
diff --git a/commands/commands.go b/commands/commands.go
index b81b867f9a0..c1042459d2f 100644
--- a/commands/commands.go
+++ b/commands/commands.go
@@ -177,7 +177,7 @@ Complete documentation is available at https://gohugo.io/.`,
},
})
- cc.cmd.PersistentFlags().StringVar(&cc.cfgFile, "config", "", "config file (default is path/config.yaml|json|toml)")
+ cc.cmd.PersistentFlags().StringVar(&cc.cfgFile, "config", "", "config file (default is hugo.yaml|json|toml)")
cc.cmd.PersistentFlags().StringVar(&cc.cfgDir, "configDir", "config", "config dir")
cc.cmd.PersistentFlags().BoolVar(&cc.quiet, "quiet", false, "build in quiet mode")
diff --git a/commands/commands_test.go b/commands/commands_test.go
index 97d81ec6ee9..35621854f76 100644
--- a/commands/commands_test.go
+++ b/commands/commands_test.go
@@ -15,7 +15,6 @@ package commands
import (
"fmt"
- "io/ioutil"
"os"
"path/filepath"
"testing"
@@ -47,7 +46,7 @@ func TestExecute(t *testing.T) {
c.Assert(resp.Err, qt.IsNil)
result := resp.Result
c.Assert(len(result.Sites) == 1, qt.Equals, true)
- c.Assert(len(result.Sites[0].RegularPages()) == 1, qt.Equals, true)
+ c.Assert(len(result.Sites[0].RegularPages()) == 2, qt.Equals, true)
c.Assert(result.Sites[0].Info.Params()["myparam"], qt.Equals, "paramproduction")
})
@@ -117,11 +116,13 @@ func TestExecute(t *testing.T) {
func checkNewSiteInited(c *qt.C, basepath string) {
paths := []string{
- filepath.Join(basepath, "layouts"),
- filepath.Join(basepath, "content"),
filepath.Join(basepath, "archetypes"),
- filepath.Join(basepath, "static"),
+ filepath.Join(basepath, "assets"),
+ filepath.Join(basepath, "content"),
filepath.Join(basepath, "data"),
+ filepath.Join(basepath, "layouts"),
+ filepath.Join(basepath, "static"),
+ filepath.Join(basepath, "themes"),
filepath.Join(basepath, "config.toml"),
}
@@ -228,7 +229,7 @@ func TestFlags(t *testing.T) {
if cmd.getCommand() == nil {
continue
}
- // We are only intereseted in the flag handling here.
+ // We are only interested in the flag handling here.
cmd.getCommand().RunE = noOpRunE
}
rootCmd := root.getCommand()
@@ -362,11 +363,25 @@ weight: 1
Content
+`)
+
+ writeFile(t, filepath.Join(dir, contentDir, "hügö.md"), `
+---
+weight: 2
+---
+
+This is hügö.
+
`)
writeFile(t, filepath.Join(dir, "layouts", "_default", "single.html"), `
-Single: {{ .Title }}
+Single: {{ .Title }}|{{ .Content }}
+
+`)
+
+ writeFile(t, filepath.Join(dir, "layouts", "404.html"), `
+404: {{ .Title }}|Not Found.
`)
@@ -386,7 +401,7 @@ PostProcess: {{ $foo.RelPermalink }}
func writeFile(t testing.TB, filename, content string) {
must(t, os.MkdirAll(filepath.Dir(filename), os.FileMode(0755)))
- must(t, ioutil.WriteFile(filename, []byte(content), os.FileMode(0755)))
+ must(t, os.WriteFile(filename, []byte(content), os.FileMode(0755)))
}
func must(t testing.TB, err error) {
diff --git a/commands/config.go b/commands/config.go
index 7fda2d40e97..a5d8aab22fe 100644
--- a/commands/config.go
+++ b/commands/config.go
@@ -126,6 +126,7 @@ type modMount struct {
Lang string `json:"lang,omitempty"`
}
+// MarshalJSON is for internal use only.
func (m *modMounts) MarshalJSON() ([]byte, error) {
var mounts []modMount
diff --git a/commands/env.go b/commands/env.go
index 65808b1be67..0fc509d6d42 100644
--- a/commands/env.go
+++ b/commands/env.go
@@ -50,6 +50,14 @@ If you add the -v flag, you will get a full dependency list.
for _, dep := range deps {
jww.FEEDBACK.Printf("%s\n", dep)
}
+ } else {
+ // These are also included in the GetDependencyList above;
+ // always print these as these are most likely the most useful to know about.
+ deps := hugo.GetDependencyListNonGo()
+ for _, dep := range deps {
+ jww.FEEDBACK.Printf("%s\n", dep)
+ }
+
}
return nil
diff --git a/commands/hugo.go b/commands/hugo.go
index 5169d65a52e..2fa08ec21e5 100644
--- a/commands/hugo.go
+++ b/commands/hugo.go
@@ -18,7 +18,7 @@ package commands
import (
"context"
"fmt"
- "io/ioutil"
+ "io"
"os"
"os/signal"
"path/filepath"
@@ -138,10 +138,10 @@ func initializeConfig(mustHaveConfigFile, failOnInitErr, running bool,
func (c *commandeer) createLogger(cfg config.Provider) (loggers.Logger, error) {
var (
- logHandle = ioutil.Discard
+ logHandle = io.Discard
logThreshold = jww.LevelWarn
logFile = cfg.GetString("logFile")
- outHandle = ioutil.Discard
+ outHandle = io.Discard
stdoutThreshold = jww.LevelWarn
)
@@ -157,7 +157,7 @@ func (c *commandeer) createLogger(cfg config.Provider) (loggers.Logger, error) {
return nil, newSystemError("Failed to open log file:", logFile, err)
}
} else {
- logHandle, err = ioutil.TempFile("", "hugo")
+ logHandle, err = os.CreateTemp("", "hugo")
if err != nil {
return nil, newSystemError(err)
}
@@ -511,12 +511,15 @@ func (c *commandeer) build() error {
c.hugo().PrintProcessingStats(os.Stdout)
fmt.Println()
- if createCounter, ok := c.publishDirFs.(hugofs.DuplicatesReporter); ok {
- dupes := createCounter.ReportDuplicates()
- if dupes != "" {
- c.logger.Warnln("Duplicate target paths:", dupes)
+ hugofs.WalkFilesystems(c.publishDirFs, func(fs afero.Fs) bool {
+ if dfs, ok := fs.(hugofs.DuplicatesReporter); ok {
+ dupes := dfs.ReportDuplicates()
+ if dupes != "" {
+ c.logger.Warnln("Duplicate target paths:", dupes)
+ }
}
- }
+ return false
+ })
unusedTemplates := c.hugo().Tmpl().(tpl.UnusedTemplatesProvider).UnusedTemplates()
for _, unusedTemplate := range unusedTemplates {
@@ -576,7 +579,7 @@ func (c *commandeer) serverBuild() error {
func (c *commandeer) copyStatic() (map[string]uint64, error) {
m, err := c.doWithPublishDirs(c.copyStaticTo)
- if err == nil || os.IsNotExist(err) {
+ if err == nil || herrors.IsNotExist(err) {
return m, nil
}
return m, err
@@ -650,10 +653,7 @@ func (c *commandeer) copyStaticTo(sourceFs *filesystems.SourceFilesystem) (uint6
syncer.NoChmod = c.Cfg.GetBool("noChmod")
syncer.ChmodFilter = chmodFilter
syncer.SrcFs = fs
- syncer.DestFs = c.Fs.PublishDir
- if c.renderStaticToDisk {
- syncer.DestFs = c.Fs.PublishDirStatic
- }
+ syncer.DestFs = c.Fs.PublishDirStatic
// Now that we are using a unionFs for the static directories
// We can effectively clean the publishDir on initial sync
syncer.Delete = c.Cfg.GetBool("cleanDestinationDir")
@@ -899,7 +899,7 @@ func (c *commandeer) newWatcher(pollIntervalStr string, dirList ...string) (*wat
}
unlock()
case err := <-watcher.Errors():
- if err != nil && !os.IsNotExist(err) {
+ if err != nil && !herrors.IsNotExist(err) {
c.logger.Errorln("Error while watching:", err)
}
}
@@ -924,6 +924,7 @@ func (c *commandeer) printChangeDetected(typ string) {
const (
configChangeConfig = "config file"
configChangeGoMod = "go.mod file"
+ configChangeGoWork = "go work file"
)
func (c *commandeer) handleEvents(watcher *watcher.Batcher,
@@ -943,6 +944,9 @@ func (c *commandeer) handleEvents(watcher *watcher.Batcher,
if strings.Contains(ev.Name, "go.mod") {
configChangeType = configChangeGoMod
}
+ if strings.Contains(ev.Name, ".work") {
+ configChangeType = configChangeGoWork
+ }
}
if !isConfig {
// It may be one of the /config folders
diff --git a/commands/import_jekyll.go b/commands/import_jekyll.go
index 91d5c69fe54..93991121d61 100644
--- a/commands/import_jekyll.go
+++ b/commands/import_jekyll.go
@@ -17,7 +17,7 @@ import (
"bytes"
"errors"
"fmt"
- "io/ioutil"
+ "io"
"os"
"path/filepath"
"regexp"
@@ -164,7 +164,7 @@ func (i *importCmd) importFromJekyll(cmd *cobra.Command, args []string) error {
func (i *importCmd) getJekyllDirInfo(fs afero.Fs, jekyllRoot string) (map[string]bool, bool) {
postDirs := make(map[string]bool)
hasAnyPost := false
- if entries, err := ioutil.ReadDir(jekyllRoot); err == nil {
+ if entries, err := os.ReadDir(jekyllRoot); err == nil {
for _, entry := range entries {
if entry.IsDir() {
subDir := filepath.Join(jekyllRoot, entry.Name())
@@ -186,7 +186,7 @@ func (i *importCmd) retrieveJekyllPostDir(fs afero.Fs, dir string) (bool, bool)
return true, !isEmpty
}
- if entries, err := ioutil.ReadDir(dir); err == nil {
+ if entries, err := os.ReadDir(dir); err == nil {
for _, entry := range entries {
if entry.IsDir() {
subDir := filepath.Join(dir, entry.Name())
@@ -247,7 +247,7 @@ func (i *importCmd) loadJekyllConfig(fs afero.Fs, jekyllRoot string) map[string]
defer f.Close()
- b, err := ioutil.ReadAll(f)
+ b, err := io.ReadAll(f)
if err != nil {
return nil
}
@@ -310,7 +310,7 @@ func (i *importCmd) copyJekyllFilesAndFolders(jekyllRoot, dest string, jekyllPos
if err != nil {
return err
}
- entries, err := ioutil.ReadDir(jekyllRoot)
+ entries, err := os.ReadDir(jekyllRoot)
if err != nil {
return err
}
@@ -386,7 +386,7 @@ func convertJekyllPost(path, relPath, targetDir string, draft bool) error {
targetParentDir := filepath.Dir(targetFile)
os.MkdirAll(targetParentDir, 0777)
- contentBytes, err := ioutil.ReadFile(path)
+ contentBytes, err := os.ReadFile(path)
if err != nil {
jww.ERROR.Println("Read file error:", path)
return err
diff --git a/commands/new.go b/commands/new.go
index c5b5cd18271..a6c2c8ca1ca 100644
--- a/commands/new.go
+++ b/commands/new.go
@@ -32,6 +32,7 @@ var _ cmder = (*newCmd)(nil)
type newCmd struct {
contentEditor string
contentType string
+ force bool
*baseBuilderCmd
}
@@ -54,6 +55,7 @@ Ensure you run this within the root directory of your site.`,
cmd.Flags().StringVarP(&cc.contentType, "kind", "k", "", "content type to create")
cmd.Flags().StringVar(&cc.contentEditor, "editor", "", "edit new content with this editor, if provided")
+ cmd.Flags().BoolVarP(&cc.force, "force", "f", false, "overwrite file if it already exists")
cmd.AddCommand(b.newNewSiteCmd().getCommand())
cmd.AddCommand(b.newNewThemeCmd().getCommand())
@@ -80,7 +82,7 @@ func (n *newCmd) newContent(cmd *cobra.Command, args []string) error {
return newUserError("path needs to be provided")
}
- return create.NewContent(c.hugo(), n.contentType, args[0])
+ return create.NewContent(c.hugo(), n.contentType, args[0], n.force)
}
func mkdir(x ...string) {
diff --git a/commands/new_site.go b/commands/new_site.go
index 384c6365bee..fc4127f8b63 100644
--- a/commands/new_site.go
+++ b/commands/new_site.go
@@ -62,11 +62,12 @@ Use ` + "`hugo new [contentPath]`" + ` to create new content.`,
func (n *newSiteCmd) doNewSite(fs *hugofs.Fs, basepath string, force bool) error {
archeTypePath := filepath.Join(basepath, "archetypes")
dirs := []string{
- filepath.Join(basepath, "layouts"),
- filepath.Join(basepath, "content"),
archeTypePath,
- filepath.Join(basepath, "static"),
+ filepath.Join(basepath, "assets"),
+ filepath.Join(basepath, "content"),
filepath.Join(basepath, "data"),
+ filepath.Join(basepath, "layouts"),
+ filepath.Join(basepath, "static"),
filepath.Join(basepath, "themes"),
}
@@ -82,6 +83,7 @@ func (n *newSiteCmd) doNewSite(fs *hugofs.Fs, basepath string, force bool) error
return errors.New(basepath + " already exists and is not empty. See --force.")
case !isEmpty && force:
+ // TODO(bep) eventually rename this to hugo.
all := append(dirs, filepath.Join(basepath, "config."+n.configFormat))
for _, path := range all {
if exists, _ := helpers.Exists(path, fs.Source); exists {
diff --git a/commands/release.go b/commands/release.go
index 6decda9ea5d..2072f3eb233 100644
--- a/commands/release.go
+++ b/commands/release.go
@@ -17,8 +17,6 @@
package commands
import (
- "errors"
-
"github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/releaser"
"github.com/spf13/cobra"
@@ -29,10 +27,9 @@ var _ cmder = (*releaseCommandeer)(nil)
type releaseCommandeer struct {
cmd *cobra.Command
- version string
-
- skipPublish bool
- try bool
+ step int
+ skipPush bool
+ try bool
}
func createReleaser() cmder {
@@ -50,9 +47,9 @@ func createReleaser() cmder {
return r.release()
}
- r.cmd.PersistentFlags().StringVarP(&r.version, "rel", "r", "", "new release version, i.e. 0.25.1")
- r.cmd.PersistentFlags().BoolVarP(&r.skipPublish, "skip-publish", "", false, "skip all publishing pipes of the release")
- r.cmd.PersistentFlags().BoolVarP(&r.try, "try", "", false, "simulate a release, i.e. no changes")
+ r.cmd.PersistentFlags().BoolVarP(&r.skipPush, "skip-push", "", false, "skip pushing to remote")
+ r.cmd.PersistentFlags().BoolVarP(&r.try, "try", "", false, "no changes")
+ r.cmd.PersistentFlags().IntVarP(&r.step, "step", "", 0, "step to run (1: set new version 2: prepare next dev version)")
return r
}
@@ -65,8 +62,10 @@ func (c *releaseCommandeer) flagsToConfig(cfg config.Provider) {
}
func (r *releaseCommandeer) release() error {
- if r.version == "" {
- return errors.New("must set the --rel flag to the relevant version number")
+ rel, err := releaser.New(r.skipPush, r.try, r.step)
+ if err != nil {
+ return err
}
- return releaser.New(r.version, r.skipPublish, r.try).Run()
+
+ return rel.Run()
}
diff --git a/commands/server.go b/commands/server.go
index f082164cee9..121a649d4dd 100644
--- a/commands/server.go
+++ b/commands/server.go
@@ -400,24 +400,31 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
}
// Ignore any query params for the operations below.
- requestURI := strings.TrimSuffix(r.RequestURI, "?"+r.URL.RawQuery)
+ requestURI, _ := url.PathUnescape(strings.TrimSuffix(r.RequestURI, "?"+r.URL.RawQuery))
for _, header := range f.c.serverConfig.MatchHeaders(requestURI) {
w.Header().Set(header.Key, header.Value)
}
if redirect := f.c.serverConfig.MatchRedirect(requestURI); !redirect.IsZero() {
+ // fullName := filepath.Join(dir, filepath.FromSlash(path.Clean("/"+name)))
doRedirect := true
// This matches Netlify's behaviour and is needed for SPA behaviour.
// See https://docs.netlify.com/routing/redirects/rewrites-proxies/
if !redirect.Force {
path := filepath.Clean(strings.TrimPrefix(requestURI, u.Path))
- fi, err := f.c.hugo().BaseFs.PublishFs.Stat(path)
+ if root != "" {
+ path = filepath.Join(root, path)
+ }
+ fs := f.c.publishDirServerFs
+
+ fi, err := fs.Stat(path)
+
if err == nil {
if fi.IsDir() {
// There will be overlapping directories, so we
// need to check for a file.
- _, err = f.c.hugo().BaseFs.PublishFs.Stat(filepath.Join(path, "index.html"))
+ _, err = fs.Stat(filepath.Join(path, "index.html"))
doRedirect = err != nil
} else {
doRedirect = false
@@ -426,15 +433,27 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
}
if doRedirect {
- if redirect.Status == 200 {
+ switch redirect.Status {
+ case 404:
+ w.WriteHeader(404)
+ file, err := fs.Open(strings.TrimPrefix(redirect.To, u.Path))
+ if err == nil {
+ defer file.Close()
+ io.Copy(w, file)
+ } else {
+ fmt.Fprintln(w, "
Page Not Found
")
+ }
+ return
+ case 200:
if r2 := f.rewriteRequest(r, strings.TrimPrefix(redirect.To, u.Path)); r2 != nil {
requestURI = redirect.To
r = r2
}
- } else {
+ default:
w.Header().Set("Content-Type", "")
http.Redirect(w, r, redirect.To, redirect.Status)
return
+
}
}
@@ -486,7 +505,7 @@ func removeErrorPrefixFromLog(content string) string {
}
var logReplacer = strings.NewReplacer(
- "can't", "can’t", // Chroma lexer does'nt do well with "can't"
+ "can't", "can’t", // Chroma lexer doesn't do well with "can't"
"*hugolib.pageState", "page.Page", // Page is the public interface.
"Rebuild failed:", "",
)
@@ -528,7 +547,7 @@ func (c *commandeer) serve(s *serverCmd) error {
roots = []string{""}
}
- // Cache it here. The HugoSites object may be unavaialble later on due to intermitent configuration errors.
+ // Cache it here. The HugoSites object may be unavailable later on due to intermittent configuration errors.
// To allow the en user to change the error template while the server is running, we use
// the freshest template we can provide.
var (
@@ -558,7 +577,7 @@ func (c *commandeer) serve(s *serverCmd) error {
// to cached values if nil.
templ, handler := getErrorTemplateAndHandler(c.hugoTry())
b := &bytes.Buffer{}
- err := handler.Execute(templ, b, ctx)
+ err := handler.ExecuteWithContext(context.Background(), templ, b, ctx)
return b, err
},
}
diff --git a/commands/server_test.go b/commands/server_test.go
index 56d3949ee83..cf790c3fc91 100644
--- a/commands/server_test.go
+++ b/commands/server_test.go
@@ -25,6 +25,7 @@ import (
"github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/helpers"
+ "github.com/gohugoio/hugo/htesting"
"golang.org/x/net/context"
"golang.org/x/sync/errgroup"
@@ -41,12 +42,98 @@ func TestServerPanicOnConfigError(t *testing.T) {
linenos='table'
`
- r := runServerTest(c, 0, config)
+ r := runServerTest(c,
+ serverTestOptions{
+ config: config,
+ },
+ )
c.Assert(r.err, qt.IsNotNil)
c.Assert(r.err.Error(), qt.Contains, "cannot parse 'Highlight.LineNos' as bool:")
}
+func TestServer404(t *testing.T) {
+ c := qt.New(t)
+
+ r := runServerTest(c,
+ serverTestOptions{
+ pathsToGet: []string{"this/does/not/exist"},
+ getNumHomes: 1,
+ },
+ )
+
+ c.Assert(r.err, qt.IsNil)
+ pr := r.pathsResults["this/does/not/exist"]
+ c.Assert(pr.statusCode, qt.Equals, http.StatusNotFound)
+ c.Assert(pr.body, qt.Contains, "404: 404 Page not found|Not Found.")
+}
+
+func TestServerPathEncodingIssues(t *testing.T) {
+ c := qt.New(t)
+
+ // Issue 10287
+ c.Run("Unicode paths", func(c *qt.C) {
+ r := runServerTest(c,
+ serverTestOptions{
+ pathsToGet: []string{"hügö/"},
+ getNumHomes: 1,
+ },
+ )
+
+ c.Assert(r.err, qt.IsNil)
+ c.Assert(r.pathsResults["hügö/"].body, qt.Contains, "This is hügö")
+ })
+
+ // Issue 10314
+ c.Run("Windows multilingual 404", func(c *qt.C) {
+ config := `
+baseURL = 'https://example.org/'
+title = 'Hugo Forum Topic #40568'
+
+defaultContentLanguageInSubdir = true
+
+[languages.en]
+contentDir = 'content/en'
+languageCode = 'en-US'
+languageName = 'English'
+weight = 1
+
+[languages.es]
+contentDir = 'content/es'
+languageCode = 'es-ES'
+languageName = 'Espanol'
+weight = 2
+
+[server]
+[[server.redirects]]
+from = '/en/**'
+to = '/en/404.html'
+status = 404
+
+[[server.redirects]]
+from = '/es/**'
+to = '/es/404.html'
+status = 404
+`
+ r := runServerTest(c,
+ serverTestOptions{
+ config: config,
+ pathsToGet: []string{"en/this/does/not/exist", "es/this/does/not/exist"},
+ getNumHomes: 1,
+ },
+ )
+
+ c.Assert(r.err, qt.IsNil)
+ pr1 := r.pathsResults["en/this/does/not/exist"]
+ pr2 := r.pathsResults["es/this/does/not/exist"]
+ c.Assert(pr1.statusCode, qt.Equals, http.StatusNotFound)
+ c.Assert(pr2.statusCode, qt.Equals, http.StatusNotFound)
+ c.Assert(pr1.body, qt.Contains, "404: 404 Page not found|Not Found.")
+ c.Assert(pr2.body, qt.Contains, "404: 404 Page not found|Not Found.")
+
+ })
+
+}
func TestServerFlags(t *testing.T) {
c := qt.New(t)
@@ -81,7 +168,13 @@ baseURL="https://example.org"
args = strings.Split(test.flag, "=")
}
- r := runServerTest(c, 1, config, args...)
+ opts := serverTestOptions{
+ config: config,
+ args: args,
+ getNumHomes: 1,
+ }
+
+ r := runServerTest(c, opts)
test.assert(c, r)
@@ -92,6 +185,10 @@ baseURL="https://example.org"
}
func TestServerBugs(t *testing.T) {
+ // TODO(bep) this is flaky on Windows on GH Actions.
+ if htesting.IsGitHubAction() && runtime.GOOS == "windows" {
+ t.Skip("skipping on windows")
+ }
c := qt.New(t)
for _, test := range []struct {
@@ -101,6 +198,10 @@ func TestServerBugs(t *testing.T) {
numservers int
assert func(c *qt.C, r serverTestResult)
}{
+ {"PostProcess, memory", "", "", 1, func(c *qt.C, r serverTestResult) {
+ c.Assert(r.err, qt.IsNil)
+ c.Assert(r.homesContent[0], qt.Contains, "PostProcess: /foo.min.css")
+ }},
// Issue 9788
{"PostProcess, memory", "", "", 1, func(c *qt.C, r serverTestResult) {
c.Assert(r.err, qt.IsNil)
@@ -110,7 +211,7 @@ func TestServerBugs(t *testing.T) {
c.Assert(r.err, qt.IsNil)
c.Assert(r.homesContent[0], qt.Contains, "PostProcess: /foo.min.css")
}},
- // Isue 9901
+ // Issue 9901
{"Multihost", `
defaultContentLanguage = 'en'
[languages]
@@ -140,7 +241,18 @@ baseURL="https://example.org"
if test.flag != "" {
args = strings.Split(test.flag, "=")
}
- r := runServerTest(c, test.numservers, test.config, args...)
+
+ opts := serverTestOptions{
+ config: test.config,
+ getNumHomes: test.numservers,
+ pathsToGet: []string{"this/does/not/exist"},
+ args: args,
+ }
+
+ r := runServerTest(c, opts)
+ pr := r.pathsResults["this/does/not/exist"]
+ c.Assert(pr.statusCode, qt.Equals, http.StatusNotFound)
+ c.Assert(pr.body, qt.Contains, "404: 404 Page not found|Not Found.")
test.assert(c, r)
})
@@ -152,11 +264,29 @@ baseURL="https://example.org"
type serverTestResult struct {
err error
homesContent []string
+ content404 string
publicDirnames map[string]bool
+ pathsResults map[string]pathResult
}
-func runServerTest(c *qt.C, getNumHomes int, config string, args ...string) (result serverTestResult) {
- dir := createSimpleTestSite(c, testSiteConfig{configTOML: config})
+type pathResult struct {
+ statusCode int
+ body string
+}
+
+type serverTestOptions struct {
+ getNumHomes int
+ config string
+ pathsToGet []string
+ args []string
+}
+
+func runServerTest(c *qt.C, opts serverTestOptions) serverTestResult {
+ dir := createSimpleTestSite(c, testSiteConfig{configTOML: opts.config})
+ result := serverTestResult{
+ publicDirnames: make(map[string]bool),
+ pathsResults: make(map[string]pathResult),
+ }
sp, err := helpers.FindAvailablePort()
c.Assert(err, qt.IsNil)
@@ -172,7 +302,7 @@ func runServerTest(c *qt.C, getNumHomes int, config string, args ...string) (res
scmd := b.newServerCmdSignaled(stop)
cmd := scmd.getCommand()
- args = append([]string{"-s=" + dir, fmt.Sprintf("-p=%d", port)}, args...)
+ args := append([]string{"-s=" + dir, fmt.Sprintf("-p=%d", port)}, opts.args...)
cmd.SetArgs(args)
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
@@ -184,16 +314,20 @@ func runServerTest(c *qt.C, getNumHomes int, config string, args ...string) (res
return err
})
- if getNumHomes > 0 {
+ if opts.getNumHomes > 0 {
// Esp. on slow CI machines, we need to wait a little before the web
// server is ready.
- time.Sleep(567 * time.Millisecond)
- result.homesContent = make([]string, getNumHomes)
- for i := 0; i < getNumHomes; i++ {
+ wait := 567 * time.Millisecond
+ if os.Getenv("CI") != "" {
+ wait = 2 * time.Second
+ }
+ time.Sleep(wait)
+ result.homesContent = make([]string, opts.getNumHomes)
+ for i := 0; i < opts.getNumHomes; i++ {
func() {
resp, err := http.Get(fmt.Sprintf("http://localhost:%d/", port+i))
- c.Check(err, qt.IsNil)
- c.Check(resp.StatusCode, qt.Equals, http.StatusOK)
+ c.Assert(err, qt.IsNil)
+ c.Assert(resp.StatusCode, qt.Equals, http.StatusOK)
if err == nil {
defer resp.Body.Close()
result.homesContent[i] = helpers.ReaderToString(resp.Body)
@@ -202,6 +336,22 @@ func runServerTest(c *qt.C, getNumHomes int, config string, args ...string) (res
}
}
+ for _, path := range opts.pathsToGet {
+ func() {
+ resp, err := http.Get(fmt.Sprintf("http://localhost:%d/%s", port, path))
+ c.Assert(err, qt.IsNil)
+ pr := pathResult{
+ statusCode: resp.StatusCode,
+ }
+
+ if err == nil {
+ defer resp.Body.Close()
+ pr.body = helpers.ReaderToString(resp.Body)
+ }
+ result.pathsResults[path] = pr
+ }()
+ }
+
time.Sleep(1 * time.Second)
select {
@@ -210,15 +360,14 @@ func runServerTest(c *qt.C, getNumHomes int, config string, args ...string) (res
}
pubFiles, err := os.ReadDir(filepath.Join(dir, "public"))
- c.Check(err, qt.IsNil)
- result.publicDirnames = make(map[string]bool)
+ c.Assert(err, qt.IsNil)
for _, f := range pubFiles {
result.publicDirnames[f.Name()] = true
}
result.err = wg.Wait()
- return
+ return result
}
diff --git a/commands/static_syncer.go b/commands/static_syncer.go
index b97c4df7ade..c248ca152c3 100644
--- a/commands/static_syncer.go
+++ b/commands/static_syncer.go
@@ -14,9 +14,9 @@
package commands
import (
- "os"
"path/filepath"
+ "github.com/gohugoio/hugo/common/herrors"
"github.com/gohugoio/hugo/hugolib/filesystems"
"github.com/fsnotify/fsnotify"
@@ -95,7 +95,7 @@ func (s *staticSyncer) syncsStaticEvents(staticEvents []fsnotify.Event) error {
// the source of that static file. In this case Hugo will incorrectly remove that file
// from the published directory.
if ev.Op&fsnotify.Rename == fsnotify.Rename || ev.Op&fsnotify.Remove == fsnotify.Remove {
- if _, err := sourceFs.Fs.Stat(relPath); os.IsNotExist(err) {
+ if _, err := sourceFs.Fs.Stat(relPath); herrors.IsNotExist(err) {
// If file doesn't exist in any static dir, remove it
logger.Println("File no longer exists in static dir, removing", relPath)
_ = c.Fs.PublishDirStatic.RemoveAll(relPath)
diff --git a/common/collections/slice.go b/common/collections/slice.go
index 51cb6ec1f80..bf5c7b52b30 100644
--- a/common/collections/slice.go
+++ b/common/collections/slice.go
@@ -15,6 +15,7 @@ package collections
import (
"reflect"
+ "sort"
)
// Slicer defines a very generic way to create a typed slice. This is used
@@ -74,3 +75,22 @@ func StringSliceToInterfaceSlice(ss []string) []any {
return result
}
+
+type SortedStringSlice []string
+
+// Contains returns true if s is in ss.
+func (ss SortedStringSlice) Contains(s string) bool {
+ i := sort.SearchStrings(ss, s)
+ return i < len(ss) && ss[i] == s
+}
+
+// Count returns the number of times s is in ss.
+func (ss SortedStringSlice) Count(s string) int {
+ var count int
+ i := sort.SearchStrings(ss, s)
+ for i < len(ss) && ss[i] == s {
+ count++
+ i++
+ }
+ return count
+}
diff --git a/common/collections/slice_test.go b/common/collections/slice_test.go
index 8e6553994da..5788b9161c8 100644
--- a/common/collections/slice_test.go
+++ b/common/collections/slice_test.go
@@ -122,3 +122,18 @@ func TestSlice(t *testing.T) {
c.Assert(test.expected, qt.DeepEquals, result, errMsg)
}
}
+
+func TestSortedStringSlice(t *testing.T) {
+ t.Parallel()
+ c := qt.New(t)
+
+ var s SortedStringSlice = []string{"a", "b", "b", "b", "c", "d"}
+
+ c.Assert(s.Contains("a"), qt.IsTrue)
+ c.Assert(s.Contains("b"), qt.IsTrue)
+ c.Assert(s.Contains("z"), qt.IsFalse)
+ c.Assert(s.Count("b"), qt.Equals, 3)
+ c.Assert(s.Count("z"), qt.Equals, 0)
+ c.Assert(s.Count("a"), qt.Equals, 1)
+
+}
diff --git a/common/docs.go b/common/docs.go
new file mode 100644
index 00000000000..041a62a0127
--- /dev/null
+++ b/common/docs.go
@@ -0,0 +1,2 @@
+// Package common provides common helper functionality for Hugo.
+package common
diff --git a/common/herrors/error_locator.go b/common/herrors/error_locator.go
index 18c21e51b2c..c7e2d2f06f5 100644
--- a/common/herrors/error_locator.go
+++ b/common/herrors/error_locator.go
@@ -16,7 +16,6 @@ package herrors
import (
"io"
- "io/ioutil"
"path/filepath"
"strings"
@@ -114,7 +113,7 @@ func locateError(r io.Reader, le FileError, matches LineMatcherFn) *ErrorContext
ectx := &ErrorContext{LinesPos: -1, Position: text.Position{Offset: -1}}
- b, err := ioutil.ReadAll(r)
+ b, err := io.ReadAll(r)
if err != nil {
return ectx
}
diff --git a/common/herrors/errors.go b/common/herrors/errors.go
index 6ce90885353..822271ef202 100644
--- a/common/herrors/errors.go
+++ b/common/herrors/errors.go
@@ -1,4 +1,4 @@
-// Copyright 2018 The Hugo Authors. All rights reserved.
+// Copyright 2022 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.
@@ -19,6 +19,7 @@ import (
"errors"
"fmt"
"io"
+ "os"
"runtime"
"runtime/debug"
"strconv"
@@ -38,7 +39,8 @@ type ErrorSender interface {
// Recover is a helper function that can be used to capture panics.
// Put this at the top of a method/function that crashes in a template:
-// defer herrors.Recover()
+//
+// defer herrors.Recover()
func Recover(args ...any) {
if r := recover(); r != nil {
fmt.Println("ERR:", r)
@@ -69,3 +71,18 @@ func Must(err error) {
panic(err)
}
}
+
+// IsNotExist returns true if the error is a file not found error.
+// Unlike os.IsNotExist, this also considers wrapped errors.
+func IsNotExist(err error) bool {
+ if os.IsNotExist(err) {
+ return true
+ }
+
+ // os.IsNotExist does not consider wrapped errors.
+ if os.IsNotExist(errors.Unwrap(err)) {
+ return true
+ }
+
+ return false
+}
diff --git a/common/herrors/errors_test.go b/common/herrors/errors_test.go
new file mode 100644
index 00000000000..1e07300284e
--- /dev/null
+++ b/common/herrors/errors_test.go
@@ -0,0 +1,36 @@
+// Copyright 2022 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 herrors
+
+import (
+ "fmt"
+ "testing"
+
+ qt "github.com/frankban/quicktest"
+ "github.com/spf13/afero"
+)
+
+func TestIsNotExist(t *testing.T) {
+ c := qt.New(t)
+
+ c.Assert(IsNotExist(afero.ErrFileNotFound), qt.Equals, true)
+ c.Assert(IsNotExist(afero.ErrFileExists), qt.Equals, false)
+ c.Assert(IsNotExist(afero.ErrDestinationExists), qt.Equals, false)
+ c.Assert(IsNotExist(nil), qt.Equals, false)
+
+ c.Assert(IsNotExist(fmt.Errorf("foo")), qt.Equals, false)
+
+ // os.IsNotExist returns false for wrapped errors.
+ c.Assert(IsNotExist(fmt.Errorf("foo: %w", afero.ErrFileNotFound)), qt.Equals, true)
+}
diff --git a/common/hreflect/helpers.go b/common/hreflect/helpers.go
index 1b7e5acf722..17afbf9127e 100644
--- a/common/hreflect/helpers.go
+++ b/common/hreflect/helpers.go
@@ -208,6 +208,23 @@ func AsTime(v reflect.Value, loc *time.Location) (time.Time, bool) {
return time.Time{}, false
}
+func CallMethodByName(cxt context.Context, name string, v reflect.Value) []reflect.Value {
+ fn := v.MethodByName(name)
+ var args []reflect.Value
+ tp := fn.Type()
+ if tp.NumIn() > 0 {
+ if tp.NumIn() > 1 {
+ panic("not supported")
+ }
+ first := tp.In(0)
+ if first.Implements(ContextInterface) {
+ args = append(args, reflect.ValueOf(cxt))
+ }
+ }
+
+ return fn.Call(args)
+}
+
// Based on: https://github.com/golang/go/blob/178a2c42254166cffed1b25fb1d3c7a5727cada6/src/text/template/exec.go#L931
func indirectInterface(v reflect.Value) reflect.Value {
if v.Kind() != reflect.Interface {
diff --git a/common/hugio/copy.go b/common/hugio/copy.go
index 7c52f872346..8dbadc48c50 100644
--- a/common/hugio/copy.go
+++ b/common/hugio/copy.go
@@ -16,8 +16,6 @@ package hugio
import (
"fmt"
"io"
- "io/ioutil"
- "os"
"path/filepath"
"github.com/spf13/afero"
@@ -53,7 +51,7 @@ func CopyFile(fs afero.Fs, from, to string) error {
// CopyDir copies a directory.
func CopyDir(fs afero.Fs, from, to string, shouldCopy func(filename string) bool) error {
- fi, err := os.Stat(from)
+ fi, err := fs.Stat(from)
if err != nil {
return err
}
@@ -67,7 +65,7 @@ func CopyDir(fs afero.Fs, from, to string, shouldCopy func(filename string) bool
return err
}
- entries, _ := ioutil.ReadDir(from)
+ entries, _ := afero.ReadDir(fs, from)
for _, entry := range entries {
fromFilename := filepath.Join(from, entry.Name())
toFilename := filepath.Join(to, entry.Name())
diff --git a/common/hugio/hasBytesWriter.go b/common/hugio/hasBytesWriter.go
new file mode 100644
index 00000000000..7b7d7a5d756
--- /dev/null
+++ b/common/hugio/hasBytesWriter.go
@@ -0,0 +1,57 @@
+// Copyright 2022 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 hugio
+
+import (
+ "bytes"
+)
+
+// HasBytesWriter is a writer that will set Match to true if the given pattern
+// is found in the stream.
+type HasBytesWriter struct {
+ Match bool
+ Pattern []byte
+
+ i int
+ done bool
+ buff []byte
+}
+
+func (h *HasBytesWriter) Write(p []byte) (n int, err error) {
+ if h.done {
+ return len(p), nil
+ }
+
+ if len(h.buff) == 0 {
+ h.buff = make([]byte, len(h.Pattern)*2)
+ }
+
+ for i := range p {
+ h.buff[h.i] = p[i]
+ h.i++
+ if h.i == len(h.buff) {
+ // Shift left.
+ copy(h.buff, h.buff[len(h.buff)/2:])
+ h.i = len(h.buff) / 2
+ }
+
+ if bytes.Contains(h.buff, h.Pattern) {
+ h.Match = true
+ h.done = true
+ return len(p), nil
+ }
+ }
+
+ return len(p), nil
+}
diff --git a/common/hugio/hasBytesWriter_test.go b/common/hugio/hasBytesWriter_test.go
new file mode 100644
index 00000000000..b1b8011d5db
--- /dev/null
+++ b/common/hugio/hasBytesWriter_test.go
@@ -0,0 +1,64 @@
+// Copyright 2022 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 hugio
+
+import (
+ "bytes"
+ "fmt"
+ "io"
+ "math/rand"
+ "strings"
+ "testing"
+ "time"
+
+ qt "github.com/frankban/quicktest"
+)
+
+func TestHasBytesWriter(t *testing.T) {
+ r := rand.New(rand.NewSource(time.Now().UnixNano()))
+
+ c := qt.New((t))
+
+ neww := func() (*HasBytesWriter, io.Writer) {
+ var b bytes.Buffer
+
+ h := &HasBytesWriter{
+ Pattern: []byte("__foo"),
+ }
+ return h, io.MultiWriter(&b, h)
+ }
+
+ rndStr := func() string {
+ return strings.Repeat("ab cfo", r.Intn(33))
+ }
+
+ for i := 0; i < 22; i++ {
+ h, w := neww()
+ fmt.Fprintf(w, rndStr()+"abc __foobar"+rndStr())
+ c.Assert(h.Match, qt.Equals, true)
+
+ h, w = neww()
+ fmt.Fprintf(w, rndStr()+"abc __f")
+ fmt.Fprintf(w, "oo bar"+rndStr())
+ c.Assert(h.Match, qt.Equals, true)
+
+ h, w = neww()
+ fmt.Fprintf(w, rndStr()+"abc __moo bar")
+ c.Assert(h.Match, qt.Equals, false)
+ }
+
+ h, w := neww()
+ fmt.Fprintf(w, "__foo")
+ c.Assert(h.Match, qt.Equals, true)
+}
diff --git a/common/hugio/writers.go b/common/hugio/writers.go
index d8be83a4043..729b2171573 100644
--- a/common/hugio/writers.go
+++ b/common/hugio/writers.go
@@ -15,7 +15,6 @@ package hugio
import (
"io"
- "io/ioutil"
)
// As implemented by strings.Builder.
@@ -34,7 +33,7 @@ type multiWriteCloser struct {
func (m multiWriteCloser) Close() error {
var err error
for _, c := range m.closers {
- if closeErr := c.Close(); err != nil {
+ if closeErr := c.Close(); closeErr != nil {
err = closeErr
}
}
@@ -63,7 +62,7 @@ func ToWriteCloser(w io.Writer) io.WriteCloser {
io.Closer
}{
w,
- ioutil.NopCloser(nil),
+ io.NopCloser(nil),
}
}
@@ -79,6 +78,6 @@ func ToReadCloser(r io.Reader) io.ReadCloser {
io.Closer
}{
r,
- ioutil.NopCloser(nil),
+ io.NopCloser(nil),
}
}
diff --git a/common/hugo/hugo.go b/common/hugo/hugo.go
index d78564a67db..efcb470a3c4 100644
--- a/common/hugo/hugo.go
+++ b/common/hugo/hugo.go
@@ -24,6 +24,8 @@ import (
"sync"
"time"
+ "github.com/bep/godartsass"
+ "github.com/gohugoio/hugo/common/hexec"
"github.com/gohugoio/hugo/hugofs/files"
"github.com/spf13/afero"
@@ -38,6 +40,8 @@ const (
)
var (
+ // buildDate allows vendor-specified build date when .git/ is unavailable.
+ buildDate string
// vendorInfo contains vendor notes about the current build.
vendorInfo string
)
@@ -66,7 +70,7 @@ func (i Info) Version() VersionString {
// Generator a Hugo meta generator HTML tag.
func (i Info) Generator() template.HTML {
- return template.HTML(fmt.Sprintf(``, CurrentVersion.String()))
+ return template.HTML(fmt.Sprintf(``, CurrentVersion.String()))
}
func (i Info) IsProduction() bool {
@@ -122,6 +126,8 @@ func GetExecEnviron(workDir string, cfg config.Provider, fs afero.Fs) []string {
config.SetEnvVars(&env, "HUGO_ENVIRONMENT", cfg.GetString("environment"))
config.SetEnvVars(&env, "HUGO_ENV", cfg.GetString("environment"))
+ config.SetEnvVars(&env, "HUGO_PUBLISHDIR", filepath.Join(workDir, cfg.GetString("publishDirOrig")))
+
if fs != nil {
fis, err := afero.ReadDir(fs, files.FolderJSConfig)
if err == nil {
@@ -182,24 +188,15 @@ func getBuildInfo() *buildInfo {
return bInfo
}
+func formatDep(path, version string) string {
+ return fmt.Sprintf("%s=%q", path, version)
+}
+
// GetDependencyList returns a sorted dependency list on the format package="version".
// It includes both Go dependencies and (a manually maintained) list of C(++) dependencies.
func GetDependencyList() []string {
var deps []string
- formatDep := func(path, version string) string {
- return fmt.Sprintf("%s=%q", path, version)
- }
-
- if IsExtended {
- deps = append(
- deps,
- // TODO(bep) consider adding a DepsNonGo() method to these upstream projects.
- formatDep("github.com/sass/libsass", "3.6.5"),
- formatDep("github.com/webmproject/libwebp", "v1.2.0"),
- )
- }
-
bi := getBuildInfo()
if bi == nil {
return deps
@@ -209,11 +206,36 @@ func GetDependencyList() []string {
deps = append(deps, formatDep(dep.Path, dep.Version))
}
+ deps = append(deps, GetDependencyListNonGo()...)
+
sort.Strings(deps)
return deps
}
+// GetDependencyListNonGo returns a list of non-Go dependencies.
+func GetDependencyListNonGo() []string {
+ var deps []string
+
+ if IsExtended {
+ deps = append(
+ deps,
+ formatDep("github.com/sass/libsass", "3.6.5"),
+ formatDep("github.com/webmproject/libwebp", "v1.2.4"),
+ )
+ }
+
+ if dartSass := dartSassVersion(); dartSass.ProtocolVersion != "" {
+ const dartSassPath = "github.com/sass/dart-sass-embedded"
+ deps = append(deps,
+ formatDep(dartSassPath+"/protocol", dartSass.ProtocolVersion),
+ formatDep(dartSassPath+"/compiler", dartSass.CompilerVersion),
+ formatDep(dartSassPath+"/implementation", dartSass.ImplementationVersion),
+ )
+ }
+ return deps
+}
+
// IsRunningAsTest reports whether we are running as a test.
func IsRunningAsTest() bool {
for _, arg := range os.Args {
@@ -247,3 +269,13 @@ type Dependency struct {
// Replaced by this dependency.
Replace *Dependency
}
+
+func dartSassVersion() godartsass.DartSassVersion {
+ // This is also duplicated in the dartsass package.
+ const dartSassEmbeddedBinaryName = "dart-sass-embedded"
+ if !hexec.InPath(dartSassEmbeddedBinaryName) {
+ return godartsass.DartSassVersion{}
+ }
+ v, _ := godartsass.Version(dartSassEmbeddedBinaryName)
+ return v
+}
diff --git a/common/hugo/version.go b/common/hugo/version.go
index edcb983d730..3bb6472e2fa 100644
--- a/common/hugo/version.go
+++ b/common/hugo/version.go
@@ -153,6 +153,10 @@ func BuildVersionString() string {
osArch := bi.GoOS + "/" + bi.GoArch
date := bi.RevisionTime
+ if date == "" {
+ // Accept vendor-specified build date if .git/ is unavailable.
+ date = buildDate
+ }
if date == "" {
date = "unknown"
}
diff --git a/common/hugo/version_current.go b/common/hugo/version_current.go
index e30e87bd75d..847939b8436 100644
--- a/common/hugo/version_current.go
+++ b/common/hugo/version_current.go
@@ -17,7 +17,7 @@ package hugo
// This should be the only one.
var CurrentVersion = Version{
Major: 0,
- Minor: 101,
- PatchLevel: 0,
+ Minor: 111,
+ PatchLevel: 2,
Suffix: "",
}
diff --git a/common/loggers/loggers.go b/common/loggers/loggers.go
index 308635fe9d4..2c331352a6b 100644
--- a/common/loggers/loggers.go
+++ b/common/loggers/loggers.go
@@ -17,7 +17,6 @@ import (
"bytes"
"fmt"
"io"
- "io/ioutil"
"log"
"os"
"regexp"
@@ -92,7 +91,7 @@ type logger struct {
*jww.Notepad
// The writer that represents stdout.
- // Will be ioutil.Discard when in quiet mode.
+ // Will be io.Discard when in quiet mode.
out io.Writer
logCounters *LogCounters
@@ -232,12 +231,12 @@ func NewErrorLogger() Logger {
// NewBasicLogger creates a new basic logger writing to Stdout.
func NewBasicLogger(t jww.Threshold) Logger {
- return newLogger(t, jww.LevelError, os.Stdout, ioutil.Discard, false)
+ return newLogger(t, jww.LevelError, os.Stdout, io.Discard, false)
}
// NewBasicLoggerForWriter creates a new basic logger writing to w.
func NewBasicLoggerForWriter(t jww.Threshold, w io.Writer) Logger {
- return newLogger(t, jww.LevelError, w, ioutil.Discard, false)
+ return newLogger(t, jww.LevelError, w, io.Discard, false)
}
// RemoveANSIColours removes all ANSI colours from the given string.
@@ -291,7 +290,7 @@ func InitGlobalLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, lo
func getLogWriters(outHandle, logHandle io.Writer) (io.Writer, io.Writer) {
isTerm := terminal.PrintANSIColors(os.Stdout)
- if logHandle != ioutil.Discard && isTerm {
+ if logHandle != io.Discard && isTerm {
// Remove any Ansi coloring from log output
logHandle = ansiCleaner{w: logHandle}
}
diff --git a/common/maps/scratch.go b/common/maps/scratch.go
index d4745d27c3b..e9f412540b2 100644
--- a/common/maps/scratch.go
+++ b/common/maps/scratch.go
@@ -30,6 +30,7 @@ type Scratch struct {
// Scratcher provides a scratching service.
type Scratcher interface {
+ // Scratch returns a "scratch pad" that can be used to store state.
Scratch() *Scratch
}
diff --git a/common/para/para.go b/common/para/para.go
index 69bfc205b8b..c323a3073a4 100644
--- a/common/para/para.go
+++ b/common/para/para.go
@@ -27,7 +27,7 @@ type Workers struct {
// Runner wraps the lifecycle methods of a new task set.
//
-// Run wil block until a worker is available or the context is cancelled,
+// Run will block until a worker is available or the context is cancelled,
// and then run the given func in a new goroutine.
// Wait will wait for all the running goroutines to finish.
type Runner interface {
diff --git a/common/paths/path.go b/common/paths/path.go
index 3a7f3e7908a..f1992f196cd 100644
--- a/common/paths/path.go
+++ b/common/paths/path.go
@@ -100,25 +100,25 @@ var isFileRe = regexp.MustCompile(`.*\..{1,6}$`)
// GetDottedRelativePath expects a relative path starting after the content directory.
// It returns a relative path with dots ("..") navigating up the path structure.
func GetDottedRelativePath(inPath string) string {
- inPath = filepath.Clean(filepath.FromSlash(inPath))
+ inPath = path.Clean(filepath.ToSlash(inPath))
if inPath == "." {
return "./"
}
- if !isFileRe.MatchString(inPath) && !strings.HasSuffix(inPath, FilePathSeparator) {
- inPath += FilePathSeparator
+ if !isFileRe.MatchString(inPath) && !strings.HasSuffix(inPath, "/") {
+ inPath += "/"
}
- if !strings.HasPrefix(inPath, FilePathSeparator) {
- inPath = FilePathSeparator + inPath
+ if !strings.HasPrefix(inPath, "/") {
+ inPath = "/" + inPath
}
dir, _ := filepath.Split(inPath)
- sectionCount := strings.Count(dir, FilePathSeparator)
+ sectionCount := strings.Count(dir, "/")
- if sectionCount == 0 || dir == FilePathSeparator {
+ if sectionCount == 0 || dir == "/" {
return "./"
}
@@ -263,3 +263,14 @@ func (n NamedSlice) String() string {
}
return fmt.Sprintf("%s%s{%s}", n.Name, FilePathSeparator, strings.Join(n.Slice, ","))
}
+
+// DirFile holds the result from path.Split.
+type DirFile struct {
+ Dir string
+ File string
+}
+
+// Used in test.
+func (df DirFile) String() string {
+ return fmt.Sprintf("%s|%s", df.Dir, df.File)
+}
diff --git a/common/text/position.go b/common/text/position.go
index cc1eda3540a..eb9de5624ef 100644
--- a/common/text/position.go
+++ b/common/text/position.go
@@ -24,6 +24,8 @@ import (
// Positioner represents a thing that knows its position in a text file or stream,
// typically an error.
type Positioner interface {
+ // Position returns the current position.
+ // Useful in error logging, e.g. {{ errorf "error in code block: %s" .Position }}.
Position() Position
}
diff --git a/common/types/css/csstypes.go b/common/types/css/csstypes.go
new file mode 100644
index 00000000000..a31df00e768
--- /dev/null
+++ b/common/types/css/csstypes.go
@@ -0,0 +1,20 @@
+// Copyright 2023 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 css
+
+// QuotedString is a string that needs to be quoted in CSS.
+type QuotedString string
+
+// UnquotedString is a string that does not need to be quoted in CSS.
+type UnquotedString string
diff --git a/compare/compare.go b/compare/compare.go
index de97690c7d4..67bb1c1256d 100644
--- a/compare/compare.go
+++ b/compare/compare.go
@@ -36,3 +36,19 @@ type ProbablyEqer interface {
type Comparer interface {
Compare(other any) int
}
+
+// Eq returns whether v1 is equal to v2.
+// It will use the Eqer interface if implemented, which
+// defines equals when two value are interchangeable
+// in the Hugo templates.
+func Eq(v1, v2 any) bool {
+ if v1 == nil || v2 == nil {
+ return v1 == v2
+ }
+
+ if eqer, ok := v1.(Eqer); ok {
+ return eqer.Eq(v2)
+ }
+
+ return v1 == v2
+}
diff --git a/config/commonConfig.go b/config/commonConfig.go
index efaa589d18e..31705841ef2 100644
--- a/config/commonConfig.go
+++ b/config/commonConfig.go
@@ -180,10 +180,15 @@ type Headers struct {
}
type Redirect struct {
- From string
- To string
+ From string
+ To string
+
+ // HTTP status code to use for the redirect.
+ // A status code of 200 will trigger a URL rewrite.
Status int
- Force bool
+
+ // Forcode redirect, even if original request path exists.
+ Force bool
}
func (r Redirect) IsZero() bool {
@@ -200,16 +205,31 @@ func DecodeServer(cfg Provider) (*Server, error) {
_ = mapstructure.WeakDecode(m, s)
for i, redir := range s.Redirects {
- // Get it in line with the Hugo server.
- redir.To = strings.TrimSuffix(redir.To, "index.html")
- if !strings.HasPrefix(redir.To, "https") && !strings.HasSuffix(redir.To, "/") {
- // There are some tricky infinite loop situations when dealing
- // when the target does not have a trailing slash.
- // This can certainly be handled better, but not time for that now.
- return nil, fmt.Errorf("unsupported redirect to value %q in server config; currently this must be either a remote destination or a local folder, e.g. \"/blog/\" or \"/blog/index.html\"", redir.To)
+ // Get it in line with the Hugo server for OK responses.
+ // We currently treat the 404 as a special case, they are always "ugly", so keep them as is.
+ if redir.Status != 404 {
+ redir.To = strings.TrimSuffix(redir.To, "index.html")
+ if !strings.HasPrefix(redir.To, "https") && !strings.HasSuffix(redir.To, "/") {
+ // There are some tricky infinite loop situations when dealing
+ // when the target does not have a trailing slash.
+ // This can certainly be handled better, but not time for that now.
+ return nil, fmt.Errorf("unsupported redirect to value %q in server config; currently this must be either a remote destination or a local folder, e.g. \"/blog/\" or \"/blog/index.html\"", redir.To)
+ }
}
s.Redirects[i] = redir
}
+ if len(s.Redirects) == 0 {
+ // Set up a default redirect for 404s.
+ s.Redirects = []Redirect{
+ {
+ From: "**",
+ To: "/404.html",
+ Status: 404,
+ },
+ }
+
+ }
+
return s, nil
}
diff --git a/config/configLoader.go b/config/configLoader.go
index 6722c12fd73..95594fc62d2 100644
--- a/config/configLoader.go
+++ b/config/configLoader.go
@@ -29,11 +29,22 @@ import (
)
var (
+ // See issue #8979 for context.
+ // Hugo has always used config.toml etc. as the default config file name.
+ // But hugo.toml is a more descriptive name, but we need to check for both.
+ DefaultConfigNames = []string{"hugo", "config"}
+
+ DefaultConfigNamesSet = make(map[string]bool)
+
ValidConfigFileExtensions = []string{"toml", "yaml", "yml", "json"}
validConfigFileExtensionsMap map[string]bool = make(map[string]bool)
)
func init() {
+ for _, name := range DefaultConfigNames {
+ DefaultConfigNamesSet[name] = true
+ }
+
for _, ext := range ValidConfigFileExtensions {
validConfigFileExtensionsMap[ext] = true
}
@@ -142,8 +153,7 @@ func LoadConfigFromDir(sourceFs afero.Fs, configDir, environment string) (Provid
}
var keyPath []string
-
- if name != "config" {
+ if !DefaultConfigNamesSet[name] {
// Can be params.jp, menus.en etc.
name, lang := paths.FileAndExtNoDelimiter(name)
diff --git a/config/security/securityConfig.go b/config/security/securityConfig.go
index b2748123099..4b0e0708606 100644
--- a/config/security/securityConfig.go
+++ b/config/security/securityConfig.go
@@ -42,10 +42,10 @@ var DefaultConfig = Config{
),
// These have been tested to work with Hugo's external programs
// on Windows, Linux and MacOS.
- OsEnv: NewWhitelist("(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$"),
+ OsEnv: NewWhitelist(`(?i)^((HTTPS?|NO)_PROXY|PATH(EXT)?|APPDATA|TE?MP|TERM|GO\w+)$`),
},
Funcs: Funcs{
- Getenv: NewWhitelist("^HUGO_"),
+ Getenv: NewWhitelist("^HUGO_", "^CI$"),
},
HTTP: HTTP{
URLs: NewWhitelist(".*"),
diff --git a/config/security/securityonfig_test.go b/config/security/securityConfig_test.go
similarity index 88%
rename from config/security/securityonfig_test.go
rename to config/security/securityConfig_test.go
index d0416a20df3..55409e318bf 100644
--- a/config/security/securityonfig_test.go
+++ b/config/security/securityConfig_test.go
@@ -140,7 +140,7 @@ func TestToTOML(t *testing.T) {
got := DefaultConfig.ToTOML()
c.Assert(got, qt.Equals,
- "[security]\n enableInlineShortcodes = false\n [security.exec]\n allow = ['^dart-sass-embedded$', '^go$', '^npx$', '^postcss$']\n osEnv = ['(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$']\n\n [security.funcs]\n getenv = ['^HUGO_']\n\n [security.http]\n methods = ['(?i)GET|POST']\n urls = ['.*']",
+ "[security]\n enableInlineShortcodes = false\n\n [security.exec]\n allow = ['^dart-sass-embedded$', '^go$', '^npx$', '^postcss$']\n osEnv = ['(?i)^((HTTPS?|NO)_PROXY|PATH(EXT)?|APPDATA|TE?MP|TERM|GO\\w+)$']\n\n [security.funcs]\n getenv = ['^HUGO_', '^CI$']\n\n [security.http]\n methods = ['(?i)GET|POST']\n urls = ['.*']",
)
}
@@ -163,4 +163,8 @@ func TestDecodeConfigDefault(t *testing.T) {
c.Assert(pc.HTTP.Methods.Accept("GET"), qt.IsTrue)
c.Assert(pc.HTTP.Methods.Accept("get"), qt.IsTrue)
c.Assert(pc.HTTP.Methods.Accept("DELETE"), qt.IsFalse)
+
+ c.Assert(pc.Exec.OsEnv.Accept("PATH"), qt.IsTrue)
+ c.Assert(pc.Exec.OsEnv.Accept("GOROOT"), qt.IsTrue)
+ c.Assert(pc.Exec.OsEnv.Accept("MYSECRET"), qt.IsFalse)
}
diff --git a/config/security/whitelist.go b/config/security/whitelist.go
index 0d2c187c6e5..ee1025d3bd8 100644
--- a/config/security/whitelist.go
+++ b/config/security/whitelist.go
@@ -33,6 +33,7 @@ type Whitelist struct {
patternsStrings []string
}
+// MarshalJSON is for internal use only.
func (w Whitelist) MarshalJSON() ([]byte, error) {
if w.acceptNone {
return json.Marshal(acceptNoneKeyword)
@@ -43,7 +44,7 @@ func (w Whitelist) MarshalJSON() ([]byte, error) {
// NewWhitelist creates a new Whitelist from zero or more patterns.
// An empty patterns list or a pattern with the value 'none' will create
-// a whitelist that will Accept noone.
+// a whitelist that will Accept none.
func NewWhitelist(patterns ...string) Whitelist {
if len(patterns) == 0 {
return Whitelist{acceptNone: true}
diff --git a/create/content.go b/create/content.go
index 5f05e25f9d9..f8629a77898 100644
--- a/create/content.go
+++ b/create/content.go
@@ -52,7 +52,7 @@ draft: true
// NewContent creates a new content file in h (or a full bundle if the archetype is a directory)
// in targetPath.
-func NewContent(h *hugolib.HugoSites, kind, targetPath string) error {
+func NewContent(h *hugolib.HugoSites, kind, targetPath string, force bool) error {
if h.BaseFs.Content.Dirs == nil {
return errors.New("no existing content directory configured for this project")
}
@@ -76,6 +76,7 @@ func NewContent(h *hugolib.HugoSites, kind, targetPath string) error {
kind: kind,
targetPath: targetPath,
+ force: force,
}
ext := paths.Ext(targetPath)
@@ -94,7 +95,7 @@ func NewContent(h *hugolib.HugoSites, kind, targetPath string) error {
}
if ext == "" {
- return "", fmt.Errorf("failed to resolve %q to a archetype template", targetPath)
+ return "", fmt.Errorf("failed to resolve %q to an archetype template", targetPath)
}
if !files.IsContentFile(b.targetPath) {
@@ -132,6 +133,7 @@ type contentBuilder struct {
kind string
isDir bool
dirMap archetypeMap
+ force bool
}
func (b *contentBuilder) buildDir() error {
@@ -145,7 +147,7 @@ func (b *contentBuilder) buildDir() error {
for _, fi := range b.dirMap.contentFiles {
targetFilename := filepath.Join(b.targetPath, strings.TrimPrefix(fi.Meta().Path, b.archetypeFilename))
- abs, err := b.cf.CreateContentPlaceHolder(targetFilename)
+ abs, err := b.cf.CreateContentPlaceHolder(targetFilename, b.force)
if err != nil {
return err
}
@@ -218,7 +220,7 @@ func (b *contentBuilder) buildDir() error {
}
func (b *contentBuilder) buildFile() (string, error) {
- contentPlaceholderAbsFilename, err := b.cf.CreateContentPlaceHolder(b.targetPath)
+ contentPlaceholderAbsFilename, err := b.cf.CreateContentPlaceHolder(b.targetPath, b.force)
if err != nil {
return "", err
}
diff --git a/create/content_test.go b/create/content_test.go
index 80a66609367..fdfee6e68c4 100644
--- a/create/content_test.go
+++ b/create/content_test.go
@@ -82,7 +82,7 @@ func TestNewContentFromFile(t *testing.T) {
cfg, fs := newTestCfg(c, mm)
h, err := hugolib.NewHugoSites(deps.DepsCfg{Cfg: cfg, Fs: fs})
c.Assert(err, qt.IsNil)
- err = create.NewContent(h, cas.kind, cas.path)
+ err = create.NewContent(h, cas.kind, cas.path, false)
if b, ok := cas.expected.(bool); ok && !b {
if !b {
@@ -145,7 +145,7 @@ i18n: {{ T "hugo" }}
c.Assert(err, qt.IsNil)
c.Assert(len(h.Sites), qt.Equals, 2)
- c.Assert(create.NewContent(h, "my-bundle", "post/my-post"), qt.IsNil)
+ c.Assert(create.NewContent(h, "my-bundle", "post/my-post", false), qt.IsNil)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-post/resources/hugo1.json")), `hugo1: {{ printf "no template handling in here" }}`)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-post/resources/hugo2.xml")), `hugo2: {{ printf "no template handling in here" }}`)
@@ -157,7 +157,7 @@ i18n: {{ T "hugo" }}
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-post/pages/bio.md")), `File: bio.md`, `Site Lang: en`, `Name: Bio`)
- c.Assert(create.NewContent(h, "my-theme-bundle", "post/my-theme-post"), qt.IsNil)
+ c.Assert(create.NewContent(h, "my-theme-bundle", "post/my-theme-post", false), qt.IsNil)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-theme-post/index.md")), `File: index.md`, `Site Lang: en`, `Name: My Theme Post`, `i18n: Hugo Rocks!`)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-theme-post/resources/hugo1.json")), `hugo1: {{ printf "no template handling in here" }}`)
}
@@ -187,19 +187,19 @@ site RegularPages: {{ len site.RegularPages }}
c.Assert(err, qt.IsNil)
c.Assert(len(h.Sites), qt.Equals, 2)
- c.Assert(create.NewContent(h, "my-bundle", "post/my-post"), qt.IsNil)
+ c.Assert(create.NewContent(h, "my-bundle", "post/my-post", false), qt.IsNil)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-post/index.md")), `site RegularPages: 10`)
// Default bundle archetype
- c.Assert(create.NewContent(h, "", "post/my-post2"), qt.IsNil)
+ c.Assert(create.NewContent(h, "", "post/my-post2", false), qt.IsNil)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-post2/index.md")), `default archetype index.md`)
// Regular file with bundle kind.
- c.Assert(create.NewContent(h, "my-bundle", "post/foo.md"), qt.IsNil)
+ c.Assert(create.NewContent(h, "my-bundle", "post/foo.md", false), qt.IsNil)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/foo.md")), `draft: true`)
// Regular files should fall back to the default archetype (we have no regular file archetype).
- c.Assert(create.NewContent(h, "my-bundle", "mypage.md"), qt.IsNil)
+ c.Assert(create.NewContent(h, "my-bundle", "mypage.md", false), qt.IsNil)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "mypage.md")), `draft: true`)
}
@@ -237,7 +237,7 @@ i18n: {{ T "hugo" }}
c.Assert(err, qt.IsNil)
c.Assert(len(h.Sites), qt.Equals, 2)
- c.Assert(create.NewContent(h, "my-bundle", "post/my-post"), qt.IsNil)
+ c.Assert(create.NewContent(h, "my-bundle", "post/my-post", false), qt.IsNil)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-post/resources/hugo1.json")), `hugo1: {{ printf "no template handling in here" }}`)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-post/resources/hugo2.xml")), `hugo2: {{ printf "no template handling in here" }}`)
@@ -247,11 +247,38 @@ i18n: {{ T "hugo" }}
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-post/pages/bio.md")), `File: bio.md`, `Name: Bio`)
- c.Assert(create.NewContent(h, "my-theme-bundle", "post/my-theme-post"), qt.IsNil)
+ c.Assert(create.NewContent(h, "my-theme-bundle", "post/my-theme-post", false), qt.IsNil)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-theme-post/index.md")), `File: index.md`, `Name: My Theme Post`, `i18n: Hugo Rocks!`)
cContains(c, readFileFromFs(t, fs.Source, filepath.Join("content", "post/my-theme-post/resources/hugo1.json")), `hugo1: {{ printf "no template handling in here" }}`)
}
+func TestNewContentForce(t *testing.T) {
+ mm := afero.NewMemMapFs()
+ c := qt.New(t)
+
+ archetypeDir := filepath.Join("archetypes", "my-bundle")
+ c.Assert(mm.MkdirAll(archetypeDir, 0o755), qt.IsNil)
+ c.Assert(afero.WriteFile(mm, filepath.Join(archetypeDir, "index.md"), []byte(""), 0o755), qt.IsNil)
+ c.Assert(afero.WriteFile(mm, filepath.Join(archetypeDir, "index.nn.md"), []byte(""), 0o755), qt.IsNil)
+
+ c.Assert(initFs(mm), qt.IsNil)
+ cfg, fs := newTestCfg(c, mm)
+
+ h, err := hugolib.NewHugoSites(deps.DepsCfg{Cfg: cfg, Fs: fs})
+ c.Assert(err, qt.IsNil)
+ c.Assert(len(h.Sites), qt.Equals, 2)
+
+ // from file
+ c.Assert(create.NewContent(h, "post", "post/my-post.md", false), qt.IsNil)
+ c.Assert(create.NewContent(h, "post", "post/my-post.md", false), qt.IsNotNil)
+ c.Assert(create.NewContent(h, "post", "post/my-post.md", true), qt.IsNil)
+
+ // from dir
+ c.Assert(create.NewContent(h, "my-bundle", "post/my-post", false), qt.IsNil)
+ c.Assert(create.NewContent(h, "my-bundle", "post/my-post", false), qt.IsNotNil)
+ c.Assert(create.NewContent(h, "my-bundle", "post/my-post", true), qt.IsNil)
+}
+
func initFs(fs afero.Fs) error {
perm := os.FileMode(0o755)
var err error
diff --git a/deploy/deploy.go b/deploy/deploy.go
index f0a4e017837..5675d7aa04f 100644
--- a/deploy/deploy.go
+++ b/deploy/deploy.go
@@ -24,7 +24,6 @@ import (
"encoding/hex"
"fmt"
"io"
- "io/ioutil"
"mime"
"os"
"path/filepath"
@@ -403,7 +402,7 @@ func (lf *localFile) Reader() (io.ReadCloser, error) {
// We've got the gzipped contents cached in gzipped.
// Note: we can't use lf.gzipped directly as a Reader, since we it discards
// data after it is read, and we may read it more than once.
- return ioutil.NopCloser(bytes.NewReader(lf.gzipped.Bytes())), nil
+ return io.NopCloser(bytes.NewReader(lf.gzipped.Bytes())), nil
}
// Not expected to fail since we did it successfully earlier in newLocalFile,
// but could happen due to changes in the underlying filesystem.
diff --git a/deploy/deploy_test.go b/deploy/deploy_test.go
index a92649b7420..5c436abf27e 100644
--- a/deploy/deploy_test.go
+++ b/deploy/deploy_test.go
@@ -23,7 +23,6 @@ import (
"crypto/md5"
"fmt"
"io"
- "io/ioutil"
"os"
"path"
"path/filepath"
@@ -407,7 +406,7 @@ func TestLocalFile(t *testing.T) {
if err != nil {
t.Fatal(err)
}
- gotContent, err := ioutil.ReadAll(r)
+ gotContent, err := io.ReadAll(r)
if err != nil {
t.Fatal(err)
}
@@ -420,7 +419,7 @@ func TestLocalFile(t *testing.T) {
if err != nil {
t.Fatal(err)
}
- gotContent, err = ioutil.ReadAll(r)
+ gotContent, err = io.ReadAll(r)
if err != nil {
t.Fatal(err)
}
@@ -520,47 +519,35 @@ type fsTest struct {
// 1. An in-memory afero.Fs paired with an in-memory Go CDK bucket.
// 2. A filesystem-based afero.Fs paired with an filesystem-based Go CDK bucket.
// It returns the pair of tests and a cleanup function.
-func initFsTests() ([]*fsTest, func(), error) {
- tmpfsdir, err := ioutil.TempDir("", "fs")
- if err != nil {
- return nil, nil, err
- }
- tmpbucketdir, err := ioutil.TempDir("", "bucket")
- if err != nil {
- return nil, nil, err
- }
+func initFsTests(t *testing.T) []*fsTest {
+ t.Helper()
+
+ tmpfsdir := t.TempDir()
+ tmpbucketdir := t.TempDir()
memfs := afero.NewMemMapFs()
membucket := memblob.OpenBucket(nil)
+ t.Cleanup(func() { membucket.Close() })
filefs := afero.NewBasePathFs(afero.NewOsFs(), tmpfsdir)
filebucket, err := fileblob.OpenBucket(tmpbucketdir, nil)
if err != nil {
- return nil, nil, err
+ t.Fatal(err)
}
+ t.Cleanup(func() { filebucket.Close() })
tests := []*fsTest{
{"mem", memfs, membucket},
{"file", filefs, filebucket},
}
- cleanup := func() {
- membucket.Close()
- filebucket.Close()
- os.RemoveAll(tmpfsdir)
- os.RemoveAll(tmpbucketdir)
- }
- return tests, cleanup, nil
+ return tests
}
// TestEndToEndSync verifies that basic adds, updates, and deletes are working
// correctly.
func TestEndToEndSync(t *testing.T) {
ctx := context.Background()
- tests, cleanup, err := initFsTests()
- if err != nil {
- t.Fatal(err)
- }
- defer cleanup()
+ tests := initFsTests(t)
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
local, err := initLocalFs(ctx, test.fs)
@@ -643,11 +630,7 @@ func TestEndToEndSync(t *testing.T) {
// TestMaxDeletes verifies that the "maxDeletes" flag is working correctly.
func TestMaxDeletes(t *testing.T) {
ctx := context.Background()
- tests, cleanup, err := initFsTests()
- if err != nil {
- t.Fatal(err)
- }
- defer cleanup()
+ tests := initFsTests(t)
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
local, err := initLocalFs(ctx, test.fs)
@@ -772,14 +755,10 @@ func TestIncludeExclude(t *testing.T) {
}
for _, test := range tests {
t.Run(fmt.Sprintf("include %q exclude %q", test.Include, test.Exclude), func(t *testing.T) {
- fsTests, cleanup, err := initFsTests()
- if err != nil {
- t.Fatal(err)
- }
- defer cleanup()
+ fsTests := initFsTests(t)
fsTest := fsTests[1] // just do file-based test
- _, err = initLocalFs(ctx, fsTest.fs)
+ _, err := initLocalFs(ctx, fsTest.fs)
if err != nil {
t.Fatal(err)
}
@@ -841,11 +820,7 @@ func TestIncludeExcludeRemoteDelete(t *testing.T) {
}
for _, test := range tests {
t.Run(fmt.Sprintf("include %q exclude %q", test.Include, test.Exclude), func(t *testing.T) {
- fsTests, cleanup, err := initFsTests()
- if err != nil {
- t.Fatal(err)
- }
- defer cleanup()
+ fsTests := initFsTests(t)
fsTest := fsTests[1] // just do file-based test
local, err := initLocalFs(ctx, fsTest.fs)
@@ -897,11 +872,7 @@ func TestIncludeExcludeRemoteDelete(t *testing.T) {
func TestCompression(t *testing.T) {
ctx := context.Background()
- tests, cleanup, err := initFsTests()
- if err != nil {
- t.Fatal(err)
- }
- defer cleanup()
+ tests := initFsTests(t)
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
local, err := initLocalFs(ctx, test.fs)
@@ -956,11 +927,7 @@ func TestCompression(t *testing.T) {
// attribute for matcher works.
func TestMatching(t *testing.T) {
ctx := context.Background()
- tests, cleanup, err := initFsTests()
- if err != nil {
- t.Fatal(err)
- }
- defer cleanup()
+ tests := initFsTests(t)
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
_, err := initLocalFs(ctx, test.fs)
diff --git a/deps/deps.go b/deps/deps.go
index ece4203024f..7b252d020c0 100644
--- a/deps/deps.go
+++ b/deps/deps.go
@@ -1,7 +1,10 @@
package deps
import (
+ "context"
"fmt"
+ "path/filepath"
+ "strings"
"sync"
"sync/atomic"
"time"
@@ -9,6 +12,7 @@ import (
"github.com/gohugoio/hugo/cache/filecache"
"github.com/gohugoio/hugo/common/hexec"
"github.com/gohugoio/hugo/common/loggers"
+ "github.com/gohugoio/hugo/common/types"
"github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/config/security"
"github.com/gohugoio/hugo/helpers"
@@ -16,6 +20,7 @@ import (
"github.com/gohugoio/hugo/langs"
"github.com/gohugoio/hugo/media"
"github.com/gohugoio/hugo/resources/page"
+ "github.com/gohugoio/hugo/resources/postpub"
"github.com/gohugoio/hugo/metrics"
"github.com/gohugoio/hugo/output"
@@ -67,7 +72,7 @@ type Deps struct {
FileCaches filecache.Caches
// The translation func to use
- Translate func(translationID string, templateData any) string `json:"-"`
+ Translate func(ctx context.Context, translationID string, templateData any) string `json:"-"`
// The language in use. TODO(bep) consolidate with site
Language *langs.Language
@@ -78,6 +83,10 @@ type Deps struct {
// All the output formats available for the current site.
OutputFormatsConfig output.Formats
+ // FilenameHasPostProcessPrefix is a set of filenames in /public that
+ // contains a post-processing prefix.
+ FilenameHasPostProcessPrefix []string
+
templateProvider ResourceProvider
WithTemplate func(templ tpl.TemplateManager) error `json:"-"`
@@ -202,6 +211,7 @@ func New(cfg DepsCfg) (*Deps, error) {
var (
logger = cfg.Logger
fs = cfg.Fs
+ d *Deps
)
if cfg.TemplateProvider == nil {
@@ -239,6 +249,32 @@ func New(cfg DepsCfg) (*Deps, error) {
}
execHelper := hexec.New(securityConfig)
+ var filenameHasPostProcessPrefixMu sync.Mutex
+ hashBytesReceiverFunc := func(name string, match bool) {
+ if !match {
+ return
+ }
+ filenameHasPostProcessPrefixMu.Lock()
+ d.FilenameHasPostProcessPrefix = append(d.FilenameHasPostProcessPrefix, name)
+ filenameHasPostProcessPrefixMu.Unlock()
+ }
+
+ // Skip binary files.
+ hashBytesSHouldCheck := func(name string) bool {
+ ext := strings.TrimPrefix(filepath.Ext(name), ".")
+ mime, _, found := cfg.MediaTypes.GetBySuffix(ext)
+ if !found {
+ return false
+ }
+ switch mime.MainType {
+ case "text", "application":
+ return true
+ default:
+ return false
+ }
+ }
+ fs.PublishDir = hugofs.NewHasBytesReceiver(fs.PublishDir, hashBytesSHouldCheck, hashBytesReceiverFunc, []byte(postpub.PostProcessPrefix))
+
ps, err := helpers.NewPathSpec(fs, cfg.Language, logger)
if err != nil {
return nil, fmt.Errorf("create PathSpec: %w", err)
@@ -264,17 +300,20 @@ func New(cfg DepsCfg) (*Deps, error) {
sp := source.NewSourceSpec(ps, nil, fs.Source)
- timeoutms := cfg.Language.GetInt("timeout")
- if timeoutms <= 0 {
- timeoutms = 3000
+ timeout := 30 * time.Second
+ if cfg.Cfg.IsSet("timeout") {
+ v := cfg.Cfg.Get("timeout")
+ d, err := types.ToDurationE(v)
+ if err == nil {
+ timeout = d
+ }
}
-
ignoreErrors := cast.ToStringSlice(cfg.Cfg.Get("ignoreErrors"))
ignorableLogger := loggers.NewIgnorableLogger(logger, ignoreErrors...)
logDistinct := helpers.NewDistinctLogger(logger)
- d := &Deps{
+ d = &Deps{
Fs: fs,
Log: ignorableLogger,
LogDistinct: logDistinct,
@@ -295,7 +334,7 @@ func New(cfg DepsCfg) (*Deps, error) {
BuildClosers: &Closers{},
BuildState: buildState,
Running: cfg.Running,
- Timeout: time.Duration(timeoutms) * time.Millisecond,
+ Timeout: timeout,
globalErrHandler: errorHandler,
}
diff --git a/docs/.cspell.json b/docs/.cspell.json
index 1a197ea7b30..0958b76450a 100644
--- a/docs/.cspell.json
+++ b/docs/.cspell.json
@@ -34,6 +34,7 @@
"brlink",
"Brotli",
"Browsersync",
+ "canonicalization",
"canonify",
"Catmull",
"Catwoman",
@@ -61,6 +62,8 @@
"datatable",
"DATOCMS",
"debugconfig",
+ "defang",
+ "Deindent",
"DELIM",
"dhersam",
"digitalcraftsman",
@@ -72,17 +75,21 @@
"DRING",
"Eiqc",
"Eliott",
+ "embeddable",
"Emojify",
"Enwrite",
"eopkg",
"eparis",
"errorf",
"erroridf",
+ "esbuild",
"Evernote",
+ "Exif",
"exitwp",
"expirydate",
"Feminella",
"firstpost",
+ "Flickr",
"Formspree",
"fpath",
"Francia",
@@ -91,10 +98,12 @@
"funcs",
"funcsig",
"Garen",
+ "Garuda",
"gcloud",
"Getenv",
"getjson",
"getpage",
+ "Gitee",
"Gmfc",
"Goel",
"Gohugo",
@@ -106,6 +115,7 @@
"govendor",
"Gowans",
"Grayscale",
+ "Gregor",
"Gruber",
"gtag",
"gvfs",
@@ -141,10 +151,12 @@
"Joomla",
"JRBR",
"jsonify",
+ "Karmada",
"katex",
"keycdn",
"KEYVALS",
"kubernetes",
+ "Kubuntu",
"Lanczos",
"langformatnumber",
"lastmod",
@@ -152,6 +164,7 @@
"linktitle",
"Lipi",
"lrwxr",
+ "Lubuntu",
"maingo",
"markdownified",
"markdownify",
@@ -188,6 +201,7 @@
"newparam",
"Nichlas",
"Nikhil",
+ "Nikola",
"Njjy",
"nlist",
"nobr",
@@ -221,6 +235,7 @@
"Poupin",
"prerender",
"println",
+ "Pritchard",
"publishdate",
"Pygments",
"qref",
@@ -249,6 +264,7 @@
"safejs",
"Samsa",
"schemaorg",
+ "setx",
"Shekhar",
"Shortcode",
"Shortcodes",
@@ -257,7 +273,9 @@
"Sindre",
"sitemapindex",
"sitemapxml",
+ "slugorfilename",
"Smartcrop",
+ "Sobre",
"Sprintf",
"Startseite",
"strconv",
@@ -278,6 +296,7 @@
"Tknx",
"TLDR",
"TMPDIR",
+ "toclevels",
"TOCSS",
"todos",
"tojson",
@@ -288,6 +307,8 @@
"toyaml",
"twitteruser",
"Unmarshal",
+ "unpublishdate",
+ "Unsharp",
"urlize",
"urlset",
"utimestamp",
@@ -301,15 +322,19 @@
"wibble",
"wordcount",
"workson",
+ "Wowchemy",
"wpxr",
"Xbaabbab",
+ "Xubuntu",
"xvzf",
"yoyoyo",
+ "yunbox",
"Zgotmpl",
+ "Zorin",
"zzbbaabb",
"مدونتي"
],
- "language": "en,en-GB,en-US,de,fr",
+ "language": "en,en-US,de,fr",
"allowCompoundWords": true,
"files": [
"**/*.md"
@@ -331,5 +356,6 @@
"**/news/*",
"**/showcase/*"
],
- "useGitignore": true
+ "useGitignore": true,
+ "enabled": true
}
diff --git a/docs/.github/stale.yml b/docs/.github/stale.yml
index 38920529407..1e72eb329c0 100644
--- a/docs/.github/stale.yml
+++ b/docs/.github/stale.yml
@@ -17,6 +17,6 @@ markComment: >
If you still think this is important, please tell us why.
This issue will automatically be closed in the near future if no further activity occurs. Thank you for all your contributions.
-
+
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: false
diff --git a/docs/.github/workflows/codeql-analysis.yml b/docs/.github/workflows/codeql-analysis.yml
new file mode 100644
index 00000000000..30f98a000b4
--- /dev/null
+++ b/docs/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,26 @@
+name: "CodeQL"
+
+on:
+ schedule:
+ - cron: "0 0 1 * *"
+
+jobs:
+ analyze:
+ name: Analyze
+ runs-on: ubuntu-latest
+ permissions:
+ actions: read
+ contents: read
+ security-events: write
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v3
+
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v2
+ with:
+ languages: "javascript"
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v2
diff --git a/docs/.github/workflows/spellcheck.yml b/docs/.github/workflows/spellcheck.yml
index 0129bbb278b..59462160400 100644
--- a/docs/.github/workflows/spellcheck.yml
+++ b/docs/.github/workflows/spellcheck.yml
@@ -1,17 +1,21 @@
-name: 'Check spelling'
+name: "Check spelling"
on: # rebuild any PRs and main branch changes
push:
branches-ignore:
- "dependabot/**"
pull_request:
+permissions:
+ contents: read
+
jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
- - uses: streetsidesoftware/cspell-action@3bc52c39528d0214a947ff7f8b5c23ad3273435b
+ - uses: actions/checkout@v3
+ - uses: streetsidesoftware/cspell-action@v2
with:
+ check_dot_files: false
+ incremental_files_only: true
inline: warning
strict: false
- incremental_files_only: true
diff --git a/docs/.github/workflows/super-linter.yml b/docs/.github/workflows/super-linter.yml
new file mode 100644
index 00000000000..efd20696096
--- /dev/null
+++ b/docs/.github/workflows/super-linter.yml
@@ -0,0 +1,41 @@
+name: Super Linter
+
+on:
+ workflow_dispatch:
+
+permissions:
+ contents: read # to fetch code (actions/checkout)
+
+jobs:
+ build:
+ permissions:
+ contents: read # to fetch code (actions/checkout)
+ statuses: write # to mark status of each linter run (github/super-linter/slim)
+
+ name: Lint Code Base
+ runs-on: ubuntu-latest
+ if: ${{ github.actor != 'dependabot[bot]' }}
+
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v3
+
+ - name: Lint Code Base
+ uses: github/super-linter/slim@v4
+ env:
+ DEFAULT_BRANCH: master
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ IGNORE_GITIGNORED_FILES: true
+ LINTER_RULES_PATH: /
+ LOG_LEVEL: NOTICE
+ MARKDOWN_CONFIG_FILE: .markdownlint.yaml
+ SUPPRESS_POSSUM: true
+ VALIDATE_CSS: false
+ VALIDATE_EDITORCONFIG: false
+ VALIDATE_GITLEAKS: false
+ VALIDATE_HTML: false
+ VALIDATE_JAVASCRIPT_STANDARD: false
+ VALIDATE_JSCPD: false
+ VALIDATE_NATURAL_LANGUAGE: false
+ VALIDATE_SHELL_SHFMT: false
+ VALIDATE_XML: false
diff --git a/docs/.gitignore b/docs/.gitignore
index 4164d21f8d1..f9cab2f8016 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1,6 +1,7 @@
/.idea
/.vscode
/public
+/dist
node_modules
nohup.out
.DS_Store
diff --git a/docs/.markdownlint.yaml b/docs/.markdownlint.yaml
index 1b76d280eca..58f84dc67a3 100644
--- a/docs/.markdownlint.yaml
+++ b/docs/.markdownlint.yaml
@@ -1,4 +1,24 @@
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
-MD013: false # Line length
-MD033: false # Inline HTML
+MD002: false
+MD003: false
+MD004: false
+MD007: false
+MD012:
+ maximum: 2
+MD013: false
+MD014: false
+MD022: false
+MD024: false
+MD031: false
+MD032: false
+MD033: false
+MD034: false
+MD036: false
+MD037: false
+MD038: false
+MD041: false
+MD046: false
+MD049: false
+MD050: false
+MD053: false
diff --git a/docs/.markdownlintignore b/docs/.markdownlintignore
new file mode 100644
index 00000000000..4ac45b3953a
--- /dev/null
+++ b/docs/.markdownlintignore
@@ -0,0 +1,6 @@
+**/commands/**
+**/functions/**
+**/news/**
+**/showcase/**
+**/zh/**
+**/license.md
diff --git a/docs/.textlintignore b/docs/.textlintignore
new file mode 100644
index 00000000000..97a18e37c1d
--- /dev/null
+++ b/docs/.textlintignore
@@ -0,0 +1,3 @@
+**/news/**
+**/showcase/**
+**/zh/**
\ No newline at end of file
diff --git a/docs/.vscode/extensions.json b/docs/.vscode/extensions.json
index 4ca64b165e6..76c6afe3f66 100644
--- a/docs/.vscode/extensions.json
+++ b/docs/.vscode/extensions.json
@@ -1,6 +1,7 @@
{
"recommendations": [
+ "DavidAnson.vscode-markdownlint",
"EditorConfig.EditorConfig",
- "esbenp.prettier-vscode",
+ "streetsidesoftware.code-spell-checker"
]
}
diff --git a/docs/README.md b/docs/README.md
index a2c767b7b21..730ad5fc81b 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -7,11 +7,11 @@ Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast a
## Contributing
-We welcome contributions to Hugo of any kind including documentation, suggestions, bug reports, pull requests etc. Also check out our [contribution guide](https://gohugo.io/contribute/documentation/). We would love to hear from you.
+We welcome contributions to Hugo of any kind including documentation, suggestions, bug reports, pull requests etc. Also check out our [contribution guide](https://gohugo.io/contribute/documentation/). We would love to hear from you.
-Note that this repository contains solely the documentation for Hugo. For contributions that aren't documentation-related please refer to the [hugo](https://github.com/gohugoio/hugo) repository.
+Note that this repository contains solely the documentation for Hugo. For contributions that aren't documentation-related please refer to the [hugo](https://github.com/gohugoio/hugo) repository.
-*Pull requests shall **only** contain changes to the actual documentation. However, changes on the code base of Hugo **and** the documentation shall be a single, atomic pull request in the [hugo](https://github.com/gohugoio/hugo) repository.*
+*Pull requests shall **only** contain changes to the actual documentation. However, changes on the codebase of Hugo **and** the documentation shall be a single, atomic pull request in the [hugo](https://github.com/gohugoio/hugo) repository.*
Spelling fixes are most welcomed, and if you want to contribute longer sections to the documentation, it would be great if you had the following criteria in mind when writing:
@@ -19,6 +19,15 @@ Spelling fixes are most welcomed, and if you want to contribute longer sections
* For example, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great. Don't list long and similar examples just so people can use them on their sites.
* Hugo has users from all over the world, so easy to understand and [simple English](https://simple.wikipedia.org/wiki/Basic_English) is good.
+
+## Edit the theme
+
+If you want to do docs-related theme changes, the simplest way is to have both `hugoDocs` and `gohugoioTheme` cloned as sibling directories, and then run:
+
+```
+HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"
+```
+
## Branches
* The `master` branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_code.css b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_code.css
index 66a2fc24693..c82e77ee776 100644
--- a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_code.css
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_code.css
@@ -54,7 +54,7 @@ pre {
}
@media (--breakpoint-large) {
- .full-width, pre.expand:hover
+ .full-width
{
/*width: 100vw;
position: relative;
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_font-family.css b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_font-family.css
index 9b451cf1ca9..440b5efdd79 100644
--- a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_font-family.css
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_font-family.css
@@ -1,4 +1,4 @@
-/* From http://cssfontstack.com */
+/* From https://www.cssfontstack.com */
code, .code, pre code, .highlight pre {
font-family: 'inconsolata',Menlo,Monaco,'Courier New',monospace;
}
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_hljs.css b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_hljs.css
deleted file mode 100644
index c4910765529..00000000000
--- a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/css/_hljs.css
+++ /dev/null
@@ -1,11 +0,0 @@
-/* modified from:*/
-@import 'highlight.js/styles/atom-one-light.css';
-
-/* hljs-template-variable covers the handlebars templating*/
-.hljs-template-variable {
- color: var(--primary-color);
-}
-
-.hljs-attr {
- color: var(--accent-color-light);
-}
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/bep-consulting.svg b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/bep-consulting.svg
new file mode 100644
index 00000000000..5b1170f9b1a
--- /dev/null
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/bep-consulting.svg
@@ -0,0 +1,3 @@
+
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/butter-dark.svg b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/butter-dark.svg
new file mode 100644
index 00000000000..657b75c5033
--- /dev/null
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/butter-dark.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/butter-light.svg b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/butter-light.svg
new file mode 100644
index 00000000000..a0697df083d
--- /dev/null
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/butter-light.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/static/images/sponsors/esolia-logo.svg b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/esolia-logo.svg
similarity index 100%
rename from docs/_vendor/github.com/gohugoio/gohugoioTheme/static/images/sponsors/esolia-logo.svg
rename to docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/esolia-logo.svg
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/graitykit-dark.svg b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/graitykit-dark.svg
new file mode 100644
index 00000000000..fd7d12f5cf9
--- /dev/null
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/graitykit-dark.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/linode-logo.svg b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/linode-logo.svg
new file mode 100644
index 00000000000..7060e856f00
--- /dev/null
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/linode-logo.svg
@@ -0,0 +1 @@
+
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/static/images/sponsors/linode-logo_standard_light_medium.png b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/linode-logo_standard_light_medium.png
similarity index 100%
rename from docs/_vendor/github.com/gohugoio/gohugoioTheme/static/images/sponsors/linode-logo_standard_light_medium.png
rename to docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/linode-logo_standard_light_medium.png
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/your-company-dark.svg b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/your-company-dark.svg
new file mode 100644
index 00000000000..1793cb6446a
--- /dev/null
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/your-company-dark.svg
@@ -0,0 +1,4 @@
+
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/your-company.svg b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/your-company.svg
new file mode 100644
index 00000000000..6f3082b548a
--- /dev/null
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/images/sponsors/your-company.svg
@@ -0,0 +1,4 @@
+
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/index.js b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/index.js
index e309bdb99ce..c89af041bee 100644
--- a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/index.js
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/index.js
@@ -1,12 +1,10 @@
-require("typeface-muli")
+require('typeface-muli');
import styles from './css/main.css';
-import './js/clipboardjs.js'
-import './js/codeblocks.js'
-import './js/docsearch.js'
-import './js/hljs.js'
-import './js/lazysizes.js'
-import './js/menutoggle.js'
-import './js/scrolldir.js'
-import './js/smoothscroll.js'
-import './js/tabs.js'
-import './js/nojs.js'
+import './js/clipboardjs.js';
+import './js/docsearch.js';
+import './js/lazysizes.js';
+import './js/menutoggle.js';
+import './js/scrolldir.js';
+import './js/smoothscroll.js';
+import './js/tabs.js';
+import './js/nojs.js';
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/codeblocks.js b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/codeblocks.js
deleted file mode 100644
index d8039c5d6f5..00000000000
--- a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/codeblocks.js
+++ /dev/null
@@ -1,10 +0,0 @@
-let article = document.getElementById('prose')
-
-if (article) {
- let codeBlocks = article.getElementsByTagName('code')
- for (let [key, codeBlock] of Object.entries(codeBlocks)){
- var widthDif = codeBlock.scrollWidth - codeBlock.clientWidth
- if (widthDif > 0)
- codeBlock.parentNode.classList.add('expand')
- }
-}
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/docsearch.js b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/docsearch.js
index 0074da8cd7f..e14fb299490 100644
--- a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/docsearch.js
+++ b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/docsearch.js
@@ -1,7 +1,8 @@
var docsearch = require('docsearch.js/dist/cdn/docsearch.js');
docsearch({
- apiKey: '167e7998590aebda7f9fedcf86bc4a55',
- indexName: 'hugodocs',
- inputSelector: '#search-input',
- debug: true // Set debug to true if you want to inspect the dropdown
+ appId: 'D1BPLZHGYQ',
+ apiKey: '6df94e1e5d55d258c56f60d974d10314',
+ indexName: 'hugodocs',
+ inputSelector: '#search-input',
+ debug: true, // Set debug to true if you want to inspect the dropdown
});
diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/hljs.js b/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/hljs.js
deleted file mode 100644
index c2252e78315..00000000000
--- a/docs/_vendor/github.com/gohugoio/gohugoioTheme/assets/js/hljs.js
+++ /dev/null
@@ -1,19 +0,0 @@
-var hljs = require('highlight.js/lib/highlight.js');
-
-hljs.registerLanguage('bash', require('highlight.js/lib/languages/bash'));
-hljs.registerLanguage('css', require('highlight.js/lib/languages/css'));
-hljs.registerLanguage('markdown', require('highlight.js/lib/languages/markdown'));
-hljs.registerLanguage('diff', require('highlight.js/lib/languages/diff'));
-// hljs.registerLanguage('go', require('highlight.js/lib/languages/go'));
-hljs.registerLanguage('javascript', require('highlight.js/lib/languages/javascript'));
-hljs.registerLanguage('json', require('highlight.js/lib/languages/json'));
-hljs.registerLanguage('yaml', require('highlight.js/lib/languages/yaml'));
-hljs.registerLanguage('xml', require('highlight.js/lib/languages/xml'));
-hljs.registerLanguage('html', require('highlight.js/lib/languages/handlebars'));
-
-hljs.registerLanguage("go", function(e) {
- var t = { keyword: "code output note warning break default func interface select case map struct chan else goto package switch const fallthrough if range end type continue for import return var go defer bool byte complex64 complex128 float32 float64 int8 int16 int32 int64 string uint8 uint16 uint32 uint64 int uint uintptr rune id autoplay Get", literal: "file download copy true false iota nil Pages with", built_in: "append cap close complex highlight copy imag len make new panic print println real recover delete Site Data tweet youtube ref relref vimeo instagram gist figure innershortcode" };
- return { aliases: ["golang","hugo"], k: t, i: "0)&&"visible"!=_(s,"overflow")&&(r=s.getBoundingClientRect(),o=G>r.left&&Wr.top-1&&J500&&i.clientWidth>500?500:370),X=r.expand,Z=X*r.expFactor),re2&&z>2&&!t.hidden?(re=Z,se=0):re=z>1&&se>1&&ie<6?X:0;for(;s=l&&(J=o.top)<=V&&(G=o.right)>=l*Y&&(W=o.left)<=K&&(Q||G||W||J)&&(r.loadHidden||"hidden"!=_(f[s],"visibility"))&&(q&&ie<3&&!h&&(z<3||se<4)||ae(f[s],u))){if(ge(f[s]),c=!0,ie>9)break}else!c&&q&&!a&&ie<4&&se<4&&z>2&&(B[0]||r.preloadAfterLoad)&&(B[0]||!h&&(Q||G||W||J||"auto"!=f[s].getAttribute(r.sizesAttr)))&&(a=B[0]||f[s]);else ge(f[s]);a&&!c&&ge(a)}},ue=function(e){var t,n=0,i=r.throttleDelay,o=r.ricTimeout,a=function(){t=!1,n=s.now(),e()},u=l&&o>49?function(){l(a,{timeout:o}),o!==r.ricTimeout&&(o=r.ricTimeout)}:S((function(){c(a)}),!0);return function(e){var r;(e=!0===e)&&(o=33),t||(t=!0,(r=i-(s.now()-n))<0&&(r=0),e||r<9?u():c(u,r))}}(ce),le=function(e){m(e.target,r.loadedClass),v(e.target,r.loadingClass),y(e.target,de),b(e.target,"lazyloaded")},he=S(le),de=function(e){he({target:e.target})},fe=function(e){var t,n=e.getAttribute(r.srcsetAttr);(t=r.customMedia[e.getAttribute("data-media")||e.getAttribute("media")])&&e.setAttribute("media",t),n&&e.setAttribute("srcset",n)},pe=S((function(e,t,n,i,s){var o,a,u,l,d,f;(d=b(e,"lazybeforeunveil",t)).defaultPrevented||(i&&(n?m(e,r.autosizesClass):e.setAttribute("sizes",i)),a=e.getAttribute(r.srcsetAttr),o=e.getAttribute(r.srcAttr),s&&(l=(u=e.parentNode)&&h.test(u.nodeName||"")),f=t.firesLoad||"src"in e&&(a||o||l),d={target:e},f&&(y(e,oe,!0),clearTimeout(F),F=c(oe,2500),m(e,r.loadingClass),y(e,de,!0)),l&&p.call(u.getElementsByTagName("source"),fe),a?e.setAttribute("srcset",a):o&&!l&&(te.test(e.nodeName)?function(e,t){try{e.contentWindow.location.replace(t)}catch(n){e.src=t}}(e,o):e.src=o),s&&(a||l)&&w(e,{src:o})),e._lazyRace&&delete e._lazyRace,v(e,r.lazyClass),x((function(){(!f||e.complete&&e.naturalWidth>1)&&(f?oe(d):ie--,le(d))}),!0)})),ge=function(e){var t,n=ee.test(e.nodeName),i=n&&(e.getAttribute(r.sizesAttr)||e.getAttribute("sizes")),s="auto"==i;(!s&&q||!n||!e.getAttribute("src")&&!e.srcset||e.complete||g(e,r.errorClass)||!g(e,r.lazyClass))&&(t=b(e,"lazyunveilread").detail,s&&I.updateElem(e,!0,e.offsetWidth),e._lazyRace=!0,ie++,pe(e,t,s,i,n))},me=function(){if(!q)if(s.now()-U<999)c(me,999);else{var e=C((function(){r.loadMode=3,ue()}));q=!0,r.loadMode=3,ue(),a("scroll",(function(){3==r.loadMode&&(r.loadMode=2),e()}),!0)}},{_:function(){U=s.now(),n.elements=t.getElementsByClassName(r.lazyClass),B=t.getElementsByClassName(r.lazyClass+" "+r.preloadClass),Y=r.hFac,a("scroll",ue,!0),a("resize",ue,!0),e.MutationObserver?new MutationObserver(ue).observe(i,{childList:!0,subtree:!0,attributes:!0}):(i.addEventListener("DOMNodeInserted",ue,!0),i.addEventListener("DOMAttrModified",ue,!0),setInterval(ue,999)),a("hashchange",ue,!0),["focus","mouseover","click","load","transitionend","animationend","webkitAnimationEnd"].forEach((function(e){t.addEventListener(e,ue,!0)})),/d$|^c/.test(t.readyState)?me():(a("load",me),t.addEventListener("DOMContentLoaded",ue),c(me,2e4)),n.elements.length?(ce(),x._lsFlush()):ue()},checkElems:ue,unveil:ge}),I=(P=S((function(e,t,n,r){var i,s,o;if(e._lazysizesWidth=r,r+="px",e.setAttribute("sizes",r),h.test(t.nodeName||""))for(s=0,o=(i=t.getElementsByTagName("source")).length;s0)&&"visible"!=_(i,"overflow")&&(r=i.getBoundingClientRect(),s=z>r.left&&Fr.top-1&&H500&&o.clientWidth>500?500:370:i.expand,r._defEx=d,p=d*i.expFactor,g=i.hFac,U=null,W2&&D>2&&!e.hidden?(W=p,X=0):W=D>1&&X>1&&Q<6?d:0),f!==c&&($=innerWidth+c*g,M=innerHeight+c,l=-1*c,f=c),s=m[n].getBoundingClientRect(),(B=s.bottom)>=l&&(H=s.top)<=M&&(z=s.right)>=l*g&&(F=s.left)<=$&&(B||z||F||H)&&(i.loadHidden||Z(m[n]))&&(R&&Q<3&&!h&&(D<3||X<4)||Y(m[n],c))){if(at(m[n]),u=!0,Q>9)break}else!u&&R&&!a&&Q<4&&X<4&&D>2&&(L[0]||i.preloadAfterLoad)&&(L[0]||!h&&(B||z||F||H||"auto"!=m[n].getAttribute(i.sizesAttr)))&&(a=L[0]||m[n]);a&&!u&&at(a)}},et=function(t){var e,r=0,o=i.throttleDelay,s=i.ricTimeout,a=function(){e=!1,r=n.now(),t()},c=l&&s>49?function(){l(a,{timeout:s}),s!==i.ricTimeout&&(s=i.ricTimeout)}:C((function(){u(a)}),!0);return function(t){var i;(t=!0===t)&&(s=33),e||(e=!0,(i=o-(n.now()-r))<0&&(i=0),t||i<9?c():u(c,i))}}(tt),nt=function(t){var e=t.target;e._lazyCache?delete e._lazyCache:(G(t),m(e,i.loadedClass),y(e,i.loadingClass),v(e,it),b(e,"lazyloaded"))},rt=C(nt),it=function(t){rt({target:t.target})},ot=function(t){var e,n=t.getAttribute(i.srcsetAttr);(e=i.customMedia[t.getAttribute("data-media")||t.getAttribute("media")])&&t.setAttribute("media",e),n&&t.setAttribute("srcset",n)},st=C((function(t,e,n,r,o){var s,a,c,l,f,d;(f=b(t,"lazybeforeunveil",e)).defaultPrevented||(r&&(n?m(t,i.autosizesClass):t.setAttribute("sizes",r)),a=t.getAttribute(i.srcsetAttr),s=t.getAttribute(i.srcAttr),o&&(l=(c=t.parentNode)&&h.test(c.nodeName||"")),d=e.firesLoad||"src"in t&&(a||s||l),f={target:t},m(t,i.loadingClass),d&&(clearTimeout(P),P=u(G,2500),v(t,it,!0)),l&&p.call(c.getElementsByTagName("source"),ot),a?t.setAttribute("srcset",a):s&&!l&&(K.test(t.nodeName)?function(t,e){var n=t.getAttribute("data-load-mode")||i.iframeLoadMode;0==n?t.contentWindow.location.replace(e):1==n&&(t.src=e)}(t,s):t.src=s),o&&(a||l)&&w(t,{src:s})),t._lazyRace&&delete t._lazyRace,y(t,i.lazyClass),S((function(){var e=t.complete&&t.naturalWidth>1;d&&!e||(e&&m(t,i.fastLoadedClass),nt(f),t._lazyCache=!0,u((function(){"_lazyCache"in t&&delete t._lazyCache}),9)),"lazy"==t.loading&&Q--}),!0)})),at=function(t){if(!t._lazyRace){var e,n=V.test(t.nodeName),r=n&&(t.getAttribute(i.sizesAttr)||t.getAttribute("sizes")),o="auto"==r;(!o&&R||!n||!t.getAttribute("src")&&!t.srcset||t.complete||g(t,i.errorClass)||!g(t,i.lazyClass))&&(e=b(t,"lazyunveilread").detail,o&&T.updateElem(t,!0,t.offsetWidth),t._lazyRace=!0,Q++,st(t,e,o,r,n))}},ut=A((function(){i.loadMode=3,et()})),ct=function(){3==i.loadMode&&(i.loadMode=2),ut()},lt=function(){R||(n.now()-q<999?u(lt,999):(R=!0,i.loadMode=3,et(),a("scroll",ct,!0)))},{_:function(){q=n.now(),r.elements=e.getElementsByClassName(i.lazyClass),L=e.getElementsByClassName(i.lazyClass+" "+i.preloadClass),a("scroll",et,!0),a("resize",et,!0),a("pageshow",(function(t){if(t.persisted){var n=e.querySelectorAll("."+i.loadingClass);n.length&&n.forEach&&c((function(){n.forEach((function(t){t.complete&&at(t)}))}))}})),t.MutationObserver?new MutationObserver(et).observe(o,{childList:!0,subtree:!0,attributes:!0}):(o.addEventListener("DOMNodeInserted",et,!0),o.addEventListener("DOMAttrModified",et,!0),setInterval(et,999)),a("hashchange",et,!0),["focus","mouseover","click","load","transitionend","animationend"].forEach((function(t){e.addEventListener(t,et,!0)})),/d$|^c/.test(e.readyState)?lt():(a("load",lt),e.addEventListener("DOMContentLoaded",et),u(lt,2e4)),r.elements.length?(tt(),S._lsFlush()):et()},checkElems:et,unveil:at,_aLSL:ct}),T=(N=C((function(t,e,n,r){var i,o,s;if(t._lazysizesWidth=r,r+="px",t.setAttribute("sizes",r),h.test(e.nodeName||""))for(o=0,s=(i=e.getElementsByTagName("source")).length;o0&&void 0!==arguments[0]?arguments[0]:{};this.action="function"==typeof e.action?e.action:this.defaultAction,this.target="function"==typeof e.target?e.target:this.defaultTarget,this.text="function"==typeof e.text?e.text:this.defaultText,this.container="object"===r(e.container)?e.container:document.body}},{key:"listenClick",value:function(e){var t=this;this.listener=(0,a.default)(e,"click",(function(e){return t.onClick(e)}))}},{key:"onClick",value:function(e){var t=e.delegateTarget||e.currentTarget;this.clipboardAction&&(this.clipboardAction=null),this.clipboardAction=new s.default({action:this.action(t),target:this.target(t),text:this.text(t),container:this.container,trigger:t,emitter:this})}},{key:"defaultAction",value:function(e){return l("action",e)}},{key:"defaultTarget",value:function(e){var t=l("target",e);if(t)return document.querySelector(t)}},{key:"defaultText",value:function(e){return l("text",e)}},{key:"destroy",value:function(){this.listener.destroy(),this.clipboardAction&&(this.clipboardAction.destroy(),this.clipboardAction=null)}}],[{key:"isSupported",value:function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:["copy","cut"],t="string"==typeof e?[e]:e,n=!!document.queryCommandSupported;return t.forEach((function(e){n=n&&!!document.queryCommandSupported(e)})),n}}]),t}(o.default);function l(e,t){var n="data-clipboard-"+e;if(t.hasAttribute(n))return t.getAttribute(n)}e.exports=u},function(e,t,n){"use strict";var r,i="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},s=function(){function e(e,t){for(var n=0;n0&&void 0!==arguments[0]?arguments[0]:{};this.action=e.action,this.container=e.container,this.emitter=e.emitter,this.target=e.target,this.text=e.text,this.trigger=e.trigger,this.selectedText=""}},{key:"initSelection",value:function(){this.text?this.selectFake():this.target&&this.selectTarget()}},{key:"selectFake",value:function(){var e=this,t="rtl"==document.documentElement.getAttribute("dir");this.removeFake(),this.fakeHandlerCallback=function(){return e.removeFake()},this.fakeHandler=this.container.addEventListener("click",this.fakeHandlerCallback)||!0,this.fakeElem=document.createElement("textarea"),this.fakeElem.style.fontSize="12pt",this.fakeElem.style.border="0",this.fakeElem.style.padding="0",this.fakeElem.style.margin="0",this.fakeElem.style.position="absolute",this.fakeElem.style[t?"right":"left"]="-9999px";var n=window.pageYOffset||document.documentElement.scrollTop;this.fakeElem.style.top=n+"px",this.fakeElem.setAttribute("readonly",""),this.fakeElem.value=this.text,this.container.appendChild(this.fakeElem),this.selectedText=(0,a.default)(this.fakeElem),this.copyText()}},{key:"removeFake",value:function(){this.fakeHandler&&(this.container.removeEventListener("click",this.fakeHandlerCallback),this.fakeHandler=null,this.fakeHandlerCallback=null),this.fakeElem&&(this.container.removeChild(this.fakeElem),this.fakeElem=null)}},{key:"selectTarget",value:function(){this.selectedText=(0,a.default)(this.target),this.copyText()}},{key:"copyText",value:function(){var e=void 0;try{e=document.execCommand(this.action)}catch(t){e=!1}this.handleResult(e)}},{key:"handleResult",value:function(e){this.emitter.emit(e?"success":"error",{action:this.action,text:this.selectedText,trigger:this.trigger,clearSelection:this.clearSelection.bind(this)})}},{key:"clearSelection",value:function(){this.trigger&&this.trigger.focus(),window.getSelection().removeAllRanges()}},{key:"destroy",value:function(){this.removeFake()}},{key:"action",set:function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"copy";if(this._action=e,"copy"!==this._action&&"cut"!==this._action)throw new Error('Invalid "action" value, use either "copy" or "cut"')},get:function(){return this._action}},{key:"target",set:function(e){if(void 0!==e){if(!e||"object"!==(void 0===e?"undefined":i(e))||1!==e.nodeType)throw new Error('Invalid "target" value, use a valid Element');if("copy"===this.action&&e.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if("cut"===this.action&&(e.hasAttribute("readonly")||e.hasAttribute("disabled")))throw new Error('Invalid "target" attribute. You can\'t cut text from elements with "readonly" or "disabled" attributes');this._target=e}},get:function(){return this._target}}]),e}();e.exports=c},function(e,t){e.exports=function(e){var t;if("SELECT"===e.nodeName)e.focus(),t=e.value;else if("INPUT"===e.nodeName||"TEXTAREA"===e.nodeName){var n=e.hasAttribute("readonly");n||e.setAttribute("readonly",""),e.select(),e.setSelectionRange(0,e.value.length),n||e.removeAttribute("readonly"),t=e.value}else{e.hasAttribute("contenteditable")&&e.focus();var r=window.getSelection(),i=document.createRange();i.selectNodeContents(e),r.removeAllRanges(),r.addRange(i),t=r.toString()}return t}},function(e,t){function n(){}n.prototype={on:function(e,t,n){var r=this.e||(this.e={});return(r[e]||(r[e]=[])).push({fn:t,ctx:n}),this},once:function(e,t,n){var r=this;function i(){r.off(e,i),t.apply(n,arguments)}return i._=t,this.on(e,i,n)},emit:function(e){for(var t=[].slice.call(arguments,1),n=((this.e||(this.e={}))[e]||[]).slice(),r=0,i=n.length;r0&&n.parentNode.classList.add("expand")}}},function(e,t,n){n(8)({apiKey:"167e7998590aebda7f9fedcf86bc4a55",indexName:"hugodocs",inputSelector:"#search-input",debug:!0})},function(e,t,n){
+var r;r=function(){return function(t){var e={};function n(r){if(e[r])return e[r].exports;var i=e[r]={i:r,l:!1,exports:{}};return t[r].call(i.exports,i,i.exports,n),i.l=!0,i.exports}return n.m=t,n.c=e,n.d=function(t,e,r){n.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:r})},n.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},n.t=function(t,e){if(1&e&&(t=n(t)),8&e)return t;if(4&e&&"object"==typeof t&&t&&t.__esModule)return t;var r=Object.create(null);if(n.r(r),Object.defineProperty(r,"default",{enumerable:!0,value:t}),2&e&&"string"!=typeof t)for(var i in t)n.d(r,i,function(e){return t[e]}.bind(null,i));return r},n.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return n.d(e,"a",e),e},n.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},n.p="",n(n.s=0)}([function(t,e,n){"use strict";var r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},i=function(){function t(t,e){for(var n=0;n0&&void 0!==arguments[0]?arguments[0]:{};this.action="function"==typeof t.action?t.action:this.defaultAction,this.target="function"==typeof t.target?t.target:this.defaultTarget,this.text="function"==typeof t.text?t.text:this.defaultText,this.container="object"===r(t.container)?t.container:document.body}},{key:"listenClick",value:function(t){var e=this;this.listener=(0,a.default)(t,"click",(function(t){return e.onClick(t)}))}},{key:"onClick",value:function(t){var e=t.delegateTarget||t.currentTarget;this.clipboardAction&&(this.clipboardAction=null),this.clipboardAction=new o.default({action:this.action(e),target:this.target(e),text:this.text(e),container:this.container,trigger:e,emitter:this})}},{key:"defaultAction",value:function(t){return l("action",t)}},{key:"defaultTarget",value:function(t){var e=l("target",t);if(e)return document.querySelector(e)}},{key:"defaultText",value:function(t){return l("text",t)}},{key:"destroy",value:function(){this.listener.destroy(),this.clipboardAction&&(this.clipboardAction.destroy(),this.clipboardAction=null)}}],[{key:"isSupported",value:function(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:["copy","cut"],e="string"==typeof t?[t]:t,n=!!document.queryCommandSupported;return e.forEach((function(t){n=n&&!!document.queryCommandSupported(t)})),n}}]),e}(s.default);function l(t,e){var n="data-clipboard-"+t;if(e.hasAttribute(n))return e.getAttribute(n)}t.exports=c},function(t,e,n){"use strict";var r,i="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},o=function(){function t(t,e){for(var n=0;n0&&void 0!==arguments[0]?arguments[0]:{};this.action=t.action,this.container=t.container,this.emitter=t.emitter,this.target=t.target,this.text=t.text,this.trigger=t.trigger,this.selectedText=""}},{key:"initSelection",value:function(){this.text?this.selectFake():this.target&&this.selectTarget()}},{key:"selectFake",value:function(){var t=this,e="rtl"==document.documentElement.getAttribute("dir");this.removeFake(),this.fakeHandlerCallback=function(){return t.removeFake()},this.fakeHandler=this.container.addEventListener("click",this.fakeHandlerCallback)||!0,this.fakeElem=document.createElement("textarea"),this.fakeElem.style.fontSize="12pt",this.fakeElem.style.border="0",this.fakeElem.style.padding="0",this.fakeElem.style.margin="0",this.fakeElem.style.position="absolute",this.fakeElem.style[e?"right":"left"]="-9999px";var n=window.pageYOffset||document.documentElement.scrollTop;this.fakeElem.style.top=n+"px",this.fakeElem.setAttribute("readonly",""),this.fakeElem.value=this.text,this.container.appendChild(this.fakeElem),this.selectedText=(0,a.default)(this.fakeElem),this.copyText()}},{key:"removeFake",value:function(){this.fakeHandler&&(this.container.removeEventListener("click",this.fakeHandlerCallback),this.fakeHandler=null,this.fakeHandlerCallback=null),this.fakeElem&&(this.container.removeChild(this.fakeElem),this.fakeElem=null)}},{key:"selectTarget",value:function(){this.selectedText=(0,a.default)(this.target),this.copyText()}},{key:"copyText",value:function(){var t=void 0;try{t=document.execCommand(this.action)}catch(e){t=!1}this.handleResult(t)}},{key:"handleResult",value:function(t){this.emitter.emit(t?"success":"error",{action:this.action,text:this.selectedText,trigger:this.trigger,clearSelection:this.clearSelection.bind(this)})}},{key:"clearSelection",value:function(){this.trigger&&this.trigger.focus(),window.getSelection().removeAllRanges()}},{key:"destroy",value:function(){this.removeFake()}},{key:"action",set:function(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"copy";if(this._action=t,"copy"!==this._action&&"cut"!==this._action)throw new Error('Invalid "action" value, use either "copy" or "cut"')},get:function(){return this._action}},{key:"target",set:function(t){if(void 0!==t){if(!t||"object"!==(void 0===t?"undefined":i(t))||1!==t.nodeType)throw new Error('Invalid "target" value, use a valid Element');if("copy"===this.action&&t.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if("cut"===this.action&&(t.hasAttribute("readonly")||t.hasAttribute("disabled")))throw new Error('Invalid "target" attribute. You can\'t cut text from elements with "readonly" or "disabled" attributes');this._target=t}},get:function(){return this._target}}]),t}();t.exports=u},function(t,e){t.exports=function(t){var e;if("SELECT"===t.nodeName)t.focus(),e=t.value;else if("INPUT"===t.nodeName||"TEXTAREA"===t.nodeName){var n=t.hasAttribute("readonly");n||t.setAttribute("readonly",""),t.select(),t.setSelectionRange(0,t.value.length),n||t.removeAttribute("readonly"),e=t.value}else{t.hasAttribute("contenteditable")&&t.focus();var r=window.getSelection(),i=document.createRange();i.selectNodeContents(t),r.removeAllRanges(),r.addRange(i),e=r.toString()}return e}},function(t,e){function n(){}n.prototype={on:function(t,e,n){var r=this.e||(this.e={});return(r[t]||(r[t]=[])).push({fn:e,ctx:n}),this},once:function(t,e,n){var r=this;function i(){r.off(t,i),e.apply(n,arguments)}return i._=e,this.on(t,i,n)},emit:function(t){for(var e=[].slice.call(arguments,1),n=((this.e||(this.e={}))[t]||[]).slice(),r=0,i=n.length;r";var r=document.createElement("div");r.appendChild(document.createTextNode(t)),n=n||"";var i=document.createElement("div");i.appendChild(document.createTextNode(n));var o=document.createElement("div");return o.appendChild(document.createTextNode(e)),o.innerHTML.replace(RegExp(s(r.innerHTML),"g"),t).replace(RegExp(s(i.innerHTML),"g"),n)}}},function(e,t,n){"use strict";e.exports={element:null}},function(e,t){var n=Object.prototype.hasOwnProperty,r=Object.prototype.toString;e.exports=function(e,t,i){if("[object Function]"!==r.call(t))throw new TypeError("iterator must be a function");var s=e.length;if(s===+s)for(var o=0;o was loaded but did not call our provided callback"),JSONPScriptError:s("JSONPScriptError","
-
-{{ end }}
-
-
-
-
+ ">
+ +
+ {{/* https://www.zachleat.com/web/preload/ */}}
+
+
+
+
+
+ {{/* NOTE: the Site's title, and if there is a page title, that is set too */}}
+
+ {{ block "title" . }}
+ {{ with .Title }}{{ . }} | {{ end }}{{ .Site.Title }}
+ {{ end }}
+
+
+
+
+ {{ hugo.Generator }}
+
+ {{ if hugo.IsProduction }}
+
+ {{ else }}
+
+ {{ end }}
+
+ {{ range .AlternativeOutputFormats -}}
+
+ {{ end -}}
+
+ {{ $isDev := eq hugo.Environment "development" }}
+ {{ $stylesheet := resources.Get "output/css/app.css" }}
+ {{ if not $isDev }}
+ {{ $stylesheet = $stylesheet | minify | fingerprint }}
+ {{ end }}
+ {{ with $stylesheet }}
+ {{ if $isDev }}
+
+ {{ else }}
+
+ {{ end }}
+ {{ $.Scratch.Set "stylesheet" . }}
+ {{ end }}
+
+
+
+
+ {{ block "scripts" . }}
+ {{- partial "site-scripts.html" . -}}
+ {{ end }}
+ {{ partial "site-manifest.html" . }}
+ {{- partial "head-additions.html" . -}}
+ {{- partial "opengraph/opengraph.html" . -}}
+ {{- template "_internal/schema.html" . -}}
+ {{- partial "opengraph/twitter_cards.html" . -}}
+
+ {{ if hugo.IsProduction }}
+ {{ partial "gtag" . }}
+ {{ end }}
+
+
+
+
+ 
+
+
+