Compare commits

..

No commits in common. "master" and "v0.112.3" have entirely different histories.

3114 changed files with 97698 additions and 135614 deletions

View file

@ -4,7 +4,7 @@ parameters:
defaults: &defaults defaults: &defaults
resource_class: large resource_class: large
docker: docker:
- image: bepsays/ci-hugoreleaser:1.22400.20000 - image: bepsays/ci-hugoreleaser:1.22000.20100
environment: &buildenv environment: &buildenv
GOMODCACHE: /root/project/gomodcache GOMODCACHE: /root/project/gomodcache
version: 2 version: 2
@ -14,7 +14,9 @@ jobs:
environment: &buildenv environment: &buildenv
GOMODCACHE: /root/project/gomodcache GOMODCACHE: /root/project/gomodcache
steps: steps:
- setup_remote_docker - &remote-docker
setup_remote_docker:
version: 20.10.14
- checkout: - checkout:
path: hugo path: hugo
- &git-config - &git-config
@ -58,7 +60,7 @@ jobs:
environment: environment:
<<: [*buildenv] <<: [*buildenv]
docker: docker:
- image: bepsays/ci-hugoreleaser-linux-arm64:1.22400.20000 - image: bepsays/ci-hugoreleaser-linux-arm64:1.22000.20100
steps: steps:
- *restore-cache - *restore-cache
- &attach-workspace - &attach-workspace

View file

@ -5,11 +5,6 @@ assignees: ''
about: Create a report to help us improve about: Create a report to help us improve
--- ---
<!--
Please do not use the issue queue for questions or troubleshooting. Unless you are certain that your issue is a software defect, use the forum:
https://discourse.gohugo.io
-->
<!-- Please answer these questions before submitting your issue. Thanks! --> <!-- Please answer these questions before submitting your issue. Thanks! -->

View file

@ -1,49 +0,0 @@
name: Build Docker image
on:
release:
types: [published]
pull_request:
permissions:
packages: write
env:
REGISTRY_IMAGE: ghcr.io/gohugoio/hugo
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- name: Docker meta
id: meta
uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
with:
images: ${{ env.REGISTRY_IMAGE }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1
- name: Login to GHCR
# Login is only needed when the image is pushed
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push
id: build
uses: docker/build-push-action@16ebe778df0e7752d2cfcbd924afdbbd89c1a755 # v6.6.1
with:
context: .
provenance: mode=max
sbom: true
push: ${{ github.event_name != 'pull_request' }}
platforms: linux/amd64,linux/arm64
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
build-args: HUGO_BUILD_TAGS=extended,withdeploy

View file

@ -12,7 +12,7 @@ jobs:
pull-requests: write pull-requests: write
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: dessant/lock-threads@7de207be1d3ce97a9abe6ff1306222982d1ca9f9 # v5.0.1 - uses: dessant/lock-threads@08e671be8ac8944d0e132aa71d0ae8ccfb347675
with: with:
issue-inactive-days: 21 issue-inactive-days: 21
add-issue-labels: 'Outdated' add-issue-labels: 'Outdated'
@ -24,7 +24,7 @@ jobs:
This pull request has been automatically locked since there This pull request has been automatically locked since there
has not been any recent activity after it was closed. has not been any recent activity after it was closed.
Please open a new issue for related bugs. Please open a new issue for related bugs.
- uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9.0.0 - uses: actions/stale@04a1828bc18ada028d85a0252a47cd2963a91abe
with: with:
operations-per-run: 999 operations-per-run: 999
days-before-issue-stale: 365 days-before-issue-stale: 365

View file

@ -1,42 +1,29 @@
on: on:
push: push:
branches: [master] branches: [ master ]
pull_request: pull_request:
name: Test name: Test
env: env:
GOPROXY: https://proxy.golang.org GOPROXY: https://proxy.golang.org
GO111MODULE: on GO111MODULE: on
SASS_VERSION: 1.80.3 DART_SASS_VERSION: 1.56.2
DART_SASS_SHA_LINUX: 7c933edbad0a7d389192c5b79393485c088bd2c4398e32f5754c32af006a9ffd DART_SASS_SHA_LINUX: 9e4f455f7b8619959d7878af2862383be58392eb963a14ff87cc512c03701e2a
DART_SASS_SHA_MACOS: 79e060b0e131c3bb3c16926bafc371dc33feab122bfa8c01aa337a072097967b DART_SASS_SHA_MACOS: 5992e979e2c30ec363f8e338822bb2b4443c74232b3340501a76180f5652cb09
DART_SASS_SHA_WINDOWS: 0bc4708b37cd1bac4740e83ac5e3176e66b774f77fd5dd364da5b5cfc9bfb469 DART_SASS_SHA_WINDOWS: 8d3d9117c54840e3e6a4919e43acf75ea52f28a64fc87a8e29d80ec72ee36cfb
permissions: permissions:
contents: read contents: read
jobs: jobs:
test: test:
strategy: strategy:
matrix: matrix:
go-version: [1.23.x, 1.24.x] go-version: [1.19.x,1.20.x]
os: [ubuntu-latest, windows-latest] # macos disabled for now because of disk space issues. os: [ubuntu-latest, macos-latest, windows-latest]
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
steps: steps:
- if: matrix.os == 'ubuntu-latest'
name: Free Disk Space (Ubuntu)
uses: jlumbroso/free-disk-space@54081f138730dfa15788a46383842cd2f914a1be # v1.3.1
with:
# this might remove tools that are actually needed,
# if set to "true" but frees about 6 GB
tool-cache: false
android: true
dotnet: true
haskell: true
large-packages: true
docker-images: true
swap-storage: true
- name: Checkout code - name: Checkout code
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
- name: Install Go - name: Install Go
uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2 uses: actions/setup-go@268d8c0ca0432bb2cf416faae41297df9d262d7f
with: with:
go-version: ${{ matrix.go-version }} go-version: ${{ matrix.go-version }}
check-latest: true check-latest: true
@ -45,22 +32,22 @@ jobs:
**/go.sum **/go.sum
**/go.mod **/go.mod
- name: Install Ruby - name: Install Ruby
uses: ruby/setup-ruby@a6e6f86333f0a2523ece813039b8b4be04560854 # v1.190.0 uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4
with: with:
ruby-version: "2.7" ruby-version: '2.7'
bundler-cache: true # bundler-cache: true #
- name: Install Python - name: Install Python
uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f # v5.1.1 uses: actions/setup-python@3105fb18c05ddd93efea5f9e0bef7a03a6e9e7df
with: with:
python-version: "3.x" python-version: '3.x'
- name: Install Mage - name: Install Mage
run: go install github.com/magefile/mage@v1.15.0 run: go install github.com/magefile/mage@07afc7d24f4d6d6442305d49552f04fbda5ccb3e
- name: Install asciidoctor - name: Install asciidoctor
uses: reitzig/actions-asciidoctor@c642db5eedd1d729bb8c92034770d0b2f769eda6 # v2.0.2 uses: reitzig/actions-asciidoctor@7570212ae20b63653481675fb1ff62d1073632b0
- name: Install docutils - name: Install docutils
run: | run: |
pip install docutils pip install docutils
rst2html --version rst2html.py --version
- if: matrix.os == 'ubuntu-latest' - if: matrix.os == 'ubuntu-latest'
name: Install pandoc on Linux name: Install pandoc on Linux
run: | run: |
@ -71,62 +58,37 @@ jobs:
brew install pandoc brew install pandoc
- if: matrix.os == 'windows-latest' - if: matrix.os == 'windows-latest'
run: | run: |
choco install pandoc Choco-Install -PackageName pandoc
- run: pandoc -v - run: pandoc -v
- if: matrix.os == 'windows-latest' - if: matrix.os == 'windows-latest'
run: | run: |
choco install mingw Choco-Install -PackageName mingw -ArgumentList "--version","10.2.0","--allow-downgrade"
- if: matrix.os == 'ubuntu-latest' - if: matrix.os == 'ubuntu-latest'
name: Install dart-sass Linux name: Install dart-sass-embedded Linux
run: | run: |
echo "Install Dart Sass version ${SASS_VERSION} ..." echo "Install Dart Sass version ${DART_SASS_VERSION} ..."
curl -LJO "https://github.com/sass/dart-sass/releases/download/${SASS_VERSION}/dart-sass-${SASS_VERSION}-linux-x64.tar.gz"; 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} dart-sass-${SASS_VERSION}-linux-x64.tar.gz" | sha256sum -c; echo "${DART_SASS_SHA_LINUX} sass_embedded-${DART_SASS_VERSION}-linux-x64.tar.gz" | sha256sum -c;
tar -xvf "dart-sass-${SASS_VERSION}-linux-x64.tar.gz"; tar -xvf "sass_embedded-${DART_SASS_VERSION}-linux-x64.tar.gz";
echo "$GOBIN" echo "$GITHUB_WORKSPACE/sass_embedded/" >> $GITHUB_PATH
echo "$GITHUB_WORKSPACE/dart-sass/" >> $GITHUB_PATH
- if: matrix.os == 'macos-latest' - if: matrix.os == 'macos-latest'
name: Install dart-sass MacOS name: Install dart-sass-embedded MacOS
run: | run: |
echo "Install Dart Sass version ${SASS_VERSION} ..." echo "Install Dart Sass version ${DART_SASS_VERSION} ..."
curl -LJO "https://github.com/sass/dart-sass/releases/download/${SASS_VERSION}/dart-sass-${SASS_VERSION}-macos-x64.tar.gz"; 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} dart-sass-${SASS_VERSION}-macos-x64.tar.gz" | shasum -a 256 -c; echo "${DART_SASS_SHA_MACOS} sass_embedded-${DART_SASS_VERSION}-macos-x64.tar.gz" | shasum -a 256 -c;
tar -xvf "dart-sass-${SASS_VERSION}-macos-x64.tar.gz"; tar -xvf "sass_embedded-${DART_SASS_VERSION}-macos-x64.tar.gz";
echo "$GITHUB_WORKSPACE/dart-sass/" >> $GITHUB_PATH echo "$GITHUB_WORKSPACE/sass_embedded/" >> $GITHUB_PATH
- if: matrix.os == 'windows-latest' - if: matrix.os == 'windows-latest'
name: Install dart-sass Windows name: Install dart-sass-embedded Windows
run: | run: |
echo "Install Dart Sass version ${env:SASS_VERSION} ..." echo "Install Dart Sass version ${env:DART_SASS_VERSION} ..."
curl -LJO "https://github.com/sass/dart-sass/releases/download/${env:SASS_VERSION}/dart-sass-${env:SASS_VERSION}-windows-x64.zip"; 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 "dart-sass-${env:SASS_VERSION}-windows-x64.zip" -DestinationPath .; Expand-Archive -Path "sass_embedded-${env:DART_SASS_VERSION}-windows-x64.zip" -DestinationPath .;
echo "$env:GITHUB_WORKSPACE/dart-sass/" | Out-File -FilePath $Env:GITHUB_PATH -Encoding utf-8 -Append echo "$env:GITHUB_WORKSPACE/sass_embedded/" | Out-File -FilePath $Env:GITHUB_PATH -Encoding utf-8 -Append
- if: matrix.os == 'ubuntu-latest' - name: Check
name: Install staticcheck
run: go install honnef.co/go/tools/cmd/staticcheck@latest
- if: matrix.os == 'ubuntu-latest'
name: Run staticcheck
run: staticcheck ./...
- if: matrix.os != 'windows-latest'
name: Check
run: | run: |
sass --version;
mage -v check; mage -v check;
env: env:
HUGO_BUILD_TAGS: extended,withdeploy HUGO_BUILD_TAGS: extended
- if: matrix.os == 'windows-latest'
# See issue #11052. We limit the build to regular test (no -race flag) on Windows for now.
name: Test
run: |
mage -v test;
env:
HUGO_BUILD_TAGS: extended,withdeploy
- name: Build tags
run: |
go install -tags extended
- if: matrix.os == 'ubuntu-latest'
name: Build for dragonfly
run: |
go install
env:
GOARCH: amd64
GOOS: dragonfly

3
.gitignore vendored
View file

@ -1,6 +1,3 @@
*.test *.test
imports.* imports.*
dist/
public/
.DS_Store

View file

@ -1,4 +1,4 @@
>**Note:** We would appreciate if you hold on with any big refactoring (like renaming deprecated Go packages), mainly because of potential for extra merge work for future coming in in the near future. >**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.
# Contributing to Hugo # Contributing to Hugo
@ -93,7 +93,6 @@ Most title/subjects should have a lower-cased prefix with a colon and one whites
* If this commit touches many packages without a common functional topic, prefix with `all:` (e.g. `all: Reformat Go code`) * If this commit touches many packages without a common functional topic, prefix with `all:` (e.g. `all: Reformat Go code`)
* If this is a documentation update, prefix with `docs:`. * If this is a documentation update, prefix with `docs:`.
* If nothing of the above applies, just leave the prefix out. * If nothing of the above applies, just leave the prefix out.
* Note that the above excludes nouns seen in other repositories, e.g. "chore:".
Also, if your commit references one or more GitHub issues, always end your commit message body with *See #1234* or *Fixes #1234*. Also, if your commit references one or more GitHub issues, always end your commit message body with *See #1234* or *Fixes #1234*.
Replace *1234* with the GitHub issue ID. The last example will close the issue when the commit is merged into *master*. Replace *1234* with the GitHub issue ID. The last example will close the issue when the commit is merged into *master*.
@ -123,6 +122,8 @@ cd hugo
go install go install
``` ```
>Note: Some Go tools may not be fully updated to support Go Modules yet. One example would be LiteIDE. Follow [this workaround](https://github.com/visualfc/liteide/issues/986#issuecomment-428117702) for how to continue to work with Hugo below `GOPATH`.
For some convenient build and test targets, you also will want to install Mage: For some convenient build and test targets, you also will want to install Mage:
```bash ```bash

View file

@ -2,98 +2,44 @@
# Twitter: https://twitter.com/gohugoio # Twitter: https://twitter.com/gohugoio
# Website: https://gohugo.io/ # Website: https://gohugo.io/
ARG GO_VERSION="1.24" FROM golang:1.19-alpine AS build
ARG ALPINE_VERSION="3.22"
ARG DART_SASS_VERSION="1.79.3"
FROM --platform=$BUILDPLATFORM tonistiigi/xx:1.5.0 AS xx # Optionally set HUGO_BUILD_TAGS to "extended" or "nodeploy" when building like so:
FROM --platform=$BUILDPLATFORM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS gobuild # docker build --build-arg HUGO_BUILD_TAGS=extended .
FROM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS gorun ARG HUGO_BUILD_TAGS
ARG CGO=1
FROM gobuild AS build ENV CGO_ENABLED=${CGO}
ENV GOOS=linux
RUN apk add clang lld ENV GO111MODULE=on
# Set up cross-compilation helpers
COPY --from=xx / /
ARG TARGETPLATFORM
RUN xx-apk add musl-dev gcc g++
# Optionally set HUGO_BUILD_TAGS to "none" or "withdeploy" when building like so:
# docker build --build-arg HUGO_BUILD_TAGS=withdeploy .
#
# We build the extended version by default.
ARG HUGO_BUILD_TAGS="extended"
ENV CGO_ENABLED=1
ENV GOPROXY=https://proxy.golang.org
ENV GOCACHE=/root/.cache/go-build
ENV GOMODCACHE=/go/pkg/mod
ARG TARGETPLATFORM
WORKDIR /go/src/github.com/gohugoio/hugo WORKDIR /go/src/github.com/gohugoio/hugo
# For --mount=type=cache the value of target is the default cache id, so COPY . /go/src/github.com/gohugoio/hugo/
# for the go mod cache it would be good if we could share it with other Go images using the same setup,
# but the go build cache needs to be per platform.
# See this comment: https://github.com/moby/buildkit/issues/1706#issuecomment-702238282
RUN --mount=target=. \
--mount=type=cache,target=/go/pkg/mod \
--mount=type=cache,target=/root/.cache/go-build,id=go-build-$TARGETPLATFORM <<EOT
set -ex
xx-go build -tags "$HUGO_BUILD_TAGS" -ldflags "-s -w -X github.com/gohugoio/hugo/common/hugo.vendorInfo=docker" -o /usr/bin/hugo
xx-verify /usr/bin/hugo
EOT
# dart-sass downloads the dart-sass runtime dependency # gcc/g++ are required to build SASS libraries for extended version
FROM alpine:${ALPINE_VERSION} AS dart-sass RUN apk update && \
ARG TARGETARCH apk add --no-cache gcc g++ musl-dev git && \
ARG DART_SASS_VERSION go install github.com/magefile/mage
ARG DART_ARCH=${TARGETARCH/amd64/x64}
WORKDIR /out
ADD https://github.com/sass/dart-sass/releases/download/${DART_SASS_VERSION}/dart-sass-${DART_SASS_VERSION}-linux-${DART_ARCH}.tar.gz .
RUN tar -xf dart-sass-${DART_SASS_VERSION}-linux-${DART_ARCH}.tar.gz
FROM gorun AS final RUN mage hugo && mage install
COPY --from=build /usr/bin/hugo /usr/bin/hugo # ---
# libc6-compat are required for extended libraries (libsass, libwebp). FROM alpine:3.16
RUN apk add --no-cache \
libc6-compat \
git \
runuser \
nodejs \
npm
RUN mkdir -p /var/hugo/bin /cache && \ COPY --from=build /go/bin/hugo /usr/bin/hugo
addgroup -Sg 1000 hugo && \
adduser -Sg hugo -u 1000 -h /var/hugo hugo && \
chown -R hugo: /var/hugo /cache && \
# For the Hugo's Git integration to work.
runuser -u hugo -- git config --global --add safe.directory /project && \
# See https://github.com/gohugoio/hugo/issues/9810
runuser -u hugo -- git config --global core.quotepath false
USER hugo:hugo # libc6-compat & libstdc++ are required for extended SASS libraries
VOLUME /project # ca-certificates are required to fetch outside resources (like Twitter oEmbeds)
WORKDIR /project RUN apk update && \
ENV HUGO_CACHEDIR=/cache apk add --no-cache ca-certificates libc6-compat libstdc++ git
ENV PATH="/var/hugo/bin:$PATH"
COPY scripts/docker/entrypoint.sh /entrypoint.sh VOLUME /site
COPY --from=dart-sass /out/dart-sass /var/hugo/bin/dart-sass WORKDIR /site
# Update PATH to reflect the new dependencies.
# For more complex setups, we should probably find a way to
# delegate this to the script itself, but this will have to do for now.
# Also, the dart-sass binary is a little special, other binaries can be put/linked
# directly in /var/hugo/bin.
ENV PATH="/var/hugo/bin/dart-sass:$PATH"
# Expose port for live server # Expose port for live server
EXPOSE 1313 EXPOSE 1313
ENTRYPOINT ["/entrypoint.sh"] ENTRYPOINT ["hugo"]
CMD ["--help"] CMD ["--help"]

View file

@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier same "printed page" as the copyright notice for easier
identification within third-party archives. 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"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.

393
README.md
View file

@ -1,282 +1,243 @@
[bep]: https://github.com/bep
[bugs]: https://github.com/gohugoio/hugo/issues?q=is%3Aopen+is%3Aissue+label%3ABug
[contributing]: CONTRIBUTING.md
[create a proposal]: https://github.com/gohugoio/hugo/issues/new?labels=Proposal%2C+NeedsTriage&template=feature_request.md
[documentation repository]: https://github.com/gohugoio/hugoDocs
[documentation]: https://gohugo.io/documentation
[dragonfly bsd, freebsd, netbsd, and openbsd]: https://gohugo.io/installation/bsd
[features]: https://gohugo.io/about/features/
[forum]: https://discourse.gohugo.io
[friends]: https://github.com/gohugoio/hugo/graphs/contributors
[go]: https://go.dev/
[hugo modules]: https://gohugo.io/hugo-modules/
[installation]: https://gohugo.io/installation
[issue queue]: https://github.com/gohugoio/hugo/issues
[linux]: https://gohugo.io/installation/linux
[macos]: https://gohugo.io/installation/macos
[prebuilt binary]: https://github.com/gohugoio/hugo/releases/latest
[requesting help]: https://discourse.gohugo.io/t/requesting-help/9132
[spf13]: https://github.com/spf13
[static site generator]: https://en.wikipedia.org/wiki/Static_site_generator
[support]: https://discourse.gohugo.io
[themes]: https://themes.gohugo.io/
[website]: https://gohugo.io
[windows]: https://gohugo.io/installation/windows
<a href="https://gohugo.io/"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/static/images/hugo-logo-wide.svg?sanitize=true" alt="Hugo" width="565"></a> <a href="https://gohugo.io/"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/static/images/hugo-logo-wide.svg?sanitize=true" alt="Hugo" width="565"></a>
A fast and flexible static site generator built with love by [bep], [spf13], and [friends] 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) |
[Documentation](https://gohugo.io/getting-started/) |
[Installation Guide](https://gohugo.io/getting-started/installing/) |
[Contribution Guide](CONTRIBUTING.md) |
[Twitter](https://twitter.com/gohugoio)
[![GoDoc](https://godoc.org/github.com/gohugoio/hugo?status.svg)](https://godoc.org/github.com/gohugoio/hugo) [![GoDoc](https://godoc.org/github.com/gohugoio/hugo?status.svg)](https://godoc.org/github.com/gohugoio/hugo)
[![Tests on Linux, MacOS and Windows](https://github.com/gohugoio/hugo/workflows/Test/badge.svg)](https://github.com/gohugoio/hugo/actions?query=workflow%3ATest) [![Tests on Linux, MacOS and Windows](https://github.com/gohugoio/hugo/workflows/Test/badge.svg)](https://github.com/gohugoio/hugo/actions?query=workflow%3ATest)
[![Go Report Card](https://goreportcard.com/badge/github.com/gohugoio/hugo)](https://goreportcard.com/report/github.com/gohugoio/hugo) [![Go Report Card](https://goreportcard.com/badge/github.com/gohugoio/hugo)](https://goreportcard.com/report/github.com/gohugoio/hugo)
[Website] | [Installation] | [Documentation] | [Support] | [Contributing] | <a rel="me" href="https://fosstodon.org/@gohugoio">Mastodon</a> * [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 ## Overview
Hugo is a [static site generator] written in [Go], optimized for speed and designed for flexibility. With its advanced templating system and fast asset pipelines, Hugo renders a complete site in seconds, often less. 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.
Due to its flexible framework, multilingual support, and powerful taxonomy system, Hugo is widely used to create: Hugo relies on Markdown files with front matter for metadata, and you can run Hugo from any directory.
This works well for shared hosts and other systems where you dont have a privileged account.
- Corporate, government, nonprofit, education, news, event, and project sites Hugo renders a typical website of moderate size in a fraction of a second.
- Documentation sites A good rule of thumb is that each piece of content renders in around 1 millisecond.
- Image portfolios
- Landing pages
- Business, professional, and personal blogs
- Resumes and CVs
Use Hugo's embedded web server during development to instantly see changes to content, structure, behavior, and presentation. Then deploy the site to your host, or push changes to your Git provider for automated builds and deployment. Hugo is designed to work well for any kind of website including blogs, tumbles, and docs.
Hugo's fast asset pipelines include:
- Image processing &ndash; Convert, resize, crop, rotate, adjust colors, apply filters, overlay text and images, and extract EXIF data
- JavaScript bundling &ndash; Transpile TypeScript and JSX to JavaScript, bundle, tree shake, minify, create source maps, and perform SRI hashing.
- Sass processing &ndash; Transpile Sass to CSS, bundle, tree shake, minify, create source maps, perform SRI hashing, and integrate with PostCSS
- Tailwind CSS processing &ndash; Compile Tailwind CSS utility classes into standard CSS, bundle, tree shake, optimize, minify, perform SRI hashing, and integrate with PostCSS
And with [Hugo Modules], you can share content, assets, data, translations, themes, templates, and configuration with other projects via public or private Git repositories.
See the [features] section of the documentation for a comprehensive summary of Hugo's capabilities.
## Sponsors
## Banner Sponsors
<p>&nbsp;</p> <p>&nbsp;</p>
<p float="left"> <p float="left">
<a href="https://www.linode.com/?utm_campaign=hugosponsor&utm_medium=banner&utm_source=hugogithub" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/hugoDocs/master/assets/images/sponsors/linode-logo_standard_light_medium.png" width="200" alt="Linode"></a> <a href="https://www.linode.com/?utm_campaign=hugosponsor&utm_medium=banner&utm_source=hugogithub" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/linode-logo_standard_light_medium.png" width="200" alt="Linode"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp; <p>&nbsp;</p>
<a href="https://www.jetbrains.com/go/?utm_source=OSS&utm_medium=referral&utm_campaign=hugo" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/hugoDocs/master/assets/images/sponsors/goland.svg" width="200" alt="The complete IDE crafted for professional Go developers."></a>
&nbsp;&nbsp;&nbsp;
<a href="https://pinme.eth.limo/?s=hugo" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/hugoDocs/master/assets/images/sponsors/logo-pinme.svg" width="200" alt="PinMe."></a>
</p>
## Editions ## Supported Architectures
Hugo is available in three editions: standard, extended, and extended/deploy. While the standard edition provides core functionality, the extended and extended/deploy editions offer advanced features. 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.
Feature|extended edition|extended/deploy edition Hugo may also be compiled from source wherever the Go compiler tool chain can run, e.g. for other operating systems including Plan 9 and Solaris.
:--|:-:|:-:
Encode to the WebP format when [processing images]. You can decode WebP images with any edition.|:heavy_check_mark:|:heavy_check_mark:
[Transpile Sass to CSS] using the embedded LibSass transpiler. You can use the [Dart Sass] transpiler with any edition.|:heavy_check_mark:|:heavy_check_mark:
Deploy your site directly to a Google Cloud Storage bucket, an AWS S3 bucket, or an Azure Storage container. See&nbsp;[details].|:x:|:heavy_check_mark:
[dart sass]: https://gohugo.io/functions/css/sass/#dart-sass **Complete documentation is available at [Hugo Documentation](https://gohugo.io/getting-started/).**
[processing images]: https://gohugo.io/content-management/image-processing/
[transpile sass to css]: https://gohugo.io/functions/css/sass/
[details]: https://gohugo.io/hosting-and-deployment/hugo-deploy/
Unless your specific deployment needs require the extended/deploy edition, we recommend the extended edition. ## Choose How to Install
## Installation If you want to use Hugo as your site generator, simply install the Hugo binaries.
Install Hugo from a [prebuilt binary], package manager, or package repository. Please see the installation instructions for your operating system: 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.
- [macOS] Finally, you can install the Hugo source code with `go`, build the binaries yourself, and run Hugo that way.
- [Linux] Building the binaries is an easy task for an experienced `go` getter.
- [Windows]
- [DragonFly BSD, FreeBSD, NetBSD, and OpenBSD]
## Build from source ### Install Hugo as Your Site Generator (Binary Install)
Prerequisites to build Hugo from source: Use the [installation instructions in the Hugo documentation](https://gohugo.io/getting-started/installing/).
- Standard edition: Go 1.23.0 or later ### Build and Install the Binary from Source (Using the Go toolchain)
- Extended edition: Go 1.23.0 or later, and GCC
- Extended/deploy edition: Go 1.23.0 or later, and GCC
Build the standard edition: #### Prerequisite Tools
```text * [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, build and install from the Github source:
```bash
go install github.com/gohugoio/hugo@latest go install github.com/gohugoio/hugo@latest
``` ```
Build the extended edition: 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:
```text ```bash
CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest
``` ```
Build the extended/deploy edition: ## The Hugo Documentation
```text The Hugo documentation now lives in its own repository, see https://github.com/gohugoio/hugoDocs. But we do keep a version of that documentation as a `git subtree` in this repository. To build the sub folder `/docs` as a Hugo site, you need to clone this repo:
CGO_ENABLED=1 go install -tags extended,withdeploy github.com/gohugoio/hugo@latest
```bash
git clone git@github.com:gohugoio/hugo.git
``` ```
## Contributing code to Hugo
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=gohugoio/hugo&type=Timeline)](https://star-history.com/#gohugoio/hugo&Timeline)
## Documentation
Hugo's [documentation] includes installation instructions, a quick start guide, conceptual explanations, reference information, and examples.
Please submit documentation issues and pull requests to the [documentation repository].
## Support
Please **do not use the issue queue** for questions or troubleshooting. Unless you are certain that your issue is a software defect, use the [forum].
Hugos [forum] is an active community of users and developers who answer questions, share knowledge, and provide examples. A quick search of over 20,000 topics will often answer your question. Please be sure to read about [requesting help] before asking your first question.
## Contributing
You can contribute to the Hugo project by:
- Answering questions on the [forum]
- Improving the [documentation]
- Monitoring the [issue queue]
- Creating or improving [themes]
- Squashing [bugs]
Please submit documentation issues and pull requests to the [documentation repository].
If you have an idea for an enhancement or new feature, create a new topic on the [forum] in the "Feature" category. This will help you to:
- Determine if the capability already exists
- Measure interest
- Refine the concept
If there is sufficient interest, [create a proposal]. Do not submit a pull request until the project lead accepts the proposal.
For a complete guide to contributing to Hugo, see the [Contribution Guide](CONTRIBUTING.md). For a complete guide to contributing to Hugo, see the [Contribution Guide](CONTRIBUTING.md).
We welcome contributions to Hugo of any kind including documentation, themes,
organization, tutorials, blog posts, bug reports, issues, feature requests,
feature implementations, pull requests, answering questions on the forum,
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
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
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`).
## Dependencies ## Dependencies
Hugo stands on the shoulders of great open source libraries. Run `hugo env --logLevel info` to display a list of dependencies. Hugo stands on the shoulder of many great open source libraries.
<details> If you run `hugo env -v` you will get a complete and up to date list.
<summary>See current dependencies</summary>
```text In Hugo 0.111.2 that list is, in lexical order:
```
cloud.google.com/go/compute="v1.6.1"
cloud.google.com/go/iam="v0.3.0"
cloud.google.com/go/storage="v1.22.0"
cloud.google.com/go="v0.101.0"
github.com/Azure/azure-pipeline-go="v0.2.3"
github.com/Azure/azure-storage-blob-go="v0.14.0"
github.com/Azure/go-autorest/autorest/adal="v0.9.15"
github.com/Azure/go-autorest/autorest/date="v0.3.0"
github.com/Azure/go-autorest/autorest="v0.11.20"
github.com/Azure/go-autorest/logger="v0.2.1"
github.com/Azure/go-autorest/tracing="v0.6.0"
github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69" github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
github.com/PuerkitoBio/goquery="v1.10.1" github.com/PuerkitoBio/purell="v1.1.1"
github.com/alecthomas/chroma/v2="v2.15.0" github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578"
github.com/andybalholm/cascadia="v1.3.3" github.com/alecthomas/chroma/v2="v2.5.0"
github.com/armon/go-radix="v1.0.1-0.20221118154546-54df44f2176c" github.com/armon/go-radix="v1.0.0"
github.com/bep/clocks="v0.5.0" github.com/aws/aws-sdk-go-v2/config="v1.7.0"
github.com/aws/aws-sdk-go-v2/credentials="v1.4.0"
github.com/aws/aws-sdk-go-v2/feature/ec2/imds="v1.5.0"
github.com/aws/aws-sdk-go-v2/internal/ini="v1.2.2"
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url="v1.3.0"
github.com/aws/aws-sdk-go-v2/service/sso="v1.4.0"
github.com/aws/aws-sdk-go-v2/service/sts="v1.7.0"
github.com/aws/aws-sdk-go-v2="v1.9.0"
github.com/aws/aws-sdk-go="v1.43.5"
github.com/aws/smithy-go="v1.8.0"
github.com/bep/clock="v0.3.0"
github.com/bep/debounce="v1.2.0" github.com/bep/debounce="v1.2.0"
github.com/bep/gitmap="v1.6.0" github.com/bep/gitmap="v1.1.2"
github.com/bep/goat="v0.5.0" github.com/bep/goat="v0.5.0"
github.com/bep/godartsass/v2="v2.3.2" github.com/bep/godartsass="v0.16.0"
github.com/bep/golibsass="v1.2.0" github.com/bep/golibsass="v1.1.0"
github.com/bep/gowebp="v0.3.0" github.com/bep/gowebp="v0.2.0"
github.com/bep/imagemeta="v0.8.4" github.com/bep/lazycache="v0.2.0"
github.com/bep/lazycache="v0.7.0" github.com/bep/overlayfs="v0.6.0"
github.com/bep/logg="v0.4.0"
github.com/bep/mclib="v1.20400.20402"
github.com/bep/overlayfs="v0.9.2"
github.com/bep/simplecobra="v0.5.0"
github.com/bep/tmc="v0.5.1" github.com/bep/tmc="v0.5.1"
github.com/cespare/xxhash/v2="v2.3.0" github.com/clbanning/mxj/v2="v2.5.7"
github.com/clbanning/mxj/v2="v2.7.0" github.com/cli/safeexec="v1.0.0"
github.com/cpuguy83/go-md2man/v2="v2.0.4" github.com/cpuguy83/go-md2man/v2="v2.0.2"
github.com/disintegration/gift="v1.2.1" github.com/disintegration/gift="v1.2.1"
github.com/dlclark/regexp2="v1.11.5" github.com/dlclark/regexp2="v1.7.0"
github.com/dop251/goja="v0.0.0-20250125213203-5ef83b82af17" github.com/dustin/go-humanize="v1.0.0"
github.com/evanw/esbuild="v0.24.2" github.com/evanw/esbuild="v0.17.0"
github.com/fatih/color="v1.18.0" github.com/frankban/quicktest="v1.14.4"
github.com/frankban/quicktest="v1.14.6" github.com/fsnotify/fsnotify="v1.6.0"
github.com/fsnotify/fsnotify="v1.8.0" github.com/getkin/kin-openapi="v0.110.0"
github.com/getkin/kin-openapi="v0.129.0"
github.com/ghodss/yaml="v1.0.0" github.com/ghodss/yaml="v1.0.0"
github.com/go-openapi/jsonpointer="v0.21.0" github.com/go-openapi/jsonpointer="v0.19.5"
github.com/go-openapi/swag="v0.23.0" github.com/go-openapi/swag="v0.19.5"
github.com/go-sourcemap/sourcemap="v2.1.4+incompatible" github.com/gobuffalo/flect="v0.3.0"
github.com/gobuffalo/flect="v1.0.3"
github.com/gobwas/glob="v0.2.3" github.com/gobwas/glob="v0.2.3"
github.com/gohugoio/go-i18n/v2="v2.1.3-0.20230805085216-e63c13218d0e" github.com/gohugoio/go-i18n/v2="v2.1.3-0.20210430103248-4c28c89f8013"
github.com/gohugoio/hashstructure="v0.5.0"
github.com/gohugoio/httpcache="v0.7.0"
github.com/gohugoio/hugo-goldmark-extensions/extras="v0.2.0"
github.com/gohugoio/hugo-goldmark-extensions/passthrough="v0.3.0"
github.com/gohugoio/locales="v0.14.0" github.com/gohugoio/locales="v0.14.0"
github.com/gohugoio/localescompressed="v1.0.1" github.com/gohugoio/localescompressed="v1.0.1"
github.com/golang/freetype="v0.0.0-20170609003504-e2365dfdc4a0" github.com/golang-jwt/jwt/v4="v4.0.0"
github.com/google/go-cmp="v0.6.0" github.com/golang/groupcache="v0.0.0-20210331224755-41bb18bfe9da"
github.com/google/pprof="v0.0.0-20250208200701-d0013a598941" github.com/golang/protobuf="v1.5.2"
github.com/gorilla/websocket="v1.5.3" github.com/google/go-cmp="v0.5.9"
github.com/hairyhenderson/go-codeowners="v0.7.0" github.com/google/uuid="v1.3.0"
github.com/hashicorp/golang-lru/v2="v2.0.7" github.com/google/wire="v0.5.0"
github.com/googleapis/gax-go/v2="v2.3.0"
github.com/googleapis/go-type-adapters="v1.0.0"
github.com/gorilla/websocket="v1.5.0"
github.com/hairyhenderson/go-codeowners="v0.2.3-0.20201026200250-cdc7c0759690"
github.com/hashicorp/golang-lru/v2="v2.0.1"
github.com/invopop/yaml="v0.1.0"
github.com/jdkato/prose="v1.2.1" github.com/jdkato/prose="v1.2.1"
github.com/josharian/intern="v1.0.0" github.com/jmespath/go-jmespath="v0.4.0"
github.com/kr/pretty="v0.3.1" github.com/kr/pretty="v0.3.1"
github.com/kr/text="v0.2.0" github.com/kr/text="v0.2.0"
github.com/kyokomi/emoji/v2="v2.2.13" github.com/kyokomi/emoji/v2="v2.2.11"
github.com/lucasb-eyer/go-colorful="v1.2.0" github.com/mailru/easyjson="v0.0.0-20190626092158-b2ccc519800e"
github.com/mailru/easyjson="v0.7.7" github.com/marekm4/color-extractor="v1.2.0"
github.com/makeworld-the-better-one/dither/v2="v2.4.0" github.com/mattn/go-ieproxy="v0.0.1"
github.com/marekm4/color-extractor="v1.2.1" github.com/mattn/go-isatty="v0.0.17"
github.com/mattn/go-colorable="v0.1.13"
github.com/mattn/go-isatty="v0.0.20"
github.com/mattn/go-runewidth="v0.0.9" github.com/mattn/go-runewidth="v0.0.9"
github.com/mazznoer/csscolorparser="v0.1.5" github.com/mitchellh/hashstructure="v1.1.0"
github.com/mitchellh/mapstructure="v1.5.1-0.20231216201459-8508981c8b6c" github.com/mitchellh/mapstructure="v1.5.0"
github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826" github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826"
github.com/muesli/smartcrop="v0.3.0" github.com/muesli/smartcrop="v0.3.0"
github.com/niklasfasching/go-org="v1.7.0" github.com/niklasfasching/go-org="v1.6.5"
github.com/oasdiff/yaml3="v0.0.0-20241210130736-a94c01f36349"
github.com/oasdiff/yaml="v0.0.0-20241210131133-6b86fb107d80"
github.com/olekukonko/tablewriter="v0.0.5" github.com/olekukonko/tablewriter="v0.0.5"
github.com/pbnjay/memory="v0.0.0-20210728143218-7b4eea64cf58" github.com/pelletier/go-toml/v2="v2.0.6"
github.com/pelletier/go-toml/v2="v2.2.3" github.com/rogpeppe/go-internal="v1.9.0"
github.com/perimeterx/marshmallow="v1.1.5"
github.com/pkg/browser="v0.0.0-20240102092130-5ac0b6a4141c"
github.com/pkg/errors="v0.9.1"
github.com/rivo/uniseg="v0.4.7"
github.com/rogpeppe/go-internal="v1.13.1"
github.com/russross/blackfriday/v2="v2.1.0" github.com/russross/blackfriday/v2="v2.1.0"
github.com/sass/libsass="3.6.6" github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
github.com/spf13/afero="v1.11.0" github.com/sanity-io/litter="v1.5.5"
github.com/spf13/cast="v1.7.1" github.com/sass/libsass="3.6.5"
github.com/spf13/cobra="v1.8.1" github.com/spf13/afero="v1.9.3"
github.com/spf13/fsync="v0.10.1" github.com/spf13/cast="v1.5.0"
github.com/spf13/pflag="v1.0.6" github.com/spf13/cobra="v1.6.1"
github.com/tdewolff/minify/v2="v2.20.37" github.com/spf13/fsync="v0.9.0"
github.com/tdewolff/parse/v2="v2.7.15" github.com/spf13/jwalterweatherman="v1.1.0"
github.com/tetratelabs/wazero="v1.8.2" github.com/spf13/pflag="v1.0.5"
github.com/webmproject/libwebp="v1.3.2" github.com/tdewolff/minify/v2="v2.12.4"
github.com/yuin/goldmark-emoji="v1.0.4" github.com/tdewolff/parse/v2="v2.6.5"
github.com/yuin/goldmark="v1.7.8" github.com/webmproject/libwebp="v1.2.4"
go.uber.org/automaxprocs="v1.5.3" github.com/yuin/goldmark="v1.5.4"
golang.org/x/crypto="v0.33.0" go.opencensus.io="v0.24.0"
golang.org/x/exp="v0.0.0-20250210185358-939b2ce775ac" go.uber.org/atomic="v1.10.0"
golang.org/x/image="v0.24.0" gocloud.dev="v0.24.0"
golang.org/x/mod="v0.23.0" golang.org/x/crypto="v0.3.0"
golang.org/x/net="v0.35.0" golang.org/x/exp="v0.0.0-20221031165847-c99f073a8326"
golang.org/x/sync="v0.11.0" golang.org/x/image="v0.5.0"
golang.org/x/sys="v0.30.0" golang.org/x/net="v0.7.0"
golang.org/x/text="v0.22.0" golang.org/x/oauth2="v0.2.0"
golang.org/x/tools="v0.30.0" golang.org/x/sync="v0.1.0"
golang.org/x/xerrors="v0.0.0-20240903120638-7835f813f4da" golang.org/x/sys="v0.5.0"
gonum.org/v1/plot="v0.15.0" golang.org/x/text="v0.7.0"
google.golang.org/protobuf="v1.36.5" golang.org/x/tools="v0.4.0"
golang.org/x/xerrors="v0.0.0-20220907171357-04be3eba64a2"
google.golang.org/api="v0.76.0"
google.golang.org/genproto="v0.0.0-20220426171045-31bebdecfb46"
google.golang.org/grpc="v1.46.0"
google.golang.org/protobuf="v1.28.1"
gopkg.in/yaml.v2="v2.4.0" gopkg.in/yaml.v2="v2.4.0"
gopkg.in/yaml.v3="v3.0.1" gopkg.in/yaml.v3="v3.0.1"
oss.terrastruct.com/d2="v0.6.9"
oss.terrastruct.com/util-go="v0.0.0-20241005222610-44c011a04896"
rsc.io/qr="v0.2.0"
software.sslmate.com/src/go-pkcs12="v0.2.0"
``` ```
</details>

View file

@ -4,4 +4,4 @@
Please report (suspected) security vulnerabilities to **[bjorn.erik.pedersen@gmail.com](mailto:bjorn.erik.pedersen@gmail.com)**. You will receive a response from us within 48 hours. If we can confirm the issue, we will release a patch as soon as possible depending on the complexity of the issue but historically within days. Please report (suspected) security vulnerabilities to **[bjorn.erik.pedersen@gmail.com](mailto:bjorn.erik.pedersen@gmail.com)**. You will receive a response from us within 48 hours. If we can confirm the issue, we will release a patch as soon as possible depending on the complexity of the issue but historically within days.
Also see [Hugo's Security Model](https://gohugo.io/about/security/). Also see [Hugo's Security Model](https://gohugo.io/about/security-model/).

37
bench.sh Executable file
View file

@ -0,0 +1,37 @@
#!/usr/bin/env bash
# allow user to override go executable by running as GOEXE=xxx make ...
GOEXE="${GOEXE-go}"
# Convenience script to
# - For a given branch
# - Run benchmark tests for a given package
# - Do the same for master
# - then compare the two runs with benchcmp
benchFilter=".*"
if (( $# < 2 ));
then
echo "USAGE: ./bench.sh <git-branch> <package-to-bench> (and <benchmark filter> (regexp, optional))"
exit 1
fi
if [ $# -eq 3 ]; then
benchFilter=$3
fi
BRANCH=$1
PACKAGE=$2
git checkout $BRANCH
"${GOEXE}" test -test.run=NONE -bench="$benchFilter" -test.benchmem=true ./$PACKAGE > /tmp/bench-$PACKAGE-$BRANCH.txt
git checkout master
"${GOEXE}" test -test.run=NONE -bench="$benchFilter" -test.benchmem=true ./$PACKAGE > /tmp/bench-$PACKAGE-master.txt
benchcmp /tmp/bench-$PACKAGE-master.txt /tmp/bench-$PACKAGE-$BRANCH.txt

12
benchSite.sh Executable file
View file

@ -0,0 +1,12 @@
#!/bin/bash
# allow user to override go executable by running as GOEXE=xxx make ...
GOEXE="${GOEXE-go}"
# Send in a regexp matching the benchmarks you want to run, i.e. './benchSite.sh "YAML"'.
# Note the quotes, which will be needed for more complex expressions.
# The above will run all variations, but only for front matter YAML.
echo "Running with BenchmarkSiteBuilding/${1}"
"${GOEXE}" test -run="NONE" -bench="BenchmarkSiteBuilding/${1}" -test.benchmem=true ./hugolib -memprofile mem.prof -count 3 -cpuprofile cpu.prof

1
benchbep.sh Executable file
View file

@ -0,0 +1 @@
gobench -package=./hugolib -bench="BenchmarkSiteNew/Deep_content_tree"

1
bepdock.sh Executable file
View file

@ -0,0 +1 @@
docker run --rm --mount type=bind,source="$(pwd)",target=/hugo -w /hugo -i -t bepsays/ci-goreleaser:1.11-2 /bin/bash

2
cache/docs.go vendored
View file

@ -1,2 +1,2 @@
// Package cache contains the different cache implementations. // Package cache contains the differenct cache implementations.
package cache package cache

View file

@ -1,647 +0,0 @@
// Copyright 2024 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 dynacache
import (
"context"
"fmt"
"math"
"path"
"regexp"
"runtime"
"sync"
"time"
"github.com/bep/lazycache"
"github.com/bep/logg"
"github.com/gohugoio/hugo/common/collections"
"github.com/gohugoio/hugo/common/herrors"
"github.com/gohugoio/hugo/common/loggers"
"github.com/gohugoio/hugo/common/paths"
"github.com/gohugoio/hugo/common/rungroup"
"github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/helpers"
"github.com/gohugoio/hugo/identity"
"github.com/gohugoio/hugo/resources/resource"
)
const minMaxSize = 10
type KeyIdentity struct {
Key any
Identity identity.Identity
}
// New creates a new cache.
func New(opts Options) *Cache {
if opts.CheckInterval == 0 {
opts.CheckInterval = time.Second * 2
}
if opts.MaxSize == 0 {
opts.MaxSize = 100000
}
if opts.Log == nil {
panic("nil Log")
}
if opts.MinMaxSize == 0 {
opts.MinMaxSize = 30
}
stats := &stats{
opts: opts,
adjustmentFactor: 1.0,
currentMaxSize: opts.MaxSize,
availableMemory: config.GetMemoryLimit(),
}
infol := opts.Log.InfoCommand("dynacache")
evictedIdentities := collections.NewStack[KeyIdentity]()
onEvict := func(k, v any) {
if !opts.Watching {
return
}
identity.WalkIdentitiesShallow(v, func(level int, id identity.Identity) bool {
evictedIdentities.Push(KeyIdentity{Key: k, Identity: id})
return false
})
resource.MarkStale(v)
}
c := &Cache{
partitions: make(map[string]PartitionManager),
onEvict: onEvict,
evictedIdentities: evictedIdentities,
opts: opts,
stats: stats,
infol: infol,
}
c.stop = c.start()
return c
}
// Options for the cache.
type Options struct {
Log loggers.Logger
CheckInterval time.Duration
MaxSize int
MinMaxSize int
Watching bool
}
// Options for a partition.
type OptionsPartition struct {
// When to clear the this partition.
ClearWhen ClearWhen
// Weight is a number between 1 and 100 that indicates how, in general, how big this partition may get.
Weight int
}
func (o OptionsPartition) WeightFraction() float64 {
return float64(o.Weight) / 100
}
func (o OptionsPartition) CalculateMaxSize(maxSizePerPartition int) int {
return int(math.Floor(float64(maxSizePerPartition) * o.WeightFraction()))
}
// A dynamic partitioned cache.
type Cache struct {
mu sync.RWMutex
partitions map[string]PartitionManager
onEvict func(k, v any)
evictedIdentities *collections.Stack[KeyIdentity]
opts Options
infol logg.LevelLogger
stats *stats
stopOnce sync.Once
stop func()
}
// DrainEvictedIdentities drains the evicted identities from the cache.
func (c *Cache) DrainEvictedIdentities() []KeyIdentity {
return c.evictedIdentities.Drain()
}
// DrainEvictedIdentitiesMatching drains the evicted identities from the cache that match the given predicate.
func (c *Cache) DrainEvictedIdentitiesMatching(predicate func(KeyIdentity) bool) []KeyIdentity {
return c.evictedIdentities.DrainMatching(predicate)
}
// ClearMatching clears all partition for which the predicate returns true.
func (c *Cache) ClearMatching(predicatePartition func(k string, p PartitionManager) bool, predicateValue func(k, v any) bool) {
if predicatePartition == nil {
predicatePartition = func(k string, p PartitionManager) bool { return true }
}
if predicateValue == nil {
panic("nil predicateValue")
}
g := rungroup.Run[PartitionManager](context.Background(), rungroup.Config[PartitionManager]{
NumWorkers: len(c.partitions),
Handle: func(ctx context.Context, partition PartitionManager) error {
partition.clearMatching(predicateValue)
return nil
},
})
for k, p := range c.partitions {
if !predicatePartition(k, p) {
continue
}
g.Enqueue(p)
}
g.Wait()
}
// ClearOnRebuild prepares the cache for a new rebuild taking the given changeset into account.
// predicate is optional and will clear any entry for which it returns true.
func (c *Cache) ClearOnRebuild(predicate func(k, v any) bool, changeset ...identity.Identity) {
g := rungroup.Run[PartitionManager](context.Background(), rungroup.Config[PartitionManager]{
NumWorkers: len(c.partitions),
Handle: func(ctx context.Context, partition PartitionManager) error {
partition.clearOnRebuild(predicate, changeset...)
return nil
},
})
for _, p := range c.partitions {
g.Enqueue(p)
}
g.Wait()
// Clear any entries marked as stale above.
g = rungroup.Run[PartitionManager](context.Background(), rungroup.Config[PartitionManager]{
NumWorkers: len(c.partitions),
Handle: func(ctx context.Context, partition PartitionManager) error {
partition.clearStale()
return nil
},
})
for _, p := range c.partitions {
g.Enqueue(p)
}
g.Wait()
}
type keysProvider interface {
Keys() []string
}
// Keys returns a list of keys in all partitions.
func (c *Cache) Keys(predicate func(s string) bool) []string {
if predicate == nil {
predicate = func(s string) bool { return true }
}
var keys []string
for pn, g := range c.partitions {
pkeys := g.(keysProvider).Keys()
for _, k := range pkeys {
p := path.Join(pn, k)
if predicate(p) {
keys = append(keys, p)
}
}
}
return keys
}
func calculateMaxSizePerPartition(maxItemsTotal, totalWeightQuantity, numPartitions int) int {
if numPartitions == 0 {
panic("numPartitions must be > 0")
}
if totalWeightQuantity == 0 {
panic("totalWeightQuantity must be > 0")
}
avgWeight := float64(totalWeightQuantity) / float64(numPartitions)
return int(math.Floor(float64(maxItemsTotal) / float64(numPartitions) * (100.0 / avgWeight)))
}
// Stop stops the cache.
func (c *Cache) Stop() {
c.stopOnce.Do(func() {
c.stop()
})
}
func (c *Cache) adjustCurrentMaxSize() {
c.mu.RLock()
defer c.mu.RUnlock()
if len(c.partitions) == 0 {
return
}
var m runtime.MemStats
runtime.ReadMemStats(&m)
s := c.stats
s.memstatsCurrent = m
// fmt.Printf("\n\nAvailable = %v\nAlloc = %v\nTotalAlloc = %v\nSys = %v\nNumGC = %v\nMaxSize = %d\nAdjustmentFactor=%f\n\n", helpers.FormatByteCount(s.availableMemory), helpers.FormatByteCount(m.Alloc), helpers.FormatByteCount(m.TotalAlloc), helpers.FormatByteCount(m.Sys), m.NumGC, c.stats.currentMaxSize, s.adjustmentFactor)
if s.availableMemory >= s.memstatsCurrent.Alloc {
if s.adjustmentFactor <= 1.0 {
s.adjustmentFactor += 0.2
}
} else {
// We're low on memory.
s.adjustmentFactor -= 0.4
}
if s.adjustmentFactor <= 0 {
s.adjustmentFactor = 0.05
}
if !s.adjustCurrentMaxSize() {
return
}
totalWeight := 0
for _, pm := range c.partitions {
totalWeight += pm.getOptions().Weight
}
maxSizePerPartition := calculateMaxSizePerPartition(c.stats.currentMaxSize, totalWeight, len(c.partitions))
evicted := 0
for _, p := range c.partitions {
evicted += p.adjustMaxSize(p.getOptions().CalculateMaxSize(maxSizePerPartition))
}
if evicted > 0 {
c.infol.
WithFields(
logg.Fields{
{Name: "evicted", Value: evicted},
{Name: "numGC", Value: m.NumGC},
{Name: "limit", Value: helpers.FormatByteCount(c.stats.availableMemory)},
{Name: "alloc", Value: helpers.FormatByteCount(m.Alloc)},
{Name: "totalAlloc", Value: helpers.FormatByteCount(m.TotalAlloc)},
},
).Logf("adjusted partitions' max size")
}
}
func (c *Cache) start() func() {
ticker := time.NewTicker(c.opts.CheckInterval)
quit := make(chan struct{})
go func() {
for {
select {
case <-ticker.C:
c.adjustCurrentMaxSize()
// Reset the ticker to avoid drift.
ticker.Reset(c.opts.CheckInterval)
case <-quit:
ticker.Stop()
return
}
}
}()
return func() {
close(quit)
}
}
var partitionNameRe = regexp.MustCompile(`^\/[a-zA-Z0-9]{4}(\/[a-zA-Z0-9]+)?(\/[a-zA-Z0-9]+)?`)
// GetOrCreatePartition gets or creates a partition with the given name.
func GetOrCreatePartition[K comparable, V any](c *Cache, name string, opts OptionsPartition) *Partition[K, V] {
if c == nil {
panic("nil Cache")
}
if opts.Weight < 1 || opts.Weight > 100 {
panic("invalid Weight, must be between 1 and 100")
}
if partitionNameRe.FindString(name) != name {
panic(fmt.Sprintf("invalid partition name %q", name))
}
c.mu.RLock()
p, found := c.partitions[name]
c.mu.RUnlock()
if found {
return p.(*Partition[K, V])
}
c.mu.Lock()
defer c.mu.Unlock()
// Double check.
p, found = c.partitions[name]
if found {
return p.(*Partition[K, V])
}
// At this point, we don't know the number of partitions or their configuration, but
// this will be re-adjusted later.
const numberOfPartitionsEstimate = 10
maxSize := opts.CalculateMaxSize(c.opts.MaxSize / numberOfPartitionsEstimate)
onEvict := func(k K, v V) {
c.onEvict(k, v)
}
// Create a new partition and cache it.
partition := &Partition[K, V]{
c: lazycache.New(lazycache.Options[K, V]{MaxEntries: maxSize, OnEvict: onEvict}),
maxSize: maxSize,
trace: c.opts.Log.Logger().WithLevel(logg.LevelTrace).WithField("partition", name),
opts: opts,
}
c.partitions[name] = partition
return partition
}
// Partition is a partition in the cache.
type Partition[K comparable, V any] struct {
c *lazycache.Cache[K, V]
zero V
trace logg.LevelLogger
opts OptionsPartition
maxSize int
}
// GetOrCreate gets or creates a value for the given key.
func (p *Partition[K, V]) GetOrCreate(key K, create func(key K) (V, error)) (V, error) {
v, err := p.doGetOrCreate(key, create)
if err != nil {
return p.zero, err
}
if resource.StaleVersion(v) > 0 {
p.c.Delete(key)
return p.doGetOrCreate(key, create)
}
return v, err
}
func (p *Partition[K, V]) doGetOrCreate(key K, create func(key K) (V, error)) (V, error) {
v, _, err := p.c.GetOrCreate(key, create)
return v, err
}
func (p *Partition[K, V]) GetOrCreateWitTimeout(key K, duration time.Duration, create func(key K) (V, error)) (V, error) {
v, err := p.doGetOrCreateWitTimeout(key, duration, create)
if err != nil {
return p.zero, err
}
if resource.StaleVersion(v) > 0 {
p.c.Delete(key)
return p.doGetOrCreateWitTimeout(key, duration, create)
}
return v, err
}
// GetOrCreateWitTimeout gets or creates a value for the given key and times out if the create function
// takes too long.
func (p *Partition[K, V]) doGetOrCreateWitTimeout(key K, duration time.Duration, create func(key K) (V, error)) (V, error) {
resultch := make(chan V, 1)
errch := make(chan error, 1)
go func() {
var (
v V
err error
)
defer func() {
if r := recover(); r != nil {
if rerr, ok := r.(error); ok {
err = rerr
} else {
err = fmt.Errorf("panic: %v", r)
}
}
if err != nil {
errch <- err
} else {
resultch <- v
}
}()
v, _, err = p.c.GetOrCreate(key, create)
}()
select {
case v := <-resultch:
return v, nil
case err := <-errch:
return p.zero, err
case <-time.After(duration):
return p.zero, &herrors.TimeoutError{
Duration: duration,
}
}
}
func (p *Partition[K, V]) clearMatching(predicate func(k, v any) bool) {
p.c.DeleteFunc(func(key K, v V) bool {
if predicate(key, v) {
p.trace.Log(
logg.StringFunc(
func() string {
return fmt.Sprintf("clearing cache key %v", key)
},
),
)
return true
}
return false
})
}
func (p *Partition[K, V]) clearOnRebuild(predicate func(k, v any) bool, changeset ...identity.Identity) {
if predicate == nil {
predicate = func(k, v any) bool {
return false
}
}
opts := p.getOptions()
if opts.ClearWhen == ClearNever {
return
}
if opts.ClearWhen == ClearOnRebuild {
// Clear all.
p.Clear()
return
}
depsFinder := identity.NewFinder(identity.FinderConfig{})
shouldDelete := func(key K, v V) bool {
// We always clear elements marked as stale.
if resource.StaleVersion(v) > 0 {
return true
}
// Now check if this entry has changed based on the changeset
// based on filesystem events.
if len(changeset) == 0 {
// Nothing changed.
return false
}
var probablyDependent bool
identity.WalkIdentitiesShallow(v, func(level int, id2 identity.Identity) bool {
for _, id := range changeset {
if r := depsFinder.Contains(id, id2, -1); r > 0 {
// It's probably dependent, evict from cache.
probablyDependent = true
return true
}
}
return false
})
return probablyDependent
}
// First pass.
// Second pass needs to be done in a separate loop to catch any
// elements marked as stale in the other partitions.
p.c.DeleteFunc(func(key K, v V) bool {
if predicate(key, v) || shouldDelete(key, v) {
p.trace.Log(
logg.StringFunc(
func() string {
return fmt.Sprintf("first pass: clearing cache key %v", key)
},
),
)
return true
}
return false
})
}
func (p *Partition[K, V]) Keys() []K {
var keys []K
p.c.DeleteFunc(func(key K, v V) bool {
keys = append(keys, key)
return false
})
return keys
}
func (p *Partition[K, V]) clearStale() {
p.c.DeleteFunc(func(key K, v V) bool {
staleVersion := resource.StaleVersion(v)
if staleVersion > 0 {
p.trace.Log(
logg.StringFunc(
func() string {
return fmt.Sprintf("second pass: clearing cache key %v", key)
},
),
)
}
return staleVersion > 0
})
}
// adjustMaxSize adjusts the max size of the and returns the number of items evicted.
func (p *Partition[K, V]) adjustMaxSize(newMaxSize int) int {
if newMaxSize < minMaxSize {
newMaxSize = minMaxSize
}
oldMaxSize := p.maxSize
if newMaxSize == oldMaxSize {
return 0
}
p.maxSize = newMaxSize
// fmt.Println("Adjusting max size of partition from", oldMaxSize, "to", newMaxSize)
return p.c.Resize(newMaxSize)
}
func (p *Partition[K, V]) getMaxSize() int {
return p.maxSize
}
func (p *Partition[K, V]) getOptions() OptionsPartition {
return p.opts
}
func (p *Partition[K, V]) Clear() {
p.c.DeleteFunc(func(key K, v V) bool {
return true
})
}
func (p *Partition[K, V]) Get(ctx context.Context, key K) (V, bool) {
return p.c.Get(key)
}
type PartitionManager interface {
adjustMaxSize(addend int) int
getMaxSize() int
getOptions() OptionsPartition
clearOnRebuild(predicate func(k, v any) bool, changeset ...identity.Identity)
clearMatching(predicate func(k, v any) bool)
clearStale()
}
const (
ClearOnRebuild ClearWhen = iota + 1
ClearOnChange
ClearNever
)
type ClearWhen int
type stats struct {
opts Options
memstatsCurrent runtime.MemStats
currentMaxSize int
availableMemory uint64
adjustmentFactor float64
}
func (s *stats) adjustCurrentMaxSize() bool {
newCurrentMaxSize := int(math.Floor(float64(s.opts.MaxSize) * s.adjustmentFactor))
if newCurrentMaxSize < s.opts.MinMaxSize {
newCurrentMaxSize = int(s.opts.MinMaxSize)
}
changed := newCurrentMaxSize != s.currentMaxSize
s.currentMaxSize = newCurrentMaxSize
return changed
}
// CleanKey turns s into a format suitable for a cache key for this package.
// The key will be a Unix-styled path with a leading slash but no trailing slash.
func CleanKey(s string) string {
return path.Clean(paths.ToSlashPreserveLeading(s))
}

View file

@ -1,230 +0,0 @@
// Copyright 2024 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 dynacache
import (
"errors"
"fmt"
"path/filepath"
"testing"
"time"
qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/common/loggers"
"github.com/gohugoio/hugo/identity"
"github.com/gohugoio/hugo/resources/resource"
)
var (
_ resource.StaleInfo = (*testItem)(nil)
_ identity.Identity = (*testItem)(nil)
)
type testItem struct {
name string
staleVersion uint32
}
func (t testItem) StaleVersion() uint32 {
return t.staleVersion
}
func (t testItem) IdentifierBase() string {
return t.name
}
func TestCache(t *testing.T) {
t.Parallel()
c := qt.New(t)
cache := New(Options{
Log: loggers.NewDefault(),
})
c.Cleanup(func() {
cache.Stop()
})
opts := OptionsPartition{Weight: 30}
c.Assert(cache, qt.Not(qt.IsNil))
p1 := GetOrCreatePartition[string, testItem](cache, "/aaaa/bbbb", opts)
c.Assert(p1, qt.Not(qt.IsNil))
p2 := GetOrCreatePartition[string, testItem](cache, "/aaaa/bbbb", opts)
c.Assert(func() { GetOrCreatePartition[string, testItem](cache, "foo bar", opts) }, qt.PanicMatches, ".*invalid partition name.*")
c.Assert(func() { GetOrCreatePartition[string, testItem](cache, "/aaaa/cccc", OptionsPartition{Weight: 1234}) }, qt.PanicMatches, ".*invalid Weight.*")
c.Assert(p2, qt.Equals, p1)
p3 := GetOrCreatePartition[string, testItem](cache, "/aaaa/cccc", opts)
c.Assert(p3, qt.Not(qt.IsNil))
c.Assert(p3, qt.Not(qt.Equals), p1)
c.Assert(func() { New(Options{}) }, qt.PanicMatches, ".*nil Log.*")
}
func TestCalculateMaxSizePerPartition(t *testing.T) {
t.Parallel()
c := qt.New(t)
c.Assert(calculateMaxSizePerPartition(1000, 500, 5), qt.Equals, 200)
c.Assert(calculateMaxSizePerPartition(1000, 250, 5), qt.Equals, 400)
c.Assert(func() { calculateMaxSizePerPartition(1000, 250, 0) }, qt.PanicMatches, ".*must be > 0.*")
c.Assert(func() { calculateMaxSizePerPartition(1000, 0, 1) }, qt.PanicMatches, ".*must be > 0.*")
}
func TestCleanKey(t *testing.T) {
c := qt.New(t)
c.Assert(CleanKey("a/b/c"), qt.Equals, "/a/b/c")
c.Assert(CleanKey("/a/b/c"), qt.Equals, "/a/b/c")
c.Assert(CleanKey("a/b/c/"), qt.Equals, "/a/b/c")
c.Assert(CleanKey(filepath.FromSlash("/a/b/c/")), qt.Equals, "/a/b/c")
}
func newTestCache(t *testing.T) *Cache {
cache := New(
Options{
Log: loggers.NewDefault(),
},
)
p1 := GetOrCreatePartition[string, testItem](cache, "/aaaa/bbbb", OptionsPartition{Weight: 30, ClearWhen: ClearOnRebuild})
p2 := GetOrCreatePartition[string, testItem](cache, "/aaaa/cccc", OptionsPartition{Weight: 30, ClearWhen: ClearOnChange})
p1.GetOrCreate("clearOnRebuild", func(string) (testItem, error) {
return testItem{}, nil
})
p2.GetOrCreate("clearBecauseStale", func(string) (testItem, error) {
return testItem{
staleVersion: 32,
}, nil
})
p2.GetOrCreate("clearBecauseIdentityChanged", func(string) (testItem, error) {
return testItem{
name: "changed",
}, nil
})
p2.GetOrCreate("clearNever", func(string) (testItem, error) {
return testItem{
staleVersion: 0,
}, nil
})
t.Cleanup(func() {
cache.Stop()
})
return cache
}
func TestClear(t *testing.T) {
t.Parallel()
c := qt.New(t)
predicateAll := func(string) bool {
return true
}
cache := newTestCache(t)
c.Assert(cache.Keys(predicateAll), qt.HasLen, 4)
cache.ClearOnRebuild(nil)
// Stale items are always cleared.
c.Assert(cache.Keys(predicateAll), qt.HasLen, 2)
cache = newTestCache(t)
cache.ClearOnRebuild(nil, identity.StringIdentity("changed"))
c.Assert(cache.Keys(nil), qt.HasLen, 1)
cache = newTestCache(t)
cache.ClearMatching(nil, func(k, v any) bool {
return k.(string) == "clearOnRebuild"
})
c.Assert(cache.Keys(predicateAll), qt.HasLen, 3)
cache.adjustCurrentMaxSize()
}
func TestPanicInCreate(t *testing.T) {
t.Parallel()
c := qt.New(t)
cache := newTestCache(t)
p1 := GetOrCreatePartition[string, testItem](cache, "/aaaa/bbbb", OptionsPartition{Weight: 30, ClearWhen: ClearOnRebuild})
willPanic := func(i int) func() {
return func() {
p1.GetOrCreate(fmt.Sprintf("panic-%d", i), func(key string) (testItem, error) {
panic(errors.New(key))
})
}
}
// GetOrCreateWitTimeout needs to recover from panics in the create func.
willErr := func(i int) error {
_, err := p1.GetOrCreateWitTimeout(fmt.Sprintf("error-%d", i), 10*time.Second, func(key string) (testItem, error) {
return testItem{}, errors.New(key)
})
return err
}
for i := range 3 {
for range 3 {
c.Assert(willPanic(i), qt.PanicMatches, fmt.Sprintf("panic-%d", i))
c.Assert(willErr(i), qt.ErrorMatches, fmt.Sprintf("error-%d", i))
}
}
// Test the same keys again without the panic.
for i := range 3 {
for range 3 {
v, err := p1.GetOrCreate(fmt.Sprintf("panic-%d", i), func(key string) (testItem, error) {
return testItem{
name: key,
}, nil
})
c.Assert(err, qt.IsNil)
c.Assert(v.name, qt.Equals, fmt.Sprintf("panic-%d", i))
v, err = p1.GetOrCreateWitTimeout(fmt.Sprintf("error-%d", i), 10*time.Second, func(key string) (testItem, error) {
return testItem{
name: key,
}, nil
})
c.Assert(err, qt.IsNil)
c.Assert(v.name, qt.Equals, fmt.Sprintf("error-%d", i))
}
}
}
func TestAdjustCurrentMaxSize(t *testing.T) {
t.Parallel()
c := qt.New(t)
cache := newTestCache(t)
alloc := cache.stats.memstatsCurrent.Alloc
cache.adjustCurrentMaxSize()
c.Assert(cache.stats.memstatsCurrent.Alloc, qt.Not(qt.Equals), alloc)
}

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2018 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -23,9 +23,7 @@ import (
"sync" "sync"
"time" "time"
"github.com/gohugoio/httpcache"
"github.com/gohugoio/hugo/common/hugio" "github.com/gohugoio/hugo/common/hugio"
"github.com/gohugoio/hugo/hugofs"
"github.com/gohugoio/hugo/helpers" "github.com/gohugoio/hugo/helpers"
@ -53,9 +51,6 @@ type Cache struct {
pruneAllRootDir string pruneAllRootDir string
nlocker *lockTracker nlocker *lockTracker
initOnce sync.Once
initErr error
} }
type lockTracker struct { type lockTracker struct {
@ -108,23 +103,9 @@ func (l *lockedFile) Close() error {
return l.File.Close() return l.File.Close()
} }
func (c *Cache) init() error {
c.initOnce.Do(func() {
// Create the base dir if it does not exist.
if err := c.Fs.MkdirAll("", 0o777); err != nil && !os.IsExist(err) {
c.initErr = err
}
})
return c.initErr
}
// WriteCloser returns a transactional writer into the cache. // WriteCloser returns a transactional writer into the cache.
// It's important that it's closed when done. // It's important that it's closed when done.
func (c *Cache) WriteCloser(id string) (ItemInfo, io.WriteCloser, error) { func (c *Cache) WriteCloser(id string) (ItemInfo, io.WriteCloser, error) {
if err := c.init(); err != nil {
return ItemInfo{}, nil, err
}
id = cleanID(id) id = cleanID(id)
c.nlocker.Lock(id) c.nlocker.Lock(id)
@ -148,12 +129,7 @@ func (c *Cache) WriteCloser(id string) (ItemInfo, io.WriteCloser, error) {
// it when done. // it when done.
func (c *Cache) ReadOrCreate(id string, func (c *Cache) ReadOrCreate(id string,
read func(info ItemInfo, r io.ReadSeeker) error, read func(info ItemInfo, r io.ReadSeeker) error,
create func(info ItemInfo, w io.WriteCloser) error, create func(info ItemInfo, w io.WriteCloser) error) (info ItemInfo, err error) {
) (info ItemInfo, err error) {
if err := c.init(); err != nil {
return ItemInfo{}, err
}
id = cleanID(id) id = cleanID(id)
c.nlocker.Lock(id) c.nlocker.Lock(id)
@ -183,22 +159,10 @@ func (c *Cache) ReadOrCreate(id string,
return return
} }
// NamedLock locks the given id. The lock is released when the returned function is called.
func (c *Cache) NamedLock(id string) func() {
id = cleanID(id)
c.nlocker.Lock(id)
return func() {
c.nlocker.Unlock(id)
}
}
// GetOrCreate tries to get the file with the given id from cache. If not found or expired, create will // GetOrCreate tries to get the file with the given id from cache. If not found or expired, create will
// be invoked and the result cached. // be invoked and the result cached.
// This method is protected by a named lock using the given id as identifier. // This method is protected by a named lock using the given id as identifier.
func (c *Cache) GetOrCreate(id string, create func() (io.ReadCloser, error)) (ItemInfo, io.ReadCloser, error) { func (c *Cache) GetOrCreate(id string, create func() (io.ReadCloser, error)) (ItemInfo, io.ReadCloser, error) {
if err := c.init(); err != nil {
return ItemInfo{}, nil, err
}
id = cleanID(id) id = cleanID(id)
c.nlocker.Lock(id) c.nlocker.Lock(id)
@ -228,30 +192,11 @@ func (c *Cache) GetOrCreate(id string, create func() (io.ReadCloser, error)) (It
var buff bytes.Buffer var buff bytes.Buffer
return info, return info,
hugio.ToReadCloser(&buff), hugio.ToReadCloser(&buff),
c.writeReader(id, io.TeeReader(r, &buff)) afero.WriteReader(c.Fs, id, io.TeeReader(r, &buff))
}
func (c *Cache) writeReader(id string, r io.Reader) error {
dir := filepath.Dir(id)
if dir != "" {
_ = c.Fs.MkdirAll(dir, 0o777)
}
f, err := c.Fs.Create(id)
if err != nil {
return err
}
defer f.Close()
_, _ = io.Copy(f, r)
return nil
} }
// GetOrCreateBytes is the same as GetOrCreate, but produces a byte slice. // GetOrCreateBytes is the same as GetOrCreate, but produces a byte slice.
func (c *Cache) GetOrCreateBytes(id string, create func() ([]byte, error)) (ItemInfo, []byte, error) { func (c *Cache) GetOrCreateBytes(id string, create func() ([]byte, error)) (ItemInfo, []byte, error) {
if err := c.init(); err != nil {
return ItemInfo{}, nil, err
}
id = cleanID(id) id = cleanID(id)
c.nlocker.Lock(id) c.nlocker.Lock(id)
@ -279,18 +224,14 @@ func (c *Cache) GetOrCreateBytes(id string, create func() ([]byte, error)) (Item
return info, b, nil return info, b, nil
} }
if err := c.writeReader(id, bytes.NewReader(b)); err != nil { if err := afero.WriteReader(c.Fs, id, bytes.NewReader(b)); err != nil {
return info, nil, err return info, nil, err
} }
return info, b, nil return info, b, nil
} }
// GetBytes gets the file content with the given id from the cache, nil if none found. // GetBytes gets the file content with the given id from the cache, nil if none found.
func (c *Cache) GetBytes(id string) (ItemInfo, []byte, error) { func (c *Cache) GetBytes(id string) (ItemInfo, []byte, error) {
if err := c.init(); err != nil {
return ItemInfo{}, nil, err
}
id = cleanID(id) id = cleanID(id)
c.nlocker.Lock(id) c.nlocker.Lock(id)
@ -309,9 +250,6 @@ func (c *Cache) GetBytes(id string) (ItemInfo, []byte, error) {
// Get gets the file with the given id from the cache, 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) { func (c *Cache) Get(id string) (ItemInfo, io.ReadCloser, error) {
if err := c.init(); err != nil {
return ItemInfo{}, nil, err
}
id = cleanID(id) id = cleanID(id)
c.nlocker.Lock(id) c.nlocker.Lock(id)
@ -332,10 +270,18 @@ func (c *Cache) getOrRemove(id string) hugio.ReadSeekCloser {
return nil return nil
} }
if removed, err := c.removeIfExpired(id); err != nil || removed { if c.maxAge > 0 {
fi, err := c.Fs.Stat(id)
if err != nil {
return nil return nil
} }
if c.isExpired(fi.ModTime()) {
c.Fs.Remove(id)
return nil
}
}
f, err := c.Fs.Open(id) f, err := c.Fs.Open(id)
if err != nil { if err != nil {
return nil return nil
@ -344,49 +290,6 @@ func (c *Cache) getOrRemove(id string) hugio.ReadSeekCloser {
return f return f
} }
func (c *Cache) getBytesAndRemoveIfExpired(id string) ([]byte, bool) {
if c.maxAge == 0 {
// No caching.
return nil, false
}
f, err := c.Fs.Open(id)
if err != nil {
return nil, false
}
defer f.Close()
b, err := io.ReadAll(f)
if err != nil {
return nil, false
}
removed, err := c.removeIfExpired(id)
if err != nil {
return nil, false
}
return b, removed
}
func (c *Cache) removeIfExpired(id string) (bool, error) {
if c.maxAge <= 0 {
return false, nil
}
fi, err := c.Fs.Stat(id)
if err != nil {
return false, err
}
if c.isExpired(fi.ModTime()) {
c.Fs.Remove(id)
return true, nil
}
return false, nil
}
func (c *Cache) isExpired(modTime time.Time) bool { func (c *Cache) isExpired(modTime time.Time) bool {
if c.maxAge < 0 { if c.maxAge < 0 {
return false return false
@ -444,7 +347,11 @@ func NewCaches(p *helpers.PathSpec) (Caches, error) {
baseDir := v.DirCompiled baseDir := v.DirCompiled
bfs := hugofs.NewBasePathFs(cfs, baseDir) if err := cfs.MkdirAll(baseDir, 0777); err != nil && !os.IsExist(err) {
return nil, err
}
bfs := afero.NewBasePathFs(cfs, baseDir)
var pruneAllRootDir string var pruneAllRootDir string
if k == CacheKeyModules { if k == CacheKeyModules {
@ -460,37 +367,3 @@ func NewCaches(p *helpers.PathSpec) (Caches, error) {
func cleanID(name string) string { func cleanID(name string) string {
return strings.TrimPrefix(filepath.Clean(name), helpers.FilePathSeparator) return strings.TrimPrefix(filepath.Clean(name), helpers.FilePathSeparator)
} }
// AsHTTPCache returns an httpcache.Cache implementation for this file cache.
// Note that none of the methods are protected by named locks, so you need to make sure
// to do that in your own code.
func (c *Cache) AsHTTPCache() httpcache.Cache {
return &httpCache{c: c}
}
type httpCache struct {
c *Cache
}
func (h *httpCache) Get(id string) (resp []byte, ok bool) {
id = cleanID(id)
b, removed := h.c.getBytesAndRemoveIfExpired(id)
return b, !removed
}
func (h *httpCache) Set(id string, resp []byte) {
if h.c.maxAge == 0 {
return
}
id = cleanID(id)
if err := h.c.writeReader(id, bytes.NewReader(resp)); err != nil {
panic(err)
}
}
func (h *httpCache) Delete(key string) {
h.c.Fs.Remove(key)
}

View file

@ -15,7 +15,6 @@
package filecache package filecache
import ( import (
"errors"
"fmt" "fmt"
"path" "path"
"path/filepath" "path/filepath"
@ -25,6 +24,8 @@ import (
"github.com/gohugoio/hugo/common/maps" "github.com/gohugoio/hugo/common/maps"
"github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config"
"errors"
"github.com/mitchellh/mapstructure" "github.com/mitchellh/mapstructure"
"github.com/spf13/afero" "github.com/spf13/afero"
) )
@ -46,7 +47,6 @@ const (
CacheKeyAssets = "assets" CacheKeyAssets = "assets"
CacheKeyModules = "modules" CacheKeyModules = "modules"
CacheKeyGetResource = "getresource" CacheKeyGetResource = "getresource"
CacheKeyMisc = "misc"
) )
type Configs map[string]FileCacheConfig type Configs map[string]FileCacheConfig
@ -71,21 +71,17 @@ var defaultCacheConfigs = Configs{
MaxAge: -1, MaxAge: -1,
Dir: resourcesGenDir, Dir: resourcesGenDir,
}, },
CacheKeyGetResource: { CacheKeyGetResource: FileCacheConfig{
MaxAge: -1, // Never expire MaxAge: -1, // Never expire
Dir: cacheDirProject, Dir: cacheDirProject,
}, },
CacheKeyMisc: {
MaxAge: -1,
Dir: cacheDirProject,
},
} }
type FileCacheConfig struct { type FileCacheConfig struct {
// Max age of cache entries in this cache. Any items older than this will // Max age of cache entries in this cache. Any items older than this will
// be removed and not returned from the cache. // be removed and not returned from the cache.
// A negative value means forever, 0 means cache is disabled. // A negative value means forever, 0 means cache is disabled.
// Hugo is lenient with what types it accepts here, but we recommend using // Hugo is leninent with what types it accepts here, but we recommend using
// a duration string, a sequence of decimal numbers, each with optional fraction and a unit suffix, // a duration string, a sequence of decimal numbers, each with optional fraction and a unit suffix,
// such as "300ms", "1.5h" or "2h45m". // such as "300ms", "1.5h" or "2h45m".
// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". // Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
@ -97,7 +93,7 @@ type FileCacheConfig struct {
// Will resources/_gen will get its own composite filesystem that // Will resources/_gen will get its own composite filesystem that
// also checks any theme. // also checks any theme.
IsResourceDir bool `json:"-"` IsResourceDir bool
} }
// GetJSONCache gets the file cache for getJSON. // GetJSONCache gets the file cache for getJSON.
@ -125,11 +121,6 @@ func (f Caches) AssetsCache() *Cache {
return f[CacheKeyAssets] return f[CacheKeyAssets]
} }
// MiscCache gets the file cache for miscellaneous stuff.
func (f Caches) MiscCache() *Cache {
return f[CacheKeyMisc]
}
// GetResourceCache gets the file cache for remote resources. // GetResourceCache gets the file cache for remote resources.
func (f Caches) GetResourceCache() *Cache { func (f Caches) GetResourceCache() *Cache {
return f[CacheKeyGetResource] return f[CacheKeyGetResource]
@ -234,6 +225,7 @@ func DecodeConfig(fs afero.Fs, bcfg config.BaseConfig, m map[string]any) (Config
// Resolves :resourceDir => /myproject/resources etc., :cacheDir => ... // Resolves :resourceDir => /myproject/resources etc., :cacheDir => ...
func resolveDirPlaceholder(fs afero.Fs, bcfg config.BaseConfig, placeholder string) (cacheDir string, isResource bool, err error) { func resolveDirPlaceholder(fs afero.Fs, bcfg config.BaseConfig, placeholder string) (cacheDir string, isResource bool, err error) {
switch strings.ToLower(placeholder) { switch strings.ToLower(placeholder) {
case ":resourcedir": case ":resourcedir":
return "", true, nil return "", true, nil

View file

@ -59,7 +59,7 @@ dir = "/path/to/c4"
c.Assert(err, qt.IsNil) c.Assert(err, qt.IsNil)
fs := afero.NewMemMapFs() fs := afero.NewMemMapFs()
decoded := testconfig.GetTestConfigs(fs, cfg).Base.Caches decoded := testconfig.GetTestConfigs(fs, cfg).Base.Caches
c.Assert(len(decoded), qt.Equals, 7) c.Assert(len(decoded), qt.Equals, 6)
c2 := decoded["getcsv"] c2 := decoded["getcsv"]
c.Assert(c2.MaxAge.String(), qt.Equals, "11h0m0s") c.Assert(c2.MaxAge.String(), qt.Equals, "11h0m0s")
@ -106,7 +106,7 @@ dir = "/path/to/c4"
c.Assert(err, qt.IsNil) c.Assert(err, qt.IsNil)
fs := afero.NewMemMapFs() fs := afero.NewMemMapFs()
decoded := testconfig.GetTestConfigs(fs, cfg).Base.Caches decoded := testconfig.GetTestConfigs(fs, cfg).Base.Caches
c.Assert(len(decoded), qt.Equals, 7) c.Assert(len(decoded), qt.Equals, 6)
for _, v := range decoded { for _, v := range decoded {
c.Assert(v.MaxAge, qt.Equals, time.Duration(0)) c.Assert(v.MaxAge, qt.Equals, time.Duration(0))
@ -129,7 +129,7 @@ func TestDecodeConfigDefault(t *testing.T) {
fs := afero.NewMemMapFs() fs := afero.NewMemMapFs()
decoded := testconfig.GetTestConfigs(fs, cfg).Base.Caches decoded := testconfig.GetTestConfigs(fs, cfg).Base.Caches
c.Assert(len(decoded), qt.Equals, 7) c.Assert(len(decoded), qt.Equals, 6)
imgConfig := decoded[filecache.CacheKeyImages] imgConfig := decoded[filecache.CacheKeyImages]
jsonConfig := decoded[filecache.CacheKeyGetJSON] jsonConfig := decoded[filecache.CacheKeyGetJSON]

View file

@ -1,106 +0,0 @@
// Copyright 2024 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"
"github.com/bep/logg"
qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/htesting"
"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) {
if htesting.IsCI() {
// TODO(bep)
t.Skip("skip flaky test on CI server")
}
t.Skip("skip flaky test")
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 --
{{ warnf "HOME!" }}
{{ $img := resources.GetMatch "**.png" }}
{{ $img = $img.Resize "3x3" }}
{{ $img.RelPermalink }}
`
b := hugolib.NewIntegrationTestBuilder(
hugolib.IntegrationTestConfig{T: t, TxtarString: files, Running: true, RunGC: true, NeedsOsFS: true, LogLevel: logg.LevelInfo},
).Build()
b.Assert(b.GCCount, qt.Equals, 0)
b.Assert(b.H, qt.IsNotNil)
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(500 * 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)
}

View file

@ -53,13 +53,11 @@ func (c *Cache) Prune(force bool) (int, error) {
if c.pruneAllRootDir != "" { if c.pruneAllRootDir != "" {
return c.pruneRootDir(force) return c.pruneRootDir(force)
} }
if err := c.init(); err != nil {
return 0, err
}
counter := 0 counter := 0
err := afero.Walk(c.Fs, "", func(name string, info os.FileInfo, err error) error { err := afero.Walk(c.Fs, "", func(name string, info os.FileInfo, err error) error {
if info == nil { if info == nil {
return nil return nil
} }
@ -68,6 +66,7 @@ func (c *Cache) Prune(force bool) (int, error) {
if info.IsDir() { if info.IsDir() {
f, err := c.Fs.Open(name) f, err := c.Fs.Open(name)
if err != nil { if err != nil {
// This cache dir may not exist. // This cache dir may not exist.
return nil return nil
@ -118,9 +117,6 @@ func (c *Cache) Prune(force bool) (int, error) {
} }
func (c *Cache) pruneRootDir(force bool) (int, error) { func (c *Cache) pruneRootDir(force bool) (int, error) {
if err := c.init(); err != nil {
return 0, err
}
info, err := c.Fs.Stat(c.pruneAllRootDir) info, err := c.Fs.Stat(c.pruneAllRootDir)
if err != nil { if err != nil {
if herrors.IsNotExist(err) { if herrors.IsNotExist(err) {

View file

@ -59,7 +59,7 @@ dir = ":resourceDir/_gen"
caches, err := filecache.NewCaches(p) caches, err := filecache.NewCaches(p)
c.Assert(err, qt.IsNil) c.Assert(err, qt.IsNil)
cache := caches[name] cache := caches[name]
for i := range 10 { for i := 0; i < 10; i++ {
id := fmt.Sprintf("i%d", i) id := fmt.Sprintf("i%d", i)
cache.GetOrCreateBytes(id, func() ([]byte, error) { cache.GetOrCreateBytes(id, func() ([]byte, error) {
return []byte("abc"), nil return []byte("abc"), nil
@ -74,7 +74,7 @@ dir = ":resourceDir/_gen"
c.Assert(err, qt.IsNil) c.Assert(err, qt.IsNil)
c.Assert(count, qt.Equals, 5, msg) c.Assert(count, qt.Equals, 5, msg)
for i := range 10 { for i := 0; i < 10; i++ {
id := fmt.Sprintf("i%d", i) id := fmt.Sprintf("i%d", i)
v := cache.GetString(id) v := cache.GetString(id)
if i < 5 { if i < 5 {
@ -97,7 +97,7 @@ dir = ":resourceDir/_gen"
c.Assert(count, qt.Equals, 4) c.Assert(count, qt.Equals, 4)
// Now only the i5 should be left. // Now only the i5 should be left.
for i := range 10 { for i := 0; i < 10; i++ {
id := fmt.Sprintf("i%d", i) id := fmt.Sprintf("i%d", i)
v := cache.GetString(id) v := cache.GetString(id)
if i != 5 { if i != 5 {

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2018 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -17,6 +17,7 @@ import (
"errors" "errors"
"fmt" "fmt"
"io" "io"
"path/filepath"
"strings" "strings"
"sync" "sync"
"testing" "testing"
@ -85,8 +86,17 @@ dir = ":cacheDir/c"
cache := caches.Get("GetJSON") cache := caches.Get("GetJSON")
c.Assert(cache, qt.Not(qt.IsNil)) c.Assert(cache, qt.Not(qt.IsNil))
bfs, ok := cache.Fs.(*afero.BasePathFs)
c.Assert(ok, qt.Equals, true)
filename, err := bfs.RealPath("key")
c.Assert(err, qt.IsNil)
cache = caches.Get("Images") cache = caches.Get("Images")
c.Assert(cache, qt.Not(qt.IsNil)) c.Assert(cache, qt.Not(qt.IsNil))
bfs, ok = cache.Fs.(*afero.BasePathFs)
c.Assert(ok, qt.Equals, true)
filename, _ = bfs.RealPath("key")
c.Assert(filename, qt.Equals, filepath.FromSlash("_gen/images/key"))
rf := func(s string) func() (io.ReadCloser, error) { rf := func(s string) func() (io.ReadCloser, error) {
return func() (io.ReadCloser, error) { return func() (io.ReadCloser, error) {
@ -105,7 +115,7 @@ dir = ":cacheDir/c"
} }
for _, ca := range []*filecache.Cache{caches.ImageCache(), caches.AssetsCache(), caches.GetJSONCache(), caches.GetCSVCache()} { for _, ca := range []*filecache.Cache{caches.ImageCache(), caches.AssetsCache(), caches.GetJSONCache(), caches.GetCSVCache()} {
for range 2 { for i := 0; i < 2; i++ {
info, r, err := ca.GetOrCreate("a", rf("abc")) info, r, err := ca.GetOrCreate("a", rf("abc"))
c.Assert(err, qt.IsNil) c.Assert(err, qt.IsNil)
c.Assert(r, qt.Not(qt.IsNil)) c.Assert(r, qt.Not(qt.IsNil))
@ -193,11 +203,11 @@ dir = "/cache/c"
var wg sync.WaitGroup var wg sync.WaitGroup
for i := range 50 { for i := 0; i < 50; i++ {
wg.Add(1) wg.Add(1)
go func(i int) { go func(i int) {
defer wg.Done() defer wg.Done()
for range 20 { for j := 0; j < 20; j++ {
ca := caches.Get(cacheName) ca := caches.Get(cacheName)
c.Assert(ca, qt.Not(qt.IsNil)) c.Assert(ca, qt.Not(qt.IsNil))
filename, data := filenameData(i) filename, data := filenameData(i)

109
cache/filecache/integration_test.go vendored Normal file
View file

@ -0,0 +1,109 @@
// 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"
jww "github.com/spf13/jwalterweatherman"
"testing"
"time"
qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/htesting"
"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) {
if htesting.IsCI() {
// TODO(bep)
t.Skip("skip flaky test on CI server")
}
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 --
{{ warnf "HOME!" }}
{{ $img := resources.GetMatch "**.png" }}
{{ $img = $img.Resize "3x3" }}
{{ $img.RelPermalink }}
`
b := hugolib.NewIntegrationTestBuilder(
hugolib.IntegrationTestConfig{T: t, TxtarString: files, Running: true, RunGC: true, NeedsOsFS: true, LogLevel: jww.LevelInfo},
).Build()
b.Assert(b.GCCount, qt.Equals, 0)
b.Assert(b.H, qt.IsNotNil)
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)
}

View file

@ -1,229 +0,0 @@
// Copyright 2024 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 httpcache
import (
"encoding/json"
"time"
"github.com/gobwas/glob"
"github.com/gohugoio/hugo/common/predicate"
"github.com/gohugoio/hugo/config"
"github.com/mitchellh/mapstructure"
)
// DefaultConfig holds the default configuration for the HTTP cache.
var DefaultConfig = Config{
Cache: Cache{
For: GlobMatcher{
Excludes: []string{"**"},
},
},
Polls: []PollConfig{
{
For: GlobMatcher{
Includes: []string{"**"},
},
Disable: true,
},
},
}
// Config holds the configuration for the HTTP cache.
type Config struct {
// Configures the HTTP cache behavior (RFC 9111).
// When this is not enabled for a resource, Hugo will go straight to the file cache.
Cache Cache
// Polls holds a list of configurations for polling remote resources to detect changes in watch mode.
// This can be disabled for some resources, typically if they are known to not change.
Polls []PollConfig
}
type Cache struct {
// Enable HTTP cache behavior (RFC 9111) for these resources.
For GlobMatcher
}
func (c *Config) Compile() (ConfigCompiled, error) {
var cc ConfigCompiled
p, err := c.Cache.For.CompilePredicate()
if err != nil {
return cc, err
}
cc.For = p
for _, pc := range c.Polls {
p, err := pc.For.CompilePredicate()
if err != nil {
return cc, err
}
cc.PollConfigs = append(cc.PollConfigs, PollConfigCompiled{
For: p,
Config: pc,
})
}
return cc, nil
}
// PollConfig holds the configuration for polling remote resources to detect changes in watch mode.
type PollConfig struct {
// What remote resources to apply this configuration to.
For GlobMatcher
// Disable polling for this configuration.
Disable bool
// Low is the lower bound for the polling interval.
// This is the starting point when the resource has recently changed,
// if that resource stops changing, the polling interval will gradually increase towards High.
Low time.Duration
// High is the upper bound for the polling interval.
// This is the interval used when the resource is stable.
High time.Duration
}
func (c PollConfig) MarshalJSON() (b []byte, err error) {
// Marshal the durations as strings.
type Alias PollConfig
return json.Marshal(&struct {
Low string
High string
Alias
}{
Low: c.Low.String(),
High: c.High.String(),
Alias: (Alias)(c),
})
}
type GlobMatcher struct {
// Excludes holds a list of glob patterns that will be excluded.
Excludes []string
// Includes holds a list of glob patterns that will be included.
Includes []string
}
func (gm GlobMatcher) IsZero() bool {
return len(gm.Includes) == 0 && len(gm.Excludes) == 0
}
type ConfigCompiled struct {
For predicate.P[string]
PollConfigs []PollConfigCompiled
}
func (c *ConfigCompiled) PollConfigFor(s string) PollConfigCompiled {
for _, pc := range c.PollConfigs {
if pc.For(s) {
return pc
}
}
return PollConfigCompiled{}
}
func (c *ConfigCompiled) IsPollingDisabled() bool {
for _, pc := range c.PollConfigs {
if !pc.Config.Disable {
return false
}
}
return true
}
type PollConfigCompiled struct {
For predicate.P[string]
Config PollConfig
}
func (p PollConfigCompiled) IsZero() bool {
return p.For == nil
}
func (gm *GlobMatcher) CompilePredicate() (func(string) bool, error) {
if gm.IsZero() {
panic("no includes or excludes")
}
var p predicate.P[string]
for _, include := range gm.Includes {
g, err := glob.Compile(include, '/')
if err != nil {
return nil, err
}
fn := func(s string) bool {
return g.Match(s)
}
p = p.Or(fn)
}
for _, exclude := range gm.Excludes {
g, err := glob.Compile(exclude, '/')
if err != nil {
return nil, err
}
fn := func(s string) bool {
return !g.Match(s)
}
p = p.And(fn)
}
return p, nil
}
func DecodeConfig(_ config.BaseConfig, m map[string]any) (Config, error) {
if len(m) == 0 {
return DefaultConfig, nil
}
var c Config
dc := &mapstructure.DecoderConfig{
Result: &c,
DecodeHook: mapstructure.StringToTimeDurationHookFunc(),
WeaklyTypedInput: true,
}
decoder, err := mapstructure.NewDecoder(dc)
if err != nil {
return c, err
}
if err := decoder.Decode(m); err != nil {
return c, err
}
if c.Cache.For.IsZero() {
c.Cache.For = DefaultConfig.Cache.For
}
for pci := range c.Polls {
if c.Polls[pci].For.IsZero() {
c.Polls[pci].For = DefaultConfig.Cache.For
c.Polls[pci].Disable = true
}
}
if len(c.Polls) == 0 {
c.Polls = DefaultConfig.Polls
}
return c, nil
}

View file

@ -1,95 +0,0 @@
// Copyright 2024 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 httpcache_test
import (
"testing"
"time"
qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/hugolib"
)
func TestConfigCustom(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
[httpcache]
[httpcache.cache.for]
includes = ["**gohugo.io**"]
[[httpcache.polls]]
low = "5s"
high = "32s"
[httpcache.polls.for]
includes = ["**gohugo.io**"]
`
b := hugolib.Test(t, files)
httpcacheConf := b.H.Configs.Base.HTTPCache
compiled := b.H.Configs.Base.C.HTTPCache
b.Assert(httpcacheConf.Cache.For.Includes, qt.DeepEquals, []string{"**gohugo.io**"})
b.Assert(httpcacheConf.Cache.For.Excludes, qt.IsNil)
pc := compiled.PollConfigFor("https://gohugo.io/foo.jpg")
b.Assert(pc.Config.Low, qt.Equals, 5*time.Second)
b.Assert(pc.Config.High, qt.Equals, 32*time.Second)
b.Assert(compiled.PollConfigFor("https://example.com/foo.jpg").IsZero(), qt.IsTrue)
}
func TestConfigDefault(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
`
b := hugolib.Test(t, files)
compiled := b.H.Configs.Base.C.HTTPCache
b.Assert(compiled.For("https://gohugo.io/posts.json"), qt.IsFalse)
b.Assert(compiled.For("https://gohugo.io/foo.jpg"), qt.IsFalse)
b.Assert(compiled.PollConfigFor("https://gohugo.io/foo.jpg").Config.Disable, qt.IsTrue)
}
func TestConfigPollsOnly(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
[httpcache]
[[httpcache.polls]]
low = "5s"
high = "32s"
[httpcache.polls.for]
includes = ["**gohugo.io**"]
`
b := hugolib.Test(t, files)
compiled := b.H.Configs.Base.C.HTTPCache
b.Assert(compiled.For("https://gohugo.io/posts.json"), qt.IsFalse)
b.Assert(compiled.For("https://gohugo.io/foo.jpg"), qt.IsFalse)
pc := compiled.PollConfigFor("https://gohugo.io/foo.jpg")
b.Assert(pc.Config.Low, qt.Equals, 5*time.Second)
b.Assert(pc.Config.High, qt.Equals, 32*time.Second)
b.Assert(compiled.PollConfigFor("https://example.com/foo.jpg").IsZero(), qt.IsTrue)
}

View file

@ -1,73 +0,0 @@
// Copyright 2024 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 httpcache
import (
"testing"
qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/config"
)
func TestGlobMatcher(t *testing.T) {
c := qt.New(t)
g := GlobMatcher{
Includes: []string{"**/*.jpg", "**.png", "**/bar/**"},
Excludes: []string{"**/foo.jpg", "**.css"},
}
p, err := g.CompilePredicate()
c.Assert(err, qt.IsNil)
c.Assert(p("foo.jpg"), qt.IsFalse)
c.Assert(p("foo.png"), qt.IsTrue)
c.Assert(p("foo/bar.jpg"), qt.IsTrue)
c.Assert(p("foo/bar.png"), qt.IsTrue)
c.Assert(p("foo/bar/foo.jpg"), qt.IsFalse)
c.Assert(p("foo/bar/foo.css"), qt.IsFalse)
c.Assert(p("foo.css"), qt.IsFalse)
c.Assert(p("foo/bar/foo.css"), qt.IsFalse)
c.Assert(p("foo/bar/foo.xml"), qt.IsTrue)
}
func TestDefaultConfig(t *testing.T) {
c := qt.New(t)
_, err := DefaultConfig.Compile()
c.Assert(err, qt.IsNil)
}
func TestDecodeConfigInjectsDefaultAndCompiles(t *testing.T) {
c := qt.New(t)
cfg, err := DecodeConfig(config.BaseConfig{}, map[string]interface{}{})
c.Assert(err, qt.IsNil)
c.Assert(cfg, qt.DeepEquals, DefaultConfig)
_, err = cfg.Compile()
c.Assert(err, qt.IsNil)
cfg, err = DecodeConfig(config.BaseConfig{}, map[string]any{
"cache": map[string]any{
"polls": []map[string]any{
{"disable": true},
},
},
})
c.Assert(err, qt.IsNil)
_, err = cfg.Compile()
c.Assert(err, qt.IsNil)
}

78
cache/namedmemcache/named_cache.go vendored Normal file
View file

@ -0,0 +1,78 @@
// Copyright 2018 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package namedmemcache provides a memory cache with a named lock. This is suitable
// for situations where creating the cached resource can be time consuming or otherwise
// resource hungry, or in situations where a "once only per key" is a requirement.
package namedmemcache
import (
"sync"
"github.com/BurntSushi/locker"
)
// Cache holds the cached values.
type Cache struct {
nlocker *locker.Locker
cache map[string]cacheEntry
mu sync.RWMutex
}
type cacheEntry struct {
value any
err error
}
// New creates a new cache.
func New() *Cache {
return &Cache{
nlocker: locker.NewLocker(),
cache: make(map[string]cacheEntry),
}
}
// Clear clears the cache state.
func (c *Cache) Clear() {
c.mu.Lock()
defer c.mu.Unlock()
c.cache = make(map[string]cacheEntry)
c.nlocker = locker.NewLocker()
}
// GetOrCreate tries to get the value with the given cache key, if not found
// create will be called and cached.
// This method is thread safe. It also guarantees that the create func for a given
// key is invoked only once for this cache.
func (c *Cache) GetOrCreate(key string, create func() (any, error)) (any, error) {
c.mu.RLock()
entry, found := c.cache[key]
c.mu.RUnlock()
if found {
return entry.value, entry.err
}
c.nlocker.Lock(key)
defer c.nlocker.Unlock(key)
// Create it.
value, err := create()
c.mu.Lock()
c.cache[key] = cacheEntry{value: value, err: err}
c.mu.Unlock()
return value, err
}

80
cache/namedmemcache/named_cache_test.go vendored Normal file
View file

@ -0,0 +1,80 @@
// Copyright 2018 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package namedmemcache
import (
"fmt"
"sync"
"testing"
qt "github.com/frankban/quicktest"
)
func TestNamedCache(t *testing.T) {
t.Parallel()
c := qt.New(t)
cache := New()
counter := 0
create := func() (any, error) {
counter++
return counter, nil
}
for i := 0; i < 5; i++ {
v1, err := cache.GetOrCreate("a1", create)
c.Assert(err, qt.IsNil)
c.Assert(v1, qt.Equals, 1)
v2, err := cache.GetOrCreate("a2", create)
c.Assert(err, qt.IsNil)
c.Assert(v2, qt.Equals, 2)
}
cache.Clear()
v3, err := cache.GetOrCreate("a2", create)
c.Assert(err, qt.IsNil)
c.Assert(v3, qt.Equals, 3)
}
func TestNamedCacheConcurrent(t *testing.T) {
t.Parallel()
c := qt.New(t)
var wg sync.WaitGroup
cache := New()
create := func(i int) func() (any, error) {
return func() (any, error) {
return i, nil
}
}
for i := 0; i < 10; i++ {
wg.Add(1)
go func() {
defer wg.Done()
for j := 0; j < 100; j++ {
id := fmt.Sprintf("id%d", j)
v, err := cache.GetOrCreate(id, create(j))
c.Assert(err, qt.IsNil)
c.Assert(v, qt.Equals, j)
}
}()
}
wg.Wait()
}

View file

@ -1,2 +0,0 @@
#!/usr/bin/env bash
diff <(gofmt -d .) <(printf '')

View file

@ -26,7 +26,6 @@ import (
"path/filepath" "path/filepath"
"reflect" "reflect"
"regexp" "regexp"
"slices"
"sort" "sort"
"strings" "strings"
"sync" "sync"
@ -103,7 +102,7 @@ func (c *Inspector) MethodsFromTypes(include []reflect.Type, exclude []reflect.T
} }
for _, t := range include { for _, t := range include {
for i := range t.NumMethod() { for i := 0; i < t.NumMethod(); i++ {
m := t.Method(i) m := t.Method(i)
if excludes[m.Name] || seen[m.Name] { if excludes[m.Name] || seen[m.Name] {
@ -123,7 +122,7 @@ func (c *Inspector) MethodsFromTypes(include []reflect.Type, exclude []reflect.T
method := Method{Owner: t, OwnerName: ownerName, Name: m.Name} method := Method{Owner: t, OwnerName: ownerName, Name: m.Name}
for i := range numIn { for i := 0; i < numIn; i++ {
in := m.Type.In(i) in := m.Type.In(i)
name, pkg := nameAndPackage(in) name, pkg := nameAndPackage(in)
@ -138,7 +137,7 @@ func (c *Inspector) MethodsFromTypes(include []reflect.Type, exclude []reflect.T
numOut := m.Type.NumOut() numOut := m.Type.NumOut()
if numOut > 0 { if numOut > 0 {
for i := range numOut { for i := 0; i < numOut; i++ {
out := m.Type.Out(i) out := m.Type.Out(i)
name, pkg := nameAndPackage(out) name, pkg := nameAndPackage(out)
@ -305,7 +304,7 @@ func (m Method) inOutStr() string {
} }
args := make([]string, len(m.In)) args := make([]string, len(m.In))
for i := range args { for i := 0; i < len(args); i++ {
args[i] = fmt.Sprintf("arg%d", i) args[i] = fmt.Sprintf("arg%d", i)
} }
return "(" + strings.Join(args, ", ") + ")" return "(" + strings.Join(args, ", ") + ")"
@ -317,7 +316,7 @@ func (m Method) inStr() string {
} }
args := make([]string, len(m.In)) args := make([]string, len(m.In))
for i := range args { for i := 0; i < len(args); i++ {
args[i] = fmt.Sprintf("arg%d %s", i, m.In[i]) args[i] = fmt.Sprintf("arg%d %s", i, m.In[i])
} }
return "(" + strings.Join(args, ", ") + ")" return "(" + strings.Join(args, ", ") + ")"
@ -340,7 +339,7 @@ func (m Method) outStrNamed() string {
} }
outs := make([]string, len(m.Out)) outs := make([]string, len(m.Out))
for i := range outs { for i := 0; i < len(outs); i++ {
outs[i] = fmt.Sprintf("o%d %s", i, m.Out[i]) outs[i] = fmt.Sprintf("o%d %s", i, m.Out[i])
} }
@ -436,7 +435,7 @@ func (m Methods) ToMarshalJSON(receiver, pkgPath string, excludes ...string) (st
// Exclude self // Exclude self
for i, pkgImp := range pkgImports { for i, pkgImp := range pkgImports {
if pkgImp == pkgPath { if pkgImp == pkgPath {
pkgImports = slices.Delete(pkgImports, i, i+1) pkgImports = append(pkgImports[:i], pkgImports[i+1:]...)
} }
} }
} }
@ -462,6 +461,7 @@ func collectMethodsRecursive(pkg string, f []*ast.Field) []string {
pkg, pkg,
tt.Methods.List)...) tt.Methods.List)...)
} }
} else { } else {
// Embedded, but in a different file/package. Return the // Embedded, but in a different file/package. Return the
// package.Name and deal with that later. // package.Name and deal with that later.

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -18,22 +18,20 @@ import (
"errors" "errors"
"fmt" "fmt"
"io" "io"
"log"
"os" "os"
"os/signal" "os/signal"
"path/filepath" "path/filepath"
"runtime"
"strings"
"sync" "sync"
"sync/atomic" "sync/atomic"
"syscall" "syscall"
"time" "time"
jww "github.com/spf13/jwalterweatherman"
"go.uber.org/automaxprocs/maxprocs" "go.uber.org/automaxprocs/maxprocs"
"github.com/bep/clocks" "github.com/bep/clock"
"github.com/bep/lazycache" "github.com/bep/lazycache"
"github.com/bep/logg"
"github.com/bep/overlayfs" "github.com/bep/overlayfs"
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
@ -41,20 +39,19 @@ import (
"github.com/gohugoio/hugo/common/htime" "github.com/gohugoio/hugo/common/htime"
"github.com/gohugoio/hugo/common/loggers" "github.com/gohugoio/hugo/common/loggers"
"github.com/gohugoio/hugo/common/paths" "github.com/gohugoio/hugo/common/paths"
"github.com/gohugoio/hugo/common/types"
"github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/config/allconfig" "github.com/gohugoio/hugo/config/allconfig"
"github.com/gohugoio/hugo/deps" "github.com/gohugoio/hugo/deps"
"github.com/gohugoio/hugo/helpers" "github.com/gohugoio/hugo/helpers"
"github.com/gohugoio/hugo/hugofs" "github.com/gohugoio/hugo/hugofs"
"github.com/gohugoio/hugo/hugolib" "github.com/gohugoio/hugo/hugolib"
"github.com/gohugoio/hugo/identity"
"github.com/gohugoio/hugo/resources/kinds"
"github.com/spf13/afero" "github.com/spf13/afero"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
var errHelp = errors.New("help requested") var (
errHelp = errors.New("help requested")
)
// Execute executes a command. // Execute executes a command.
func Execute(args []string) error { func Execute(args []string) error {
@ -66,12 +63,6 @@ func Execute(args []string) error {
} }
args = mapLegacyArgs(args) args = mapLegacyArgs(args)
cd, err := x.Execute(context.Background(), args) cd, err := x.Execute(context.Background(), args)
if cd != nil {
if closer, ok := cd.Root.Command.(types.Closer); ok {
closer.Close()
}
}
if err != nil { if err != nil {
if err == errHelp { if err == errHelp {
cd.CobraCommand.Help() cd.CobraCommand.Help()
@ -94,17 +85,11 @@ type commonConfig struct {
fs *hugofs.Fs fs *hugofs.Fs
} }
type configKey struct {
counter int32
ignoreModulesDoesNotExists bool
}
// This is the root command. // This is the root command.
type rootCommand struct { type rootCommand struct {
Printf func(format string, v ...any) Printf func(format string, v ...interface{})
Println func(a ...any) Println func(a ...interface{})
StdOut io.Writer Out io.Writer
StdErr io.Writer
logger loggers.Logger logger loggers.Logger
@ -113,11 +98,8 @@ type rootCommand struct {
// Some, but not all commands need access to these. // Some, but not all commands need access to these.
// Some needs more than one, so keep them in a small cache. // Some needs more than one, so keep them in a small cache.
commonConfigs *lazycache.Cache[configKey, *commonConfig] commonConfigs *lazycache.Cache[int32, *commonConfig]
hugoSites *lazycache.Cache[configKey, *hugolib.HugoSites] hugoSites *lazycache.Cache[int32, *hugolib.HugoSites]
// changesFromBuild received from Hugo in watch mode.
changesFromBuild chan []identity.Identity
commands []simplecobra.Commander commands []simplecobra.Commander
@ -126,11 +108,17 @@ type rootCommand struct {
buildWatch bool buildWatch bool
environment string environment string
// File format to read or write (TOML, YAML, JSON).
format string
// Common build flags. // Common build flags.
baseURL string baseURL string
gc bool gc bool
poll string poll string
panicOnWarning bool
forceSyncStatic bool forceSyncStatic bool
printPathWarnings bool
printUnusedTemplates bool
// Profile flags (for debugging of performance problems) // Profile flags (for debugging of performance problems)
cpuprofile string cpuprofile string
@ -139,31 +127,17 @@ type rootCommand struct {
traceprofile string traceprofile string
printm bool printm bool
logLevel string // TODO(bep) var vs string
logging bool
verbose bool
verboseLog bool
debug bool
quiet bool quiet bool
devMode bool // Hidden flag.
renderToMemory bool renderToMemory bool
cfgFile string cfgFile string
cfgDir string cfgDir string
} logFile string
func (r *rootCommand) isVerbose() bool {
return r.logger.Level() <= logg.LevelInfo
}
func (r *rootCommand) Close() error {
if r.hugoSites != nil {
r.hugoSites.DeleteFunc(func(key configKey, value *hugolib.HugoSites) bool {
if value != nil {
value.Close()
}
return false
})
}
return nil
} }
func (r *rootCommand) Build(cd *simplecobra.Commandeer, bcfg hugolib.BuildCfg, cfg config.Provider) (*hugolib.HugoSites, error) { func (r *rootCommand) Build(cd *simplecobra.Commandeer, bcfg hugolib.BuildCfg, cfg config.Provider) (*hugolib.HugoSites, error) {
@ -182,8 +156,8 @@ func (r *rootCommand) Commands() []simplecobra.Commander {
return r.commands return r.commands
} }
func (r *rootCommand) ConfigFromConfig(key configKey, oldConf *commonConfig) (*commonConfig, error) { func (r *rootCommand) ConfigFromConfig(key int32, oldConf *commonConfig) (*commonConfig, error) {
cc, _, err := r.commonConfigs.GetOrCreate(key, func(key configKey) (*commonConfig, error) { cc, _, err := r.commonConfigs.GetOrCreate(key, func(key int32) (*commonConfig, error) {
fs := oldConf.fs fs := oldConf.fs
configs, err := allconfig.LoadConfig( configs, err := allconfig.LoadConfig(
allconfig.ConfigSourceDescriptor{ allconfig.ConfigSourceDescriptor{
@ -193,7 +167,6 @@ func (r *rootCommand) ConfigFromConfig(key configKey, oldConf *commonConfig) (*c
ConfigDir: r.cfgDir, ConfigDir: r.cfgDir,
Logger: r.logger, Logger: r.logger,
Environment: r.environment, Environment: r.environment,
IgnoreModuleDoesNotExist: key.ignoreModulesDoesNotExists,
}, },
) )
if err != nil { if err != nil {
@ -202,7 +175,7 @@ func (r *rootCommand) ConfigFromConfig(key configKey, oldConf *commonConfig) (*c
if !configs.Base.C.Clock.IsZero() { if !configs.Base.C.Clock.IsZero() {
// TODO(bep) find a better place for this. // TODO(bep) find a better place for this.
htime.Clock = clocks.Start(configs.Base.C.Clock) htime.Clock = clock.Start(configs.Base.C.Clock)
} }
return &commonConfig{ return &commonConfig{
@ -211,16 +184,18 @@ func (r *rootCommand) ConfigFromConfig(key configKey, oldConf *commonConfig) (*c
cfg: oldConf.cfg, cfg: oldConf.cfg,
fs: fs, fs: fs,
}, nil }, nil
}) })
return cc, err return cc, err
} }
func (r *rootCommand) ConfigFromProvider(key configKey, cfg config.Provider) (*commonConfig, error) { func (r *rootCommand) ConfigFromProvider(key int32, cfg config.Provider) (*commonConfig, error) {
if cfg == nil { if cfg == nil {
panic("cfg must be set") panic("cfg must be set")
} }
cc, _, err := r.commonConfigs.GetOrCreate(key, func(key configKey) (*commonConfig, error) { cc, _, err := r.commonConfigs.GetOrCreate(key, func(key int32) (*commonConfig, error) {
var dir string var dir string
if r.source != "" { if r.source != "" {
dir, _ = filepath.Abs(r.source) dir, _ = filepath.Abs(r.source)
@ -232,10 +207,13 @@ func (r *rootCommand) ConfigFromProvider(key configKey, cfg config.Provider) (*c
cfg = config.New() cfg = config.New()
} }
if !cfg.IsSet("renderToDisk") {
cfg.Set("renderToDisk", true)
}
if !cfg.IsSet("workingDir") { if !cfg.IsSet("workingDir") {
cfg.Set("workingDir", dir) cfg.Set("workingDir", dir)
} else { } else {
if err := os.MkdirAll(cfg.GetString("workingDir"), 0o777); err != nil { if err := os.MkdirAll(cfg.GetString("workingDir"), 0777); err != nil {
return nil, fmt.Errorf("failed to create workingDir: %w", err) return nil, fmt.Errorf("failed to create workingDir: %w", err)
} }
} }
@ -249,7 +227,6 @@ func (r *rootCommand) ConfigFromProvider(key configKey, cfg config.Provider) (*c
ConfigDir: r.cfgDir, ConfigDir: r.cfgDir,
Environment: r.environment, Environment: r.environment,
Logger: r.logger, Logger: r.logger,
IgnoreModuleDoesNotExist: key.ignoreModulesDoesNotExists,
}, },
) )
if err != nil { if err != nil {
@ -265,9 +242,11 @@ func (r *rootCommand) ConfigFromProvider(key configKey, cfg config.Provider) (*c
renderStaticToDisk := cfg.GetBool("renderStaticToDisk") renderStaticToDisk := cfg.GetBool("renderStaticToDisk")
sourceFs := hugofs.Os sourceFs := hugofs.Os
var destinationFs afero.Fs var desinationFs afero.Fs
if cfg.GetBool("renderToMemory") { if cfg.GetBool("renderToDisk") {
destinationFs = afero.NewMemMapFs() desinationFs = hugofs.Os
} else {
desinationFs = afero.NewMemMapFs()
if renderStaticToDisk { if renderStaticToDisk {
// Hybrid, render dynamic content to Root. // Hybrid, render dynamic content to Root.
cfg.Set("publishDirDynamic", "/") cfg.Set("publishDirDynamic", "/")
@ -276,18 +255,16 @@ func (r *rootCommand) ConfigFromProvider(key configKey, cfg config.Provider) (*c
cfg.Set("publishDirDynamic", "/") cfg.Set("publishDirDynamic", "/")
cfg.Set("publishDirStatic", "/") cfg.Set("publishDirStatic", "/")
} }
} else {
destinationFs = hugofs.Os
} }
fs := hugofs.NewFromSourceAndDestination(sourceFs, destinationFs, cfg) fs := hugofs.NewFromSourceAndDestination(sourceFs, desinationFs, cfg)
if renderStaticToDisk { if renderStaticToDisk {
dynamicFs := fs.PublishDir dynamicFs := fs.PublishDir
publishDirStatic := cfg.GetString("publishDirStatic") publishDirStatic := cfg.GetString("publishDirStatic")
workingDir := cfg.GetString("workingDir") workingDir := cfg.GetString("workingDir")
absPublishDirStatic := paths.AbsPathify(workingDir, publishDirStatic) absPublishDirStatic := paths.AbsPathify(workingDir, publishDirStatic)
staticFs := hugofs.NewBasePathFs(afero.NewOsFs(), absPublishDirStatic) staticFs := afero.NewBasePathFs(afero.NewOsFs(), absPublishDirStatic)
// Serve from both the static and dynamic fs, // Serve from both the static and dynamic fs,
// the first will take priority. // the first will take priority.
@ -308,10 +285,10 @@ func (r *rootCommand) ConfigFromProvider(key configKey, cfg config.Provider) (*c
if !base.C.Clock.IsZero() { if !base.C.Clock.IsZero() {
// TODO(bep) find a better place for this. // TODO(bep) find a better place for this.
htime.Clock = clocks.Start(configs.Base.C.Clock) htime.Clock = clock.Start(configs.Base.C.Clock)
} }
if base.PrintPathWarnings { if base.LogPathWarnings {
// Note that we only care about the "dynamic creates" here, // Note that we only care about the "dynamic creates" here,
// so skip the static fs. // so skip the static fs.
fs.PublishDir = hugofs.NewCreateCountingFs(fs.PublishDir) fs.PublishDir = hugofs.NewCreateCountingFs(fs.PublishDir)
@ -328,49 +305,40 @@ func (r *rootCommand) ConfigFromProvider(key configKey, cfg config.Provider) (*c
}) })
return cc, err return cc, err
} }
func (r *rootCommand) HugFromConfig(conf *commonConfig) (*hugolib.HugoSites, error) { func (r *rootCommand) HugFromConfig(conf *commonConfig) (*hugolib.HugoSites, error) {
k := configKey{counter: r.configVersionID.Load()} h, _, err := r.hugoSites.GetOrCreate(r.configVersionID.Load(), func(key int32) (*hugolib.HugoSites, error) {
h, _, err := r.hugoSites.GetOrCreate(k, func(key configKey) (*hugolib.HugoSites, error) { depsCfg := deps.DepsCfg{Configs: conf.configs, Fs: conf.fs, Logger: r.logger}
depsCfg := r.newDepsConfig(conf)
return hugolib.NewHugoSites(depsCfg) return hugolib.NewHugoSites(depsCfg)
}) })
return h, err return h, err
} }
func (r *rootCommand) Hugo(cfg config.Provider) (*hugolib.HugoSites, error) { func (r *rootCommand) Hugo(cfg config.Provider) (*hugolib.HugoSites, error) {
return r.getOrCreateHugo(cfg, false) h, _, err := r.hugoSites.GetOrCreate(r.configVersionID.Load(), func(key int32) (*hugolib.HugoSites, error) {
}
func (r *rootCommand) getOrCreateHugo(cfg config.Provider, ignoreModuleDoesNotExist bool) (*hugolib.HugoSites, error) {
k := configKey{counter: r.configVersionID.Load(), ignoreModulesDoesNotExists: ignoreModuleDoesNotExist}
h, _, err := r.hugoSites.GetOrCreate(k, func(key configKey) (*hugolib.HugoSites, error) {
conf, err := r.ConfigFromProvider(key, cfg) conf, err := r.ConfigFromProvider(key, cfg)
if err != nil { if err != nil {
return nil, err return nil, err
} }
depsCfg := r.newDepsConfig(conf) depsCfg := deps.DepsCfg{Configs: conf.configs, Fs: conf.fs, Logger: r.logger}
return hugolib.NewHugoSites(depsCfg) return hugolib.NewHugoSites(depsCfg)
}) })
return h, err return h, err
} }
func (r *rootCommand) newDepsConfig(conf *commonConfig) deps.DepsCfg {
return deps.DepsCfg{Configs: conf.configs, Fs: conf.fs, StdOut: r.logger.StdOut(), StdErr: r.logger.StdErr(), LogLevel: r.logger.Level(), ChangesFromBuild: r.changesFromBuild}
}
func (r *rootCommand) Name() string { func (r *rootCommand) Name() string {
return "hugo" return "hugo"
} }
func (r *rootCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error { func (r *rootCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
b := newHugoBuilder(r, nil)
if !r.buildWatch { if !r.buildWatch {
defer b.postBuild("Total", time.Now()) defer r.timeTrack(time.Now(), "Total")
} }
b := newHugoBuilder(r, nil)
if err := b.loadConfig(cd, false); err != nil { if err := b.loadConfig(cd, false); err != nil {
return err return err
} }
@ -380,11 +348,9 @@ func (r *rootCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args
defer r.timeTrack(time.Now(), "Built") defer r.timeTrack(time.Now(), "Built")
} }
err := b.build() err := b.build()
if err != nil {
return err return err
}
return nil
}() }()
if err != nil { if err != nil {
return err return err
} }
@ -422,23 +388,18 @@ func (r *rootCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args
} }
func (r *rootCommand) PreRun(cd, runner *simplecobra.Commandeer) error { func (r *rootCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
r.StdOut = os.Stdout r.Out = os.Stdout
r.StdErr = os.Stderr
if r.quiet { if r.quiet {
r.StdOut = io.Discard r.Out = io.Discard
r.StdErr = io.Discard
} }
// Used by mkcert (server). r.Printf = func(format string, v ...interface{}) {
log.SetOutput(r.StdOut)
r.Printf = func(format string, v ...any) {
if !r.quiet { if !r.quiet {
fmt.Fprintf(r.StdOut, format, v...) fmt.Fprintf(r.Out, format, v...)
} }
} }
r.Println = func(a ...any) { r.Println = func(a ...interface{}) {
if !r.quiet { if !r.quiet {
fmt.Fprintln(r.StdOut, a...) fmt.Fprintln(r.Out, a...)
} }
} }
_, running := runner.Command.(*serverCommand) _, running := runner.Command.(*serverCommand)
@ -447,60 +408,63 @@ func (r *rootCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
if err != nil { if err != nil {
return err return err
} }
// Set up the global logger early to allow info deprecations during config load. switch r.format {
loggers.SetGlobalLogger(r.logger) case "json", "toml", "yaml":
// OK
default:
return fmt.Errorf("unsupported format %q; must be one of json, toml or yaml", r.format)
}
r.changesFromBuild = make(chan []identity.Identity, 10) loggers.PanicOnWarning.Store(r.panicOnWarning)
r.commonConfigs = lazycache.New[int32, *commonConfig](lazycache.Options{MaxEntries: 5})
r.commonConfigs = lazycache.New(lazycache.Options[configKey, *commonConfig]{MaxEntries: 5}) r.hugoSites = lazycache.New[int32, *hugolib.HugoSites](lazycache.Options{MaxEntries: 5})
// We don't want to keep stale HugoSites in memory longer than needed.
r.hugoSites = lazycache.New(lazycache.Options[configKey, *hugolib.HugoSites]{
MaxEntries: 1,
OnEvict: func(key configKey, value *hugolib.HugoSites) {
value.Close()
runtime.GC()
},
})
return nil return nil
} }
func (r *rootCommand) createLogger(running bool) (loggers.Logger, error) { func (r *rootCommand) createLogger(running bool) (loggers.Logger, error) {
level := logg.LevelWarn var (
logHandle = io.Discard
logThreshold = jww.LevelWarn
outHandle = r.Out
stdoutThreshold = jww.LevelWarn
)
if r.devMode { if r.verboseLog || r.logging || (r.logFile != "") {
level = logg.LevelTrace var err error
if r.logFile != "" {
logHandle, err = os.OpenFile(r.logFile, os.O_RDWR|os.O_APPEND|os.O_CREATE, 0666)
if err != nil {
return nil, fmt.Errorf("Failed to open log file %q: %s", r.logFile, err)
}
} else { } else {
if r.logLevel != "" { logHandle, err = os.CreateTemp("", "hugo")
switch strings.ToLower(r.logLevel) { if err != nil {
case "debug": return nil, err
level = logg.LevelDebug
case "info":
level = logg.LevelInfo
case "warn", "warning":
level = logg.LevelWarn
case "error":
level = logg.LevelError
default:
return nil, fmt.Errorf("invalid log level: %q, must be one of debug, warn, info or error", r.logLevel)
} }
} }
} else if r.verbose {
stdoutThreshold = jww.LevelInfo
}
if r.debug {
stdoutThreshold = jww.LevelDebug
}
if r.verboseLog {
logThreshold = jww.LevelInfo
if r.debug {
logThreshold = jww.LevelDebug
}
} }
optsLogger := loggers.Options{ loggers.InitGlobalLogger(stdoutThreshold, logThreshold, outHandle, logHandle)
DistinctLevel: logg.LevelWarn, helpers.InitLoggers()
Level: level, return loggers.NewLogger(stdoutThreshold, logThreshold, outHandle, logHandle, running), nil
StdOut: r.StdOut,
StdErr: r.StdErr,
StoreErrors: running,
}
return loggers.New(optsLogger), nil
} }
func (r *rootCommand) resetLogs() { func (r *rootCommand) Reset() {
r.logger.Reset() r.logger.Reset()
loggers.Log().Reset()
} }
// IsTestRun reports whether the command is running as a test. // IsTestRun reports whether the command is running as a test.
@ -509,96 +473,80 @@ func (r *rootCommand) IsTestRun() bool {
} }
func (r *rootCommand) Init(cd *simplecobra.Commandeer) error { func (r *rootCommand) Init(cd *simplecobra.Commandeer) error {
return r.initRootCommand("", cd)
}
func (r *rootCommand) initRootCommand(subCommandName string, cd *simplecobra.Commandeer) error {
cmd := cd.CobraCommand cmd := cd.CobraCommand
commandName := "hugo" cmd.Use = "hugo [flags]"
if subCommandName != "" { cmd.Short = "hugo builds your site"
commandName = subCommandName cmd.Long = `hugo is the main command, used to build your Hugo site.
}
cmd.Use = fmt.Sprintf("%s [flags]", commandName)
cmd.Short = "Build your site"
cmd.Long = `COMMAND_NAME is the main command, used to build your Hugo site.
Hugo is a Fast and Flexible Static Site Generator Hugo is a Fast and Flexible Static Site Generator
built with love by spf13 and friends in Go. built with love by spf13 and friends in Go.
Complete documentation is available at https://gohugo.io/.` Complete documentation is available at https://gohugo.io/.`
cmd.Long = strings.ReplaceAll(cmd.Long, "COMMAND_NAME", commandName)
// Configure persistent flags // Configure persistent flags
cmd.PersistentFlags().StringVarP(&r.source, "source", "s", "", "filesystem path to read files relative from") cmd.PersistentFlags().StringVarP(&r.source, "source", "s", "", "filesystem path to read files relative from")
_ = cmd.MarkFlagDirname("source") cmd.PersistentFlags().StringVar(&r.format, "format", "toml", "preferred file format (toml, yaml or json)")
cmd.PersistentFlags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{})
cmd.PersistentFlags().StringP("destination", "d", "", "filesystem path to write files to") cmd.PersistentFlags().StringP("destination", "d", "", "filesystem path to write files to")
_ = cmd.MarkFlagDirname("destination") cmd.PersistentFlags().SetAnnotation("destination", cobra.BashCompSubdirsInDir, []string{})
cmd.PersistentFlags().StringVarP(&r.environment, "environment", "e", "", "build environment") cmd.PersistentFlags().StringVarP(&r.environment, "environment", "e", "", "build environment")
_ = cmd.RegisterFlagCompletionFunc("environment", cobra.NoFileCompletions)
cmd.PersistentFlags().StringP("themesDir", "", "", "filesystem path to themes directory") cmd.PersistentFlags().StringP("themesDir", "", "", "filesystem path to themes directory")
_ = cmd.MarkFlagDirname("themesDir")
cmd.PersistentFlags().StringP("ignoreVendorPaths", "", "", "ignores any _vendor for module paths matching the given Glob pattern") cmd.PersistentFlags().StringP("ignoreVendorPaths", "", "", "ignores any _vendor for module paths matching the given Glob pattern")
cmd.PersistentFlags().BoolP("noBuildLock", "", false, "don't create .hugo_build.lock file")
_ = cmd.RegisterFlagCompletionFunc("ignoreVendorPaths", cobra.NoFileCompletions)
cmd.PersistentFlags().String("clock", "", "set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00") cmd.PersistentFlags().String("clock", "", "set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00")
_ = cmd.RegisterFlagCompletionFunc("clock", cobra.NoFileCompletions)
cmd.PersistentFlags().StringVar(&r.cfgFile, "config", "", "config file (default is hugo.yaml|json|toml)") cmd.PersistentFlags().StringVar(&r.cfgFile, "config", "", "config file (default is hugo.yaml|json|toml)")
_ = cmd.MarkFlagFilename("config", config.ValidConfigFileExtensions...)
cmd.PersistentFlags().StringVar(&r.cfgDir, "configDir", "config", "config dir") cmd.PersistentFlags().StringVar(&r.cfgDir, "configDir", "config", "config dir")
_ = cmd.MarkFlagDirname("configDir")
cmd.PersistentFlags().BoolVar(&r.quiet, "quiet", false, "build in quiet mode") cmd.PersistentFlags().BoolVar(&r.quiet, "quiet", false, "build in quiet mode")
cmd.PersistentFlags().BoolVarP(&r.renderToMemory, "renderToMemory", "M", false, "render to memory (mostly useful when running the server)")
cmd.PersistentFlags().BoolVarP(&r.devMode, "devMode", "", false, "only used for internal testing, flag hidden.") // Set bash-completion
cmd.PersistentFlags().StringVar(&r.logLevel, "logLevel", "", "log level (debug|info|warn|error)") _ = cmd.PersistentFlags().SetAnnotation("config", cobra.BashCompFilenameExt, config.ValidConfigFileExtensions)
_ = cmd.RegisterFlagCompletionFunc("logLevel", cobra.FixedCompletions([]string{"debug", "info", "warn", "error"}, cobra.ShellCompDirectiveNoFileComp))
cmd.PersistentFlags().BoolVarP(&r.verbose, "verbose", "v", false, "verbose output")
cmd.PersistentFlags().BoolVarP(&r.debug, "debug", "", false, "debug output")
cmd.PersistentFlags().BoolVar(&r.logging, "log", false, "enable Logging")
cmd.PersistentFlags().StringVar(&r.logFile, "logFile", "", "log File path (if set, logging enabled automatically)")
cmd.PersistentFlags().BoolVar(&r.verboseLog, "verboseLog", false, "verbose logging")
cmd.Flags().BoolVarP(&r.buildWatch, "watch", "w", false, "watch filesystem for changes and recreate as needed") cmd.Flags().BoolVarP(&r.buildWatch, "watch", "w", false, "watch filesystem for changes and recreate as needed")
cmd.Flags().BoolVar(&r.renderToMemory, "renderToMemory", false, "render to memory (only useful for benchmark testing)")
cmd.PersistentFlags().MarkHidden("devMode") // Set bash-completion
_ = cmd.PersistentFlags().SetAnnotation("logFile", cobra.BashCompFilenameExt, []string{})
// Configure local flags // Configure local flags
applyLocalFlagsBuild(cmd, r) applyLocalBuildFlags(cmd, r)
// Set bash-completion.
// Each flag must first be defined before using the SetAnnotation() call.
_ = cmd.Flags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{})
return nil return nil
} }
// A sub set of the complete build flags. These flags are used by new and mod. func applyLocalBuildFlags(cmd *cobra.Command, r *rootCommand) {
func applyLocalFlagsBuildConfig(cmd *cobra.Command, r *rootCommand) {
cmd.Flags().StringSliceP("theme", "t", []string{}, "themes to use (located in /themes/THEMENAME/)")
_ = cmd.MarkFlagDirname("theme")
cmd.Flags().StringVarP(&r.baseURL, "baseURL", "b", "", "hostname (and path) to the root, e.g. https://spf13.com/")
cmd.Flags().StringP("cacheDir", "", "", "filesystem path to cache directory")
_ = cmd.MarkFlagDirname("cacheDir")
cmd.Flags().StringP("contentDir", "c", "", "filesystem path to content directory")
cmd.Flags().StringSliceP("renderSegments", "", []string{}, "named segments to render (configured in the segments config)")
}
// Flags needed to do a build (used by hugo and hugo server commands)
func applyLocalFlagsBuild(cmd *cobra.Command, r *rootCommand) {
applyLocalFlagsBuildConfig(cmd, r)
cmd.Flags().Bool("cleanDestinationDir", false, "remove files from destination not found in static directories") cmd.Flags().Bool("cleanDestinationDir", false, "remove files from destination not found in static directories")
cmd.Flags().BoolP("buildDrafts", "D", false, "include content marked as draft") cmd.Flags().BoolP("buildDrafts", "D", false, "include content marked as draft")
cmd.Flags().BoolP("buildFuture", "F", false, "include content with publishdate in the future") cmd.Flags().BoolP("buildFuture", "F", false, "include content with publishdate in the future")
cmd.Flags().BoolP("buildExpired", "E", false, "include expired content") cmd.Flags().BoolP("buildExpired", "E", false, "include expired content")
cmd.Flags().BoolP("ignoreCache", "", false, "ignores the cache directory") cmd.Flags().StringP("contentDir", "c", "", "filesystem path to content directory")
cmd.Flags().Bool("enableGitInfo", false, "add Git revision, date, author, and CODEOWNERS info to the pages")
cmd.Flags().StringP("layoutDir", "l", "", "filesystem path to layout directory") cmd.Flags().StringP("layoutDir", "l", "", "filesystem path to layout directory")
_ = cmd.MarkFlagDirname("layoutDir") cmd.Flags().StringP("cacheDir", "", "", "filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/")
cmd.Flags().BoolP("ignoreCache", "", false, "ignores the cache directory")
cmd.Flags().StringSliceP("theme", "t", []string{}, "themes to use (located in /themes/THEMENAME/)")
cmd.Flags().StringVarP(&r.baseURL, "baseURL", "b", "", "hostname (and path) to the root, e.g. https://spf13.com/")
cmd.Flags().Bool("enableGitInfo", false, "add Git revision, date, author, and CODEOWNERS info to the pages")
cmd.Flags().BoolVar(&r.gc, "gc", false, "enable to run some cleanup tasks (remove unused cache files) after the build") cmd.Flags().BoolVar(&r.gc, "gc", false, "enable to run some cleanup tasks (remove unused cache files) after the build")
cmd.Flags().StringVar(&r.poll, "poll", "", "set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes") cmd.Flags().StringVar(&r.poll, "poll", "", "set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes")
_ = cmd.RegisterFlagCompletionFunc("poll", cobra.NoFileCompletions) cmd.Flags().BoolVar(&r.panicOnWarning, "panicOnWarning", false, "panic on first WARNING log")
cmd.Flags().Bool("panicOnWarning", false, "panic on first WARNING log")
cmd.Flags().Bool("templateMetrics", false, "display metrics about template executions") cmd.Flags().Bool("templateMetrics", false, "display metrics about template executions")
cmd.Flags().Bool("templateMetricsHints", false, "calculate some improvement hints when combined with --templateMetrics") cmd.Flags().Bool("templateMetricsHints", false, "calculate some improvement hints when combined with --templateMetrics")
cmd.Flags().BoolVar(&r.forceSyncStatic, "forceSyncStatic", false, "copy all files when static is changed.") cmd.Flags().BoolVar(&r.forceSyncStatic, "forceSyncStatic", false, "copy all files when static is changed.")
cmd.Flags().BoolP("noTimes", "", false, "don't sync modification time of files") cmd.Flags().BoolP("noTimes", "", false, "don't sync modification time of files")
cmd.Flags().BoolP("noChmod", "", false, "don't sync permission mode of files") cmd.Flags().BoolP("noChmod", "", false, "don't sync permission mode of files")
cmd.Flags().BoolP("noBuildLock", "", false, "don't create .hugo_build.lock file")
cmd.Flags().BoolP("printI18nWarnings", "", false, "print missing translations") cmd.Flags().BoolP("printI18nWarnings", "", false, "print missing translations")
cmd.Flags().BoolP("printPathWarnings", "", false, "print warnings on duplicate target paths etc.") cmd.Flags().BoolVarP(&r.printPathWarnings, "printPathWarnings", "", false, "print warnings on duplicate target paths etc.")
cmd.Flags().BoolP("printUnusedTemplates", "", false, "print warnings on unused templates.") cmd.Flags().BoolVarP(&r.printUnusedTemplates, "printUnusedTemplates", "", false, "print warnings on unused templates.")
cmd.Flags().StringVarP(&r.cpuprofile, "profile-cpu", "", "", "write cpu profile to `file`") cmd.Flags().StringVarP(&r.cpuprofile, "profile-cpu", "", "", "write cpu profile to `file`")
cmd.Flags().StringVarP(&r.memprofile, "profile-mem", "", "", "write memory profile to `file`") cmd.Flags().StringVarP(&r.memprofile, "profile-mem", "", "", "write memory profile to `file`")
cmd.Flags().BoolVarP(&r.printm, "printMemoryUsage", "", false, "print memory usage to screen at intervals") cmd.Flags().BoolVarP(&r.printm, "printMemoryUsage", "", false, "print memory usage to screen at intervals")
@ -611,8 +559,13 @@ func applyLocalFlagsBuild(cmd *cobra.Command, r *rootCommand) {
cmd.Flags().MarkHidden("profile-mutex") cmd.Flags().MarkHidden("profile-mutex")
cmd.Flags().StringSlice("disableKinds", []string{}, "disable different kind of pages (home, RSS etc.)") cmd.Flags().StringSlice("disableKinds", []string{}, "disable different kind of pages (home, RSS etc.)")
_ = cmd.RegisterFlagCompletionFunc("disableKinds", cobra.FixedCompletions(kinds.AllKinds, cobra.ShellCompDirectiveNoFileComp))
cmd.Flags().Bool("minify", false, "minify any supported output format (HTML, XML etc.)") cmd.Flags().Bool("minify", false, "minify any supported output format (HTML, XML etc.)")
_ = cmd.Flags().SetAnnotation("cacheDir", cobra.BashCompSubdirsInDir, []string{})
_ = cmd.Flags().SetAnnotation("destination", cobra.BashCompSubdirsInDir, []string{})
_ = cmd.Flags().SetAnnotation("theme", cobra.BashCompSubdirsInDir, []string{"themes"})
} }
func (r *rootCommand) timeTrack(start time.Time, name string) { func (r *rootCommand) timeTrack(start time.Time, name string) {
@ -626,7 +579,7 @@ type simpleCommand struct {
short string short string
long string long string
run func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *rootCommand, args []string) error run func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *rootCommand, args []string) error
withc func(cmd *cobra.Command, r *rootCommand) withc func(cmd *cobra.Command)
initc func(cd *simplecobra.Commandeer) error initc func(cd *simplecobra.Commandeer) error
commands []simplecobra.Commander commands []simplecobra.Commander
@ -650,7 +603,6 @@ func (c *simpleCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, arg
} }
func (c *simpleCommand) Init(cd *simplecobra.Commandeer) error { func (c *simpleCommand) Init(cd *simplecobra.Commandeer) error {
c.rootCmd = cd.Root.Command.(*rootCommand)
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = c.short cmd.Short = c.short
cmd.Long = c.long cmd.Long = c.long
@ -658,12 +610,13 @@ func (c *simpleCommand) Init(cd *simplecobra.Commandeer) error {
cmd.Use = c.use cmd.Use = c.use
} }
if c.withc != nil { if c.withc != nil {
c.withc(cmd, c.rootCmd) c.withc(cmd)
} }
return nil return nil
} }
func (c *simpleCommand) PreRun(cd, runner *simplecobra.Commandeer) error { func (c *simpleCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
c.rootCmd = cd.Root.Command.(*rootCommand)
if c.initc != nil { if c.initc != nil {
return c.initc(cd) return c.initc(cd)
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -14,8 +14,6 @@
package commands package commands
import ( import (
"context"
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
) )
@ -23,7 +21,6 @@ import (
func newExec() (*simplecobra.Exec, error) { func newExec() (*simplecobra.Exec, error) {
rootCmd := &rootCommand{ rootCmd := &rootCommand{
commands: []simplecobra.Commander{ commands: []simplecobra.Commander{
newHugoBuildCmd(),
newVersionCmd(), newVersionCmd(),
newEnvCommand(), newEnvCommand(),
newServerCommand(), newServerCommand(),
@ -40,34 +37,5 @@ func newExec() (*simplecobra.Exec, error) {
} }
return simplecobra.New(rootCmd) return simplecobra.New(rootCmd)
}
func newHugoBuildCmd() simplecobra.Commander {
return &hugoBuildCommand{}
}
// hugoBuildCommand just delegates to the rootCommand.
type hugoBuildCommand struct {
rootCmd *rootCommand
}
func (c *hugoBuildCommand) Commands() []simplecobra.Commander {
return nil
}
func (c *hugoBuildCommand) Name() string {
return "build"
}
func (c *hugoBuildCommand) Init(cd *simplecobra.Commandeer) error {
c.rootCmd = cd.Root.Command.(*rootCommand)
return c.rootCmd.initRootCommand("build", cd)
}
func (c *hugoBuildCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
return c.rootCmd.PreRun(cd, runner)
}
func (c *hugoBuildCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
return c.rootCmd.Run(ctx, cd, args)
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -17,18 +17,14 @@ import (
"bytes" "bytes"
"context" "context"
"encoding/json" "encoding/json"
"fmt"
"os" "os"
"strings" "strings"
"time" "time"
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
"github.com/gohugoio/hugo/common/maps"
"github.com/gohugoio/hugo/config/allconfig"
"github.com/gohugoio/hugo/modules" "github.com/gohugoio/hugo/modules"
"github.com/gohugoio/hugo/parser" "github.com/gohugoio/hugo/parser"
"github.com/gohugoio/hugo/parser/metadecoders" "github.com/gohugoio/hugo/parser/metadecoders"
"github.com/spf13/cobra"
) )
// newConfigCommand creates a new config command and its subcommands. // newConfigCommand creates a new config command and its subcommands.
@ -38,15 +34,12 @@ func newConfigCommand() *configCommand {
&configMountsCommand{}, &configMountsCommand{},
}, },
} }
} }
type configCommand struct { type configCommand struct {
r *rootCommand r *rootCommand
format string
lang string
printZero bool
commands []simplecobra.Commander commands []simplecobra.Commander
} }
@ -59,49 +52,37 @@ func (c *configCommand) Name() string {
} }
func (c *configCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error { func (c *configCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
conf, err := c.r.ConfigFromProvider(configKey{counter: c.r.configVersionID.Load()}, flagsToCfg(cd, nil)) conf, err := c.r.ConfigFromProvider(c.r.configVersionID.Load(), flagsToCfg(cd, nil))
if err != nil { if err != nil {
return err return err
} }
var config *allconfig.Config config := conf.configs.Base
if c.lang != "" {
var found bool
config, found = conf.configs.LanguageConfigMap[c.lang]
if !found {
return fmt.Errorf("language %q not found", c.lang)
}
} else {
config = conf.configs.LanguageConfigSlice[0]
}
var buf bytes.Buffer var buf bytes.Buffer
dec := json.NewEncoder(&buf) dec := json.NewEncoder(&buf)
dec.SetIndent("", " ") dec.SetIndent("", " ")
dec.SetEscapeHTML(false) dec.SetEscapeHTML(false)
if err := dec.Encode(parser.ReplacingJSONMarshaller{Value: config, KeysToLower: true, OmitEmpty: !c.printZero}); err != nil { if err := dec.Encode(parser.ReplacingJSONMarshaller{Value: config, KeysToLower: true, OmitEmpty: true}); err != nil {
return err return err
} }
format := strings.ToLower(c.format) format := strings.ToLower(c.r.format)
switch format { switch format {
case "json": case "json":
os.Stdout.Write(buf.Bytes()) os.Stdout.Write(buf.Bytes())
default: default:
// Decode the JSON to a map[string]interface{} and then unmarshal it again to the correct format. // Decode the JSON to a map[string]interface{} and then unmarshal it again to the correct format.
var m map[string]any var m map[string]interface{}
if err := json.Unmarshal(buf.Bytes(), &m); err != nil { if err := json.Unmarshal(buf.Bytes(), &m); err != nil {
return err return err
} }
maps.ConvertFloat64WithNoDecimalsToInt(m)
switch format { switch format {
case "yaml": case "yaml":
return parser.InterfaceToConfig(m, metadecoders.YAML, os.Stdout) return parser.InterfaceToConfig(m, metadecoders.YAML, os.Stdout)
case "toml": case "toml":
return parser.InterfaceToConfig(m, metadecoders.TOML, os.Stdout) return parser.InterfaceToConfig(m, metadecoders.TOML, os.Stdout)
default:
return fmt.Errorf("unsupported format: %q", format)
} }
} }
@ -109,21 +90,14 @@ func (c *configCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, arg
} }
func (c *configCommand) Init(cd *simplecobra.Commandeer) error { func (c *configCommand) Init(cd *simplecobra.Commandeer) error {
c.r = cd.Root.Command.(*rootCommand)
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = "Display site configuration" cmd.Short = "Print the site configuration"
cmd.Long = `Display site configuration, both default and custom settings.` cmd.Long = `Print the site configuration, both default and custom settings.`
cmd.Flags().StringVar(&c.format, "format", "toml", "preferred file format (toml, yaml or json)")
_ = cmd.RegisterFlagCompletionFunc("format", cobra.FixedCompletions([]string{"toml", "yaml", "json"}, cobra.ShellCompDirectiveNoFileComp))
cmd.Flags().StringVar(&c.lang, "lang", "", "the language to display config for. Defaults to the first language defined.")
cmd.Flags().BoolVar(&c.printZero, "printZero", false, `include config options with zero values (e.g. false, 0, "") in the output`)
_ = cmd.RegisterFlagCompletionFunc("lang", cobra.NoFileCompletions)
applyLocalFlagsBuildConfig(cmd, c.r)
return nil return nil
} }
func (c *configCommand) PreRun(cd, runner *simplecobra.Commandeer) error { func (c *configCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
c.r = cd.Root.Command.(*rootCommand)
return nil return nil
} }
@ -194,10 +168,10 @@ func (m *configModMounts) MarshalJSON() ([]byte, error) {
Dir: m.m.Dir(), Dir: m.m.Dir(),
Mounts: mounts, Mounts: mounts,
}) })
} }
type configMountsCommand struct { type configMountsCommand struct {
r *rootCommand
configCmd *configCommand configCmd *configCommand
} }
@ -211,13 +185,13 @@ func (c *configMountsCommand) Name() string {
func (c *configMountsCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error { func (c *configMountsCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
r := c.configCmd.r r := c.configCmd.r
conf, err := r.ConfigFromProvider(configKey{counter: c.r.configVersionID.Load()}, flagsToCfg(cd, nil)) conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, nil))
if err != nil { if err != nil {
return err return err
} }
for _, m := range conf.configs.Modules { for _, m := range conf.configs.Modules {
if err := parser.InterfaceToConfig(&configModMounts{m: m, verbose: r.isVerbose()}, metadecoders.JSON, os.Stdout); err != nil { if err := parser.InterfaceToConfig(&configModMounts{m: m, verbose: r.verbose}, metadecoders.JSON, os.Stdout); err != nil {
return err return err
} }
} }
@ -225,11 +199,8 @@ func (c *configMountsCommand) Run(ctx context.Context, cd *simplecobra.Commandee
} }
func (c *configMountsCommand) Init(cd *simplecobra.Commandeer) error { func (c *configMountsCommand) Init(cd *simplecobra.Commandeer) error {
c.r = cd.Root.Command.(*rootCommand)
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = "Print the configured file mounts" cmd.Short = "Print the configured file mounts"
cmd.ValidArgsFunction = cobra.NoFileCompletions
applyLocalFlagsBuildConfig(cmd, c.r)
return nil return nil
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -45,8 +45,7 @@ to use JSON for the front matter.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
return c.convertContents(metadecoders.JSON) return c.convertContents(metadecoders.JSON)
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
}, },
}, },
&simpleCommand{ &simpleCommand{
@ -57,8 +56,7 @@ to use TOML for the front matter.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
return c.convertContents(metadecoders.TOML) return c.convertContents(metadecoders.TOML)
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
}, },
}, },
&simpleCommand{ &simpleCommand{
@ -69,8 +67,7 @@ to use YAML for the front matter.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
return c.convertContents(metadecoders.YAML) return c.convertContents(metadecoders.YAML)
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
}, },
}, },
}, },
@ -87,7 +84,7 @@ type convertCommand struct {
r *rootCommand r *rootCommand
h *hugolib.HugoSites h *hugolib.HugoSites
// Commands. // Commmands.
commands []simplecobra.Commander commands []simplecobra.Commander
} }
@ -105,16 +102,14 @@ func (c *convertCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, ar
func (c *convertCommand) Init(cd *simplecobra.Commandeer) error { func (c *convertCommand) Init(cd *simplecobra.Commandeer) error {
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = "Convert front matter to another format" cmd.Short = "Convert your content to different formats"
cmd.Long = `Convert front matter to another format. cmd.Long = `Convert your content (e.g. front matter) to different formats.
See convert's subcommands toJSON, toTOML and toYAML for more information.` See convert's subcommands toJSON, toTOML and toYAML for more information.`
cmd.PersistentFlags().StringVarP(&c.outputDir, "output", "o", "", "filesystem path to write files to") cmd.PersistentFlags().StringVarP(&c.outputDir, "output", "o", "", "filesystem path to write files to")
_ = cmd.MarkFlagDirname("output")
cmd.PersistentFlags().BoolVar(&c.unsafe, "unsafe", false, "enable less safe operations, please backup first") cmd.PersistentFlags().BoolVar(&c.unsafe, "unsafe", false, "enable less safe operations, please backup first")
cmd.RunE = nil
return nil return nil
} }
@ -138,14 +133,14 @@ func (c *convertCommand) convertAndSavePage(p page.Page, site *hugolib.Site, tar
} }
} }
if p.File() == nil { if p.File().IsZero() {
// No content file. // No content file.
return nil return nil
} }
errMsg := fmt.Errorf("error processing file %q", p.File().Path()) errMsg := fmt.Errorf("error processing file %q", p.File().Path())
site.Log.Infoln("attempting to convert", p.File().Filename()) site.Log.Infoln("ttempting to convert", p.File().Filename())
f := p.File() f := p.File()
file, err := f.FileInfo().Meta().Open() file, err := f.FileInfo().Meta().Open()
@ -213,7 +208,7 @@ func (c *convertCommand) convertContents(format metadecoders.Format) error {
var pagesBackedByFile page.Pages var pagesBackedByFile page.Pages
for _, p := range site.AllPages() { for _, p := range site.AllPages() {
if p.File() == nil { if p.File().IsZero() {
continue continue
} }
pagesBackedByFile = append(pagesBackedByFile, p) pagesBackedByFile = append(pagesBackedByFile, p)

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -11,24 +11,38 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
//go:build withdeploy //go:build !nodeploy
// +build !nodeploy
// 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 commands package commands
import ( import (
"context" "context"
"github.com/gohugoio/hugo/deploy"
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
"github.com/gohugoio/hugo/deploy"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
func newDeployCommand() simplecobra.Commander { func newDeployCommand() simplecobra.Commander {
return &simpleCommand{ return &simpleCommand{
name: "deploy", name: "deploy",
short: "Deploy your site to a cloud provider", short: "Deploy your site to a Cloud provider.",
long: `Deploy your site to a cloud provider long: `Deploy your site to a Cloud provider.
See https://gohugo.io/hosting-and-deployment/hugo-deploy/ for detailed See https://gohugo.io/hosting-and-deployment/hugo-deploy/ for detailed
documentation. documentation.
@ -38,14 +52,20 @@ documentation.
if err != nil { if err != nil {
return err return err
} }
deployer, err := deploy.New(h.Configs.GetFirstLanguageConfig(), h.Log, h.PathSpec.PublishFs) deployer, err := deploy.New(h.Configs.GetFirstLanguageConfig(), h.PathSpec.PublishFs)
if err != nil { if err != nil {
return err return err
} }
return deployer.Deploy(ctx) return deployer.Deploy(ctx)
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
applyDeployFlags(cmd, r) cmd.Flags().String("target", "", "target deployment from deployments section in config file; defaults to the first one")
cmd.Flags().Bool("confirm", false, "ask for confirmation before making changes to the target")
cmd.Flags().Bool("dryRun", false, "dry run")
cmd.Flags().Bool("force", false, "force upload of all files")
cmd.Flags().Bool("invalidateCDN", true, "invalidate the CDN cache listed in the deployment target")
cmd.Flags().Int("maxDeletes", 256, "maximum # of files to delete, or -1 to disable")
cmd.Flags().Int("workers", 10, "number of workers to transfer files. defaults to 10")
}, },
} }
} }

View file

@ -1,33 +0,0 @@
// Copyright 2024 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 commands
import (
"github.com/gohugoio/hugo/deploy/deployconfig"
"github.com/spf13/cobra"
)
func applyDeployFlags(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
cmd.Flags().String("target", "", "target deployment from deployments section in config file; defaults to the first one")
_ = cmd.RegisterFlagCompletionFunc("target", cobra.NoFileCompletions)
cmd.Flags().Bool("confirm", false, "ask for confirmation before making changes to the target")
cmd.Flags().Bool("dryRun", false, "dry run")
cmd.Flags().Bool("force", false, "force upload of all files")
cmd.Flags().Bool("invalidateCDN", deployconfig.DefaultConfig.InvalidateCDN, "invalidate the CDN cache listed in the deployment target")
cmd.Flags().Int("maxDeletes", deployconfig.DefaultConfig.MaxDeletes, "maximum # of files to delete, or -1 to disable")
_ = cmd.RegisterFlagCompletionFunc("maxDeletes", cobra.NoFileCompletions)
cmd.Flags().Int("workers", deployconfig.DefaultConfig.Workers, "number of workers to transfer files. defaults to 10")
_ = cmd.RegisterFlagCompletionFunc("workers", cobra.NoFileCompletions)
}

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -11,9 +11,10 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
//go:build !withdeploy //go:build nodeploy
// +build nodeploy
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -29,10 +30,8 @@
package commands package commands
import ( import (
"context"
"errors" "errors"
"github.com/bep/simplecobra"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
@ -40,10 +39,9 @@ func newDeployCommand() simplecobra.Commander {
return &simpleCommand{ return &simpleCommand{
name: "deploy", name: "deploy",
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
return errors.New("deploy not supported in this version of Hugo; install a release with 'withdeploy' in the archive filename or build yourself with the 'withdeploy' build tag. Also see https://github.com/gohugoio/hugo/pull/12995") return nil
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
applyDeployFlags(cmd, r)
cmd.Hidden = true cmd.Hidden = true
}, },
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -19,21 +19,20 @@ import (
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
"github.com/gohugoio/hugo/common/hugo" "github.com/gohugoio/hugo/common/hugo"
"github.com/spf13/cobra"
) )
func newEnvCommand() simplecobra.Commander { func newEnvCommand() simplecobra.Commander {
return &simpleCommand{ return &simpleCommand{
name: "env", name: "env",
short: "Display version and environment info", short: "Print Hugo version and environment info",
long: "Display version and environment info. This is useful in Hugo bug reports", long: "Print Hugo version and environment info. This is useful in Hugo bug reports",
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
r.Printf("%s\n", hugo.BuildVersionString()) r.Printf("%s\n", hugo.BuildVersionString())
r.Printf("GOOS=%q\n", runtime.GOOS) r.Printf("GOOS=%q\n", runtime.GOOS)
r.Printf("GOARCH=%q\n", runtime.GOARCH) r.Printf("GOARCH=%q\n", runtime.GOARCH)
r.Printf("GOVERSION=%q\n", runtime.Version()) r.Printf("GOVERSION=%q\n", runtime.Version())
if r.isVerbose() { if r.verbose {
deps := hugo.GetDependencyList() deps := hugo.GetDependencyList()
for _, dep := range deps { for _, dep := range deps {
r.Printf("%s\n", dep) r.Printf("%s\n", dep)
@ -48,9 +47,6 @@ func newEnvCommand() simplecobra.Commander {
} }
return nil return nil
}, },
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
},
} }
} }
@ -61,10 +57,7 @@ func newVersionCmd() simplecobra.Commander {
r.Println(hugo.BuildVersionString()) r.Println(hugo.BuildVersionString())
return nil return nil
}, },
short: "Display version", short: "Print Hugo version and environment info",
long: "Display version and environment info. This is useful in Hugo bug reports.", long: "Print Hugo version and environment info. This is useful in Hugo bug reports.",
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
},
} }
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -14,14 +14,12 @@
package commands package commands
import ( import (
"bytes"
"context" "context"
"encoding/json" "encoding/json"
"fmt" "fmt"
"os" "os"
"path" "path"
"path/filepath" "path/filepath"
"slices"
"strings" "strings"
"github.com/alecthomas/chroma/v2" "github.com/alecthomas/chroma/v2"
@ -32,11 +30,8 @@ import (
"github.com/gohugoio/hugo/docshelper" "github.com/gohugoio/hugo/docshelper"
"github.com/gohugoio/hugo/helpers" "github.com/gohugoio/hugo/helpers"
"github.com/gohugoio/hugo/hugofs" "github.com/gohugoio/hugo/hugofs"
"github.com/gohugoio/hugo/hugolib"
"github.com/gohugoio/hugo/parser"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/cobra/doc" "github.com/spf13/cobra/doc"
"gopkg.in/yaml.v2"
) )
func newGenCommand() *genCommand { func newGenCommand() *genCommand {
@ -48,9 +43,7 @@ func newGenCommand() *genCommand {
// Chroma flags. // Chroma flags.
style string style string
highlightStyle string highlightStyle string
lineNumbersInlineStyle string linesStyle string
lineNumbersTableStyle string
omitEmpty bool
) )
newChromaStyles := func() simplecobra.Commander { newChromaStyles := func() simplecobra.Commander {
@ -62,49 +55,25 @@ func newGenCommand() *genCommand {
See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles`, See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
style = strings.ToLower(style)
if !slices.Contains(styles.Names(), style) {
return fmt.Errorf("invalid style: %s", style)
}
builder := styles.Get(style).Builder() builder := styles.Get(style).Builder()
if highlightStyle != "" { if highlightStyle != "" {
builder.Add(chroma.LineHighlight, highlightStyle) builder.Add(chroma.LineHighlight, highlightStyle)
} }
if lineNumbersInlineStyle != "" { if linesStyle != "" {
builder.Add(chroma.LineNumbers, lineNumbersInlineStyle) builder.Add(chroma.LineNumbers, linesStyle)
}
if lineNumbersTableStyle != "" {
builder.Add(chroma.LineNumbersTable, lineNumbersTableStyle)
} }
style, err := builder.Build() style, err := builder.Build()
if err != nil { if err != nil {
return err return err
} }
formatter := html.New(html.WithAllClasses(true))
var formatter *html.Formatter formatter.WriteCSS(os.Stdout, style)
if omitEmpty {
formatter = html.New(html.WithClasses(true))
} else {
formatter = html.New(html.WithAllClasses(true))
}
w := os.Stdout
fmt.Fprintf(w, "/* Generated using: hugo %s */\n\n", strings.Join(os.Args[1:], " "))
formatter.WriteCSS(w, style)
return nil return nil
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
cmd.PersistentFlags().StringVar(&style, "style", "friendly", "highlighter style (see https://xyproto.github.io/splash/docs/)") cmd.PersistentFlags().StringVar(&style, "style", "friendly", "highlighter style (see https://xyproto.github.io/splash/docs/)")
_ = cmd.RegisterFlagCompletionFunc("style", cobra.NoFileCompletions) cmd.PersistentFlags().StringVar(&highlightStyle, "highlightStyle", "bg:#ffffcc", "style used for highlighting lines (see https://github.com/alecthomas/chroma)")
cmd.PersistentFlags().StringVar(&highlightStyle, "highlightStyle", "", `foreground and background colors for highlighted lines, e.g. --highlightStyle "#fff000 bg:#000fff"`) cmd.PersistentFlags().StringVar(&linesStyle, "linesStyle", "", "style used for line numbers (see https://github.com/alecthomas/chroma)")
_ = cmd.RegisterFlagCompletionFunc("highlightStyle", cobra.NoFileCompletions)
cmd.PersistentFlags().StringVar(&lineNumbersInlineStyle, "lineNumbersInlineStyle", "", `foreground and background colors for inline line numbers, e.g. --lineNumbersInlineStyle "#fff000 bg:#000fff"`)
_ = cmd.RegisterFlagCompletionFunc("lineNumbersInlineStyle", cobra.NoFileCompletions)
cmd.PersistentFlags().StringVar(&lineNumbersTableStyle, "lineNumbersTableStyle", "", `foreground and background colors for table line numbers, e.g. --lineNumbersTableStyle "#fff000 bg:#000fff"`)
_ = cmd.RegisterFlagCompletionFunc("lineNumbersTableStyle", cobra.NoFileCompletions)
cmd.PersistentFlags().BoolVar(&omitEmpty, "omitEmpty", false, `omit empty CSS rules`)
_ = cmd.RegisterFlagCompletionFunc("omitEmpty", cobra.NoFileCompletions)
}, },
} }
} }
@ -128,7 +97,7 @@ See https://xyproto.github.io/splash/docs/all.html for a preview of the availabl
} }
if found, _ := helpers.Exists(genmandir, hugofs.Os); !found { if found, _ := helpers.Exists(genmandir, hugofs.Os); !found {
r.Println("Directory", genmandir, "does not exist, creating...") r.Println("Directory", genmandir, "does not exist, creating...")
if err := hugofs.Os.MkdirAll(genmandir, 0o777); err != nil { if err := hugofs.Os.MkdirAll(genmandir, 0777); err != nil {
return err return err
} }
} }
@ -141,10 +110,10 @@ See https://xyproto.github.io/splash/docs/all.html for a preview of the availabl
return nil return nil
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
cmd.PersistentFlags().StringVar(&genmandir, "dir", "man/", "the directory to write the man pages.") cmd.PersistentFlags().StringVar(&genmandir, "dir", "man/", "the directory to write the man pages.")
_ = cmd.MarkFlagDirname("dir") // For bash-completion
cmd.PersistentFlags().SetAnnotation("dir", cobra.BashCompSubdirsInDir, []string{})
}, },
} }
} }
@ -159,7 +128,7 @@ url: %s
return &simpleCommand{ return &simpleCommand{
name: "doc", name: "doc",
short: "Generate Markdown documentation for the Hugo CLI", short: "Generate Markdown documentation for the Hugo CLI.",
long: `Generate Markdown documentation for the Hugo CLI. long: `Generate Markdown documentation for the Hugo CLI.
This command is, mostly, used to create up-to-date documentation This command is, mostly, used to create up-to-date documentation
of Hugo's command-line interface for https://gohugo.io/. of Hugo's command-line interface for https://gohugo.io/.
@ -177,20 +146,20 @@ url: %s
} }
if found, _ := helpers.Exists(gendocdir, hugofs.Os); !found { if found, _ := helpers.Exists(gendocdir, hugofs.Os); !found {
r.Println("Directory", gendocdir, "does not exist, creating...") r.Println("Directory", gendocdir, "does not exist, creating...")
if err := hugofs.Os.MkdirAll(gendocdir, 0o777); err != nil { if err := hugofs.Os.MkdirAll(gendocdir, 0777); err != nil {
return err return err
} }
} }
prepender := func(filename string) string { prepender := func(filename string) string {
name := filepath.Base(filename) name := filepath.Base(filename)
base := strings.TrimSuffix(name, path.Ext(name)) base := strings.TrimSuffix(name, path.Ext(name))
url := "/docs/reference/commands/" + strings.ToLower(base) + "/" url := "/commands/" + strings.ToLower(base) + "/"
return fmt.Sprintf(gendocFrontmatterTemplate, strings.Replace(base, "_", " ", -1), base, url) return fmt.Sprintf(gendocFrontmatterTemplate, strings.Replace(base, "_", " ", -1), base, url)
} }
linkHandler := func(name string) string { linkHandler := func(name string) string {
base := strings.TrimSuffix(name, path.Ext(name)) base := strings.TrimSuffix(name, path.Ext(name))
return "/docs/reference/commands/" + strings.ToLower(base) + "/" return "/commands/" + strings.ToLower(base) + "/"
} }
r.Println("Generating Hugo command-line documentation in", gendocdir, "...") r.Println("Generating Hugo command-line documentation in", gendocdir, "...")
doc.GenMarkdownTreeCustom(cd.CobraCommand.Root(), gendocdir, prepender, linkHandler) doc.GenMarkdownTreeCustom(cd.CobraCommand.Root(), gendocdir, prepender, linkHandler)
@ -198,12 +167,13 @@ url: %s
return nil return nil
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
cmd.PersistentFlags().StringVar(&gendocdir, "dir", "/tmp/hugodoc/", "the directory to write the doc.") cmd.PersistentFlags().StringVar(&gendocdir, "dir", "/tmp/hugodoc/", "the directory to write the doc.")
_ = cmd.MarkFlagDirname("dir") // For bash-completion
cmd.PersistentFlags().SetAnnotation("dir", cobra.BashCompSubdirsInDir, []string{})
}, },
} }
} }
var docsHelperTarget string var docsHelperTarget string
@ -211,50 +181,31 @@ url: %s
newDocsHelper := func() simplecobra.Commander { newDocsHelper := func() simplecobra.Commander {
return &simpleCommand{ return &simpleCommand{
name: "docshelper", name: "docshelper",
short: "Generate some data files for the Hugo docs", short: "Generate some data files for the Hugo docs.",
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
r.Println("Generate docs data to", docsHelperTarget) r.Println("Generate docs data to", docsHelperTarget)
var buf bytes.Buffer targetFile := filepath.Join(docsHelperTarget, "docs.json")
jsonEnc := json.NewEncoder(&buf)
configProvider := func() docshelper.DocProvider {
conf := hugolib.DefaultConfig()
conf.CacheDir = "" // The default value does not make sense in the docs.
defaultConfig := parser.NullBoolJSONMarshaller{Wrapped: parser.LowerCaseCamelJSONMarshaller{Value: conf}}
return docshelper.DocProvider{"config": defaultConfig}
}
docshelper.AddDocProviderFunc(configProvider)
if err := jsonEnc.Encode(docshelper.GetDocProvider()); err != nil {
return err
}
// Decode the JSON to a map[string]interface{} and then unmarshal it again to the correct format.
var m map[string]any
if err := json.Unmarshal(buf.Bytes(), &m); err != nil {
return err
}
targetFile := filepath.Join(docsHelperTarget, "docs.yaml")
f, err := os.Create(targetFile) f, err := os.Create(targetFile)
if err != nil { if err != nil {
return err return err
} }
defer f.Close() defer f.Close()
yamlEnc := yaml.NewEncoder(f)
if err := yamlEnc.Encode(m); err != nil { enc := json.NewEncoder(f)
enc.SetIndent("", " ")
if err := enc.Encode(docshelper.GetDocProvider()); err != nil {
return err return err
} }
r.Println("Done!") r.Println("Done!")
return nil return nil
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.Hidden = true cmd.Hidden = true
cmd.ValidArgsFunction = cobra.NoFileCompletions
cmd.PersistentFlags().StringVarP(&docsHelperTarget, "dir", "", "docs/data", "data dir") cmd.PersistentFlags().StringVarP(&docsHelperTarget, "dir", "", "docs/data", "data dir")
}, },
} }
@ -268,6 +219,7 @@ url: %s
newDocsHelper(), newDocsHelper(),
}, },
} }
} }
type genCommand struct { type genCommand struct {
@ -290,10 +242,7 @@ func (c *genCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args [
func (c *genCommand) Init(cd *simplecobra.Commandeer) error { func (c *genCommand) Init(cd *simplecobra.Commandeer) error {
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = "Generate documentation and syntax highlighting styles" cmd.Short = "A collection of several useful generators."
cmd.Long = "Generate documentation for your project using Hugo's documentation engine, including syntax highlighting for various programming languages."
cmd.RunE = nil
return nil return nil
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -14,6 +14,7 @@
package commands package commands
import ( import (
"bytes"
"errors" "errors"
"fmt" "fmt"
"log" "log"
@ -23,6 +24,8 @@ import (
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
"github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/helpers"
"github.com/spf13/afero"
"github.com/spf13/pflag" "github.com/spf13/pflag"
) )
@ -78,6 +81,8 @@ func flagsToCfgWithAdditionalConfigBase(cd *simplecobra.Commandeer, cfg config.P
keyMap := map[string]string{ keyMap := map[string]string{
"minify": "minifyOutput", "minify": "minifyOutput",
"destination": "publishDir", "destination": "publishDir",
"printI18nWarnings": "logI18nWarnings",
"printPathWarnings": "logPathWarnings",
"editor": "newContentEditor", "editor": "newContentEditor",
} }
@ -86,6 +91,7 @@ func flagsToCfgWithAdditionalConfigBase(cd *simplecobra.Commandeer, cfg config.P
"quiet": true, "quiet": true,
"verbose": true, "verbose": true,
"watch": true, "watch": true,
"disableLiveReload": true,
"liveReloadPort": true, "liveReloadPort": true,
"renderToMemory": true, "renderToMemory": true,
"clock": true, "clock": true,
@ -110,11 +116,20 @@ func flagsToCfgWithAdditionalConfigBase(cd *simplecobra.Commandeer, cfg config.P
}) })
return cfg return cfg
} }
func mkdir(x ...string) { func mkdir(x ...string) {
p := filepath.Join(x...) p := filepath.Join(x...)
err := os.MkdirAll(p, 0o777) // before umask err := os.MkdirAll(p, 0777) // before umask
if err != nil {
log.Fatal(err)
}
}
func touchFile(fs afero.Fs, filename string) {
mkdir(filepath.Dir(filename))
err := helpers.WriteToDisk(filename, bytes.NewReader([]byte{}), fs)
if err != nil { if err != nil {
log.Fatal(err) log.Fatal(err)
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -25,9 +25,9 @@ func init() {
// This message to show to Windows users if Hugo is opened from explorer.exe // This message to show to Windows users if Hugo is opened from explorer.exe
cobra.MousetrapHelpText = ` cobra.MousetrapHelpText = `
Hugo is a command-line tool for generating static websites. Hugo is a command-line tool for generating static website.
You need to open PowerShell and run Hugo from there. You need to open cmd.exe and run Hugo from there.
Visit https://gohugo.io/ for more information.` Visit https://gohugo.io/ for more information.`
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -24,7 +24,6 @@ import (
"runtime/trace" "runtime/trace"
"strings" "strings"
"sync" "sync"
"sync/atomic"
"time" "time"
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
@ -32,9 +31,7 @@ import (
"github.com/gohugoio/hugo/common/herrors" "github.com/gohugoio/hugo/common/herrors"
"github.com/gohugoio/hugo/common/htime" "github.com/gohugoio/hugo/common/htime"
"github.com/gohugoio/hugo/common/hugo" "github.com/gohugoio/hugo/common/hugo"
"github.com/gohugoio/hugo/common/loggers"
"github.com/gohugoio/hugo/common/maps" "github.com/gohugoio/hugo/common/maps"
"github.com/gohugoio/hugo/common/paths"
"github.com/gohugoio/hugo/common/terminal" "github.com/gohugoio/hugo/common/terminal"
"github.com/gohugoio/hugo/common/types" "github.com/gohugoio/hugo/common/types"
"github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config"
@ -42,10 +39,11 @@ import (
"github.com/gohugoio/hugo/hugofs" "github.com/gohugoio/hugo/hugofs"
"github.com/gohugoio/hugo/hugolib" "github.com/gohugoio/hugo/hugolib"
"github.com/gohugoio/hugo/hugolib/filesystems" "github.com/gohugoio/hugo/hugolib/filesystems"
"github.com/gohugoio/hugo/identity"
"github.com/gohugoio/hugo/livereload" "github.com/gohugoio/hugo/livereload"
"github.com/gohugoio/hugo/resources/page" "github.com/gohugoio/hugo/resources/page"
"github.com/gohugoio/hugo/tpl"
"github.com/gohugoio/hugo/watcher" "github.com/gohugoio/hugo/watcher"
"github.com/spf13/afero"
"github.com/spf13/fsync" "github.com/spf13/fsync"
"golang.org/x/sync/errgroup" "golang.org/x/sync/errgroup"
"golang.org/x/sync/semaphore" "golang.org/x/sync/semaphore"
@ -62,7 +60,7 @@ type hugoBuilder struct {
// Currently only set when in "fast render mode". // Currently only set when in "fast render mode".
changeDetector *fileChangeDetector changeDetector *fileChangeDetector
visitedURLs *types.EvictingQueue[string] visitedURLs *types.EvictingStringQueue
fullRebuildSem *semaphore.Weighted fullRebuildSem *semaphore.Weighted
debounce func(f func()) debounce func(f func())
@ -70,19 +68,15 @@ type hugoBuilder struct {
onConfigLoaded func(reloaded bool) error onConfigLoaded func(reloaded bool) error
fastRenderMode bool fastRenderMode bool
buildWatch bool
showErrorInBrowser bool showErrorInBrowser bool
errState hugoBuilderErrState errState hugoBuilderErrState
} }
var errConfigNotSet = errors.New("config not set")
func (c *hugoBuilder) withConfE(fn func(conf *commonConfig) error) error { func (c *hugoBuilder) withConfE(fn func(conf *commonConfig) error) error {
c.confmu.Lock() c.confmu.Lock()
defer c.confmu.Unlock() defer c.confmu.Unlock()
if c.conf == nil {
return errConfigNotSet
}
return fn(c.conf) return fn(c.conf)
} }
@ -90,6 +84,7 @@ func (c *hugoBuilder) withConf(fn func(conf *commonConfig)) {
c.confmu.Lock() c.confmu.Lock()
defer c.confmu.Unlock() defer c.confmu.Unlock()
fn(c.conf) fn(c.conf)
} }
type hugoBuilderErrState struct { type hugoBuilderErrState struct {
@ -135,14 +130,52 @@ func (e *hugoBuilderErrState) wasErr() bool {
return e.waserr return e.waserr
} }
func (c *hugoBuilder) errCount() int {
return int(c.r.logger.LogCounters().ErrorCounter.Count())
}
// getDirList provides NewWatcher() with a list of directories to watch for changes. // getDirList provides NewWatcher() with a list of directories to watch for changes.
func (c *hugoBuilder) getDirList() ([]string, error) { func (c *hugoBuilder) getDirList() ([]string, error) {
var filenames []string
walkFn := func(path string, fi hugofs.FileMetaInfo, err error) error {
if err != nil {
c.r.logger.Errorln("walker: ", err)
return nil
}
if fi.IsDir() {
if fi.Name() == ".git" ||
fi.Name() == "node_modules" || fi.Name() == "bower_components" {
return filepath.SkipDir
}
filenames = append(filenames, fi.Meta().Filename)
}
return nil
}
h, err := c.hugo() h, err := c.hugo()
if err != nil { if err != nil {
return nil, err return nil, err
} }
watchFiles := h.PathSpec.BaseFs.WatchDirs()
for _, fi := range watchFiles {
if !fi.IsDir() {
filenames = append(filenames, fi.Meta().Filename)
continue
}
return helpers.UniqueStringsSorted(h.PathSpec.BaseFs.WatchFilenames()), nil w := hugofs.NewWalkway(hugofs.WalkwayConfig{Logger: c.r.logger, Info: fi, WalkFn: walkFn})
if err := w.Walk(); err != nil {
c.r.logger.Errorln("walker: ", err)
}
}
filenames = helpers.UniqueStringsSorted(filenames)
return filenames, nil
} }
func (c *hugoBuilder) initCPUProfile() (func(), error) { func (c *hugoBuilder) initCPUProfile() (func(), error) {
@ -330,7 +363,7 @@ func (c *hugoBuilder) newWatcher(pollIntervalStr string, dirList ...string) (*wa
configFiles = conf.configs.LoadingInfo.ConfigFiles configFiles = conf.configs.LoadingInfo.ConfigFiles
}) })
c.r.Println("Watching for config changes in", strings.Join(configFiles, ", ")) c.r.logger.Println("Watching for config changes in", strings.Join(configFiles, ", "))
for _, configFile := range configFiles { for _, configFile := range configFiles {
watcher.Add(configFile) watcher.Add(configFile)
configSet[configFile] = true configSet[configFile] = true
@ -339,26 +372,6 @@ func (c *hugoBuilder) newWatcher(pollIntervalStr string, dirList ...string) (*wa
go func() { go func() {
for { for {
select { select {
case changes := <-c.r.changesFromBuild:
unlock, err := h.LockBuild()
if err != nil {
c.r.logger.Errorln("Failed to acquire a build lock: %s", err)
return
}
c.changeDetector.PrepareNew()
err = c.rebuildSitesForChanges(changes)
if err != nil {
c.r.logger.Errorln("Error while watching:", err)
}
if c.s != nil && c.s.doLiveReload {
doReload := c.changeDetector == nil || len(c.changeDetector.changed()) > 0
doReload = doReload || c.showErrorInBrowser && c.errState.buildErr() != nil
if doReload {
livereload.ForceRefresh()
}
}
unlock()
case evs := <-watcher.Events: case evs := <-watcher.Events:
unlock, err := h.LockBuild() unlock, err := h.LockBuild()
if err != nil { if err != nil {
@ -366,7 +379,7 @@ func (c *hugoBuilder) newWatcher(pollIntervalStr string, dirList ...string) (*wa
return return
} }
c.handleEvents(watcher, staticSyncer, evs, configSet) c.handleEvents(watcher, staticSyncer, evs, configSet)
if c.showErrorInBrowser && c.errState.buildErr() != nil { if c.showErrorInBrowser && c.errCount() > 0 {
// Need to reload browser to show the error // Need to reload browser to show the error
livereload.ForceRefresh() livereload.ForceRefresh()
} }
@ -405,6 +418,25 @@ func (c *hugoBuilder) build() error {
return err return err
} }
if c.r.printPathWarnings {
hugofs.WalkFilesystems(h.Fs.PublishDir, func(fs afero.Fs) bool {
if dfs, ok := fs.(hugofs.DuplicatesReporter); ok {
dupes := dfs.ReportDuplicates()
if dupes != "" {
c.r.logger.Warnln("Duplicate target paths:", dupes)
}
}
return false
})
}
if c.r.printUnusedTemplates {
unusedTemplates := h.Tmpl().(tpl.UnusedTemplatesProvider).UnusedTemplates()
for _, unusedTemplate := range unusedTemplates {
c.r.logger.Warnf("Template %s is unused, source file %s", unusedTemplate.Name(), unusedTemplate.Filename())
}
}
h.PrintProcessingStats(os.Stdout) h.PrintProcessingStats(os.Stdout)
c.r.Println() c.r.Println()
} }
@ -413,17 +445,11 @@ func (c *hugoBuilder) build() error {
} }
func (c *hugoBuilder) buildSites(noBuildLock bool) (err error) { func (c *hugoBuilder) buildSites(noBuildLock bool) (err error) {
defer func() { h, err := c.hugo()
c.errState.setBuildErr(err)
}()
var h *hugolib.HugoSites
h, err = c.hugo()
if err != nil { if err != nil {
return return err
} }
err = h.Build(hugolib.BuildCfg{NoBuildLock: noBuildLock}) return h.Build(hugolib.BuildCfg{NoBuildLock: noBuildLock})
return
} }
func (c *hugoBuilder) copyStatic() (map[string]uint64, error) { func (c *hugoBuilder) copyStatic() (map[string]uint64, error) {
@ -435,7 +461,6 @@ func (c *hugoBuilder) copyStatic() (map[string]uint64, error) {
} }
func (c *hugoBuilder) copyStaticTo(sourceFs *filesystems.SourceFilesystem) (uint64, error) { func (c *hugoBuilder) copyStaticTo(sourceFs *filesystems.SourceFilesystem) (uint64, error) {
infol := c.r.logger.InfoCommand("static")
publishDir := helpers.FilePathSeparator publishDir := helpers.FilePathSeparator
if sourceFs.PublishFolder != "" { if sourceFs.PublishFolder != "" {
@ -459,13 +484,13 @@ func (c *hugoBuilder) copyStaticTo(sourceFs *filesystems.SourceFilesystem) (uint
syncer.SrcFs = fs syncer.SrcFs = fs
if syncer.Delete { if syncer.Delete {
infol.Logf("removing all files from destination that don't exist in static dirs") c.r.logger.Infoln("removing all files from destination that don't exist in static dirs")
syncer.DeleteFilter = func(f fsync.FileInfo) bool { syncer.DeleteFilter = func(f os.FileInfo) bool {
return f.IsDir() && strings.HasPrefix(f.Name(), ".") return f.IsDir() && strings.HasPrefix(f.Name(), ".")
} }
} }
start := time.Now() c.r.logger.Infoln("syncing static files to", publishDir)
// because we are using a baseFs (to get the union right). // because we are using a baseFs (to get the union right).
// set sync src to root // set sync src to root
@ -473,10 +498,9 @@ func (c *hugoBuilder) copyStaticTo(sourceFs *filesystems.SourceFilesystem) (uint
if err != nil { if err != nil {
return 0, err return 0, err
} }
loggers.TimeTrackf(infol, start, nil, "syncing static files to %s", publishDir)
// Sync runs Stat 2 times for every source file. // Sync runs Stat 3 times for every source file (which sounds much)
numFiles := fs.statCounter / 2 numFiles := fs.statCounter / 3
return numFiles, err return numFiles, err
} }
@ -521,14 +545,15 @@ func (c *hugoBuilder) fullBuild(noBuildLock bool) error {
langCount map[string]uint64 langCount map[string]uint64
) )
c.r.logger.Println("Start building sites … ") if !c.r.quiet {
c.r.logger.Println(hugo.BuildVersionString()) fmt.Println("Start building sites … ")
c.r.logger.Println() fmt.Println(hugo.BuildVersionString())
if terminal.IsTerminal(os.Stdout) { if terminal.IsTerminal(os.Stdout) {
defer func() { defer func() {
fmt.Print(showCursor + clearLine) fmt.Print(showCursor + clearLine)
}() }()
} }
}
copyStaticFunc := func() error { copyStaticFunc := func() error {
cnt, err := c.copyStatic() cnt, err := c.copyStatic()
@ -612,16 +637,13 @@ func (c *hugoBuilder) fullRebuild(changeType string) {
time.Sleep(2 * time.Second) time.Sleep(2 * time.Second)
}() }()
defer c.postBuild("Rebuilt", time.Now()) defer c.r.timeTrack(time.Now(), "Rebuilt")
err := c.reloadConfig() err := c.reloadConfig()
if err != nil { if err != nil {
// Set the processing on pause until the state is recovered. // Set the processing on pause until the state is recovered.
c.errState.setPaused(true) c.errState.setPaused(true)
c.handleBuildErr(err, "Failed to reload config") c.handleBuildErr(err, "Failed to reload config")
if c.s.doLiveReload {
livereload.ForceRefresh()
}
} else { } else {
c.errState.setPaused(false) c.errState.setPaused(false)
} }
@ -650,44 +672,13 @@ func (c *hugoBuilder) handleBuildErr(err error, msg string) {
func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher, func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
staticSyncer *staticSyncer, staticSyncer *staticSyncer,
evs []fsnotify.Event, evs []fsnotify.Event,
configSet map[string]bool, configSet map[string]bool) {
) {
defer func() { defer func() {
c.errState.setWasErr(false) c.errState.setWasErr(false)
}() }()
var isHandled bool var isHandled bool
// Filter out ghost events (from deleted, renamed directories).
// This seems to be a bug in fsnotify, or possibly MacOS.
var n int
for _, ev := range evs {
keep := true
// Write and rename operations are often followed by CHMOD.
// There may be valid use cases for rebuilding the site on CHMOD,
// but that will require more complex logic than this simple conditional.
// On OS X this seems to be related to Spotlight, see:
// https://github.com/go-fsnotify/fsnotify/issues/15
// A workaround is to put your site(s) on the Spotlight exception list,
// but that may be a little mysterious for most end users.
// So, for now, we skip reload on CHMOD.
// We do have to check for WRITE though. On slower laptops a Chmod
// could be aggregated with other important events, and we still want
// to rebuild on those
if ev.Op == fsnotify.Chmod {
keep = false
} else if ev.Has(fsnotify.Create) || ev.Has(fsnotify.Write) {
if _, err := os.Stat(ev.Name); err != nil {
keep = false
}
}
if keep {
evs[n] = ev
n++
}
}
evs = evs[:n]
for _, ev := range evs { for _, ev := range evs {
isConfig := configSet[ev.Name] isConfig := configSet[ev.Name]
configChangeType := configChangeConfig configChangeType := configChangeConfig
@ -755,39 +746,48 @@ func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
return return
} }
c.r.logger.Debugln("Received System Events:", evs) c.r.logger.Infoln("Received System Events:", evs)
staticEvents := []fsnotify.Event{} staticEvents := []fsnotify.Event{}
dynamicEvents := []fsnotify.Event{} dynamicEvents := []fsnotify.Event{}
filterDuplicateEvents := func(evs []fsnotify.Event) []fsnotify.Event { filtered := []fsnotify.Event{}
seen := make(map[string]bool)
var n int
for _, ev := range evs {
if seen[ev.Name] {
continue
}
seen[ev.Name] = true
evs[n] = ev
n++
}
return evs[:n]
}
h, err := c.hugo() h, err := c.hugo()
if err != nil { if err != nil {
c.r.logger.Errorln("Error getting the Hugo object:", err) c.r.logger.Errorln("Error getting the Hugo object:", err)
return return
} }
n = 0
for _, ev := range evs { for _, ev := range evs {
if h.ShouldSkipFileChangeEvent(ev) { if h.ShouldSkipFileChangeEvent(ev) {
continue continue
} }
evs[n] = ev // Check the most specific first, i.e. files.
n++ contentMapped := h.ContentChanges.GetSymbolicLinkMappings(ev.Name)
if len(contentMapped) > 0 {
for _, mapped := range contentMapped {
filtered = append(filtered, fsnotify.Event{Name: mapped, Op: ev.Op})
} }
evs = evs[:n] continue
}
// Check for any symbolic directory mapping.
dir, name := filepath.Split(ev.Name)
contentMapped = h.ContentChanges.GetSymbolicLinkMappings(dir)
if len(contentMapped) == 0 {
filtered = append(filtered, ev)
continue
}
for _, mapped := range contentMapped {
mappedFilename := filepath.Join(mapped, name)
filtered = append(filtered, fsnotify.Event{Name: mappedFilename, Op: ev.Op})
}
}
evs = filtered
for _, ev := range evs { for _, ev := range evs {
ext := filepath.Ext(ev.Name) ext := filepath.Ext(ev.Name)
@ -795,7 +795,6 @@ func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
istemp := strings.HasSuffix(ext, "~") || istemp := strings.HasSuffix(ext, "~") ||
(ext == ".swp") || // vim (ext == ".swp") || // vim
(ext == ".swx") || // vim (ext == ".swx") || // vim
(ext == ".bck") || // helix
(ext == ".tmp") || // generic temp file (ext == ".tmp") || // generic temp file
(ext == ".DS_Store") || // OSX Thumbnail (ext == ".DS_Store") || // OSX Thumbnail
baseName == "4913" || // vim baseName == "4913" || // vim
@ -809,7 +808,6 @@ func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
if istemp { if istemp {
continue continue
} }
if h.Deps.SourceSpec.IgnoreFile(ev.Name) { if h.Deps.SourceSpec.IgnoreFile(ev.Name) {
continue continue
} }
@ -818,7 +816,22 @@ func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
continue continue
} }
walkAdder := func(path string, f hugofs.FileMetaInfo) error { // Write and rename operations are often followed by CHMOD.
// There may be valid use cases for rebuilding the site on CHMOD,
// but that will require more complex logic than this simple conditional.
// On OS X this seems to be related to Spotlight, see:
// https://github.com/go-fsnotify/fsnotify/issues/15
// A workaround is to put your site(s) on the Spotlight exception list,
// but that may be a little mysterious for most end users.
// So, for now, we skip reload on CHMOD.
// We do have to check for WRITE though. On slower laptops a Chmod
// could be aggregated with other important events, and we still want
// to rebuild on those
if ev.Op&(fsnotify.Chmod|fsnotify.Write|fsnotify.Create) == fsnotify.Chmod {
continue
}
walkAdder := func(path string, f hugofs.FileMetaInfo, err error) error {
if f.IsDir() { if f.IsDir() {
c.r.logger.Println("adding created directory to watchlist", path) c.r.logger.Println("adding created directory to watchlist", path)
if err := watcher.Add(path); err != nil { if err := watcher.Add(path); err != nil {
@ -834,10 +847,11 @@ func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
} }
// recursively add new directories to watch list // recursively add new directories to watch list
if ev.Has(fsnotify.Create) || ev.Has(fsnotify.Rename) { // When mkdir -p is used, only the top directory triggers an event (at least on OSX)
if ev.Op&fsnotify.Create == fsnotify.Create {
c.withConf(func(conf *commonConfig) { c.withConf(func(conf *commonConfig) {
if s, err := conf.fs.Source.Stat(ev.Name); err == nil && s.Mode().IsDir() { if s, err := conf.fs.Source.Stat(ev.Name); err == nil && s.Mode().IsDir() {
_ = helpers.Walk(conf.fs.Source, ev.Name, walkAdder) _ = helpers.SymbolicWalk(conf.fs.Source, ev.Name, walkAdder)
} }
}) })
} }
@ -849,11 +863,6 @@ func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
} }
} }
lrl := c.r.logger.InfoCommand("livereload")
staticEvents = filterDuplicateEvents(staticEvents)
dynamicEvents = filterDuplicateEvents(dynamicEvents)
if len(staticEvents) > 0 { if len(staticEvents) > 0 {
c.printChangeDetected("Static files") c.printChangeDetected("Static files")
@ -874,20 +883,19 @@ func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
if c.s != nil && c.s.doLiveReload { if c.s != nil && c.s.doLiveReload {
// Will block forever trying to write to a channel that nobody is reading if livereload isn't initialized // Will block forever trying to write to a channel that nobody is reading if livereload isn't initialized
// force refresh when more than one file
if !c.errState.wasErr() && len(staticEvents) == 1 { if !c.errState.wasErr() && len(staticEvents) == 1 {
ev := staticEvents[0]
h, err := c.hugo() h, err := c.hugo()
if err != nil { if err != nil {
c.r.logger.Errorln("Error getting the Hugo object:", err) c.r.logger.Errorln("Error getting the Hugo object:", err)
return return
} }
path := h.BaseFs.SourceFilesystems.MakeStaticPathRelative(ev.Name)
path = h.RelURL(helpers.ToSlashTrimLeading(path), false)
path := h.BaseFs.SourceFilesystems.MakeStaticPathRelative(staticEvents[0].Name)
path = h.RelURL(paths.ToSlashTrimLeading(path), false)
lrl.Logf("refreshing static file %q", path)
livereload.RefreshPath(path) livereload.RefreshPath(path)
} else { } else {
lrl.Logf("got %d static file change events, force refresh", len(staticEvents))
livereload.ForceRefresh() livereload.ForceRefresh()
} }
} }
@ -898,47 +906,33 @@ func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
h.BaseFs.SourceFilesystems, h.BaseFs.SourceFilesystems,
dynamicEvents) dynamicEvents)
onePageName := pickOneWriteOrCreatePath(h.Conf.ContentTypes(), partitionedEvents.ContentEvents) onePageName := pickOneWriteOrCreatePath(partitionedEvents.ContentEvents)
c.printChangeDetected("") c.printChangeDetected("")
c.changeDetector.PrepareNew() c.changeDetector.PrepareNew()
func() { func() {
defer c.postBuild("Total", time.Now()) defer c.r.timeTrack(time.Now(), "Total")
if err := c.rebuildSites(dynamicEvents); err != nil { if err := c.rebuildSites(dynamicEvents); err != nil {
c.handleBuildErr(err, "Rebuild failed") c.handleBuildErr(err, "Rebuild failed")
} }
}() }()
if c.s != nil && c.s.doLiveReload { if c.s != nil && c.s.doLiveReload {
if len(partitionedEvents.ContentEvents) == 0 && len(partitionedEvents.AssetEvents) > 0 {
if c.errState.wasErr() { if c.errState.wasErr() {
livereload.ForceRefresh() livereload.ForceRefresh()
return return
} }
changed := c.changeDetector.changed() changed := c.changeDetector.changed()
if c.changeDetector != nil { if c.changeDetector != nil && len(changed) == 0 {
if len(changed) >= 10 {
lrl.Logf("build changed %d files", len(changed))
} else {
lrl.Logf("build changed %d files: %q", len(changed), changed)
}
if len(changed) == 0 {
// Nothing has changed. // Nothing has changed.
return return
} } else if len(changed) == 1 {
} pathToRefresh := h.PathSpec.RelURL(helpers.ToSlashTrimLeading(changed[0]), false)
livereload.RefreshPath(pathToRefresh)
// If this change set also contains one or more CSS files, we need to
// refresh these as well.
var cssChanges []string
var otherChanges []string
for _, ev := range changed {
if strings.HasSuffix(ev, ".css") {
cssChanges = append(cssChanges, ev)
} else { } else {
otherChanges = append(otherChanges, ev) livereload.ForceRefresh()
} }
} }
@ -954,49 +948,14 @@ func (c *hugoBuilder) handleEvents(watcher *watcher.Batcher,
} }
} }
if p != nil && p.RelPermalink() != "" { if p != nil {
link, port := p.RelPermalink(), p.Site().ServerPort() livereload.NavigateToPathForPort(p.RelPermalink(), p.Site().ServerPort())
lrl.Logf("navigating to %q using port %d", link, port)
livereload.NavigateToPathForPort(link, port)
} else { } else {
lrl.Logf("no page to navigate to, force refresh")
livereload.ForceRefresh() livereload.ForceRefresh()
} }
} else if len(otherChanges) > 0 {
if len(otherChanges) == 1 {
// Allow single changes to be refreshed without a full page reload.
pathToRefresh := h.PathSpec.RelURL(paths.ToSlashTrimLeading(otherChanges[0]), false)
lrl.Logf("refreshing %q", pathToRefresh)
livereload.RefreshPath(pathToRefresh)
} else if len(cssChanges) == 0 || len(otherChanges) > 1 {
lrl.Logf("force refresh")
livereload.ForceRefresh()
}
} else {
lrl.Logf("force refresh")
livereload.ForceRefresh()
}
if len(cssChanges) > 0 {
// Allow some time for the live reload script to get reconnected.
if len(otherChanges) > 0 {
time.Sleep(200 * time.Millisecond)
}
for _, ev := range cssChanges {
pathToRefresh := h.PathSpec.RelURL(paths.ToSlashTrimLeading(ev), false)
lrl.Logf("refreshing CSS %q", pathToRefresh)
livereload.RefreshPath(pathToRefresh)
} }
} }
} }
}
}
func (c *hugoBuilder) postBuild(what string, start time.Time) {
if h, err := c.hugo(); err == nil && h.Conf.Running() {
h.LogServerAddresses()
}
c.r.timeTrack(start, what)
} }
func (c *hugoBuilder) hugo() (*hugolib.HugoSites, error) { func (c *hugoBuilder) hugo() (*hugolib.HugoSites, error) {
@ -1005,6 +964,7 @@ func (c *hugoBuilder) hugo() (*hugolib.HugoSites, error) {
var err error var err error
h, err = c.r.HugFromConfig(conf) h, err = c.r.HugFromConfig(conf)
return err return err
}); err != nil { }); err != nil {
return nil, err return nil, err
} }
@ -1028,7 +988,7 @@ func (c *hugoBuilder) hugoTry() *hugolib.HugoSites {
func (c *hugoBuilder) loadConfig(cd *simplecobra.Commandeer, running bool) error { func (c *hugoBuilder) loadConfig(cd *simplecobra.Commandeer, running bool) error {
cfg := config.New() cfg := config.New()
cfg.Set("renderToMemory", c.r.renderToMemory) cfg.Set("renderToDisk", (c.s == nil && !c.r.renderToMemory) || (c.s != nil && c.s.renderToDisk))
watch := c.r.buildWatch || (c.s != nil && c.s.serverWatch) watch := c.r.buildWatch || (c.s != nil && c.s.serverWatch)
if c.r.environment == "" { if c.r.environment == "" {
// We need to set the environment as early as possible because we need it to load the correct config. // We need to set the environment as early as possible because we need it to load the correct config.
@ -1051,20 +1011,14 @@ func (c *hugoBuilder) loadConfig(cd *simplecobra.Commandeer, running bool) error
cfg.Set("internal", maps.Params{ cfg.Set("internal", maps.Params{
"running": running, "running": running,
"watch": watch, "watch": watch,
"verbose": c.r.isVerbose(), "verbose": c.r.verbose,
"fastRenderMode": c.fastRenderMode,
}) })
conf, err := c.r.ConfigFromProvider(configKey{counter: c.r.configVersionID.Load()}, flagsToCfg(cd, cfg)) conf, err := c.r.ConfigFromProvider(c.r.configVersionID.Load(), flagsToCfg(cd, cfg))
if err != nil { if err != nil {
return err return err
} }
if len(conf.configs.LoadingInfo.ConfigFiles) == 0 {
//lint:ignore ST1005 end user message.
return errors.New("Unable to locate config file or config directory. Perhaps you need to create a new site.\nRun `hugo help new` for details.")
}
c.conf = conf c.conf = conf
if c.onConfigLoaded != nil { if c.onConfigLoaded != nil {
if err := c.onConfigLoaded(false); err != nil { if err := c.onConfigLoaded(false); err != nil {
@ -1073,65 +1027,57 @@ func (c *hugoBuilder) loadConfig(cd *simplecobra.Commandeer, running bool) error
} }
return nil return nil
}
var rebuildCounter atomic.Uint64 }
func (c *hugoBuilder) printChangeDetected(typ string) { func (c *hugoBuilder) printChangeDetected(typ string) {
msg := "\nChange" msg := "\nChange"
if typ != "" { if typ != "" {
msg += " of " + typ msg += " of " + typ
} }
msg += fmt.Sprintf(" detected, rebuilding site (#%d).", rebuildCounter.Add(1)) msg += " detected, rebuilding site."
c.r.logger.Println(msg) c.r.logger.Println(msg)
const layout = "2006-01-02 15:04:05.000 -0700" const layout = "2006-01-02 15:04:05.000 -0700"
c.r.logger.Println(htime.Now().Format(layout)) c.r.logger.Println(htime.Now().Format(layout))
} }
func (c *hugoBuilder) rebuildSites(events []fsnotify.Event) (err error) { func (c *hugoBuilder) rebuildSites(events []fsnotify.Event) error {
defer func() {
c.errState.setBuildErr(err)
}()
if err := c.errState.buildErr(); err != nil { if err := c.errState.buildErr(); err != nil {
ferrs := herrors.UnwrapFileErrorsWithErrorContext(err) ferrs := herrors.UnwrapFileErrorsWithErrorContext(err)
for _, err := range ferrs { for _, err := range ferrs {
events = append(events, fsnotify.Event{Name: err.Position().Filename, Op: fsnotify.Write}) events = append(events, fsnotify.Event{Name: err.Position().Filename, Op: fsnotify.Write})
} }
} }
var h *hugolib.HugoSites c.errState.setBuildErr(nil)
h, err = c.hugo() visited := c.visitedURLs.PeekAllSet()
h, err := c.hugo()
if err != nil { if err != nil {
return return err
} }
err = h.Build(hugolib.BuildCfg{NoBuildLock: true, RecentlyTouched: c.visitedURLs, ErrRecovery: c.errState.wasErr()}, events...) if c.fastRenderMode {
return c.withConf(func(conf *commonConfig) {
} // Make sure we always render the home pages
for _, l := range conf.configs.Languages {
func (c *hugoBuilder) rebuildSitesForChanges(ids []identity.Identity) (err error) { langPath := h.GetLangSubDir(l.Lang)
defer func() { if langPath != "" {
c.errState.setBuildErr(err) langPath = langPath + "/"
}()
var h *hugolib.HugoSites
h, err = c.hugo()
if err != nil {
return
} }
whatChanged := &hugolib.WhatChanged{} home := h.PrependBasePath("/"+langPath, false)
whatChanged.Add(ids...) visited[home] = true
err = h.Build(hugolib.BuildCfg{NoBuildLock: true, WhatChanged: whatChanged, RecentlyTouched: c.visitedURLs, ErrRecovery: c.errState.wasErr()}) }
})
return }
return h.Build(hugolib.BuildCfg{NoBuildLock: true, RecentlyVisited: visited, ErrRecovery: c.errState.wasErr()}, events...)
} }
func (c *hugoBuilder) reloadConfig() error { func (c *hugoBuilder) reloadConfig() error {
c.r.resetLogs() c.r.Reset()
c.r.configVersionID.Add(1) c.r.configVersionID.Add(1)
if err := c.withConfE(func(conf *commonConfig) error { if err := c.withConfE(func(conf *commonConfig) error {
oldConf := conf oldConf := conf
newConf, err := c.r.ConfigFromConfig(configKey{counter: c.r.configVersionID.Load()}, conf) newConf, err := c.r.ConfigFromConfig(c.r.configVersionID.Load(), conf)
if err != nil { if err != nil {
return err return err
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -19,10 +19,12 @@ import (
"errors" "errors"
"fmt" "fmt"
"io" "io"
"log"
"os" "os"
"path/filepath" "path/filepath"
"regexp" "regexp"
jww "github.com/spf13/jwalterweatherman"
"strconv" "strconv"
"strings" "strings"
"time" "time"
@ -57,8 +59,7 @@ Import from Jekyll requires two paths, e.g. ` + "`hugo import jekyll jekyll_root
} }
return c.importFromJekyll(args) return c.importFromJekyll(args)
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
cmd.Flags().BoolVar(&c.force, "force", false, "allow import into non-empty target directory") cmd.Flags().BoolVar(&c.force, "force", false, "allow import into non-empty target directory")
}, },
}, },
@ -66,6 +67,7 @@ Import from Jekyll requires two paths, e.g. ` + "`hugo import jekyll jekyll_root
} }
return c return c
} }
type importCommand struct { type importCommand struct {
@ -90,12 +92,11 @@ func (c *importCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, arg
func (c *importCommand) Init(cd *simplecobra.Commandeer) error { func (c *importCommand) Init(cd *simplecobra.Commandeer) error {
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = "Import a site from another system" cmd.Short = "Import your site from others."
cmd.Long = `Import a site from another system. cmd.Long = `Import your site from other web site generators like Jekyll.
Import requires a subcommand, e.g. ` + "`hugo import jekyll jekyll_root_path target_path`." Import requires a subcommand, e.g. ` + "`hugo import jekyll jekyll_root_path target_path`."
cmd.RunE = nil
return nil return nil
} }
@ -298,7 +299,7 @@ func (c *importCommand) convertJekyllMetaData(m any, postName string, postDate t
} }
func (c *importCommand) convertJekyllPost(path, relPath, targetDir string, draft bool) error { func (c *importCommand) convertJekyllPost(path, relPath, targetDir string, draft bool) error {
log.Println("Converting", path) jww.TRACE.Println("Converting", path)
filename := filepath.Base(path) filename := filepath.Base(path)
postDate, postName, err := c.parseJekyllFilename(filename) postDate, postName, err := c.parseJekyllFilename(filename)
@ -307,11 +308,11 @@ func (c *importCommand) convertJekyllPost(path, relPath, targetDir string, draft
return nil return nil
} }
log.Println(filename, postDate, postName) jww.TRACE.Println(filename, postDate, postName)
targetFile := filepath.Join(targetDir, relPath) targetFile := filepath.Join(targetDir, relPath)
targetParentDir := filepath.Dir(targetFile) targetParentDir := filepath.Dir(targetFile)
os.MkdirAll(targetParentDir, 0o777) os.MkdirAll(targetParentDir, 0777)
contentBytes, err := os.ReadFile(path) contentBytes, err := os.ReadFile(path)
if err != nil { if err != nil {
@ -366,7 +367,7 @@ func (c *importCommand) copyJekyllFilesAndFolders(jekyllRoot, dest string, jekyl
if _, ok := jekyllPostDirs[entry.Name()]; !ok { if _, ok := jekyllPostDirs[entry.Name()]; !ok {
err = hugio.CopyDir(fs, sfp, dfp, nil) err = hugio.CopyDir(fs, sfp, dfp, nil)
if err != nil { if err != nil {
c.r.logger.Errorln(err) jww.ERROR.Println(err)
} }
} }
} }
@ -387,7 +388,7 @@ func (c *importCommand) copyJekyllFilesAndFolders(jekyllRoot, dest string, jekyl
if !isExcept && entry.Name()[0] != '.' && entry.Name()[0] != '_' { if !isExcept && entry.Name()[0] != '.' && entry.Name()[0] != '_' {
err = hugio.CopyFile(fs, sfp, dfp) err = hugio.CopyFile(fs, sfp, dfp)
if err != nil { if err != nil {
c.r.logger.Errorln(err) jww.ERROR.Println(err)
} }
} }
} }
@ -397,6 +398,7 @@ func (c *importCommand) copyJekyllFilesAndFolders(jekyllRoot, dest string, jekyl
} }
func (c *importCommand) importFromJekyll(args []string) error { func (c *importCommand) importFromJekyll(args []string) error {
jekyllRoot, err := filepath.Abs(filepath.Clean(args[0])) jekyllRoot, err := filepath.Abs(filepath.Clean(args[0]))
if err != nil { if err != nil {
return newUserError("path error:", args[0]) return newUserError("path error:", args[0])
@ -427,7 +429,11 @@ func (c *importCommand) importFromJekyll(args []string) error {
c.r.Println("Importing...") c.r.Println("Importing...")
fileCount := 0 fileCount := 0
callback := func(path string, fi hugofs.FileMetaInfo) error { callback := func(path string, fi hugofs.FileMetaInfo, err error) error {
if err != nil {
return err
}
if fi.IsDir() { if fi.IsDir() {
return nil return nil
} }
@ -456,19 +462,16 @@ func (c *importCommand) importFromJekyll(args []string) error {
for jekyllPostDir, hasAnyPostInDir := range jekyllPostDirs { for jekyllPostDir, hasAnyPostInDir := range jekyllPostDirs {
if hasAnyPostInDir { if hasAnyPostInDir {
if err = helpers.Walk(hugofs.Os, filepath.Join(jekyllRoot, jekyllPostDir), callback); err != nil { if err = helpers.SymbolicWalk(hugofs.Os, filepath.Join(jekyllRoot, jekyllPostDir), callback); err != nil {
return err return err
} }
} }
} }
c.r.Println("Congratulations!", fileCount, "post(s) imported!") c.r.Println("Congratulations!", fileCount, "post(s) imported!")
c.r.Println("Now, start Hugo by yourself:\n") c.r.Println("Now, start Hugo by yourself:\n" +
c.r.Println("cd " + args[1]) "$ git clone https://github.com/spf13/herring-cove.git " + args[1] + "/themes/herring-cove")
c.r.Println("git init") c.r.Println("$ cd " + args[1] + "\n$ hugo server --theme=herring-cove")
c.r.Println("git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke themes/ananke")
c.r.Println("echo \"theme = 'ananke'\" > hugo.toml")
c.r.Println("hugo server")
return nil return nil
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -23,14 +23,15 @@ import (
"time" "time"
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
"github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/hugolib" "github.com/gohugoio/hugo/hugolib"
"github.com/gohugoio/hugo/resources/page" "github.com/gohugoio/hugo/resources/page"
"github.com/gohugoio/hugo/resources/resource" "github.com/gohugoio/hugo/resources/resource"
"github.com/spf13/cobra"
) )
// newListCommand creates a new list command and its subcommands. // newListCommand creates a new list command and its subcommands.
func newListCommand() *listCommand { func newListCommand() *listCommand {
createRecord := func(workingDir string, p page.Page) []string { createRecord := func(workingDir string, p page.Page) []string {
return []string{ return []string{
filepath.ToSlash(strings.TrimPrefix(p.File().Filename(), workingDir+string(os.PathSeparator))), filepath.ToSlash(strings.TrimPrefix(p.File().Filename(), workingDir+string(os.PathSeparator))),
@ -41,14 +42,12 @@ func newListCommand() *listCommand {
p.PublishDate().Format(time.RFC3339), p.PublishDate().Format(time.RFC3339),
strconv.FormatBool(p.Draft()), strconv.FormatBool(p.Draft()),
p.Permalink(), p.Permalink(),
p.Kind(),
p.Section(),
} }
} }
list := func(cd *simplecobra.Commandeer, r *rootCommand, shouldInclude func(page.Page) bool, opts ...any) error { list := func(cd *simplecobra.Commandeer, r *rootCommand, shouldInclude func(page.Page) bool, opts ...any) error {
bcfg := hugolib.BuildCfg{SkipRender: true} bcfg := hugolib.BuildCfg{SkipRender: true}
cfg := flagsToCfg(cd, nil) cfg := config.New()
for i := 0; i < len(opts); i += 2 { for i := 0; i < len(opts); i += 2 {
cfg.Set(opts[i].(string), opts[i+1]) cfg.Set(opts[i].(string), opts[i+1])
} }
@ -57,7 +56,7 @@ func newListCommand() *listCommand {
return err return err
} }
writer := csv.NewWriter(r.StdOut) writer := csv.NewWriter(r.Out)
defer writer.Flush() defer writer.Flush()
writer.Write([]string{ writer.Write([]string{
@ -69,8 +68,6 @@ func newListCommand() *listCommand {
"publishDate", "publishDate",
"draft", "draft",
"permalink", "permalink",
"kind",
"section",
}) })
for _, p := range h.Pages() { for _, p := range h.Pages() {
@ -79,24 +76,29 @@ func newListCommand() *listCommand {
if err := writer.Write(record); err != nil { if err := writer.Write(record); err != nil {
return err return err
} }
if err != nil {
return err
}
} }
} }
return nil return nil
} }
return &listCommand{ return &listCommand{
commands: []simplecobra.Commander{ commands: []simplecobra.Commander{
&simpleCommand{ &simpleCommand{
name: "drafts", name: "drafts",
short: "List draft content", short: "List all drafts",
long: `List draft content.`, long: `List all of the drafts in your content directory.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
shouldInclude := func(p page.Page) bool { shouldInclude := func(p page.Page) bool {
if !p.Draft() || p.File() == nil { if !p.Draft() || p.File().IsZero() {
return false return false
} }
return true return true
} }
return list(cd, r, shouldInclude, return list(cd, r, shouldInclude,
"buildDrafts", true, "buildDrafts", true,
@ -104,37 +106,32 @@ func newListCommand() *listCommand {
"buildExpired", true, "buildExpired", true,
) )
}, },
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
},
}, },
&simpleCommand{ &simpleCommand{
name: "future", name: "future",
short: "List future content", short: "List all posts dated in the future",
long: `List content with a future publication date.`, long: `List all of the posts in your content directory which will be posted in the future.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
shouldInclude := func(p page.Page) bool { shouldInclude := func(p page.Page) bool {
if !resource.IsFuture(p) || p.File() == nil { if !resource.IsFuture(p) || p.File().IsZero() {
return false return false
} }
return true return true
} }
return list(cd, r, shouldInclude, return list(cd, r, shouldInclude,
"buildFuture", true, "buildFuture", true,
"buildDrafts", true, "buildDrafts", true,
) )
}, },
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
},
}, },
&simpleCommand{ &simpleCommand{
name: "expired", name: "expired",
short: "List expired content", short: "List all posts already expired",
long: `List content with a past expiration date.`, long: `List all of the posts in your content directory which has already expired.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
shouldInclude := func(p page.Page) bool { shouldInclude := func(p page.Page) bool {
if !resource.IsExpired(p) || p.File() == nil { if !resource.IsExpired(p) || p.File().IsZero() {
return false return false
} }
return true return true
@ -144,40 +141,21 @@ func newListCommand() *listCommand {
"buildDrafts", true, "buildDrafts", true,
) )
}, },
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
},
}, },
&simpleCommand{ &simpleCommand{
name: "all", name: "all",
short: "List all content", short: "List all posts",
long: `List all content including draft, future, and expired.`, long: `List all of the posts in your content directory, include drafts, future and expired pages.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
shouldInclude := func(p page.Page) bool { shouldInclude := func(p page.Page) bool {
return p.File() != nil return !p.File().IsZero()
} }
return list(cd, r, shouldInclude, "buildDrafts", true, "buildFuture", true, "buildExpired", true) return list(cd, r, shouldInclude, "buildDrafts", true, "buildFuture", true, "buildExpired", true)
}, },
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
},
},
&simpleCommand{
name: "published",
short: "List published content",
long: `List content that is not draft, future, or expired.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
shouldInclude := func(p page.Page) bool {
return !p.Draft() && !resource.IsFuture(p) && !resource.IsExpired(p) && p.File() != nil
}
return list(cd, r, shouldInclude)
},
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
},
}, },
}, },
} }
} }
type listCommand struct { type listCommand struct {
@ -199,12 +177,11 @@ func (c *listCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args
func (c *listCommand) Init(cd *simplecobra.Commandeer) error { func (c *listCommand) Init(cd *simplecobra.Commandeer) error {
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = "List content" cmd.Short = "Listing out various types of content"
cmd.Long = `List content. cmd.Long = `Listing out various types of content.
List requires a subcommand, e.g. hugo list drafts` List requires a subcommand, e.g. hugo list drafts`
cmd.RunE = nil
return nil return nil
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -44,12 +44,12 @@ func newModCommands() *modCommands {
npmCommand := &simpleCommand{ npmCommand := &simpleCommand{
name: "npm", name: "npm",
short: "Various npm helpers", short: "Various npm helpers.",
long: `Various npm (Node package manager) helpers.`, long: `Various npm (Node package manager) helpers.`,
commands: []simplecobra.Commander{ commands: []simplecobra.Commander{
&simpleCommand{ &simpleCommand{
name: "pack", name: "pack",
short: "Experimental: Prepares and writes a composite package.json file for your project", short: "Experimental: Prepares and writes a composite package.json file for your project.",
long: `Prepares and writes a composite package.json file for your project. long: `Prepares and writes a composite package.json file for your project.
On first run it creates a "package.hugo.json" in the project root if not already there. This file will be used as a template file On first run it creates a "package.hugo.json" in the project root if not already there. This file will be used as a template file
@ -61,16 +61,12 @@ This command is marked as 'Experimental'. We think it's a great idea, so it's no
removed from Hugo, but we need to test this out in "real life" to get a feel of it, removed from Hugo, but we need to test this out in "real life" to get a feel of it,
so this may/will change in future versions of Hugo. so this may/will change in future versions of Hugo.
`, `,
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
applyLocalFlagsBuildConfig(cmd, r)
},
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
h, err := r.Hugo(flagsToCfg(cd, nil)) h, err := r.Hugo(flagsToCfg(cd, nil))
if err != nil { if err != nil {
return err return err
} }
return npm.Pack(h.BaseFs.ProjectSourceFs, h.BaseFs.AssetsWithDuplicatesPreserved.Fs) return npm.Pack(h.BaseFs.SourceFs, h.BaseFs.Assets.Dirs)
}, },
}, },
}, },
@ -80,7 +76,7 @@ so this may/will change in future versions of Hugo.
commands: []simplecobra.Commander{ commands: []simplecobra.Commander{
&simpleCommand{ &simpleCommand{
name: "init", name: "init",
short: "Initialize this project as a Hugo Module", short: "Initialize this project as a Hugo Module.",
long: `Initialize this project as a Hugo Module. long: `Initialize this project as a Hugo Module.
It will try to guess the module path, but you may help by passing it as an argument, e.g: It will try to guess the module path, but you may help by passing it as an argument, e.g:
@ -89,12 +85,8 @@ so this may/will change in future versions of Hugo.
Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module
inside a subfolder on GitHub, as one example. inside a subfolder on GitHub, as one example.
`, `,
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
applyLocalFlagsBuildConfig(cmd, r)
},
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
h, err := r.getOrCreateHugo(flagsToCfg(cd, nil), true) h, err := r.Hugo(flagsToCfg(cd, nil))
if err != nil { if err != nil {
return err return err
} }
@ -102,24 +94,18 @@ so this may/will change in future versions of Hugo.
if len(args) >= 1 { if len(args) >= 1 {
initPath = args[0] initPath = args[0]
} }
c := h.Configs.ModulesClient return h.Configs.ModulesClient.Init(initPath)
if err := c.Init(initPath); err != nil {
return err
}
return nil
}, },
}, },
&simpleCommand{ &simpleCommand{
name: "verify", name: "verify",
short: "Verify dependencies", short: "Verify dependencies.",
long: `Verify checks that the dependencies of the current module, which are stored in a local downloaded source cache, have not been modified since being downloaded.`, long: `Verify checks that the dependencies of the current module, which are stored in a local downloaded source cache, have not been modified since being downloaded.`,
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
applyLocalFlagsBuildConfig(cmd, r)
cmd.Flags().BoolVarP(&clean, "clean", "", false, "delete module cache for dependencies that fail verification") cmd.Flags().BoolVarP(&clean, "clean", "", false, "delete module cache for dependencies that fail verification")
}, },
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
conf, err := r.ConfigFromProvider(configKey{counter: r.configVersionID.Load()}, flagsToCfg(cd, nil)) conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, nil))
if err != nil { if err != nil {
return err return err
} }
@ -129,17 +115,15 @@ so this may/will change in future versions of Hugo.
}, },
&simpleCommand{ &simpleCommand{
name: "graph", name: "graph",
short: "Print a module dependency graph", short: "Print a module dependency graph.",
long: `Print a module dependency graph with information about module status (disabled, vendored). long: `Print a module dependency graph with information about module status (disabled, vendored).
Note that for vendored modules, that is the version listed and not the one from go.mod. Note that for vendored modules, that is the version listed and not the one from go.mod.
`, `,
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
applyLocalFlagsBuildConfig(cmd, r)
cmd.Flags().BoolVarP(&clean, "clean", "", false, "delete module cache for dependencies that fail verification") cmd.Flags().BoolVarP(&clean, "clean", "", false, "delete module cache for dependencies that fail verification")
}, },
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
conf, err := r.ConfigFromProvider(configKey{counter: r.configVersionID.Load()}, flagsToCfg(cd, nil)) conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, nil))
if err != nil { if err != nil {
return err return err
} }
@ -149,13 +133,10 @@ Note that for vendored modules, that is the version listed and not the one from
}, },
&simpleCommand{ &simpleCommand{
name: "clean", name: "clean",
short: "Delete the Hugo Module cache for the current project", short: "Delete the Hugo Module cache for the current project.",
long: `Delete the Hugo Module cache for the current project.`, long: `Delete the Hugo Module cache for the current project.`,
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
applyLocalFlagsBuildConfig(cmd, r)
cmd.Flags().StringVarP(&pattern, "pattern", "", "", `pattern matching module paths to clean (all if not set), e.g. "**hugo*"`) cmd.Flags().StringVarP(&pattern, "pattern", "", "", `pattern matching module paths to clean (all if not set), e.g. "**hugo*"`)
_ = cmd.RegisterFlagCompletionFunc("pattern", cobra.NoFileCompletions)
cmd.Flags().BoolVarP(&all, "all", "", false, "clean entire module cache") cmd.Flags().BoolVarP(&all, "all", "", false, "clean entire module cache")
}, },
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
@ -175,11 +156,7 @@ Note that for vendored modules, that is the version listed and not the one from
}, },
&simpleCommand{ &simpleCommand{
name: "tidy", name: "tidy",
short: "Remove unused entries in go.mod and go.sum", short: "Remove unused entries in go.mod and go.sum.",
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
applyLocalFlagsBuildConfig(cmd, r)
},
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
h, err := r.Hugo(flagsToCfg(cd, nil)) h, err := r.Hugo(flagsToCfg(cd, nil))
if err != nil { if err != nil {
@ -190,14 +167,10 @@ Note that for vendored modules, that is the version listed and not the one from
}, },
&simpleCommand{ &simpleCommand{
name: "vendor", name: "vendor",
short: "Vendor all module dependencies into the _vendor directory", short: "Vendor all module dependencies into the _vendor directory.",
long: `Vendor all module dependencies into the _vendor directory. long: `Vendor all module dependencies into the _vendor directory.
If a module is vendored, that is where Hugo will look for it's dependencies. If a module is vendored, that is where Hugo will look for it's dependencies.
`, `,
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
applyLocalFlagsBuildConfig(cmd, r)
},
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
h, err := r.Hugo(flagsToCfg(cd, nil)) h, err := r.Hugo(flagsToCfg(cd, nil))
if err != nil { if err != nil {
@ -209,9 +182,9 @@ Note that for vendored modules, that is the version listed and not the one from
&simpleCommand{ &simpleCommand{
name: "get", name: "get",
short: "Resolves dependencies in your current Hugo project", short: "Resolves dependencies in your current Hugo Project.",
long: ` long: `
Resolves dependencies in your current Hugo project. Resolves dependencies in your current Hugo Project.
Some examples: Some examples:
@ -223,26 +196,20 @@ Install a specific version:
hugo mod get github.com/gohugoio/testshortcodes@v0.3.0 hugo mod get github.com/gohugoio/testshortcodes@v0.3.0
Install the latest versions of all direct module dependencies: Install the latest versions of all module dependencies:
hugo mod get
hugo mod get ./... (recursive)
Install the latest versions of all module dependencies (direct and indirect):
hugo mod get -u hugo mod get -u
hugo mod get -u ./... (recursive) hugo mod get -u ./... (recursive)
Run "go help get" for more information. All flags available for "go get" is also relevant here. Run "go help get" for more information. All flags available for "go get" is also relevant here.
` + commonUsageMod, ` + commonUsageMod,
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.DisableFlagParsing = true cmd.DisableFlagParsing = true
cmd.ValidArgsFunction = cobra.NoFileCompletions
}, },
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
// We currently just pass on the flags we get to Go and // We currently just pass on the flags we get to Go and
// need to do the flag handling manually. // need to do the flag handling manually.
if len(args) == 1 && (args[0] == "-h" || args[0] == "--help") { if len(args) == 1 && args[0] == "-h" {
return errHelp return errHelp
} }
@ -272,14 +239,13 @@ Run "go help get" for more information. All flags available for "go get" is also
if info.Name() == "go.mod" { if info.Name() == "go.mod" {
// Found a module. // Found a module.
dir := filepath.Dir(path) dir := filepath.Dir(path)
r.Println("Update module in", dir)
cfg := config.New() cfg := config.New()
cfg.Set("workingDir", dir) cfg.Set("workingDir", dir)
conf, err := r.ConfigFromProvider(configKey{counter: r.configVersionID.Add(1)}, flagsToCfg(cd, cfg)) conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, cfg))
if err != nil { if err != nil {
return err return err
} }
r.Println("Update module in", conf.configs.Base.WorkingDir)
client := conf.configs.ModulesClient client := conf.configs.ModulesClient
return client.Get(args...) return client.Get(args...)
@ -288,7 +254,7 @@ Run "go help get" for more information. All flags available for "go get" is also
}) })
return nil return nil
} else { } else {
conf, err := r.ConfigFromProvider(configKey{counter: r.configVersionID.Load()}, flagsToCfg(cd, nil)) conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, nil))
if err != nil { if err != nil {
return err return err
} }
@ -300,6 +266,7 @@ Run "go help get" for more information. All flags available for "go get" is also
npmCommand, npmCommand,
}, },
} }
} }
type modCommands struct { type modCommands struct {
@ -317,18 +284,18 @@ func (c *modCommands) Name() string {
} }
func (c *modCommands) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error { func (c *modCommands) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
_, err := c.r.ConfigFromProvider(configKey{counter: c.r.configVersionID.Load()}, nil) _, err := c.r.ConfigFromProvider(c.r.configVersionID.Load(), nil)
if err != nil { if err != nil {
return err return err
} }
// config := conf.configs.Base //config := conf.configs.Base
return nil return nil
} }
func (c *modCommands) Init(cd *simplecobra.Commandeer) error { func (c *modCommands) Init(cd *simplecobra.Commandeer) error {
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = "Manage modules" cmd.Short = "Various Hugo Modules helpers."
cmd.Long = `Various helpers to help manage the modules in your project's dependency graph. cmd.Long = `Various helpers to help manage the modules in your project's dependency graph.
Most operations here requires a Go version installed on your system (>= Go 1.12) and the relevant VCS client (typically Git). Most operations here requires a Go version installed on your system (>= Go 1.12) and the relevant VCS client (typically Git).
This is not needed if you only operate on modules inside /themes or if you have vendored them via "hugo mod vendor". This is not needed if you only operate on modules inside /themes or if you have vendored them via "hugo mod vendor".

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -16,14 +16,19 @@ package commands
import ( import (
"bytes" "bytes"
"context" "context"
"errors"
"fmt"
"path/filepath" "path/filepath"
"strings" "strings"
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
"github.com/gohugoio/hugo/common/paths" "github.com/gohugoio/hugo/common/htime"
"github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/create" "github.com/gohugoio/hugo/create"
"github.com/gohugoio/hugo/create/skeletons" "github.com/gohugoio/hugo/helpers"
"github.com/gohugoio/hugo/parser"
"github.com/gohugoio/hugo/parser/metadecoders"
"github.com/spf13/afero"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
@ -31,7 +36,6 @@ func newNewCommand() *newCommand {
var ( var (
force bool force bool
contentType string contentType string
format string
) )
var c *newCommand var c *newCommand
@ -40,18 +44,18 @@ func newNewCommand() *newCommand {
&simpleCommand{ &simpleCommand{
name: "content", name: "content",
use: "content [path]", use: "content [path]",
short: "Create new content", short: "Create new content for your site",
long: `Create a new content file and automatically set the date and title. long: `Create a new content file and automatically set the date and title.
It will guess which kind of file to create based on the path provided. It will guess which kind of file to create based on the path provided.
You can also specify the kind with ` + "`-k KIND`" + `. You can also specify the kind with ` + "`-k KIND`" + `.
If archetypes are provided in your theme or site, they will be used. If archetypes are provided in your theme or site, they will be used.
Ensure you run this within the root directory of your site.`, Ensure you run this within the root directory of your site.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
if len(args) < 1 { if len(args) < 1 {
return newUserError("path needs to be provided") return errors.New("path needs to be provided")
} }
h, err := r.Hugo(flagsToCfg(cd, nil)) h, err := r.Hugo(flagsToCfg(cd, nil))
if err != nil { if err != nil {
@ -59,28 +63,22 @@ Ensure you run this within the root directory of your site.`,
} }
return create.NewContent(h, contentType, args[0], force) return create.NewContent(h, contentType, args[0], force)
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
if len(args) != 0 {
return []string{}, cobra.ShellCompDirectiveNoFileComp
}
return []string{}, cobra.ShellCompDirectiveNoFileComp | cobra.ShellCompDirectiveFilterDirs
}
cmd.Flags().StringVarP(&contentType, "kind", "k", "", "content type to create") cmd.Flags().StringVarP(&contentType, "kind", "k", "", "content type to create")
cmd.Flags().String("editor", "", "edit new content with this editor, if provided") cmd.Flags().String("editor", "", "edit new content with this editor, if provided")
_ = cmd.RegisterFlagCompletionFunc("editor", cobra.NoFileCompletions)
cmd.Flags().BoolVarP(&force, "force", "f", false, "overwrite file if it already exists") cmd.Flags().BoolVarP(&force, "force", "f", false, "overwrite file if it already exists")
applyLocalFlagsBuildConfig(cmd, r)
}, },
}, },
&simpleCommand{ &simpleCommand{
name: "site", name: "site",
use: "site [path]", use: "site [path]",
short: "Create a new site", short: "Create a new site (skeleton)",
long: `Create a new site at the specified path.`, long: `Create a new site in the provided directory.
The new site will have the correct structure, but no content or theme yet.
Use ` + "`hugo new [contentPath]`" + ` to create new content.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
if len(args) < 1 { if len(args) < 1 {
return newUserError("path needs to be provided") return errors.New("path needs to be provided")
} }
createpath, err := filepath.Abs(filepath.Clean(args[0])) createpath, err := filepath.Abs(filepath.Clean(args[0]))
if err != nil { if err != nil {
@ -91,77 +89,166 @@ Ensure you run this within the root directory of your site.`,
cfg.Set("workingDir", createpath) cfg.Set("workingDir", createpath)
cfg.Set("publishDir", "public") cfg.Set("publishDir", "public")
conf, err := r.ConfigFromProvider(configKey{counter: r.configVersionID.Load()}, flagsToCfg(cd, cfg)) conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, cfg))
if err != nil { if err != nil {
return err return err
} }
sourceFs := conf.fs.Source sourceFs := conf.fs.Source
err = skeletons.CreateSite(createpath, sourceFs, force, format) archeTypePath := filepath.Join(createpath, "archetypes")
if err != nil { dirs := []string{
return err archeTypePath,
filepath.Join(createpath, "assets"),
filepath.Join(createpath, "content"),
filepath.Join(createpath, "data"),
filepath.Join(createpath, "layouts"),
filepath.Join(createpath, "static"),
filepath.Join(createpath, "themes"),
} }
r.Printf("Congratulations! Your new Hugo site was created in %s.\n\n", createpath) if exists, _ := helpers.Exists(createpath, sourceFs); exists {
r.Println(c.newSiteNextStepsText(createpath, format)) if isDir, _ := helpers.IsDir(createpath, sourceFs); !isDir {
return errors.New(createpath + " already exists but not a directory")
}
isEmpty, _ := helpers.IsEmpty(createpath, sourceFs)
switch {
case !isEmpty && !force:
return errors.New(createpath + " already exists and is not empty. See --force.")
case !isEmpty && force:
all := append(dirs, filepath.Join(createpath, "hugo."+r.format))
for _, path := range all {
if exists, _ := helpers.Exists(path, sourceFs); exists {
return errors.New(path + " already exists")
}
}
}
}
for _, dir := range dirs {
if err := sourceFs.MkdirAll(dir, 0777); err != nil {
return fmt.Errorf("failed to create dir: %w", err)
}
}
c.newSiteCreateConfig(sourceFs, createpath, r.format)
// Create a default archetype file.
helpers.SafeWriteToDisk(filepath.Join(archeTypePath, "default.md"),
strings.NewReader(create.DefaultArchetypeTemplateTemplate), sourceFs)
r.Printf("Congratulations! Your new Hugo site is created in %s.\n\n", createpath)
r.Println(c.newSiteNextStepsText())
return nil return nil
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { cmd.Flags().BoolVar(&force, "force", false, "init inside non-empty directory")
if len(args) != 0 {
return []string{}, cobra.ShellCompDirectiveNoFileComp
}
return []string{}, cobra.ShellCompDirectiveNoFileComp | cobra.ShellCompDirectiveFilterDirs
}
cmd.Flags().BoolVarP(&force, "force", "f", false, "init inside non-empty directory")
cmd.Flags().StringVar(&format, "format", "toml", "preferred file format (toml, yaml or json)")
_ = cmd.RegisterFlagCompletionFunc("format", cobra.FixedCompletions([]string{"toml", "yaml", "json"}, cobra.ShellCompDirectiveNoFileComp))
}, },
}, },
&simpleCommand{ &simpleCommand{
name: "theme", name: "theme",
use: "theme [name]", use: "theme [path]",
short: "Create a new theme", short: "Create a new site (skeleton)",
long: `Create a new theme with the specified name in the ./themes directory. long: `Create a new site in the provided directory.
This generates a functional theme including template examples and sample content.`, The new site will have the correct structure, but no content or theme yet.
Use ` + "`hugo new [contentPath]`" + ` to create new content.`,
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
if len(args) < 1 { h, err := r.Hugo(flagsToCfg(cd, nil))
return newUserError("theme name needs to be provided")
}
cfg := config.New()
cfg.Set("publishDir", "public")
conf, err := r.ConfigFromProvider(configKey{counter: r.configVersionID.Load()}, flagsToCfg(cd, cfg))
if err != nil { if err != nil {
return err return err
} }
sourceFs := conf.fs.Source ps := h.PathSpec
createpath := paths.AbsPathify(conf.configs.Base.WorkingDir, filepath.Join(conf.configs.Base.ThemesDir, args[0])) sourceFs := ps.Fs.Source
r.Println("Creating new theme in", createpath) themesDir := h.Configs.LoadingInfo.BaseConfig.ThemesDir
createpath := ps.AbsPathify(filepath.Join(themesDir, args[0]))
r.Println("Creating theme at", createpath)
err = skeletons.CreateTheme(createpath, sourceFs, format) if x, _ := helpers.Exists(createpath, sourceFs); x {
return errors.New(createpath + " already exists")
}
for _, filename := range []string{
"index.html",
"404.html",
"_default/list.html",
"_default/single.html",
"partials/head.html",
"partials/header.html",
"partials/footer.html",
} {
touchFile(sourceFs, filepath.Join(createpath, "layouts", filename))
}
baseofDefault := []byte(`<!DOCTYPE html>
<html>
{{- partial "head.html" . -}}
<body>
{{- partial "header.html" . -}}
<div id="content">
{{- block "main" . }}{{- end }}
</div>
{{- partial "footer.html" . -}}
</body>
</html>
`)
err = helpers.WriteToDisk(filepath.Join(createpath, "layouts", "_default", "baseof.html"), bytes.NewReader(baseofDefault), sourceFs)
if err != nil { if err != nil {
return err return err
} }
mkdir(createpath, "archetypes")
archDefault := []byte("+++\n+++\n")
err = helpers.WriteToDisk(filepath.Join(createpath, "archetypes", "default.md"), bytes.NewReader(archDefault), sourceFs)
if err != nil {
return err
}
mkdir(createpath, "static", "js")
mkdir(createpath, "static", "css")
by := []byte(`The MIT License (MIT)
Copyright (c) ` + htime.Now().Format("2006") + ` YOUR_NAME_HERE
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
`)
err = helpers.WriteToDisk(filepath.Join(createpath, "LICENSE"), bytes.NewReader(by), sourceFs)
if err != nil {
return err
}
c.createThemeMD(ps.Fs.Source, createpath)
return nil return nil
}, },
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
if len(args) != 0 {
return []string{}, cobra.ShellCompDirectiveNoFileComp
}
return []string{}, cobra.ShellCompDirectiveNoFileComp | cobra.ShellCompDirectiveFilterDirs
}
cmd.Flags().StringVar(&format, "format", "toml", "preferred file format (toml, yaml or json)")
_ = cmd.RegisterFlagCompletionFunc("format", cobra.FixedCompletions([]string{"toml", "yaml", "json"}, cobra.ShellCompDirectiveNoFileComp))
},
}, },
}, },
} }
return c return c
} }
type newCommand struct { type newCommand struct {
@ -184,7 +271,7 @@ func (c *newCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args [
func (c *newCommand) Init(cd *simplecobra.Commandeer) error { func (c *newCommand) Init(cd *simplecobra.Commandeer) error {
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = "Create new content" cmd.Short = "Create new content for your site"
cmd.Long = `Create a new content file and automatically set the date and title. cmd.Long = `Create a new content file and automatically set the date and title.
It will guess which kind of file to create based on the path provided. It will guess which kind of file to create based on the path provided.
@ -193,8 +280,6 @@ You can also specify the kind with ` + "`-k KIND`" + `.
If archetypes are provided in your theme or site, they will be used. If archetypes are provided in your theme or site, they will be used.
Ensure you run this within the root directory of your site.` Ensure you run this within the root directory of your site.`
cmd.RunE = nil
return nil return nil
} }
@ -203,25 +288,77 @@ func (c *newCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
return nil return nil
} }
func (c *newCommand) newSiteNextStepsText(path string, format string) string { func (c *newCommand) newSiteCreateConfig(fs afero.Fs, inpath string, kind string) (err error) {
format = strings.ToLower(format) in := map[string]string{
"baseURL": "http://example.org/",
"title": "My New Hugo Site",
"languageCode": "en-us",
}
var buf bytes.Buffer
err = parser.InterfaceToConfig(in, metadecoders.FormatFromString(kind), &buf)
if err != nil {
return err
}
return helpers.WriteToDisk(filepath.Join(inpath, "hugo."+kind), &buf, fs)
}
func (c *newCommand) newSiteNextStepsText() string {
var nextStepsText bytes.Buffer var nextStepsText bytes.Buffer
nextStepsText.WriteString(`Just a few more steps... nextStepsText.WriteString(`Just a few more steps and you're ready to go:
1. Change the current directory to ` + path + `. 1. Download a theme into the same-named folder.
2. Create or install a theme: Choose a theme from https://themes.gohugo.io/ or
- Create a new theme with the command "hugo new theme <THEMENAME>" create your own with the "hugo new theme <THEMENAME>" command.
- Or, install a theme from https://themes.gohugo.io/ 2. Perhaps you want to add some content. You can add single files
3. Edit hugo.` + format + `, setting the "theme" property to the theme name. with "hugo new `)
4. Create new content with the command "hugo new content `)
nextStepsText.WriteString(filepath.Join("<SECTIONNAME>", "<FILENAME>.<FORMAT>")) nextStepsText.WriteString(filepath.Join("<SECTIONNAME>", "<FILENAME>.<FORMAT>"))
nextStepsText.WriteString(`". nextStepsText.WriteString(`".
5. Start the embedded web server with the command "hugo server --buildDrafts". 3. Start the built-in live server via "hugo server".
See documentation at https://gohugo.io/.`) Visit https://gohugo.io/ for quickstart guide and full documentation.`)
return nextStepsText.String() return nextStepsText.String()
} }
func (c *newCommand) createThemeMD(fs afero.Fs, inpath string) (err error) {
by := []byte(`# theme.toml template for a Hugo theme
# See https://github.com/gohugoio/hugoThemes#themetoml for an example
name = "` + strings.Title(helpers.MakeTitle(filepath.Base(inpath))) + `"
license = "MIT"
licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE"
description = ""
homepage = "http://example.com/"
tags = []
features = []
min_version = "0.112.3"
[author]
name = ""
homepage = ""
# If porting an existing theme
[original]
name = ""
homepage = ""
repo = ""
`)
err = helpers.WriteToDisk(filepath.Join(inpath, "theme.toml"), bytes.NewReader(by), fs)
if err != nil {
return
}
err = helpers.WriteToDisk(filepath.Join(inpath, "hugo.toml"), strings.NewReader("# Theme config.\n"), fs)
if err != nil {
return
}
return nil
}

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -24,6 +24,7 @@ import (
// Note: This is a command only meant for internal use and must be run // Note: This is a command only meant for internal use and must be run
// via "go run -tags release main.go release" on the actual code base that is in the release. // via "go run -tags release main.go release" on the actual code base that is in the release.
func newReleaseCommand() simplecobra.Commander { func newReleaseCommand() simplecobra.Commander {
var ( var (
step int step int
skipPush bool skipPush bool
@ -32,7 +33,7 @@ func newReleaseCommand() simplecobra.Commander {
return &simpleCommand{ return &simpleCommand{
name: "release", name: "release",
short: "Release a new version of Hugo", short: "Release a new version of Hugo.",
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error { run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
rel, err := releaser.New(skipPush, try, step) rel, err := releaser.New(skipPush, try, step)
if err != nil { if err != nil {
@ -41,13 +42,11 @@ func newReleaseCommand() simplecobra.Commander {
return rel.Run() return rel.Run()
}, },
withc: func(cmd *cobra.Command, r *rootCommand) { withc: func(cmd *cobra.Command) {
cmd.Hidden = true cmd.Hidden = true
cmd.ValidArgsFunction = cobra.NoFileCompletions
cmd.PersistentFlags().BoolVarP(&skipPush, "skip-push", "", false, "skip pushing to remote") cmd.PersistentFlags().BoolVarP(&skipPush, "skip-push", "", false, "skip pushing to remote")
cmd.PersistentFlags().BoolVarP(&try, "try", "", false, "no changes") cmd.PersistentFlags().BoolVarP(&try, "try", "", false, "no changes")
cmd.PersistentFlags().IntVarP(&step, "step", "", 0, "step to run (1: set new version 2: prepare next dev version)") cmd.PersistentFlags().IntVarP(&step, "step", "", 0, "step to run (1: set new version 2: prepare next dev version)")
_ = cmd.RegisterFlagCompletionFunc("step", cobra.FixedCompletions([]string{"1", "2"}, cobra.ShellCompDirectiveNoFileComp))
}, },
} }
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -16,59 +16,52 @@ package commands
import ( import (
"bytes" "bytes"
"context" "context"
"crypto/tls"
"crypto/x509"
"encoding/json" "encoding/json"
"encoding/pem"
"errors" "errors"
"fmt" "fmt"
"io" "io"
"maps" "io/ioutil"
"net" "net"
"net/http" "net/http"
_ "net/http/pprof"
"net/url" "net/url"
"os" "os"
"sync"
"sync/atomic"
"os/signal" "os/signal"
"path" "path"
"path/filepath" "path/filepath"
"regexp" "regexp"
"sort"
"strconv" "strconv"
"strings" "strings"
"sync"
"sync/atomic"
"syscall" "syscall"
"time" "time"
"github.com/bep/mclib"
"github.com/pkg/browser"
"github.com/bep/debounce" "github.com/bep/debounce"
"github.com/bep/simplecobra" "github.com/bep/simplecobra"
"github.com/fsnotify/fsnotify" "github.com/fsnotify/fsnotify"
"github.com/gohugoio/hugo/common/herrors" "github.com/gohugoio/hugo/common/herrors"
"github.com/gohugoio/hugo/common/hugo" "github.com/gohugoio/hugo/common/hugo"
"github.com/gohugoio/hugo/tpl/tplimpl"
"github.com/gohugoio/hugo/common/types" "github.com/gohugoio/hugo/common/types"
"github.com/gohugoio/hugo/common/urls" "github.com/gohugoio/hugo/common/urls"
"github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/helpers" "github.com/gohugoio/hugo/helpers"
"github.com/gohugoio/hugo/hugofs" "github.com/gohugoio/hugo/hugofs"
"github.com/gohugoio/hugo/hugofs/files"
"github.com/gohugoio/hugo/hugolib" "github.com/gohugoio/hugo/hugolib"
"github.com/gohugoio/hugo/hugolib/filesystems" "github.com/gohugoio/hugo/hugolib/filesystems"
"github.com/gohugoio/hugo/livereload" "github.com/gohugoio/hugo/livereload"
"github.com/gohugoio/hugo/tpl"
"github.com/gohugoio/hugo/transform" "github.com/gohugoio/hugo/transform"
"github.com/gohugoio/hugo/transform/livereloadinject" "github.com/gohugoio/hugo/transform/livereloadinject"
"github.com/spf13/afero" "github.com/spf13/afero"
"github.com/spf13/cobra"
"github.com/spf13/fsync" "github.com/spf13/fsync"
"golang.org/x/sync/errgroup" "golang.org/x/sync/errgroup"
"golang.org/x/sync/semaphore" "golang.org/x/sync/semaphore"
) )
var ( var (
logErrorRe = regexp.MustCompile(`(?s)ERROR \d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2} `)
logDuplicateTemplateExecuteRe = regexp.MustCompile(`: template: .*?:\d+:\d+: executing ".*?"`) logDuplicateTemplateExecuteRe = regexp.MustCompile(`: template: .*?:\d+:\d+: executing ".*?"`)
logDuplicateTemplateParseRe = regexp.MustCompile(`: template: .*?:\d+:\d*`) logDuplicateTemplateParseRe = regexp.MustCompile(`: template: .*?:\d+:\d*`)
) )
@ -85,19 +78,11 @@ const (
configChangeGoWork = "go work file" configChangeGoWork = "go work file"
) )
const (
hugoHeaderRedirect = "X-Hugo-Redirect"
)
func newHugoBuilder(r *rootCommand, s *serverCommand, onConfigLoaded ...func(reloaded bool) error) *hugoBuilder { func newHugoBuilder(r *rootCommand, s *serverCommand, onConfigLoaded ...func(reloaded bool) error) *hugoBuilder {
var visitedURLs *types.EvictingQueue[string]
if s != nil && !s.disableFastRender {
visitedURLs = types.NewEvictingQueue[string](20)
}
return &hugoBuilder{ return &hugoBuilder{
r: r, r: r,
s: s, s: s,
visitedURLs: visitedURLs, visitedURLs: types.NewEvictingStringQueue(100),
fullRebuildSem: semaphore.NewWeighted(1), fullRebuildSem: semaphore.NewWeighted(1),
debounce: debounce.New(4 * time.Second), debounce: debounce.New(4 * time.Second),
onConfigLoaded: func(reloaded bool) error { onConfigLoaded: func(reloaded bool) error {
@ -112,38 +97,13 @@ func newHugoBuilder(r *rootCommand, s *serverCommand, onConfigLoaded ...func(rel
} }
func newServerCommand() *serverCommand { func newServerCommand() *serverCommand {
// Flags. var c *serverCommand
var uninstall bool c = &serverCommand{
c := &serverCommand{
quit: make(chan bool), quit: make(chan bool),
commands: []simplecobra.Commander{
&simpleCommand{
name: "trust",
short: "Install the local CA in the system trust store",
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
action := "-install"
if uninstall {
action = "-uninstall"
} }
os.Args = []string{action}
return mclib.RunMain()
},
withc: func(cmd *cobra.Command, r *rootCommand) {
cmd.ValidArgsFunction = cobra.NoFileCompletions
cmd.Flags().BoolVar(&uninstall, "uninstall", false, "Uninstall the local CA (but do not delete it).")
},
},
},
}
return c return c
} }
func (c *serverCommand) Commands() []simplecobra.Commander {
return c.commands
}
type countingStatFs struct { type countingStatFs struct {
afero.Fs afero.Fs
statCounter uint64 statCounter uint64
@ -169,16 +129,16 @@ type dynamicEvents struct {
type fileChangeDetector struct { type fileChangeDetector struct {
sync.Mutex sync.Mutex
current map[string]uint64 current map[string]string
prev map[string]uint64 prev map[string]string
irrelevantRe *regexp.Regexp irrelevantRe *regexp.Regexp
} }
func (f *fileChangeDetector) OnFileClose(name string, checksum uint64) { func (f *fileChangeDetector) OnFileClose(name, md5sum string) {
f.Lock() f.Lock()
defer f.Unlock() defer f.Unlock()
f.current[name] = checksum f.current[name] = md5sum
} }
func (f *fileChangeDetector) PrepareNew() { func (f *fileChangeDetector) PrepareNew() {
@ -190,14 +150,16 @@ func (f *fileChangeDetector) PrepareNew() {
defer f.Unlock() defer f.Unlock()
if f.current == nil { if f.current == nil {
f.current = make(map[string]uint64) f.current = make(map[string]string)
f.prev = make(map[string]uint64) f.prev = make(map[string]string)
return return
} }
f.prev = make(map[string]uint64) f.prev = make(map[string]string)
maps.Copy(f.prev, f.current) for k, v := range f.current {
f.current = make(map[string]uint64) f.prev[k] = v
}
f.current = make(map[string]string)
} }
func (f *fileChangeDetector) changed() []string { func (f *fileChangeDetector) changed() []string {
@ -214,22 +176,21 @@ func (f *fileChangeDetector) changed() []string {
} }
} }
return f.filterIrrelevantAndSort(c) return f.filterIrrelevant(c)
} }
func (f *fileChangeDetector) filterIrrelevantAndSort(in []string) []string { func (f *fileChangeDetector) filterIrrelevant(in []string) []string {
var filtered []string var filtered []string
for _, v := range in { for _, v := range in {
if !f.irrelevantRe.MatchString(v) { if !f.irrelevantRe.MatchString(v) {
filtered = append(filtered, v) filtered = append(filtered, v)
} }
} }
sort.Strings(filtered)
return filtered return filtered
} }
type fileServer struct { type fileServer struct {
baseURLs []urls.BaseURL baseURLs []string
roots []string roots []string
errorTemplate func(err any) (io.Reader, error) errorTemplate func(err any) (io.Reader, error)
c *serverCommand c *serverCommand
@ -243,16 +204,15 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
listener := f.c.serverPorts[i].ln listener := f.c.serverPorts[i].ln
logger := f.c.r.logger logger := f.c.r.logger
if i == 0 {
r.Printf("Environment: %q\n", f.c.hugoTry().Deps.Site.Hugo().Environment) r.Printf("Environment: %q\n", f.c.hugoTry().Deps.Site.Hugo().Environment)
mainTarget := "disk"
if f.c.r.renderToMemory { if i == 0 {
mainTarget = "memory" if f.c.renderToDisk {
} r.Println("Serving pages from disk")
if f.c.renderStaticToDisk { } else if f.c.renderStaticToDisk {
r.Printf("Serving pages from %s and static files from disk\n", mainTarget) r.Println("Serving pages from memory and static files from disk")
} else { } else {
r.Printf("Serving pages from %s\n", mainTarget) r.Println("Serving pages from memory")
} }
} }
@ -266,6 +226,12 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
r.Println("Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender") r.Println("Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender")
} }
// We're only interested in the path
u, err := url.Parse(baseURL)
if err != nil {
return nil, nil, "", "", fmt.Errorf("invalid baseURL: %w", err)
}
decorate := func(h http.Handler) http.Handler { decorate := func(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if f.c.showErrorInBrowser { if f.c.showErrorInBrowser {
@ -285,7 +251,7 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
port = lrport port = lrport
} }
}) })
lr := baseURL.URL() lr := *u
lr.Host = fmt.Sprintf("%s:%d", lr.Hostname(), port) lr.Host = fmt.Sprintf("%s:%d", lr.Hostname(), port)
fmt.Fprint(w, injectLiveReloadScript(r, lr)) fmt.Fprint(w, injectLiveReloadScript(r, lr))
@ -310,19 +276,19 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
w.Header().Set(header.Key, header.Value) w.Header().Set(header.Key, header.Value)
} }
if canRedirect(requestURI, r) { if redirect := serverConfig.MatchRedirect(requestURI); !redirect.IsZero() {
if redirect := serverConfig.MatchRedirect(requestURI, r.Header); !redirect.IsZero() { // fullName := filepath.Join(dir, filepath.FromSlash(path.Clean("/"+name)))
doRedirect := true doRedirect := true
// This matches Netlify's behavior and is needed for SPA behavior. // This matches Netlify's behaviour and is needed for SPA behaviour.
// See https://docs.netlify.com/routing/redirects/rewrites-proxies/ // See https://docs.netlify.com/routing/redirects/rewrites-proxies/
if !redirect.Force { if !redirect.Force {
path := filepath.Clean(strings.TrimPrefix(requestURI, baseURL.Path())) path := filepath.Clean(strings.TrimPrefix(requestURI, u.Path))
if root != "" { if root != "" {
path = filepath.Join(root, path) path = filepath.Join(root, path)
} }
var fs afero.Fs var fs afero.Fs
f.c.withConf(func(conf *commonConfig) { f.c.withConf(func(conf *commonConfig) {
fs = conf.fs.PublishDirServer fs = conf.fs.PublishDir
}) })
fi, err := fs.Stat(path) fi, err := fs.Stat(path)
@ -340,11 +306,10 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
} }
if doRedirect { if doRedirect {
w.Header().Set(hugoHeaderRedirect, "true")
switch redirect.Status { switch redirect.Status {
case 404: case 404:
w.WriteHeader(404) w.WriteHeader(404)
file, err := fs.Open(strings.TrimPrefix(redirect.To, baseURL.Path())) file, err := fs.Open(strings.TrimPrefix(redirect.To, u.Path))
if err == nil { if err == nil {
defer file.Close() defer file.Close()
io.Copy(w, file) io.Copy(w, file)
@ -353,7 +318,7 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
} }
return return
case 200: case 200:
if r2 := f.rewriteRequest(r, strings.TrimPrefix(redirect.To, baseURL.Path())); r2 != nil { if r2 := f.rewriteRequest(r, strings.TrimPrefix(redirect.To, u.Path)); r2 != nil {
requestURI = redirect.To requestURI = redirect.To
r = r2 r = r2
} }
@ -364,11 +329,11 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
} }
} }
}
} }
if f.c.fastRenderMode && f.c.errState.buildErr() == nil { if f.c.fastRenderMode && f.c.errState.buildErr() == nil {
if isNavigation(requestURI, r) { if strings.HasSuffix(requestURI, "/") || strings.HasSuffix(requestURI, "html") || strings.HasSuffix(requestURI, "htm") {
if !f.c.visitedURLs.Contains(requestURI) { if !f.c.visitedURLs.Contains(requestURI) {
// If not already on stack, re-render that single page. // If not already on stack, re-render that single page.
if err := f.c.partialReRender(requestURI); err != nil { if err := f.c.partialReRender(requestURI); err != nil {
@ -391,10 +356,10 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
fileserver := decorate(http.FileServer(fs)) fileserver := decorate(http.FileServer(fs))
mu := http.NewServeMux() mu := http.NewServeMux()
if baseURL.Path() == "" || baseURL.Path() == "/" { if u.Path == "" || u.Path == "/" {
mu.Handle("/", fileserver) mu.Handle("/", fileserver)
} else { } else {
mu.Handle(baseURL.Path(), http.StripPrefix(baseURL.Path(), fileserver)) mu.Handle(u.Path, http.StripPrefix(u.Path, fileserver))
} }
if r.IsTestRun() { if r.IsTestRun() {
var shutDownOnce sync.Once var shutDownOnce sync.Once
@ -407,7 +372,7 @@ func (f *fileServer) createEndpoint(i int) (*http.ServeMux, net.Listener, string
endpoint := net.JoinHostPort(f.c.serverInterface, strconv.Itoa(port)) endpoint := net.JoinHostPort(f.c.serverInterface, strconv.Itoa(port))
return mu, listener, baseURL.String(), endpoint, nil return mu, listener, u.String(), endpoint, nil
} }
func (f *fileServer) rewriteRequest(r *http.Request, toPath string) *http.Request { func (f *fileServer) rewriteRequest(r *http.Request, toPath string) *http.Request {
@ -453,15 +418,11 @@ type serverCommand struct {
doLiveReload bool doLiveReload bool
// Flags. // Flags.
renderToDisk bool
renderStaticToDisk bool renderStaticToDisk bool
navigateToChanged bool navigateToChanged bool
openBrowser bool
serverAppend bool serverAppend bool
serverInterface string serverInterface string
tlsCertFile string
tlsKeyFile string
tlsAuto bool
pprof bool
serverPort int serverPort int
liveReloadPort int liveReloadPort int
serverWatch bool serverWatch bool
@ -471,16 +432,24 @@ type serverCommand struct {
disableBrowserError bool disableBrowserError bool
} }
func (c *serverCommand) Commands() []simplecobra.Commander {
return c.commands
}
func (c *serverCommand) Name() string { func (c *serverCommand) Name() string {
return "server" return "server"
} }
func (c *serverCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error { func (c *serverCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
if c.pprof { err := func() error {
go func() { defer c.r.timeTrack(time.Now(), "Built")
http.ListenAndServe("localhost:8080", nil) err := c.build()
return err
}() }()
if err != nil {
return err
} }
// Watch runs its own server as part of the routine // Watch runs its own server as part of the routine
if c.serverWatch { if c.serverWatch {
@ -503,26 +472,19 @@ func (c *serverCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, arg
} }
err := func() error {
defer c.r.timeTrack(time.Now(), "Built")
return c.build()
}()
if err != nil {
return err
}
return c.serve() return c.serve()
} }
func (c *serverCommand) Init(cd *simplecobra.Commandeer) error { func (c *serverCommand) Init(cd *simplecobra.Commandeer) error {
cmd := cd.CobraCommand cmd := cd.CobraCommand
cmd.Short = "Start the embedded web server" cmd.Short = "A high performance webserver"
cmd.Long = `Hugo provides its own webserver which builds and serves the site. cmd.Long = `Hugo provides its own webserver which builds and serves the site.
While hugo server is high performance, it is a webserver with limited options. While hugo server is high performance, it is a webserver with limited options.
Many run it in production, but the standard behavior is for people to use it
in development and use a more full featured server such as Nginx or Caddy.
The ` + "`" + `hugo server` + "`" + ` command will by default write and serve files from disk, but 'hugo server' will avoid writing the rendered and served content to disk,
you can render to memory by using the ` + "`" + `--renderToMemory` + "`" + ` flag. This can be preferring to store it in memory.
faster in some cases, but it will consume more memory.
By default hugo will also watch your files for any changes you make and By default hugo will also watch your files for any changes you make and
automatically rebuild the site. It will then live reload any open browser pages automatically rebuild the site. It will then live reload any open browser pages
@ -531,29 +493,23 @@ of a second, you will be able to save and see your changes nearly instantly.`
cmd.Aliases = []string{"serve"} cmd.Aliases = []string{"serve"}
cmd.Flags().IntVarP(&c.serverPort, "port", "p", 1313, "port on which the server will listen") cmd.Flags().IntVarP(&c.serverPort, "port", "p", 1313, "port on which the server will listen")
_ = cmd.RegisterFlagCompletionFunc("port", cobra.NoFileCompletions)
cmd.Flags().IntVar(&c.liveReloadPort, "liveReloadPort", -1, "port for live reloading (i.e. 443 in HTTPS proxy situations)") cmd.Flags().IntVar(&c.liveReloadPort, "liveReloadPort", -1, "port for live reloading (i.e. 443 in HTTPS proxy situations)")
_ = cmd.RegisterFlagCompletionFunc("liveReloadPort", cobra.NoFileCompletions)
cmd.Flags().StringVarP(&c.serverInterface, "bind", "", "127.0.0.1", "interface to which the server will bind") cmd.Flags().StringVarP(&c.serverInterface, "bind", "", "127.0.0.1", "interface to which the server will bind")
_ = cmd.RegisterFlagCompletionFunc("bind", cobra.NoFileCompletions)
cmd.Flags().StringVarP(&c.tlsCertFile, "tlsCertFile", "", "", "path to TLS certificate file")
_ = cmd.MarkFlagFilename("tlsCertFile", "pem")
cmd.Flags().StringVarP(&c.tlsKeyFile, "tlsKeyFile", "", "", "path to TLS key file")
_ = cmd.MarkFlagFilename("tlsKeyFile", "pem")
cmd.Flags().BoolVar(&c.tlsAuto, "tlsAuto", false, "generate and use locally-trusted certificates.")
cmd.Flags().BoolVar(&c.pprof, "pprof", false, "enable the pprof server (port 8080)")
cmd.Flags().BoolVarP(&c.serverWatch, "watch", "w", true, "watch filesystem for changes and recreate as needed") cmd.Flags().BoolVarP(&c.serverWatch, "watch", "w", true, "watch filesystem for changes and recreate as needed")
cmd.Flags().BoolVar(&c.noHTTPCache, "noHTTPCache", false, "prevent HTTP caching") cmd.Flags().BoolVar(&c.noHTTPCache, "noHTTPCache", false, "prevent HTTP caching")
cmd.Flags().BoolVarP(&c.serverAppend, "appendPort", "", true, "append port to baseURL") cmd.Flags().BoolVarP(&c.serverAppend, "appendPort", "", true, "append port to baseURL")
cmd.Flags().BoolVar(&c.disableLiveReload, "disableLiveReload", false, "watch without enabling live browser reload on rebuild") cmd.Flags().BoolVar(&c.disableLiveReload, "disableLiveReload", false, "watch without enabling live browser reload on rebuild")
cmd.Flags().BoolVarP(&c.navigateToChanged, "navigateToChanged", "N", false, "navigate to changed content file on live browser reload") cmd.Flags().BoolVar(&c.navigateToChanged, "navigateToChanged", false, "navigate to changed content file on live browser reload")
cmd.Flags().BoolVarP(&c.openBrowser, "openBrowser", "O", false, "open the site in a browser after server startup") cmd.Flags().BoolVar(&c.renderToDisk, "renderToDisk", false, "serve all files from disk (default is from memory)")
cmd.Flags().BoolVar(&c.renderStaticToDisk, "renderStaticToDisk", false, "serve static files from disk and dynamic files from memory") cmd.Flags().BoolVar(&c.renderStaticToDisk, "renderStaticToDisk", false, "serve static files from disk and dynamic files from memory")
cmd.Flags().BoolVar(&c.disableFastRender, "disableFastRender", false, "enables full re-renders on changes") cmd.Flags().BoolVar(&c.disableFastRender, "disableFastRender", false, "enables full re-renders on changes")
cmd.Flags().BoolVar(&c.disableBrowserError, "disableBrowserError", false, "do not show build errors in the browser") cmd.Flags().BoolVar(&c.disableBrowserError, "disableBrowserError", false, "do not show build errors in the browser")
cmd.Flags().String("memstats", "", "log memory usage to this file")
cmd.Flags().String("meminterval", "100ms", "interval to poll memory usage (requires --memstats), valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".")
r := cd.Root.Command.(*rootCommand) r := cd.Root.Command.(*rootCommand)
applyLocalFlagsBuild(cmd, r) applyLocalBuildFlags(cmd, r)
return nil return nil
} }
@ -569,15 +525,8 @@ func (c *serverCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
if err := c.createServerPorts(cd); err != nil { if err := c.createServerPorts(cd); err != nil {
return err return err
} }
if (c.tlsCertFile == "" || c.tlsKeyFile == "") && c.tlsAuto {
c.withConfE(func(conf *commonConfig) error {
return c.createCertificates(conf)
})
} }
} if err := c.setBaseURLsInConfig(); err != nil {
if err := c.setServerInfoInConfig(); err != nil {
return err return err
} }
@ -593,9 +542,7 @@ func (c *serverCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
) )
destinationFlag := cd.CobraCommand.Flags().Lookup("destination") destinationFlag := cd.CobraCommand.Flags().Lookup("destination")
if c.r.renderToMemory && (destinationFlag != nil && destinationFlag.Changed) { c.renderToDisk = c.renderToDisk || (destinationFlag != nil && destinationFlag.Changed)
return fmt.Errorf("cannot use --renderToMemory with --destination")
}
c.doLiveReload = !c.disableLiveReload c.doLiveReload = !c.disableLiveReload
c.fastRenderMode = !c.disableFastRender c.fastRenderMode = !c.disableFastRender
c.showErrorInBrowser = c.doLiveReload && !c.disableBrowserError c.showErrorInBrowser = c.doLiveReload && !c.disableBrowserError
@ -622,15 +569,15 @@ func (c *serverCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
return nil return nil
} }
func (c *serverCommand) setServerInfoInConfig() error { func (c *serverCommand) setBaseURLsInConfig() error {
if len(c.serverPorts) == 0 { if len(c.serverPorts) == 0 {
panic("no server ports set") panic("no server ports set")
} }
return c.withConfE(func(conf *commonConfig) error { return c.withConfE(func(conf *commonConfig) error {
for i, language := range conf.configs.LanguagesDefaultFirst { for i, language := range conf.configs.Languages {
isMultihost := conf.configs.IsMultihost isMultiHost := conf.configs.IsMultihost
var serverPort int var serverPort int
if isMultihost { if isMultiHost {
serverPort = c.serverPorts[i].p serverPort = c.serverPorts[i].p
} else { } else {
serverPort = c.serverPorts[0].p serverPort = c.serverPorts[0].p
@ -649,108 +596,37 @@ func (c *serverCommand) setServerInfoInConfig() error {
if c.liveReloadPort != -1 { if c.liveReloadPort != -1 {
baseURLLiveReload, _ = baseURLLiveReload.WithPort(c.liveReloadPort) baseURLLiveReload, _ = baseURLLiveReload.WithPort(c.liveReloadPort)
} }
langConfig.C.SetServerInfo(baseURL, baseURLLiveReload, c.serverInterface) langConfig.C.SetBaseURL(baseURL, baseURLLiveReload)
} }
return nil return nil
}) })
} }
func (c *serverCommand) getErrorWithContext() any { func (c *serverCommand) getErrorWithContext() any {
buildErr := c.errState.buildErr() errCount := c.errCount()
if buildErr == nil {
if errCount == 0 {
return nil return nil
} }
m := make(map[string]any) m := make(map[string]any)
m["Error"] = cleanErrorLog(c.r.logger.Errors()) //xwm["Error"] = errors.New(cleanErrorLog(removeErrorPrefixFromLog(c.r.logger.Errors())))
m["Error"] = errors.New(cleanErrorLog(removeErrorPrefixFromLog(c.r.logger.Errors())))
m["Version"] = hugo.BuildVersionString() m["Version"] = hugo.BuildVersionString()
ferrors := herrors.UnwrapFileErrorsWithErrorContext(buildErr) ferrors := herrors.UnwrapFileErrorsWithErrorContext(c.errState.buildErr())
m["Files"] = ferrors m["Files"] = ferrors
return m return m
} }
func (c *serverCommand) createCertificates(conf *commonConfig) error {
hostname := "localhost"
if c.r.baseURL != "" {
u, err := url.Parse(c.r.baseURL)
if err != nil {
return err
}
hostname = u.Hostname()
}
// For now, store these in the Hugo cache dir.
// Hugo should probably introduce some concept of a less temporary application directory.
keyDir := filepath.Join(conf.configs.LoadingInfo.BaseConfig.CacheDir, "_mkcerts")
// Create the directory if it doesn't exist.
if _, err := os.Stat(keyDir); os.IsNotExist(err) {
if err := os.MkdirAll(keyDir, 0o777); err != nil {
return err
}
}
c.tlsCertFile = filepath.Join(keyDir, fmt.Sprintf("%s.pem", hostname))
c.tlsKeyFile = filepath.Join(keyDir, fmt.Sprintf("%s-key.pem", hostname))
// Check if the certificate already exists and is valid.
certPEM, err := os.ReadFile(c.tlsCertFile)
if err == nil {
rootPem, err := os.ReadFile(filepath.Join(mclib.GetCAROOT(), "rootCA.pem"))
if err == nil {
if err := c.verifyCert(rootPem, certPEM, hostname); err == nil {
c.r.Println("Using existing", c.tlsCertFile, "and", c.tlsKeyFile)
return nil
}
}
}
c.r.Println("Creating TLS certificates in", keyDir)
// Yes, this is unfortunate, but it's currently the only way to use Mkcert as a library.
os.Args = []string{"-cert-file", c.tlsCertFile, "-key-file", c.tlsKeyFile, hostname}
return mclib.RunMain()
}
func (c *serverCommand) verifyCert(rootPEM, certPEM []byte, name string) error {
roots := x509.NewCertPool()
ok := roots.AppendCertsFromPEM(rootPEM)
if !ok {
return fmt.Errorf("failed to parse root certificate")
}
block, _ := pem.Decode(certPEM)
if block == nil {
return fmt.Errorf("failed to parse certificate PEM")
}
cert, err := x509.ParseCertificate(block.Bytes)
if err != nil {
return fmt.Errorf("failed to parse certificate: %v", err.Error())
}
opts := x509.VerifyOptions{
DNSName: name,
Roots: roots,
}
if _, err := cert.Verify(opts); err != nil {
return fmt.Errorf("failed to verify certificate: %v", err.Error())
}
return nil
}
func (c *serverCommand) createServerPorts(cd *simplecobra.Commandeer) error { func (c *serverCommand) createServerPorts(cd *simplecobra.Commandeer) error {
flags := cd.CobraCommand.Flags() flags := cd.CobraCommand.Flags()
var cerr error var cerr error
c.withConf(func(conf *commonConfig) { c.withConf(func(conf *commonConfig) {
isMultihost := conf.configs.IsMultihost isMultiHost := conf.configs.IsMultihost
c.serverPorts = make([]serverPortListener, 1) c.serverPorts = make([]serverPortListener, 1)
if isMultihost { if isMultiHost {
if !c.serverAppend { if !c.serverAppend {
cerr = errors.New("--appendPort=false not supported when in multihost mode") cerr = errors.New("--appendPort=false not supported when in multihost mode")
return return
@ -758,7 +634,7 @@ func (c *serverCommand) createServerPorts(cd *simplecobra.Commandeer) error {
c.serverPorts = make([]serverPortListener, len(conf.configs.Languages)) c.serverPorts = make([]serverPortListener, len(conf.configs.Languages))
} }
currentServerPort := c.serverPort currentServerPort := c.serverPort
for i := range c.serverPorts { for i := 0; i < len(c.serverPorts); i++ {
l, err := net.Listen("tcp", net.JoinHostPort(c.serverInterface, strconv.Itoa(currentServerPort))) l, err := net.Listen("tcp", net.JoinHostPort(c.serverInterface, strconv.Itoa(currentServerPort)))
if err == nil { if err == nil {
c.serverPorts[i] = serverPortListener{ln: l, p: currentServerPort} c.serverPorts[i] = serverPortListener{ln: l, p: currentServerPort}
@ -786,40 +662,36 @@ func (c *serverCommand) createServerPorts(cd *simplecobra.Commandeer) error {
// fixURL massages the baseURL into a form needed for serving // fixURL massages the baseURL into a form needed for serving
// all pages correctly. // all pages correctly.
func (c *serverCommand) fixURL(baseURLFromConfig, baseURLFromFlag string, port int) (string, error) { func (c *serverCommand) fixURL(baseURL, s string, port int) (string, error) {
certsSet := (c.tlsCertFile != "" && c.tlsKeyFile != "") || c.tlsAuto
useLocalhost := false useLocalhost := false
baseURL := baseURLFromFlag if s == "" {
if baseURL == "" { s = baseURL
baseURL = baseURLFromConfig
useLocalhost = true useLocalhost = true
} }
if !strings.HasSuffix(baseURL, "/") { if !strings.HasSuffix(s, "/") {
baseURL = baseURL + "/" s = s + "/"
} }
// do an initial parse of the input string // do an initial parse of the input string
u, err := url.Parse(baseURL) u, err := url.Parse(s)
if err != nil { if err != nil {
return "", err return "", err
} }
// if no Host is defined, then assume that no schema or double-slash were // if no Host is defined, then assume that no schema or double-slash were
// present in the url. Add a double-slash and make a best effort attempt. // present in the url. Add a double-slash and make a best effort attempt.
if u.Host == "" && baseURL != "/" { if u.Host == "" && s != "/" {
baseURL = "//" + baseURL s = "//" + s
u, err = url.Parse(baseURL) u, err = url.Parse(s)
if err != nil { if err != nil {
return "", err return "", err
} }
} }
if useLocalhost { if useLocalhost {
if certsSet { if u.Scheme == "https" {
u.Scheme = "https"
} else if u.Scheme == "https" {
u.Scheme = "http" u.Scheme = "http"
} }
u.Host = "localhost" u.Host = "localhost"
@ -838,57 +710,52 @@ func (c *serverCommand) fixURL(baseURLFromConfig, baseURLFromFlag string, port i
return u.String(), nil return u.String(), nil
} }
func (c *serverCommand) partialReRender(urls ...string) (err error) { func (c *serverCommand) partialReRender(urls ...string) error {
defer func() { defer func() {
c.errState.setWasErr(false) c.errState.setWasErr(false)
}() }()
visited := types.NewEvictingQueue[string](len(urls)) c.errState.setBuildErr(nil)
visited := make(map[string]bool)
for _, url := range urls { for _, url := range urls {
visited.Add(url) visited[url] = true
} }
var h *hugolib.HugoSites h, err := c.hugo()
h, err = c.hugo()
if err != nil { if err != nil {
return return err
} }
// Note: We do not set NoBuildLock as the file lock is not acquired at this stage. // Note: We do not set NoBuildLock as the file lock is not acquired at this stage.
err = h.Build(hugolib.BuildCfg{NoBuildLock: false, RecentlyTouched: visited, PartialReRender: true, ErrRecovery: c.errState.wasErr()}) return h.Build(hugolib.BuildCfg{NoBuildLock: false, RecentlyVisited: visited, PartialReRender: true, ErrRecovery: c.errState.wasErr()})
return
} }
func (c *serverCommand) serve() error { func (c *serverCommand) serve() error {
var ( var (
baseURLs []urls.BaseURL baseURLs []string
roots []string roots []string
h *hugolib.HugoSites h *hugolib.HugoSites
) )
err := c.withConfE(func(conf *commonConfig) error { err := c.withConfE(func(conf *commonConfig) error {
isMultihost := conf.configs.IsMultihost isMultiHost := conf.configs.IsMultihost
var err error var err error
h, err = c.r.HugFromConfig(conf) h, err = c.r.HugFromConfig(conf)
if err != nil { if err != nil {
return err return err
} }
// We need the server to share the same logger as the Hugo build (for error counts etc.) if isMultiHost {
c.r.logger = h.Log
if isMultihost {
for _, l := range conf.configs.ConfigLangs() { for _, l := range conf.configs.ConfigLangs() {
baseURLs = append(baseURLs, l.BaseURL()) baseURLs = append(baseURLs, l.BaseURL().String())
roots = append(roots, l.Language().Lang) roots = append(roots, l.Language().Lang)
} }
} else { } else {
l := conf.configs.GetFirstLanguageConfig() l := conf.configs.GetFirstLanguageConfig()
baseURLs = []urls.BaseURL{l.BaseURL()} baseURLs = []string{l.BaseURL().String()}
roots = []string{""} roots = []string{""}
} }
return nil return nil
}) })
if err != nil { if err != nil {
return err return err
} }
@ -897,16 +764,16 @@ func (c *serverCommand) serve() error {
// To allow the en user to change the error template while the server is running, we use // To allow the en user to change the error template while the server is running, we use
// the freshest template we can provide. // the freshest template we can provide.
var ( var (
errTempl *tplimpl.TemplInfo errTempl tpl.Template
templHandler *tplimpl.TemplateStore templHandler tpl.TemplateHandler
) )
getErrorTemplateAndHandler := func(h *hugolib.HugoSites) (*tplimpl.TemplInfo, *tplimpl.TemplateStore) { getErrorTemplateAndHandler := func(h *hugolib.HugoSites) (tpl.Template, tpl.TemplateHandler) {
if h == nil { if h == nil {
return errTempl, templHandler return errTempl, templHandler
} }
templHandler := h.GetTemplateStore() templHandler := h.Tmpl()
errTempl := templHandler.LookupByPath("/_server/error.html") errTempl, found := templHandler.Lookup("_server/error.html")
if errTempl == nil { if !found {
panic("template server/error.html not found") panic("template server/error.html not found")
} }
return errTempl, templHandler return errTempl, templHandler
@ -941,36 +808,24 @@ func (c *serverCommand) serve() error {
for i := range baseURLs { for i := range baseURLs {
mu, listener, serverURL, endpoint, err := srv.createEndpoint(i) mu, listener, serverURL, endpoint, err := srv.createEndpoint(i)
var srv *http.Server srv := &http.Server{
if c.tlsCertFile != "" && c.tlsKeyFile != "" {
srv = &http.Server{
Addr: endpoint,
Handler: mu,
TLSConfig: &tls.Config{
MinVersion: tls.VersionTLS12,
},
}
} else {
srv = &http.Server{
Addr: endpoint, Addr: endpoint,
Handler: mu, Handler: mu,
} }
}
servers = append(servers, srv) servers = append(servers, srv)
if doLiveReload { if doLiveReload {
baseURL := baseURLs[i] u, err := url.Parse(helpers.SanitizeURL(baseURLs[i]))
mu.HandleFunc(baseURL.Path()+"livereload.js", livereload.ServeJS) if err != nil {
mu.HandleFunc(baseURL.Path()+"livereload", livereload.Handler) return err
} }
c.r.Printf("Web Server is available at %s (bind address %s) %s\n", serverURL, c.serverInterface, roots[i])
mu.HandleFunc(u.Path+"/livereload.js", livereload.ServeJS)
mu.HandleFunc(u.Path+"/livereload", livereload.Handler)
}
c.r.Printf("Web Server is available at %s (bind address %s)\n", serverURL, c.serverInterface)
wg1.Go(func() error { wg1.Go(func() error {
if c.tlsCertFile != "" && c.tlsKeyFile != "" {
err = srv.ServeTLS(listener, c.tlsCertFile, c.tlsKeyFile)
} else {
err = srv.Serve(listener) err = srv.Serve(listener)
}
if err != nil && err != http.ErrServerClosed { if err != nil && err != http.ErrServerClosed {
return err return err
} }
@ -981,12 +836,8 @@ func (c *serverCommand) serve() error {
if c.r.IsTestRun() { if c.r.IsTestRun() {
// Write a .ready file to disk to signal ready status. // Write a .ready file to disk to signal ready status.
// This is where the test is run from. // This is where the test is run from.
var baseURLs []string
for _, baseURL := range srv.baseURLs {
baseURLs = append(baseURLs, baseURL.String())
}
testInfo := map[string]any{ testInfo := map[string]any{
"baseURLs": baseURLs, "baseURLs": srv.baseURLs,
} }
dir := os.Getenv("WORK") dir := os.Getenv("WORK")
@ -997,7 +848,7 @@ func (c *serverCommand) serve() error {
if err != nil { if err != nil {
return err return err
} }
err = os.WriteFile(readyFile, b, 0o777) err = ioutil.WriteFile(readyFile, b, 0777)
if err != nil { if err != nil {
return err return err
} }
@ -1007,13 +858,6 @@ func (c *serverCommand) serve() error {
c.r.Println("Press Ctrl+C to stop") c.r.Println("Press Ctrl+C to stop")
if c.openBrowser {
// There may be more than one baseURL in multihost mode, open the first.
if err := browser.OpenURL(baseURLs[0].String()); err != nil {
c.r.logger.Warnf("Failed to open browser: %s", err)
}
}
err = func() error { err = func() error {
for { for {
select { select {
@ -1026,10 +870,15 @@ func (c *serverCommand) serve() error {
} }
} }
}() }()
if err != nil { if err != nil {
c.r.Println("Error:", err) c.r.Println("Error:", err)
} }
if h := c.hugoTry(); h != nil {
h.Close()
}
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel() defer cancel()
wg2, ctx := errgroup.WithContext(ctx) wg2, ctx := errgroup.WithContext(ctx)
@ -1082,7 +931,8 @@ func (s *staticSyncer) syncsStaticEvents(staticEvents []fsnotify.Event) error {
} }
}) })
logger := s.c.r.logger // prevent spamming the log on changes
logger := helpers.NewDistinctErrorLogger()
for _, ev := range staticEvents { for _, ev := range staticEvents {
// Due to our approach of layering both directories and the content's rendered output // Due to our approach of layering both directories and the content's rendered output
@ -1103,7 +953,7 @@ func (s *staticSyncer) syncsStaticEvents(staticEvents []fsnotify.Event) error {
fromPath := ev.Name fromPath := ev.Name
relPath, found := sourceFs.MakePathRelative(fromPath, true) relPath, found := sourceFs.MakePathRelative(fromPath)
if !found { if !found {
// Not member of this virtual host. // Not member of this virtual host.
@ -1183,7 +1033,7 @@ func cleanErrorLog(content string) string {
return strings.Join(keep, ": ") return strings.Join(keep, ": ")
} }
func injectLiveReloadScript(src io.Reader, baseURL *url.URL) string { func injectLiveReloadScript(src io.Reader, baseURL url.URL) string {
var b bytes.Buffer var b bytes.Buffer
chain := transform.Chain{livereloadinject.New(baseURL)} chain := transform.Chain{livereloadinject.New(baseURL)}
chain.Apply(&b, src) chain.Apply(&b, src)
@ -1202,16 +1052,16 @@ func partitionDynamicEvents(sourceFs *filesystems.SourceFilesystems, events []fs
return return
} }
func pickOneWriteOrCreatePath(contentTypes config.ContentTypesProvider, events []fsnotify.Event) string { func pickOneWriteOrCreatePath(events []fsnotify.Event) string {
name := "" name := ""
for _, ev := range events { for _, ev := range events {
if ev.Op&fsnotify.Write == fsnotify.Write || ev.Op&fsnotify.Create == fsnotify.Create { if ev.Op&fsnotify.Write == fsnotify.Write || ev.Op&fsnotify.Create == fsnotify.Create {
if contentTypes.IsIndexContentFile(ev.Name) { if files.IsIndexContentFile(ev.Name) {
return ev.Name return ev.Name
} }
if contentTypes.IsContentFile(ev.Name) { if files.IsContentFile(ev.Name) {
name = ev.Name name = ev.Name
} }
@ -1221,6 +1071,10 @@ func pickOneWriteOrCreatePath(contentTypes config.ContentTypesProvider, events [
return name return name
} }
func removeErrorPrefixFromLog(content string) string {
return logErrorRe.ReplaceAllLiteralString(content, "")
}
func formatByteCount(b uint64) string { func formatByteCount(b uint64) string {
const unit = 1000 const unit = 1000
if b < unit { if b < unit {
@ -1234,24 +1088,3 @@ func formatByteCount(b uint64) string {
return fmt.Sprintf("%.1f %cB", return fmt.Sprintf("%.1f %cB",
float64(b)/float64(div), "kMGTPE"[exp]) float64(b)/float64(div), "kMGTPE"[exp])
} }
func canRedirect(requestURIWithoutQuery string, r *http.Request) bool {
if r.Header.Get(hugoHeaderRedirect) != "" {
return false
}
return isNavigation(requestURIWithoutQuery, r)
}
// Sec-Fetch-Mode should be sent by all recent browser versions, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-Fetch-Mode#navigate
// Fall back to the file extension if not set.
// The main take here is that we don't want to have CSS/JS files etc. partake in this logic.
func isNavigation(requestURIWithoutQuery string, r *http.Request) bool {
return r.Header.Get("Sec-Fetch-Mode") == "navigate" || isPropablyHTMLRequest(requestURIWithoutQuery)
}
func isPropablyHTMLRequest(requestURIWithoutQuery string) bool {
if strings.HasSuffix(requestURIWithoutQuery, "/") || strings.HasSuffix(requestURIWithoutQuery, "html") || strings.HasSuffix(requestURIWithoutQuery, "htm") {
return true
}
return !strings.Contains(requestURIWithoutQuery, ".")
}

View file

@ -0,0 +1,79 @@
// 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 commands
import (
"context"
"fmt"
"github.com/bep/simplecobra"
"github.com/spf13/cobra"
)
func newSimpleTemplateCommand() simplecobra.Commander {
return &simpleCommand{
name: "template",
run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
return nil
},
withc: func(cmd *cobra.Command) {
},
}
}
func newTemplateCommand() *templateCommand {
return &templateCommand{
commands: []simplecobra.Commander{},
}
}
type templateCommand struct {
r *rootCommand
commands []simplecobra.Commander
}
func (c *templateCommand) Commands() []simplecobra.Commander {
return c.commands
}
func (c *templateCommand) Name() string {
return "template"
}
func (c *templateCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
conf, err := c.r.ConfigFromProvider(c.r.configVersionID.Load(), flagsToCfg(cd, nil))
if err != nil {
return err
}
fmt.Println("templateCommand.Run", conf)
return nil
}
func (c *templateCommand) Init(cd *simplecobra.Commandeer) error {
cmd := cd.CobraCommand
cmd.Short = "Print the site configuration"
cmd.Long = `Print the site configuration, both default and custom settings.`
return nil
}
func (c *templateCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
c.r = cd.Root.Command.(*rootCommand)
return nil
}

View file

@ -22,64 +22,29 @@ import (
// If length of from is one and the only element is a slice of same type as to, // If length of from is one and the only element is a slice of same type as to,
// it will be appended. // it will be appended.
func Append(to any, from ...any) (any, error) { func Append(to any, from ...any) (any, error) {
if len(from) == 0 {
return to, nil
}
tov, toIsNil := indirect(reflect.ValueOf(to)) tov, toIsNil := indirect(reflect.ValueOf(to))
toIsNil = toIsNil || to == nil toIsNil = toIsNil || to == nil
var tot reflect.Type var tot reflect.Type
if !toIsNil { if !toIsNil {
if tov.Kind() == reflect.Slice {
// Create a copy of tov, so we don't modify the original.
c := reflect.MakeSlice(tov.Type(), tov.Len(), tov.Len()+len(from))
reflect.Copy(c, tov)
tov = c
}
if tov.Kind() != reflect.Slice { if tov.Kind() != reflect.Slice {
return nil, fmt.Errorf("expected a slice, got %T", to) return nil, fmt.Errorf("expected a slice, got %T", to)
} }
tot = tov.Type().Elem() tot = tov.Type().Elem()
if tot.Kind() == reflect.Slice {
totvt := tot.Elem()
fromvs := make([]reflect.Value, len(from))
for i, f := range from {
fromv := reflect.ValueOf(f)
fromt := fromv.Type()
if fromt.Kind() == reflect.Slice {
fromt = fromt.Elem()
}
if totvt != fromt {
return nil, fmt.Errorf("cannot append slice of %s to slice of %s", fromt, totvt)
} else {
fromvs[i] = fromv
}
}
return reflect.Append(tov, fromvs...).Interface(), nil
}
toIsNil = tov.Len() == 0 toIsNil = tov.Len() == 0
if len(from) == 1 { if len(from) == 1 {
fromv := reflect.ValueOf(from[0]) fromv := reflect.ValueOf(from[0])
if !fromv.IsValid() {
// from[0] is nil
return appendToInterfaceSliceFromValues(tov, fromv)
}
fromt := fromv.Type()
if fromt.Kind() == reflect.Slice {
fromt = fromt.Elem()
}
if fromv.Kind() == reflect.Slice { if fromv.Kind() == reflect.Slice {
if toIsNil { if toIsNil {
// If we get nil []string, we just return the []string // If we get nil []string, we just return the []string
return from[0], nil return from[0], nil
} }
fromt := reflect.TypeOf(from[0]).Elem()
// If we get []string []string, we append the from slice to to // If we get []string []string, we append the from slice to to
if tot == fromt { if tot == fromt {
return reflect.AppendSlice(tov, fromv).Interface(), nil return reflect.AppendSlice(tov, fromv).Interface(), nil
@ -87,7 +52,6 @@ func Append(to any, from ...any) (any, error) {
// Fall back to a []interface{} slice. // Fall back to a []interface{} slice.
return appendToInterfaceSliceFromValues(tov, fromv) return appendToInterfaceSliceFromValues(tov, fromv)
} }
} }
} }
} }
@ -98,7 +62,7 @@ func Append(to any, from ...any) (any, error) {
for _, f := range from { for _, f := range from {
fv := reflect.ValueOf(f) fv := reflect.ValueOf(f)
if !fv.IsValid() || !fv.Type().AssignableTo(tot) { if !fv.Type().AssignableTo(tot) {
// Fall back to a []interface{} slice. // Fall back to a []interface{} slice.
tov, _ := indirect(reflect.ValueOf(to)) tov, _ := indirect(reflect.ValueOf(to))
return appendToInterfaceSlice(tov, from...) return appendToInterfaceSlice(tov, from...)
@ -113,11 +77,7 @@ func appendToInterfaceSliceFromValues(slice1, slice2 reflect.Value) ([]any, erro
var tos []any var tos []any
for _, slice := range []reflect.Value{slice1, slice2} { for _, slice := range []reflect.Value{slice1, slice2} {
if !slice.IsValid() { for i := 0; i < slice.Len(); i++ {
tos = append(tos, nil)
continue
}
for i := range slice.Len() {
tos = append(tos, slice.Index(i).Interface()) tos = append(tos, slice.Index(i).Interface())
} }
} }
@ -128,7 +88,7 @@ func appendToInterfaceSliceFromValues(slice1, slice2 reflect.Value) ([]any, erro
func appendToInterfaceSlice(tov reflect.Value, from ...any) ([]any, error) { func appendToInterfaceSlice(tov reflect.Value, from ...any) ([]any, error) {
var tos []any var tos []any
for i := range tov.Len() { for i := 0; i < tov.Len(); i++ {
tos = append(tos, tov.Index(i).Interface()) tos = append(tos, tov.Index(i).Interface())
} }

View file

@ -15,7 +15,6 @@ package collections
import ( import (
"html/template" "html/template"
"reflect"
"testing" "testing"
qt "github.com/frankban/quicktest" qt "github.com/frankban/quicktest"
@ -25,7 +24,7 @@ func TestAppend(t *testing.T) {
t.Parallel() t.Parallel()
c := qt.New(t) c := qt.New(t)
for i, test := range []struct { for _, test := range []struct {
start any start any
addend []any addend []any
expected any expected any
@ -56,7 +55,7 @@ func TestAppend(t *testing.T) {
[]any{&tstSlicerIn1{"c"}}, []any{&tstSlicerIn1{"c"}},
testSlicerInterfaces{&tstSlicerIn1{"a"}, &tstSlicerIn1{"b"}, &tstSlicerIn1{"c"}}, testSlicerInterfaces{&tstSlicerIn1{"a"}, &tstSlicerIn1{"b"}, &tstSlicerIn1{"c"}},
}, },
// https://github.com/gohugoio/hugo/issues/5361 //https://github.com/gohugoio/hugo/issues/5361
{ {
[]string{"a", "b"}, []string{"a", "b"},
[]any{tstSlicers{&tstSlicer{"a"}, &tstSlicer{"b"}}}, []any{tstSlicers{&tstSlicer{"a"}, &tstSlicer{"b"}}},
@ -75,10 +74,6 @@ func TestAppend(t *testing.T) {
[]any{"c"}, []any{"c"},
false, false,
}, },
{[]string{"a", "b"}, []any{nil}, []any{"a", "b", nil}},
{[]string{"a", "b"}, []any{nil, "d", nil}, []any{"a", "b", nil, "d", nil}},
{[]any{"a", nil, "c"}, []any{"d", nil, "f"}, []any{"a", nil, "c", "d", nil, "f"}},
{[]string{"a", "b"}, []any{}, []string{"a", "b"}},
} { } {
result, err := Append(test.start, test.addend...) result, err := Append(test.start, test.addend...)
@ -89,125 +84,7 @@ func TestAppend(t *testing.T) {
continue continue
} }
c.Assert(err, qt.IsNil)
c.Assert(result, qt.DeepEquals, test.expected, qt.Commentf("test: [%d] %v", i, test))
}
}
// #11093
func TestAppendToMultiDimensionalSlice(t *testing.T) {
t.Parallel()
c := qt.New(t)
for _, test := range []struct {
to any
from []any
expected any
}{
{
[][]string{{"a", "b"}},
[]any{[]string{"c", "d"}},
[][]string{
{"a", "b"},
{"c", "d"},
},
},
{
[][]string{{"a", "b"}},
[]any{[]string{"c", "d"}, []string{"e", "f"}},
[][]string{
{"a", "b"},
{"c", "d"},
{"e", "f"},
},
},
{
[][]string{{"a", "b"}},
[]any{[]int{1, 2}},
false,
},
} {
result, err := Append(test.to, test.from...)
if b, ok := test.expected.(bool); ok && !b {
c.Assert(err, qt.Not(qt.IsNil))
} else {
c.Assert(err, qt.IsNil) c.Assert(err, qt.IsNil)
c.Assert(result, qt.DeepEquals, test.expected) c.Assert(result, qt.DeepEquals, test.expected)
} }
}
}
func TestAppendShouldMakeACopyOfTheInputSlice(t *testing.T) {
t.Parallel()
c := qt.New(t)
slice := make([]string, 0, 100)
slice = append(slice, "a", "b")
result, err := Append(slice, "c")
c.Assert(err, qt.IsNil)
slice[0] = "d"
c.Assert(result, qt.DeepEquals, []string{"a", "b", "c"})
c.Assert(slice, qt.DeepEquals, []string{"d", "b"})
}
func TestIndirect(t *testing.T) {
t.Parallel()
c := qt.New(t)
type testStruct struct {
Field string
}
var (
nilPtr *testStruct
nilIface interface{} = nil
nonNilIface interface{} = &testStruct{Field: "hello"}
)
tests := []struct {
name string
input any
wantKind reflect.Kind
wantNil bool
}{
{
name: "nil pointer",
input: nilPtr,
wantKind: reflect.Ptr,
wantNil: true,
},
{
name: "nil interface",
input: nilIface,
wantKind: reflect.Invalid,
wantNil: false,
},
{
name: "non-nil pointer to struct",
input: &testStruct{Field: "abc"},
wantKind: reflect.Struct,
wantNil: false,
},
{
name: "non-nil interface holding pointer",
input: nonNilIface,
wantKind: reflect.Struct,
wantNil: false,
},
{
name: "plain value",
input: testStruct{Field: "xyz"},
wantKind: reflect.Struct,
wantNil: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
v := reflect.ValueOf(tt.input)
got, isNil := indirect(v)
c.Assert(got.Kind(), qt.Equals, tt.wantKind)
c.Assert(isNil, qt.Equals, tt.wantNil)
})
}
} }

View file

@ -73,6 +73,7 @@ func StringSliceToInterfaceSlice(ss []string) []any {
result[i] = s result[i] = s
} }
return result return result
} }
type SortedStringSlice []string type SortedStringSlice []string

View file

@ -135,38 +135,5 @@ func TestSortedStringSlice(t *testing.T) {
c.Assert(s.Count("b"), qt.Equals, 3) c.Assert(s.Count("b"), qt.Equals, 3)
c.Assert(s.Count("z"), qt.Equals, 0) c.Assert(s.Count("z"), qt.Equals, 0)
c.Assert(s.Count("a"), qt.Equals, 1) c.Assert(s.Count("a"), qt.Equals, 1)
}
func TestStringSliceToInterfaceSlice(t *testing.T) {
t.Parallel()
c := qt.New(t)
tests := []struct {
name string
in []string
want []any
}{
{
name: "empty slice",
in: []string{},
want: []any{},
},
{
name: "single element",
in: []string{"hello"},
want: []any{"hello"},
},
{
name: "multiple elements",
in: []string{"a", "b", "c"},
want: []any{"a", "b", "c"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := StringSliceToInterfaceSlice(tt.in)
c.Assert(got, qt.DeepEquals, tt.want)
})
}
} }

View file

@ -1,82 +0,0 @@
// Copyright 2024 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 collections
import "slices"
import "sync"
// Stack is a simple LIFO stack that is safe for concurrent use.
type Stack[T any] struct {
items []T
zero T
mu sync.RWMutex
}
func NewStack[T any]() *Stack[T] {
return &Stack[T]{}
}
func (s *Stack[T]) Push(item T) {
s.mu.Lock()
defer s.mu.Unlock()
s.items = append(s.items, item)
}
func (s *Stack[T]) Pop() (T, bool) {
s.mu.Lock()
defer s.mu.Unlock()
if len(s.items) == 0 {
return s.zero, false
}
item := s.items[len(s.items)-1]
s.items = s.items[:len(s.items)-1]
return item, true
}
func (s *Stack[T]) Peek() (T, bool) {
s.mu.RLock()
defer s.mu.RUnlock()
if len(s.items) == 0 {
return s.zero, false
}
return s.items[len(s.items)-1], true
}
func (s *Stack[T]) Len() int {
s.mu.RLock()
defer s.mu.RUnlock()
return len(s.items)
}
func (s *Stack[T]) Drain() []T {
s.mu.Lock()
defer s.mu.Unlock()
items := s.items
s.items = nil
return items
}
func (s *Stack[T]) DrainMatching(predicate func(T) bool) []T {
s.mu.Lock()
defer s.mu.Unlock()
var items []T
for i := len(s.items) - 1; i >= 0; i-- {
if predicate(s.items[i]) {
items = append(items, s.items[i])
s.items = slices.Delete(s.items, i, i+1)
}
}
return items
}

View file

@ -1,77 +0,0 @@
package collections
import (
"testing"
qt "github.com/frankban/quicktest"
)
func TestNewStack(t *testing.T) {
t.Parallel()
c := qt.New(t)
s := NewStack[int]()
c.Assert(s, qt.IsNotNil)
}
func TestStackBasic(t *testing.T) {
t.Parallel()
c := qt.New(t)
s := NewStack[int]()
c.Assert(s.Len(), qt.Equals, 0)
s.Push(1)
s.Push(2)
s.Push(3)
c.Assert(s.Len(), qt.Equals, 3)
top, ok := s.Peek()
c.Assert(ok, qt.Equals, true)
c.Assert(top, qt.Equals, 3)
popped, ok := s.Pop()
c.Assert(ok, qt.Equals, true)
c.Assert(popped, qt.Equals, 3)
c.Assert(s.Len(), qt.Equals, 2)
_, _ = s.Pop()
_, _ = s.Pop()
_, ok = s.Pop()
c.Assert(ok, qt.Equals, false)
}
func TestStackDrain(t *testing.T) {
t.Parallel()
c := qt.New(t)
s := NewStack[string]()
s.Push("a")
s.Push("b")
got := s.Drain()
c.Assert(got, qt.DeepEquals, []string{"a", "b"})
c.Assert(s.Len(), qt.Equals, 0)
}
func TestStackDrainMatching(t *testing.T) {
t.Parallel()
c := qt.New(t)
s := NewStack[int]()
s.Push(1)
s.Push(2)
s.Push(3)
s.Push(4)
got := s.DrainMatching(func(v int) bool { return v%2 == 0 })
c.Assert(got, qt.DeepEquals, []int{4, 2})
c.Assert(s.Drain(), qt.DeepEquals, []int{1, 3})
}

View file

@ -13,37 +13,13 @@
package constants package constants
// Error/Warning IDs. // Error IDs.
// Do not change these values. // Do not change these values.
const ( const (
ErrIDAmbigousDisableKindTaxonomy = "error-disable-taxonomy"
ErrIDAmbigousOutputKindTaxonomy = "error-output-taxonomy"
// IDs for remote errors in tpl/data. // IDs for remote errors in tpl/data.
ErrRemoteGetJSON = "error-remote-getjson" ErrRemoteGetJSON = "error-remote-getjson"
ErrRemoteGetCSV = "error-remote-getcsv" ErrRemoteGetCSV = "error-remote-getcsv"
WarnFrontMatterParamsOverrides = "warning-frontmatter-params-overrides"
WarnRenderShortcodesInHTML = "warning-rendershortcodes-in-html"
WarnGoldmarkRawHTML = "warning-goldmark-raw-html"
WarnPartialSuperfluousPrefix = "warning-partial-superfluous-prefix"
WarnHomePageIsLeafBundle = "warning-home-page-is-leaf-bundle"
) )
// Field/method names with special meaning.
const (
FieldRelPermalink = "RelPermalink"
FieldPermalink = "Permalink"
)
// IsFieldRelOrPermalink returns whether the given name is a RelPermalink or Permalink.
func IsFieldRelOrPermalink(name string) bool {
return name == FieldRelPermalink || name == FieldPermalink
}
// Resource transformations.
const (
ResourceTransformationFingerprint = "fingerprint"
)
// IsResourceTransformationPermalinkHash returns whether the given name is a resource transformation that changes the permalink based on the content.
func IsResourceTransformationPermalinkHash(name string) bool {
return name == ResourceTransformationFingerprint
}

View file

@ -1,194 +0,0 @@
// Copyright 2024 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 hashing provides common hashing utilities.
package hashing
import (
"crypto/md5"
"encoding/hex"
"io"
"strconv"
"sync"
"github.com/cespare/xxhash/v2"
"github.com/gohugoio/hashstructure"
"github.com/gohugoio/hugo/identity"
)
// XXHashFromReader calculates the xxHash for the given reader.
func XXHashFromReader(r io.Reader) (uint64, int64, error) {
h := getXxHashReadFrom()
defer putXxHashReadFrom(h)
size, err := io.Copy(h, r)
if err != nil {
return 0, 0, err
}
return h.Sum64(), size, nil
}
// XxHashFromReaderHexEncoded calculates the xxHash for the given reader
// and returns the hash as a hex encoded string.
func XxHashFromReaderHexEncoded(r io.Reader) (string, error) {
h := getXxHashReadFrom()
defer putXxHashReadFrom(h)
_, err := io.Copy(h, r)
if err != nil {
return "", err
}
hash := h.Sum(nil)
return hex.EncodeToString(hash), nil
}
// XXHashFromString calculates the xxHash for the given string.
func XXHashFromString(s string) (uint64, error) {
h := xxhash.New()
h.WriteString(s)
return h.Sum64(), nil
}
// XxHashFromStringHexEncoded calculates the xxHash for the given string
// and returns the hash as a hex encoded string.
func XxHashFromStringHexEncoded(f string) string {
h := xxhash.New()
h.WriteString(f)
hash := h.Sum(nil)
return hex.EncodeToString(hash)
}
// MD5FromStringHexEncoded returns the MD5 hash of the given string.
func MD5FromStringHexEncoded(f string) string {
h := md5.New()
h.Write([]byte(f))
return hex.EncodeToString(h.Sum(nil))
}
// HashString returns a hash from the given elements.
// It will panic if the hash cannot be calculated.
// Note that this hash should be used primarily for identity, not for change detection as
// it in the more complex values (e.g. Page) will not hash the full content.
func HashString(vs ...any) string {
hash := HashUint64(vs...)
return strconv.FormatUint(hash, 10)
}
// HashStringHex returns a hash from the given elements as a hex encoded string.
// See HashString for more information.
func HashStringHex(vs ...any) string {
hash := HashUint64(vs...)
return strconv.FormatUint(hash, 16)
}
var hashOptsPool = sync.Pool{
New: func() any {
return &hashstructure.HashOptions{
Hasher: xxhash.New(),
}
},
}
func getHashOpts() *hashstructure.HashOptions {
return hashOptsPool.Get().(*hashstructure.HashOptions)
}
func putHashOpts(opts *hashstructure.HashOptions) {
opts.Hasher.Reset()
hashOptsPool.Put(opts)
}
// HashUint64 returns a hash from the given elements.
// It will panic if the hash cannot be calculated.
// Note that this hash should be used primarily for identity, not for change detection as
// it in the more complex values (e.g. Page) will not hash the full content.
func HashUint64(vs ...any) uint64 {
var o any
if len(vs) == 1 {
o = toHashable(vs[0])
} else {
elements := make([]any, len(vs))
for i, e := range vs {
elements[i] = toHashable(e)
}
o = elements
}
hash, err := Hash(o)
if err != nil {
panic(err)
}
return hash
}
// Hash returns a hash from vs.
func Hash(vs ...any) (uint64, error) {
hashOpts := getHashOpts()
defer putHashOpts(hashOpts)
var v any = vs
if len(vs) == 1 {
v = vs[0]
}
return hashstructure.Hash(v, hashOpts)
}
type keyer interface {
Key() string
}
// For structs, hashstructure.Hash only works on the exported fields,
// so rewrite the input slice for known identity types.
func toHashable(v any) any {
switch t := v.(type) {
case keyer:
return t.Key()
case identity.IdentityProvider:
return t.GetIdentity()
default:
return v
}
}
type xxhashReadFrom struct {
buff []byte
*xxhash.Digest
}
func (x *xxhashReadFrom) ReadFrom(r io.Reader) (int64, error) {
for {
n, err := r.Read(x.buff)
if n > 0 {
x.Digest.Write(x.buff[:n])
}
if err != nil {
if err == io.EOF {
err = nil
}
return int64(n), err
}
}
}
var xXhashReadFromPool = sync.Pool{
New: func() any {
return &xxhashReadFrom{Digest: xxhash.New(), buff: make([]byte, 48*1024)}
},
}
func getXxHashReadFrom() *xxhashReadFrom {
return xXhashReadFromPool.Get().(*xxhashReadFrom)
}
func putXxHashReadFrom(h *xxhashReadFrom) {
h.Reset()
xXhashReadFromPool.Put(h)
}

View file

@ -1,157 +0,0 @@
// Copyright 2024 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 hashing
import (
"fmt"
"math"
"strings"
"sync"
"testing"
qt "github.com/frankban/quicktest"
)
func TestXxHashFromReader(t *testing.T) {
c := qt.New(t)
s := "Hello World"
r := strings.NewReader(s)
got, size, err := XXHashFromReader(r)
c.Assert(err, qt.IsNil)
c.Assert(size, qt.Equals, int64(len(s)))
c.Assert(got, qt.Equals, uint64(7148569436472236994))
}
func TestXxHashFromReaderPara(t *testing.T) {
c := qt.New(t)
var wg sync.WaitGroup
for i := range 10 {
i := i
wg.Add(1)
go func() {
defer wg.Done()
for j := range 100 {
s := strings.Repeat("Hello ", i+j+1*42)
r := strings.NewReader(s)
got, size, err := XXHashFromReader(r)
c.Assert(size, qt.Equals, int64(len(s)))
c.Assert(err, qt.IsNil)
expect, _ := XXHashFromString(s)
c.Assert(got, qt.Equals, expect)
}
}()
}
wg.Wait()
}
func TestXxHashFromString(t *testing.T) {
c := qt.New(t)
s := "Hello World"
got, err := XXHashFromString(s)
c.Assert(err, qt.IsNil)
c.Assert(got, qt.Equals, uint64(7148569436472236994))
}
func TestXxHashFromStringHexEncoded(t *testing.T) {
c := qt.New(t)
s := "The quick brown fox jumps over the lazy dog"
got := XxHashFromStringHexEncoded(s)
// Facit: https://asecuritysite.com/encryption/xxhash?val=The%20quick%20brown%20fox%20jumps%20over%20the%20lazy%20dog
c.Assert(got, qt.Equals, "0b242d361fda71bc")
}
func BenchmarkXXHashFromReader(b *testing.B) {
r := strings.NewReader("Hello World")
b.ResetTimer()
for i := 0; i < b.N; i++ {
XXHashFromReader(r)
r.Seek(0, 0)
}
}
func BenchmarkXXHashFromString(b *testing.B) {
s := "Hello World"
b.ResetTimer()
for i := 0; i < b.N; i++ {
XXHashFromString(s)
}
}
func BenchmarkXXHashFromStringHexEncoded(b *testing.B) {
s := "The quick brown fox jumps over the lazy dog"
b.ResetTimer()
for i := 0; i < b.N; i++ {
XxHashFromStringHexEncoded(s)
}
}
func TestHashString(t *testing.T) {
c := qt.New(t)
c.Assert(HashString("a", "b"), qt.Equals, "3176555414984061461")
c.Assert(HashString("ab"), qt.Equals, "7347350983217793633")
var vals []any = []any{"a", "b", tstKeyer{"c"}}
c.Assert(HashString(vals...), qt.Equals, "4438730547989914315")
c.Assert(vals[2], qt.Equals, tstKeyer{"c"})
}
type tstKeyer struct {
key string
}
func (t tstKeyer) Key() string {
return t.key
}
func (t tstKeyer) String() string {
return "key: " + t.key
}
func BenchmarkHashString(b *testing.B) {
word := " hello "
var tests []string
for i := 1; i <= 5; i++ {
sentence := strings.Repeat(word, int(math.Pow(4, float64(i))))
tests = append(tests, sentence)
}
b.ResetTimer()
for _, test := range tests {
b.Run(fmt.Sprintf("n%d", len(test)), func(b *testing.B) {
for i := 0; i < b.N; i++ {
HashString(test)
}
})
}
}
func BenchmarkHashMap(b *testing.B) {
m := map[string]any{}
for i := range 1000 {
m[fmt.Sprintf("key%d", i)] = i
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
HashString(m)
}
}

View file

@ -1,46 +0,0 @@
// Copyright 2024 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 hcontext
import "context"
// ContextDispatcher is a generic interface for setting and getting values from a context.
type ContextDispatcher[T any] interface {
Set(ctx context.Context, value T) context.Context
Get(ctx context.Context) T
}
// NewContextDispatcher creates a new ContextDispatcher with the given key.
func NewContextDispatcher[T any, R comparable](key R) ContextDispatcher[T] {
return keyInContext[T, R]{
id: key,
}
}
type keyInContext[T any, R comparable] struct {
zero T
id R
}
func (f keyInContext[T, R]) Get(ctx context.Context) T {
v := ctx.Value(f.id)
if v == nil {
return f.zero
}
return v.(T)
}
func (f keyInContext[T, R]) Set(ctx context.Context, value T) context.Context {
return context.WithValue(ctx, f.id, value)
}

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2022 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -33,7 +33,7 @@ type LineMatcher struct {
} }
// LineMatcherFn is used to match a line with an error. // LineMatcherFn is used to match a line with an error.
// It returns the column number or 0 if the line was found, but column could not be determined. Returns -1 if no line match. // It returns the column number or 0 if the line was found, but column could not be determinde. Returns -1 if no line match.
type LineMatcherFn func(m LineMatcher) int type LineMatcherFn func(m LineMatcher) int
// SimpleLineMatcher simply matches by line number. // SimpleLineMatcher simply matches by line number.
@ -74,6 +74,7 @@ func ContainsMatcher(text string) func(m LineMatcher) int {
// ErrorContext contains contextual information about an error. This will // ErrorContext contains contextual information about an error. This will
// typically be the lines surrounding some problem in a file. // typically be the lines surrounding some problem in a file.
type ErrorContext struct { type ErrorContext struct {
// If a match will contain the matched line and up to 2 lines before and after. // If a match will contain the matched line and up to 2 lines before and after.
// Will be empty if no match. // Will be empty if no match.
Lines []string Lines []string
@ -152,7 +153,10 @@ func locateError(r io.Reader, le FileError, matches LineMatcherFn) *ErrorContext
} }
if ectx.Position.LineNumber > 0 { if ectx.Position.LineNumber > 0 {
low := max(ectx.Position.LineNumber-3, 0) low := ectx.Position.LineNumber - 3
if low < 0 {
low = 0
}
if ectx.Position.LineNumber > 2 { if ectx.Position.LineNumber > 2 {
ectx.LinesPos = 2 ectx.LinesPos = 2
@ -160,7 +164,10 @@ func locateError(r io.Reader, le FileError, matches LineMatcherFn) *ErrorContext
ectx.LinesPos = ectx.Position.LineNumber - 1 ectx.LinesPos = ectx.Position.LineNumber - 1
} }
high := min(ectx.Position.LineNumber+2, len(lines)) high := ectx.Position.LineNumber + 2
if high > len(lines) {
high = len(lines)
}
ectx.Lines = lines[low:high] ectx.Lines = lines[low:high]

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2022 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2022 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -15,15 +15,14 @@
package herrors package herrors
import ( import (
"bytes"
"errors" "errors"
"fmt" "fmt"
"io" "io"
"os" "os"
"regexp"
"runtime" "runtime"
"runtime/debug" "runtime/debug"
"strings" "strconv"
"time"
) )
// PrintStackTrace prints the current stacktrace to w. // PrintStackTrace prints the current stacktrace to w.
@ -50,66 +49,21 @@ func Recover(args ...any) {
} }
} }
// IsTimeoutError returns true if the given error is or contains a TimeoutError. // GetGID the current goroutine id. Used only for debugging.
func IsTimeoutError(err error) bool { func GetGID() uint64 {
return errors.Is(err, &TimeoutError{}) b := make([]byte, 64)
} b = b[:runtime.Stack(b, false)]
b = bytes.TrimPrefix(b, []byte("goroutine "))
type TimeoutError struct { b = b[:bytes.IndexByte(b, ' ')]
Duration time.Duration n, _ := strconv.ParseUint(string(b), 10, 64)
} return n
func (e *TimeoutError) Error() string {
return fmt.Sprintf("timeout after %s", e.Duration)
}
func (e *TimeoutError) Is(target error) bool {
_, ok := target.(*TimeoutError)
return ok
}
// errMessage wraps an error with a message.
type errMessage struct {
msg string
err error
}
func (e *errMessage) Error() string {
return e.msg
}
func (e *errMessage) Unwrap() error {
return e.err
}
// IsFeatureNotAvailableError returns true if the given error is or contains a FeatureNotAvailableError.
func IsFeatureNotAvailableError(err error) bool {
return errors.Is(err, &FeatureNotAvailableError{})
} }
// ErrFeatureNotAvailable denotes that a feature is unavailable. // ErrFeatureNotAvailable denotes that a feature is unavailable.
// //
// We will, at least to begin with, make some Hugo features (SCSS with libsass) optional, // We will, at least to begin with, make some Hugo features (SCSS with libsass) optional,
// and this error is used to signal those situations. // and this error is used to signal those situations.
var ErrFeatureNotAvailable = &FeatureNotAvailableError{Cause: errors.New("this feature is not available in your current Hugo version, see https://goo.gl/YMrWcn for more information")} var ErrFeatureNotAvailable = errors.New("this feature is not available in your current Hugo version, see https://goo.gl/YMrWcn for more information")
// FeatureNotAvailableError is an error type used to signal that a feature is not available.
type FeatureNotAvailableError struct {
Cause error
}
func (e *FeatureNotAvailableError) Unwrap() error {
return e.Cause
}
func (e *FeatureNotAvailableError) Error() string {
return e.Cause.Error()
}
func (e *FeatureNotAvailableError) Is(target error) bool {
_, ok := target.(*FeatureNotAvailableError)
return ok
}
// Must panics if err != nil. // Must panics if err != nil.
func Must(err error) { func Must(err error) {
@ -132,56 +86,3 @@ func IsNotExist(err error) bool {
return false return false
} }
// IsExist returns true if the error is a file exists error.
// Unlike os.IsExist, this also considers wrapped errors.
func IsExist(err error) bool {
if os.IsExist(err) {
return true
}
// os.IsExist does not consider wrapped errors.
if os.IsExist(errors.Unwrap(err)) {
return true
}
return false
}
var nilPointerErrRe = regexp.MustCompile(`at <(.*)>: error calling (.*?): runtime error: invalid memory address or nil pointer dereference`)
const deferredPrefix = "__hdeferred/"
var deferredStringToRemove = regexp.MustCompile(`executing "__hdeferred/.*?" `)
// ImproveRenderErr improves the error message for rendering errors.
func ImproveRenderErr(inErr error) (outErr error) {
outErr = inErr
msg := improveIfNilPointerMsg(inErr)
if msg != "" {
outErr = &errMessage{msg: msg, err: outErr}
}
if strings.Contains(inErr.Error(), deferredPrefix) {
msg := deferredStringToRemove.ReplaceAllString(inErr.Error(), "executing ")
outErr = &errMessage{msg: msg, err: outErr}
}
return
}
func improveIfNilPointerMsg(inErr error) string {
m := nilPointerErrRe.FindStringSubmatch(inErr.Error())
if len(m) == 0 {
return ""
}
call := m[1]
field := m[2]
parts := strings.Split(call, ".")
if len(parts) < 2 {
return ""
}
receiverName := parts[len(parts)-2]
receiver := strings.Join(parts[:len(parts)-1], ".")
s := fmt.Sprintf(" %s is nil; wrap it in if or with: {{ with %s }}{{ .%s }}{{ end }}", receiverName, receiver, field)
return nilPointerErrRe.ReplaceAllString(inErr.Error(), s)
}

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2022 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -14,7 +14,6 @@
package herrors package herrors
import ( import (
"errors"
"fmt" "fmt"
"testing" "testing"
@ -35,11 +34,3 @@ func TestIsNotExist(t *testing.T) {
// os.IsNotExist returns false for wrapped errors. // os.IsNotExist returns false for wrapped errors.
c.Assert(IsNotExist(fmt.Errorf("foo: %w", afero.ErrFileNotFound)), qt.Equals, true) c.Assert(IsNotExist(fmt.Errorf("foo: %w", afero.ErrFileNotFound)), qt.Equals, true)
} }
func TestIsFeatureNotAvailableError(t *testing.T) {
c := qt.New(t)
c.Assert(IsFeatureNotAvailableError(ErrFeatureNotAvailable), qt.Equals, true)
c.Assert(IsFeatureNotAvailableError(&FeatureNotAvailableError{}), qt.Equals, true)
c.Assert(IsFeatureNotAvailableError(errors.New("asdf")), qt.Equals, false)
}

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2022 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -15,18 +15,19 @@ package herrors
import ( import (
"encoding/json" "encoding/json"
"errors"
"fmt" "fmt"
"io" "io"
"path/filepath" "path/filepath"
"github.com/bep/godartsass/v2" "github.com/bep/godartsass"
"github.com/bep/golibsass/libsass/libsasserrors" "github.com/bep/golibsass/libsass/libsasserrors"
"github.com/gohugoio/hugo/common/paths" "github.com/gohugoio/hugo/common/paths"
"github.com/gohugoio/hugo/common/text" "github.com/gohugoio/hugo/common/text"
"github.com/pelletier/go-toml/v2" "github.com/pelletier/go-toml/v2"
"github.com/spf13/afero" "github.com/spf13/afero"
"github.com/tdewolff/parse/v2" "github.com/tdewolff/parse/v2"
"errors"
) )
// FileError represents an error when handling a file: Parsing a config file, // FileError represents an error when handling a file: Parsing a config file,
@ -44,9 +45,6 @@ type FileError interface {
// UpdateContent updates the error with a new ErrorContext from the content of the file. // UpdateContent updates the error with a new ErrorContext from the content of the file.
UpdateContent(r io.Reader, linematcher LineMatcherFn) FileError UpdateContent(r io.Reader, linematcher LineMatcherFn) FileError
// SetFilename sets the filename of the error.
SetFilename(filename string) FileError
} }
// Unwrapper can unwrap errors created with fmt.Errorf. // Unwrapper can unwrap errors created with fmt.Errorf.
@ -59,11 +57,6 @@ var (
_ Unwrapper = (*fileError)(nil) _ Unwrapper = (*fileError)(nil)
) )
func (fe *fileError) SetFilename(filename string) FileError {
fe.position.Filename = filename
return fe
}
func (fe *fileError) UpdatePosition(pos text.Position) FileError { func (fe *fileError) UpdatePosition(pos text.Position) FileError {
oldFilename := fe.Position().Filename oldFilename := fe.Position().Filename
if pos.Filename != "" && fe.fileType == "" { if pos.Filename != "" && fe.fileType == "" {
@ -119,6 +112,7 @@ func (fe *fileError) UpdateContent(r io.Reader, linematcher LineMatcherFn) FileE
} }
return fe return fe
} }
type fileError struct { type fileError struct {
@ -182,6 +176,7 @@ func NewFileErrorFromName(err error, name string) FileError {
} }
return &fileError{cause: err, fileType: fileType, position: pos} return &fileError{cause: err, fileType: fileType, position: pos}
} }
// NewFileErrorFromPos will use the filename and line number from pos to create a new FileError, wrapping err. // NewFileErrorFromPos will use the filename and line number from pos to create a new FileError, wrapping err.
@ -192,6 +187,7 @@ func NewFileErrorFromPos(err error, pos text.Position) FileError {
_, fileType = paths.FileAndExtNoDelimiter(filepath.Clean(pos.Filename)) _, fileType = paths.FileAndExtNoDelimiter(filepath.Clean(pos.Filename))
} }
return &fileError{cause: err, fileType: fileType, position: pos} return &fileError{cause: err, fileType: fileType, position: pos}
} }
func NewFileErrorFromFileInErr(err error, fs afero.Fs, linematcher LineMatcherFn) FileError { func NewFileErrorFromFileInErr(err error, fs afero.Fs, linematcher LineMatcherFn) FileError {
@ -248,6 +244,7 @@ func openFile(filename string, fs afero.Fs) (afero.File, string, error) {
}); ok { }); ok {
realFilename = s.Filename() realFilename = s.Filename()
} }
} }
f, err2 := fs.Open(filename) f, err2 := fs.Open(filename)
@ -258,27 +255,8 @@ func openFile(filename string, fs afero.Fs) (afero.File, string, error) {
return f, realFilename, nil return f, realFilename, nil
} }
// Cause returns the underlying error, that is, // Cause returns the underlying error or itself if it does not implement Unwrap.
// it unwraps errors until it finds one that does not implement
// the Unwrap method.
// For a shallow variant, see Unwrap.
func Cause(err error) error { func Cause(err error) error {
type unwrapper interface {
Unwrap() error
}
for err != nil {
cause, ok := err.(unwrapper)
if !ok {
break
}
err = cause.Unwrap()
}
return err
}
// Unwrap returns the underlying error or itself if it does not implement Unwrap.
func Unwrap(err error) error {
if u := errors.Unwrap(err); u != nil { if u := errors.Unwrap(err); u != nil {
return u return u
} }
@ -286,7 +264,7 @@ func Unwrap(err error) error {
} }
func extractFileTypePos(err error) (string, text.Position) { func extractFileTypePos(err error) (string, text.Position) {
err = Unwrap(err) err = Cause(err)
var fileType string var fileType string
@ -314,7 +292,7 @@ func extractFileTypePos(err error) (string, text.Position) {
} }
// The error type from the minifier contains line number and column number. // The error type from the minifier contains line number and column number.
if line, col := extractLineNumberAndColumnNumber(err); line >= 0 { if line, col := exctractLineNumberAndColumnNumber(err); line >= 0 {
pos.LineNumber = line pos.LineNumber = line
pos.ColumnNumber = col pos.ColumnNumber = col
return fileType, pos return fileType, pos
@ -386,7 +364,7 @@ func extractOffsetAndType(e error) (int, string) {
} }
} }
func extractLineNumberAndColumnNumber(e error) (int, int) { func exctractLineNumberAndColumnNumber(e error) (int, int) {
switch v := e.(type) { switch v := e.(type) {
case *parse.Error: case *parse.Error:
return v.Line, v.Column return v.Line, v.Column
@ -403,7 +381,7 @@ func extractPosition(e error) (pos text.Position) {
case godartsass.SassError: case godartsass.SassError:
span := v.Span span := v.Span
start := span.Start start := span.Start
filename, _ := paths.UrlStringToFilename(span.Url) filename, _ := paths.UrlToFilename(span.Url)
pos.Filename = filename pos.Filename = filename
pos.Offset = start.Offset pos.Offset = start.Offset
pos.ColumnNumber = start.Column pos.ColumnNumber = start.Column

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2022 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -14,11 +14,12 @@
package herrors package herrors
import ( import (
"errors"
"fmt" "fmt"
"strings" "strings"
"testing" "testing"
"errors"
"github.com/gohugoio/hugo/common/text" "github.com/gohugoio/hugo/common/text"
qt "github.com/frankban/quicktest" qt "github.com/frankban/quicktest"
@ -47,6 +48,7 @@ func TestNewFileError(t *testing.T) {
c.Assert(errorContext.Lines, qt.DeepEquals, []string{"line 30", "line 31", "line 32", "line 33", "line 34"}) c.Assert(errorContext.Lines, qt.DeepEquals, []string{"line 30", "line 31", "line 32", "line 33", "line 34"})
c.Assert(errorContext.LinesPos, qt.Equals, 2) c.Assert(errorContext.LinesPos, qt.Equals, 2)
c.Assert(errorContext.ChromaLexer, qt.Equals, "go-html-template") c.Assert(errorContext.ChromaLexer, qt.Equals, "go-html-template")
} }
func TestNewFileErrorExtractFromMessage(t *testing.T) { func TestNewFileErrorExtractFromMessage(t *testing.T) {

View file

@ -19,16 +19,13 @@ import (
"errors" "errors"
"fmt" "fmt"
"io" "io"
"os"
"os/exec"
"path/filepath"
"regexp" "regexp"
"strings" "strings"
"sync"
"github.com/bep/logg" "os"
"github.com/gohugoio/hugo/common/loggers" "os/exec"
"github.com/gohugoio/hugo/common/maps"
"github.com/cli/safeexec"
"github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/config/security" "github.com/gohugoio/hugo/config/security"
) )
@ -88,7 +85,7 @@ var WithEnviron = func(env []string) func(c *commandeer) {
} }
// New creates a new Exec using the provided security config. // New creates a new Exec using the provided security config.
func New(cfg security.Config, workingDir string, log loggers.Logger) *Exec { func New(cfg security.Config) *Exec {
var baseEnviron []string var baseEnviron []string
for _, v := range os.Environ() { for _, v := range os.Environ() {
k, _ := config.SplitEnvVar(v) k, _ := config.SplitEnvVar(v)
@ -99,10 +96,7 @@ func New(cfg security.Config, workingDir string, log loggers.Logger) *Exec {
return &Exec{ return &Exec{
sc: cfg, sc: cfg,
workingDir: workingDir,
infol: log.InfoCommand("exec"),
baseEnviron: baseEnviron, baseEnviron: baseEnviron,
newNPXRunnerCache: maps.NewCache[string, func(arg ...any) (Runner, error)](),
} }
} }
@ -112,27 +106,29 @@ func IsNotFound(err error) bool {
return errors.As(err, &notFoundErr) return errors.As(err, &notFoundErr)
} }
// Exec enforces a security policy for commands run via os/exec. // SafeCommand is a wrapper around os/exec Command which uses a LookPath
// implementation that does not search in current directory before looking in PATH.
// See https://github.com/cli/safeexec and the linked issues.
func SafeCommand(name string, arg ...string) (*exec.Cmd, error) {
bin, err := safeexec.LookPath(name)
if err != nil {
return nil, err
}
return exec.Command(bin, arg...), nil
}
// Exec encorces a security policy for commands run via os/exec.
type Exec struct { type Exec struct {
sc security.Config sc security.Config
workingDir string
infol logg.LevelLogger
// os.Environ filtered by the Exec.OsEnviron whitelist filter. // os.Environ filtered by the Exec.OsEnviron whitelist filter.
baseEnviron []string baseEnviron []string
newNPXRunnerCache *maps.Cache[string, func(arg ...any) (Runner, error)]
npxInit sync.Once
npxAvailable bool
}
func (e *Exec) New(name string, arg ...any) (Runner, error) {
return e.new(name, "", arg...)
} }
// New will fail if name is not allowed according to the configured security policy. // New will fail if name is not allowed according to the configured security policy.
// Else a configured Runner will be returned ready to be Run. // Else a configured Runner will be returned ready to be Run.
func (e *Exec) new(name string, fullyQualifiedName string, arg ...any) (Runner, error) { func (e *Exec) New(name string, arg ...any) (Runner, error) {
if err := e.sc.CheckAllowedExec(name); err != nil { if err := e.sc.CheckAllowedExec(name); err != nil {
return nil, err return nil, err
} }
@ -142,111 +138,17 @@ func (e *Exec) new(name string, fullyQualifiedName string, arg ...any) (Runner,
cm := &commandeer{ cm := &commandeer{
name: name, name: name,
fullyQualifiedName: fullyQualifiedName,
env: env, env: env,
} }
return cm.command(arg...) return cm.command(arg...)
} }
type binaryLocation int // Npx is a convenience method to create a Runner running npx --no-install <name> <args.
func (b binaryLocation) String() string {
switch b {
case binaryLocationNodeModules:
return "node_modules/.bin"
case binaryLocationNpx:
return "npx"
case binaryLocationPath:
return "PATH"
}
return "unknown"
}
const (
binaryLocationNodeModules binaryLocation = iota + 1
binaryLocationNpx
binaryLocationPath
)
// Npx will in order:
// 1. Try fo find the binary in the WORKINGDIR/node_modules/.bin directory.
// 2. If not found, and npx is available, run npx --no-install <name> <args>.
// 3. Fall back to the PATH.
// If name is "tailwindcss", we will try the PATH as the second option.
func (e *Exec) Npx(name string, arg ...any) (Runner, error) { func (e *Exec) Npx(name string, arg ...any) (Runner, error) {
if err := e.sc.CheckAllowedExec(name); err != nil { arg = append(arg[:0], append([]any{"--no-install", name}, arg[0:]...)...)
return nil, err return e.New("npx", arg...)
}
newRunner, err := e.newNPXRunnerCache.GetOrCreate(name, func() (func(...any) (Runner, error), error) {
type tryFunc func() func(...any) (Runner, error)
tryFuncs := map[binaryLocation]tryFunc{
binaryLocationNodeModules: func() func(...any) (Runner, error) {
nodeBinFilename := filepath.Join(e.workingDir, nodeModulesBinPath, name)
_, err := exec.LookPath(nodeBinFilename)
if err != nil {
return nil
}
return func(arg2 ...any) (Runner, error) {
return e.new(name, nodeBinFilename, arg2...)
}
},
binaryLocationNpx: func() func(...any) (Runner, error) {
e.checkNpx()
if !e.npxAvailable {
return nil
}
return func(arg2 ...any) (Runner, error) {
return e.npx(name, arg2...)
}
},
binaryLocationPath: func() func(...any) (Runner, error) {
if _, err := exec.LookPath(name); err != nil {
return nil
}
return func(arg2 ...any) (Runner, error) {
return e.New(name, arg2...)
}
},
}
locations := []binaryLocation{binaryLocationNodeModules, binaryLocationNpx, binaryLocationPath}
if name == "tailwindcss" {
// See https://github.com/gohugoio/hugo/issues/13221#issuecomment-2574801253
locations = []binaryLocation{binaryLocationNodeModules, binaryLocationPath, binaryLocationNpx}
}
for _, loc := range locations {
if f := tryFuncs[loc](); f != nil {
e.infol.Logf("resolve %q using %s", name, loc)
return f, nil
}
}
return nil, &NotFoundError{name: name, method: fmt.Sprintf("in %s", locations[len(locations)-1])}
})
if err != nil {
return nil, err
}
return newRunner(arg...)
}
const (
npxNoInstall = "--no-install"
npxBinary = "npx"
nodeModulesBinPath = "node_modules/.bin"
)
func (e *Exec) checkNpx() {
e.npxInit.Do(func() {
e.npxAvailable = InPath(npxBinary)
})
}
// npx is a convenience method to create a Runner running npx --no-install <name> <args.
func (e *Exec) npx(name string, arg ...any) (Runner, error) {
arg = append(arg[:0], append([]any{npxNoInstall, name}, arg[0:]...)...)
return e.New(npxBinary, arg...)
} }
// Sec returns the security policies this Exec is configured with. // Sec returns the security policies this Exec is configured with.
@ -256,11 +158,10 @@ func (e *Exec) Sec() security.Config {
type NotFoundError struct { type NotFoundError struct {
name string name string
method string
} }
func (e *NotFoundError) Error() string { func (e *NotFoundError) Error() string {
return fmt.Sprintf("binary with name %q not found %s", e.name, e.method) return fmt.Sprintf("binary with name %q not found", e.name)
} }
// Runner wraps a *os.Cmd. // Runner wraps a *os.Cmd.
@ -283,14 +184,8 @@ func (c *cmdWrapper) Run() error {
if err == nil { if err == nil {
return nil return nil
} }
name := c.name
method := "in PATH"
if name == npxBinary {
name = c.c.Args[2]
method = "using npx"
}
if notFoundRe.MatchString(c.outerr.String()) { if notFoundRe.MatchString(c.outerr.String()) {
return &NotFoundError{name: name, method: method} return &NotFoundError{name: c.name}
} }
return fmt.Errorf("failed to execute binary %q with args %v: %s", c.name, c.c.Args[1:], c.outerr.String()) return fmt.Errorf("failed to execute binary %q with args %v: %s", c.name, c.c.Args[1:], c.outerr.String())
} }
@ -307,7 +202,6 @@ type commandeer struct {
ctx context.Context ctx context.Context
name string name string
fullyQualifiedName string
env []string env []string
} }
@ -328,17 +222,10 @@ func (c *commandeer) command(arg ...any) (*cmdWrapper, error) {
} }
} }
var bin string bin, err := safeexec.LookPath(c.name)
if c.fullyQualifiedName != "" {
bin = c.fullyQualifiedName
} else {
var err error
bin, err = exec.LookPath(c.name)
if err != nil { if err != nil {
return nil, &NotFoundError{ return nil, &NotFoundError{
name: c.name, name: c.name,
method: "in PATH",
}
} }
} }
@ -371,7 +258,7 @@ func InPath(binaryName string) bool {
if strings.Contains(binaryName, "/") { if strings.Contains(binaryName, "/") {
panic("binary name should not contain any slash") panic("binary name should not contain any slash")
} }
_, err := exec.LookPath(binaryName) _, err := safeexec.LookPath(binaryName)
return err == nil return err == nil
} }
@ -381,7 +268,7 @@ func LookPath(binaryName string) string {
if strings.Contains(binaryName, "/") { if strings.Contains(binaryName, "/") {
panic("binary name should not contain any slash") panic("binary name should not contain any slash")
} }
s, err := exec.LookPath(binaryName) s, err := safeexec.LookPath(binaryName)
if err != nil { if err != nil {
return "" return ""
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2019 The Hugo Authors. All rights reserved.
// Some functions in this file (see comments) is based on the Go source code, // Some functions in this file (see comments) is based on the Go source code,
// copyright The Go Authors and governed by a BSD-style license. // copyright The Go Authors and governed by a BSD-style license.
// //
@ -23,7 +23,6 @@ import (
"time" "time"
"github.com/gohugoio/hugo/common/htime" "github.com/gohugoio/hugo/common/htime"
"github.com/gohugoio/hugo/common/maps"
"github.com/gohugoio/hugo/common/types" "github.com/gohugoio/hugo/common/types"
) )
@ -74,16 +73,6 @@ func IsTruthful(in any) bool {
} }
} }
// IsMap reports whether v is a map.
func IsMap(v any) bool {
return reflect.ValueOf(v).Kind() == reflect.Map
}
// IsSlice reports whether v is a slice.
func IsSlice(v any) bool {
return reflect.ValueOf(v).Kind() == reflect.Slice
}
var zeroType = reflect.TypeOf((*types.Zeroer)(nil)).Elem() var zeroType = reflect.TypeOf((*types.Zeroer)(nil)).Elem()
// IsTruthfulValue returns whether the given value has a meaningful truth value. // IsTruthfulValue returns whether the given value has a meaningful truth value.
@ -134,7 +123,12 @@ type methodKey struct {
name string name string
} }
var methodCache sync.Map type methods struct {
sync.RWMutex
cache map[methodKey]int
}
var methodCache = &methods{cache: make(map[methodKey]int)}
// GetMethodByName is the same as reflect.Value.MethodByName, but it caches the // GetMethodByName is the same as reflect.Value.MethodByName, but it caches the
// type lookup. // type lookup.
@ -152,16 +146,22 @@ func GetMethodByName(v reflect.Value, name string) reflect.Value {
// -1 if no such method exists. // -1 if no such method exists.
func GetMethodIndexByName(tp reflect.Type, name string) int { func GetMethodIndexByName(tp reflect.Type, name string) int {
k := methodKey{tp, name} k := methodKey{tp, name}
v, found := methodCache.Load(k) methodCache.RLock()
index, found := methodCache.cache[k]
methodCache.RUnlock()
if found { if found {
return v.(int) return index
} }
methodCache.Lock()
defer methodCache.Unlock()
m, ok := tp.MethodByName(name) m, ok := tp.MethodByName(name)
index := m.Index index = m.Index
if !ok { if !ok {
index = -1 index = -1
} }
methodCache.Store(k, index) methodCache.cache[k] = index
if !ok { if !ok {
return -1 return -1
@ -188,20 +188,6 @@ func IsTime(tp reflect.Type) bool {
return false return false
} }
// IsValid returns whether v is not nil and a valid value.
func IsValid(v reflect.Value) bool {
if !v.IsValid() {
return false
}
switch v.Kind() {
case reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Ptr, reflect.Slice:
return !v.IsNil()
}
return true
}
// AsTime returns v as a time.Time if possible. // AsTime returns v as a time.Time if possible.
// The given location is only used if the value implements AsTimeProvider (e.g. go-toml local). // The given location is only used if the value implements AsTimeProvider (e.g. go-toml local).
// A zero Time and false is returned if this isn't possible. // A zero Time and false is returned if this isn't possible.
@ -222,27 +208,6 @@ func AsTime(v reflect.Value, loc *time.Location) (time.Time, bool) {
return time.Time{}, false return time.Time{}, false
} }
// ToSliceAny converts the given value to a slice of any if possible.
func ToSliceAny(v any) ([]any, bool) {
if v == nil {
return nil, false
}
switch vv := v.(type) {
case []any:
return vv, true
default:
vvv := reflect.ValueOf(v)
if vvv.Kind() == reflect.Slice {
out := make([]any, vvv.Len())
for i := range vvv.Len() {
out[i] = vvv.Index(i).Interface()
}
return out, true
}
}
return nil, false
}
func CallMethodByName(cxt context.Context, name string, v reflect.Value) []reflect.Value { func CallMethodByName(cxt context.Context, name string, v reflect.Value) []reflect.Value {
fn := v.MethodByName(name) fn := v.MethodByName(name)
var args []reflect.Value var args []reflect.Value
@ -252,7 +217,7 @@ func CallMethodByName(cxt context.Context, name string, v reflect.Value) []refle
panic("not supported") panic("not supported")
} }
first := tp.In(0) first := tp.In(0)
if IsContextType(first) { if first.Implements(ContextInterface) {
args = append(args, reflect.ValueOf(cxt)) args = append(args, reflect.ValueOf(cxt))
} }
} }
@ -271,25 +236,4 @@ func indirectInterface(v reflect.Value) reflect.Value {
return v.Elem() return v.Elem()
} }
var contextInterface = reflect.TypeOf((*context.Context)(nil)).Elem() var ContextInterface = reflect.TypeOf((*context.Context)(nil)).Elem()
var isContextCache = maps.NewCache[reflect.Type, bool]()
type k string
var contextTypeValue = reflect.TypeOf(context.WithValue(context.Background(), k("key"), 32))
// IsContextType returns whether tp is a context.Context type.
func IsContextType(tp reflect.Type) bool {
if tp == contextTypeValue {
return true
}
if tp == contextInterface {
return true
}
isContext, _ := isContextCache.GetOrCreate(tp, func() (bool, error) {
return tp.Implements(contextInterface), nil
})
return isContext
}

View file

@ -14,7 +14,6 @@
package hreflect package hreflect
import ( import (
"context"
"reflect" "reflect"
"testing" "testing"
"time" "time"
@ -41,55 +40,6 @@ func TestGetMethodByName(t *testing.T) {
c.Assert(GetMethodIndexByName(tp, "Foo"), qt.Equals, -1) c.Assert(GetMethodIndexByName(tp, "Foo"), qt.Equals, -1)
} }
func TestIsContextType(t *testing.T) {
c := qt.New(t)
type k string
ctx := context.Background()
valueCtx := context.WithValue(ctx, k("key"), 32)
c.Assert(IsContextType(reflect.TypeOf(ctx)), qt.IsTrue)
c.Assert(IsContextType(reflect.TypeOf(valueCtx)), qt.IsTrue)
}
func TestToSliceAny(t *testing.T) {
c := qt.New(t)
checkOK := func(in any, expected []any) {
out, ok := ToSliceAny(in)
c.Assert(ok, qt.Equals, true)
c.Assert(out, qt.DeepEquals, expected)
}
checkOK([]any{1, 2, 3}, []any{1, 2, 3})
checkOK([]int{1, 2, 3}, []any{1, 2, 3})
}
func BenchmarkIsContextType(b *testing.B) {
type k string
b.Run("value", func(b *testing.B) {
ctx := context.Background()
ctxs := make([]reflect.Type, b.N)
for i := 0; i < b.N; i++ {
ctxs[i] = reflect.TypeOf(context.WithValue(ctx, k("key"), i))
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
if !IsContextType(ctxs[i]) {
b.Fatal("not context")
}
}
})
b.Run("background", func(b *testing.B) {
var ctxt reflect.Type = reflect.TypeOf(context.Background())
for i := 0; i < b.N; i++ {
if !IsContextType(ctxt) {
b.Fatal("not context")
}
}
})
}
func BenchmarkIsTruthFul(b *testing.B) { func BenchmarkIsTruthFul(b *testing.B) {
v := reflect.ValueOf("Hugo") v := reflect.ValueOf("Hugo")
@ -134,17 +84,3 @@ func BenchmarkGetMethodByName(b *testing.B) {
} }
} }
} }
func BenchmarkGetMethodByNamePara(b *testing.B) {
v := reflect.ValueOf(&testStruct{})
methods := []string{"Method1", "Method2", "Method3", "Method4", "Method5"}
b.ResetTimer()
b.RunParallel(func(pb *testing.PB) {
for pb.Next() {
for _, method := range methods {
_ = GetMethodByName(v, method)
}
}
})
}

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -15,10 +15,7 @@ package hstrings
import ( import (
"fmt" "fmt"
"regexp"
"slices"
"strings" "strings"
"sync"
"github.com/gohugoio/hugo/compare" "github.com/gohugoio/hugo/compare"
) )
@ -51,84 +48,10 @@ func (s StringEqualFold) Eq(s2 any) bool {
// EqualAny returns whether a string is equal to any of the given strings. // EqualAny returns whether a string is equal to any of the given strings.
func EqualAny(a string, b ...string) bool { func EqualAny(a string, b ...string) bool {
return slices.Contains(b, a) for _, s := range b {
} if a == s {
// regexpCache represents a cache of regexp objects protected by a mutex.
type regexpCache struct {
mu sync.RWMutex
re map[string]*regexp.Regexp
}
func (rc *regexpCache) getOrCompileRegexp(pattern string) (re *regexp.Regexp, err error) {
var ok bool
if re, ok = rc.get(pattern); !ok {
re, err = regexp.Compile(pattern)
if err != nil {
return nil, err
}
rc.set(pattern, re)
}
return re, nil
}
func (rc *regexpCache) get(key string) (re *regexp.Regexp, ok bool) {
rc.mu.RLock()
re, ok = rc.re[key]
rc.mu.RUnlock()
return
}
func (rc *regexpCache) set(key string, re *regexp.Regexp) {
rc.mu.Lock()
rc.re[key] = re
rc.mu.Unlock()
}
var reCache = regexpCache{re: make(map[string]*regexp.Regexp)}
// GetOrCompileRegexp retrieves a regexp object from the cache based upon the pattern.
// If the pattern is not found in the cache, the pattern is compiled and added to
// the cache.
func GetOrCompileRegexp(pattern string) (re *regexp.Regexp, err error) {
return reCache.getOrCompileRegexp(pattern)
}
// InSlice checks if a string is an element of a slice of strings
// and returns a boolean value.
func InSlice(arr []string, el string) bool {
return slices.Contains(arr, el)
}
// InSlicEqualFold checks if a string is an element of a slice of strings
// and returns a boolean value.
// It uses strings.EqualFold to compare.
func InSlicEqualFold(arr []string, el string) bool {
for _, v := range arr {
if strings.EqualFold(v, el) {
return true return true
} }
} }
return false return false
} }
// ToString converts the given value to a string.
// Note that this is a more strict version compared to cast.ToString,
// as it will not try to convert numeric values to strings,
// but only accept strings or fmt.Stringer.
func ToString(v any) (string, bool) {
switch vv := v.(type) {
case string:
return vv, true
case fmt.Stringer:
return vv.String(), true
}
return "", false
}
type (
Strings2 [2]string
Strings3 [3]string
)

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2023 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -14,7 +14,6 @@
package hstrings package hstrings
import ( import (
"regexp"
"testing" "testing"
qt "github.com/frankban/quicktest" qt "github.com/frankban/quicktest"
@ -33,24 +32,5 @@ func TestStringEqualFold(t *testing.T) {
c.Assert(StringEqualFold(s1).EqualFold("b"), qt.Equals, false) c.Assert(StringEqualFold(s1).EqualFold("b"), qt.Equals, false)
c.Assert(StringEqualFold(s1).Eq(s2), qt.Equals, true) c.Assert(StringEqualFold(s1).Eq(s2), qt.Equals, true)
c.Assert(StringEqualFold(s1).Eq("b"), qt.Equals, false) c.Assert(StringEqualFold(s1).Eq("b"), qt.Equals, false)
}
func TestGetOrCompileRegexp(t *testing.T) {
c := qt.New(t)
re, err := GetOrCompileRegexp(`\d+`)
c.Assert(err, qt.IsNil)
c.Assert(re.MatchString("123"), qt.Equals, true)
}
func BenchmarkGetOrCompileRegexp(b *testing.B) {
for i := 0; i < b.N; i++ {
GetOrCompileRegexp(`\d+`)
}
}
func BenchmarkCompileRegexp(b *testing.B) {
for i := 0; i < b.N; i++ {
regexp.MustCompile(`\d+`)
}
} }

View file

@ -1,78 +0,0 @@
// Copyright 2024 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 htime_test
import (
"testing"
"github.com/gohugoio/hugo/hugolib"
)
// Issue #11267
func TestApplyWithContext(t *testing.T) {
t.Parallel()
files := `
-- config.toml --
defaultContentLanguage = 'it'
-- layouts/index.html --
{{ $dates := slice
"2022-01-03"
"2022-02-01"
"2022-03-02"
"2022-04-07"
"2022-05-06"
"2022-06-04"
"2022-07-03"
"2022-08-01"
"2022-09-06"
"2022-10-05"
"2022-11-03"
"2022-12-02"
}}
{{ range $dates }}
{{ . | time.Format "month: _January_ weekday: _Monday_" }}
{{ . | time.Format "month: _Jan_ weekday: _Mon_" }}
{{ end }}
`
b := hugolib.Test(t, files)
b.AssertFileContent("public/index.html", `
month: _gennaio_ weekday: _lunedì_
month: _gen_ weekday: _lun_
month: _febbraio_ weekday: _martedì_
month: _feb_ weekday: _mar_
month: _marzo_ weekday: _mercoledì_
month: _mar_ weekday: _mer_
month: _aprile_ weekday: _giovedì_
month: _apr_ weekday: _gio_
month: _maggio_ weekday: _venerdì_
month: _mag_ weekday: _ven_
month: _giugno_ weekday: _sabato_
month: _giu_ weekday: _sab_
month: _luglio_ weekday: _domenica_
month: _lug_ weekday: _dom_
month: _agosto_ weekday: _lunedì_
month: _ago_ weekday: _lun_
month: _settembre_ weekday: _martedì_
month: _set_ weekday: _mar_
month: _ottobre_ weekday: _mercoledì_
month: _ott_ weekday: _mer_
month: _novembre_ weekday: _giovedì_
month: _nov_ weekday: _gio_
month: _dicembre_ weekday: _venerdì_
month: _dic_ weekday: _ven_
`)
}

View file

@ -18,7 +18,7 @@ import (
"strings" "strings"
"time" "time"
"github.com/bep/clocks" "github.com/bep/clock"
"github.com/spf13/cast" "github.com/spf13/cast"
"github.com/gohugoio/locales" "github.com/gohugoio/locales"
@ -75,7 +75,7 @@ var (
"December", "December",
} }
Clock = clocks.System() Clock = clock.System()
) )
func NewTimeFormatter(ltr locales.Translator) TimeFormatter { func NewTimeFormatter(ltr locales.Translator) TimeFormatter {
@ -124,15 +124,12 @@ func (f TimeFormatter) Format(t time.Time, layout string) string {
monthIdx := t.Month() - 1 // Month() starts at 1. monthIdx := t.Month() - 1 // Month() starts at 1.
dayIdx := t.Weekday() dayIdx := t.Weekday()
if strings.Contains(layout, "January") {
s = strings.ReplaceAll(s, longMonthNames[monthIdx], f.ltr.MonthWide(t.Month())) s = strings.ReplaceAll(s, longMonthNames[monthIdx], f.ltr.MonthWide(t.Month()))
} else if strings.Contains(layout, "Jan") { if !strings.Contains(s, f.ltr.MonthWide(t.Month())) {
s = strings.ReplaceAll(s, shortMonthNames[monthIdx], f.ltr.MonthAbbreviated(t.Month())) s = strings.ReplaceAll(s, shortMonthNames[monthIdx], f.ltr.MonthAbbreviated(t.Month()))
} }
if strings.Contains(layout, "Monday") {
s = strings.ReplaceAll(s, longDayNames[dayIdx], f.ltr.WeekdayWide(t.Weekday())) s = strings.ReplaceAll(s, longDayNames[dayIdx], f.ltr.WeekdayWide(t.Weekday()))
} else if strings.Contains(layout, "Mon") { if !strings.Contains(s, f.ltr.WeekdayWide(t.Weekday())) {
s = strings.ReplaceAll(s, shortDayNames[dayIdx], f.ltr.WeekdayAbbreviated(t.Weekday())) s = strings.ReplaceAll(s, shortDayNames[dayIdx], f.ltr.WeekdayAbbreviated(t.Weekday()))
} }

View file

@ -53,6 +53,7 @@ func TestTimeFormatter(t *testing.T) {
c.Assert(f.Format(june06, ":time_long"), qt.Equals, "02:09:37 UTC") c.Assert(f.Format(june06, ":time_long"), qt.Equals, "02:09:37 UTC")
c.Assert(f.Format(june06, ":time_medium"), qt.Equals, "02:09:37") c.Assert(f.Format(june06, ":time_medium"), qt.Equals, "02:09:37")
c.Assert(f.Format(june06, ":time_short"), qt.Equals, "02:09") c.Assert(f.Format(june06, ":time_short"), qt.Equals, "02:09")
}) })
c.Run("Custom layouts English", func(c *qt.C) { c.Run("Custom layouts English", func(c *qt.C) {
@ -67,6 +68,7 @@ func TestTimeFormatter(t *testing.T) {
c.Assert(f.Format(june06, ":time_long"), qt.Equals, "2:09:37 am UTC") c.Assert(f.Format(june06, ":time_long"), qt.Equals, "2:09:37 am UTC")
c.Assert(f.Format(june06, ":time_medium"), qt.Equals, "2:09:37 am") c.Assert(f.Format(june06, ":time_medium"), qt.Equals, "2:09:37 am")
c.Assert(f.Format(june06, ":time_short"), qt.Equals, "2:09 am") c.Assert(f.Format(june06, ":time_short"), qt.Equals, "2:09 am")
}) })
c.Run("English", func(c *qt.C) { c.Run("English", func(c *qt.C) {
@ -105,7 +107,9 @@ func TestTimeFormatter(t *testing.T) {
c.Assert(tr.MonthWide(date.Month()), qt.Equals, monthWideNorway) c.Assert(tr.MonthWide(date.Month()), qt.Equals, monthWideNorway)
c.Assert(f.Format(date, "January"), qt.Equals, monthWideNorway) c.Assert(f.Format(date, "January"), qt.Equals, monthWideNorway)
} }
}) })
} }
func BenchmarkTimeFormatter(b *testing.B) { func BenchmarkTimeFormatter(b *testing.B) {

View file

@ -16,7 +16,6 @@ package hugio
import ( import (
"fmt" "fmt"
"io" "io"
iofs "io/fs"
"path/filepath" "path/filepath"
"github.com/spf13/afero" "github.com/spf13/afero"
@ -61,16 +60,12 @@ func CopyDir(fs afero.Fs, from, to string, shouldCopy func(filename string) bool
return fmt.Errorf("%q is not a directory", from) return fmt.Errorf("%q is not a directory", from)
} }
err = fs.MkdirAll(to, 0o777) // before umask err = fs.MkdirAll(to, 0777) // before umask
if err != nil { if err != nil {
return err return err
} }
d, err := fs.Open(from) entries, _ := afero.ReadDir(fs, from)
if err != nil {
return err
}
entries, _ := d.(iofs.ReadDirFile).ReadDir(-1)
for _, entry := range entries { for _, entry := range entries {
fromFilename := filepath.Join(from, entry.Name()) fromFilename := filepath.Join(from, entry.Name())
toFilename := filepath.Join(to, entry.Name()) toFilename := filepath.Join(to, entry.Name())

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2022 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -17,35 +17,24 @@ import (
"bytes" "bytes"
) )
// HasBytesWriter is a writer will match against a slice of patterns. // HasBytesWriter is a writer that will set Match to true if the given pattern
// is found in the stream.
type HasBytesWriter struct { type HasBytesWriter struct {
Patterns []*HasBytesPattern Match bool
Pattern []byte
i int i int
done bool done bool
buff []byte buff []byte
} }
type HasBytesPattern struct {
Match bool
Pattern []byte
}
func (h *HasBytesWriter) patternLen() int {
l := 0
for _, p := range h.Patterns {
l += len(p.Pattern)
}
return l
}
func (h *HasBytesWriter) Write(p []byte) (n int, err error) { func (h *HasBytesWriter) Write(p []byte) (n int, err error) {
if h.done { if h.done {
return len(p), nil return len(p), nil
} }
if len(h.buff) == 0 { if len(h.buff) == 0 {
h.buff = make([]byte, h.patternLen()*2) h.buff = make([]byte, len(h.Pattern)*2)
} }
for i := range p { for i := range p {
@ -57,24 +46,12 @@ func (h *HasBytesWriter) Write(p []byte) (n int, err error) {
h.i = len(h.buff) / 2 h.i = len(h.buff) / 2
} }
for _, pp := range h.Patterns { if bytes.Contains(h.buff, h.Pattern) {
if bytes.Contains(h.buff, pp.Pattern) { h.Match = true
pp.Match = true
done := true
for _, ppp := range h.Patterns {
if !ppp.Match {
done = false
break
}
}
if done {
h.done = true h.done = true
}
return len(p), nil return len(p), nil
} }
} }
}
return len(p), nil return len(p), nil
} }

View file

@ -1,4 +1,4 @@
// Copyright 2024 The Hugo Authors. All rights reserved. // Copyright 2022 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -34,11 +34,8 @@ func TestHasBytesWriter(t *testing.T) {
var b bytes.Buffer var b bytes.Buffer
h := &HasBytesWriter{ h := &HasBytesWriter{
Patterns: []*HasBytesPattern{ Pattern: []byte("__foo"),
{Pattern: []byte("__foo")},
},
} }
return h, io.MultiWriter(&b, h) return h, io.MultiWriter(&b, h)
} }
@ -46,22 +43,22 @@ func TestHasBytesWriter(t *testing.T) {
return strings.Repeat("ab cfo", r.Intn(33)) return strings.Repeat("ab cfo", r.Intn(33))
} }
for range 22 { for i := 0; i < 22; i++ {
h, w := neww() h, w := neww()
fmt.Fprint(w, rndStr()+"abc __foobar"+rndStr()) fmt.Fprintf(w, rndStr()+"abc __foobar"+rndStr())
c.Assert(h.Patterns[0].Match, qt.Equals, true) c.Assert(h.Match, qt.Equals, true)
h, w = neww() h, w = neww()
fmt.Fprint(w, rndStr()+"abc __f") fmt.Fprintf(w, rndStr()+"abc __f")
fmt.Fprint(w, "oo bar"+rndStr()) fmt.Fprintf(w, "oo bar"+rndStr())
c.Assert(h.Patterns[0].Match, qt.Equals, true) c.Assert(h.Match, qt.Equals, true)
h, w = neww() h, w = neww()
fmt.Fprint(w, rndStr()+"abc __moo bar") fmt.Fprintf(w, rndStr()+"abc __moo bar")
c.Assert(h.Patterns[0].Match, qt.Equals, false) c.Assert(h.Match, qt.Equals, false)
} }
h, w := neww() h, w := neww()
fmt.Fprintf(w, "__foo") fmt.Fprintf(w, "__foo")
c.Assert(h.Patterns[0].Match, qt.Equals, true) c.Assert(h.Match, qt.Equals, true)
} }

View file

@ -14,7 +14,6 @@
package hugio package hugio
import ( import (
"bytes"
"io" "io"
"strings" "strings"
) )
@ -37,70 +36,24 @@ type ReadSeekCloserProvider interface {
ReadSeekCloser() (ReadSeekCloser, error) ReadSeekCloser() (ReadSeekCloser, error)
} }
// readSeekerNopCloser implements ReadSeekCloser by doing nothing in Close. // ReadSeekerNoOpCloser implements ReadSeekCloser by doing nothing in Close.
type readSeekerNopCloser struct { // TODO(bep) rename this and similar to ReadSeekerNopCloser, naming used in stdlib, which kind of makes sense.
type ReadSeekerNoOpCloser struct {
ReadSeeker ReadSeeker
} }
// Close does nothing. // Close does nothing.
func (r readSeekerNopCloser) Close() error { func (r ReadSeekerNoOpCloser) Close() error {
return nil return nil
} }
// NewReadSeekerNoOpCloser creates a new ReadSeekerNoOpCloser with the given ReadSeeker. // NewReadSeekerNoOpCloser creates a new ReadSeekerNoOpCloser with the given ReadSeeker.
func NewReadSeekerNoOpCloser(r ReadSeeker) ReadSeekCloser { func NewReadSeekerNoOpCloser(r ReadSeeker) ReadSeekerNoOpCloser {
return readSeekerNopCloser{r} return ReadSeekerNoOpCloser{r}
} }
// NewReadSeekerNoOpCloserFromString uses strings.NewReader to create a new ReadSeekerNoOpCloser // NewReadSeekerNoOpCloserFromString uses strings.NewReader to create a new ReadSeekerNoOpCloser
// from the given string. // from the given string.
func NewReadSeekerNoOpCloserFromString(content string) ReadSeekCloser { func NewReadSeekerNoOpCloserFromString(content string) ReadSeekerNoOpCloser {
return stringReadSeeker{s: content, readSeekerNopCloser: readSeekerNopCloser{strings.NewReader(content)}} return ReadSeekerNoOpCloser{strings.NewReader(content)}
}
var _ StringReader = (*stringReadSeeker)(nil)
type stringReadSeeker struct {
s string
readSeekerNopCloser
}
func (s *stringReadSeeker) ReadString() string {
return s.s
}
// StringReader provides a way to read a string.
type StringReader interface {
ReadString() string
}
// NewReadSeekerNoOpCloserFromBytes uses bytes.NewReader to create a new ReadSeekerNoOpCloser
// from the given bytes slice.
func NewReadSeekerNoOpCloserFromBytes(content []byte) readSeekerNopCloser {
return readSeekerNopCloser{bytes.NewReader(content)}
}
// NewOpenReadSeekCloser creates a new ReadSeekCloser from the given ReadSeeker.
// The ReadSeeker will be seeked to the beginning before returned.
func NewOpenReadSeekCloser(r ReadSeekCloser) OpenReadSeekCloser {
return func() (ReadSeekCloser, error) {
r.Seek(0, io.SeekStart)
return r, nil
}
}
// OpenReadSeekCloser allows setting some other way (than reading from a filesystem)
// to open or create a ReadSeekCloser.
type OpenReadSeekCloser func() (ReadSeekCloser, error)
// ReadString reads from the given reader and returns the content as a string.
func ReadString(r io.Reader) (string, error) {
if sr, ok := r.(StringReader); ok {
return sr.ReadString(), nil
}
b, err := io.ReadAll(r)
if err != nil {
return "", err
}
return string(b), nil
} }

View file

@ -81,33 +81,3 @@ func ToReadCloser(r io.Reader) io.ReadCloser {
io.NopCloser(nil), io.NopCloser(nil),
} }
} }
type ReadWriteCloser interface {
io.Reader
io.Writer
io.Closer
}
// PipeReadWriteCloser is a convenience type to create a pipe with a ReadCloser and a WriteCloser.
type PipeReadWriteCloser struct {
*io.PipeReader
*io.PipeWriter
}
// NewPipeReadWriteCloser creates a new PipeReadWriteCloser.
func NewPipeReadWriteCloser() PipeReadWriteCloser {
pr, pw := io.Pipe()
return PipeReadWriteCloser{pr, pw}
}
func (c PipeReadWriteCloser) Close() (err error) {
if err = c.PipeReader.Close(); err != nil {
return
}
err = c.PipeWriter.Close()
return
}
func (c PipeReadWriteCloser) WriteString(s string) (int, error) {
return c.PipeWriter.Write([]byte(s))
}

View file

@ -14,7 +14,6 @@
package hugo package hugo
import ( import (
"context"
"fmt" "fmt"
"html/template" "html/template"
"os" "os"
@ -25,19 +24,12 @@ import (
"sync" "sync"
"time" "time"
"github.com/bep/logg" "github.com/bep/godartsass"
"github.com/bep/godartsass/v2"
"github.com/gohugoio/hugo/common/hcontext"
"github.com/gohugoio/hugo/common/hexec" "github.com/gohugoio/hugo/common/hexec"
"github.com/gohugoio/hugo/common/loggers"
"github.com/gohugoio/hugo/common/maps"
"github.com/gohugoio/hugo/hugofs/files" "github.com/gohugoio/hugo/hugofs/files"
"github.com/spf13/afero" "github.com/spf13/afero"
iofs "io/fs"
"github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/hugofs" "github.com/gohugoio/hugo/hugofs"
) )
@ -54,8 +46,6 @@ var (
vendorInfo string vendorInfo string
) )
var _ maps.StoreProvider = (*HugoInfo)(nil)
// HugoInfo contains information about the current Hugo environment // HugoInfo contains information about the current Hugo environment
type HugoInfo struct { type HugoInfo struct {
CommitHash string CommitHash string
@ -72,11 +62,6 @@ type HugoInfo struct {
conf ConfigProvider conf ConfigProvider
deps []*Dependency deps []*Dependency
store *maps.Scratch
// Context gives access to some of the context scoped variables.
Context Context
} }
// Version returns the current version as a comparable version string. // Version returns the current version as a comparable version string.
@ -89,22 +74,10 @@ func (i HugoInfo) Generator() template.HTML {
return template.HTML(fmt.Sprintf(`<meta name="generator" content="Hugo %s">`, CurrentVersion.String())) return template.HTML(fmt.Sprintf(`<meta name="generator" content="Hugo %s">`, CurrentVersion.String()))
} }
// IsDevelopment reports whether the current running environment is "development".
func (i HugoInfo) IsDevelopment() bool {
return i.Environment == EnvironmentDevelopment
}
// IsProduction reports whether the current running environment is "production".
func (i HugoInfo) IsProduction() bool { func (i HugoInfo) IsProduction() bool {
return i.Environment == EnvironmentProduction return i.Environment == EnvironmentProduction
} }
// IsServer reports whether the built-in server is running.
func (i HugoInfo) IsServer() bool {
return i.conf.Running()
}
// IsExtended reports whether the Hugo binary is the extended version.
func (i HugoInfo) IsExtended() bool { func (i HugoInfo) IsExtended() bool {
return IsExtended return IsExtended
} }
@ -119,57 +92,10 @@ func (i HugoInfo) Deps() []*Dependency {
return i.deps return i.deps
} }
func (i HugoInfo) Store() *maps.Scratch {
return i.store
}
// Deprecated: Use hugo.IsMultihost instead.
func (i HugoInfo) IsMultiHost() bool {
Deprecate("hugo.IsMultiHost", "Use hugo.IsMultihost instead.", "v0.124.0")
return i.conf.IsMultihost()
}
// IsMultihost reports whether each configured language has a unique baseURL.
func (i HugoInfo) IsMultihost() bool {
return i.conf.IsMultihost()
}
// IsMultilingual reports whether there are two or more configured languages.
func (i HugoInfo) IsMultilingual() bool {
return i.conf.IsMultilingual()
}
type contextKey uint8
const (
contextKeyMarkupScope contextKey = iota
)
var markupScope = hcontext.NewContextDispatcher[string](contextKeyMarkupScope)
type Context struct{}
func (c Context) MarkupScope(ctx context.Context) string {
return GetMarkupScope(ctx)
}
// SetMarkupScope sets the markup scope in the context.
func SetMarkupScope(ctx context.Context, s string) context.Context {
return markupScope.Set(ctx, s)
}
// GetMarkupScope gets the markup scope from the context.
func GetMarkupScope(ctx context.Context) string {
return markupScope.Get(ctx)
}
// ConfigProvider represents the config options that are relevant for HugoInfo. // ConfigProvider represents the config options that are relevant for HugoInfo.
type ConfigProvider interface { type ConfigProvider interface {
Environment() string Environment() string
Running() bool
WorkingDir() string WorkingDir() string
IsMultihost() bool
IsMultilingual() bool
} }
// NewInfo creates a new Hugo Info object. // NewInfo creates a new Hugo Info object.
@ -196,7 +122,6 @@ func NewInfo(conf ConfigProvider, deps []*Dependency) HugoInfo {
Environment: conf.Environment(), Environment: conf.Environment(),
conf: conf, conf: conf,
deps: deps, deps: deps,
store: maps.NewScratch(),
GoVersion: goVersion, GoVersion: goVersion,
} }
} }
@ -216,12 +141,7 @@ func GetExecEnviron(workDir string, cfg config.AllProvider, fs afero.Fs) []strin
config.SetEnvVars(&env, "HUGO_PUBLISHDIR", filepath.Join(workDir, cfg.BaseConfig().PublishDir)) config.SetEnvVars(&env, "HUGO_PUBLISHDIR", filepath.Join(workDir, cfg.BaseConfig().PublishDir))
if fs != nil { if fs != nil {
var fis []iofs.DirEntry fis, err := afero.ReadDir(fs, files.FolderJSConfig)
d, err := fs.Open(files.FolderJSConfig)
if err == nil {
fis, err = d.(iofs.ReadDirFile).ReadDir(-1)
}
if err == nil { if err == nil {
for _, fi := range fis { for _, fi := range fis {
key := fmt.Sprintf("HUGO_FILE_%s", strings.ReplaceAll(strings.ToUpper(fi.Name()), ".", "_")) key := fmt.Sprintf("HUGO_FILE_%s", strings.ReplaceAll(strings.ToUpper(fi.Name()), ".", "_"))
@ -246,10 +166,8 @@ type buildInfo struct {
*debug.BuildInfo *debug.BuildInfo
} }
var ( var bInfo *buildInfo
bInfo *buildInfo var bInfoInit sync.Once
bInfoInit sync.Once
)
func getBuildInfo() *buildInfo { func getBuildInfo() *buildInfo {
bInfoInit.Do(func() { bInfoInit.Do(func() {
@ -276,6 +194,7 @@ func getBuildInfo() *buildInfo {
bInfo.GoArch = s.Value bInfo.GoArch = s.Value
} }
} }
}) })
return bInfo return bInfo
@ -313,16 +232,13 @@ func GetDependencyListNonGo() []string {
if IsExtended { if IsExtended {
deps = append( deps = append(
deps, deps,
formatDep("github.com/sass/libsass", "3.6.6"), formatDep("github.com/sass/libsass", "3.6.5"),
formatDep("github.com/webmproject/libwebp", "v1.3.2"), formatDep("github.com/webmproject/libwebp", "v1.2.4"),
) )
} }
if dartSass := dartSassVersion(); dartSass.ProtocolVersion != "" { if dartSass := dartSassVersion(); dartSass.ProtocolVersion != "" {
dartSassPath := "github.com/sass/dart-sass-embedded" const dartSassPath = "github.com/sass/dart-sass-embedded"
if IsDartSassGeV2() {
dartSassPath = "github.com/sass/dart-sass"
}
deps = append(deps, deps = append(deps,
formatDep(dartSassPath+"/protocol", dartSass.ProtocolVersion), formatDep(dartSassPath+"/protocol", dartSass.ProtocolVersion),
formatDep(dartSassPath+"/compiler", dartSass.CompilerVersion), formatDep(dartSassPath+"/compiler", dartSass.CompilerVersion),
@ -367,101 +283,11 @@ type Dependency struct {
} }
func dartSassVersion() godartsass.DartSassVersion { func dartSassVersion() godartsass.DartSassVersion {
if DartSassBinaryName == "" || !IsDartSassGeV2() { // This is also duplicated in the dartsass package.
const dartSassEmbeddedBinaryName = "dart-sass-embedded"
if !hexec.InPath(dartSassEmbeddedBinaryName) {
return godartsass.DartSassVersion{} return godartsass.DartSassVersion{}
} }
v, _ := godartsass.Version(DartSassBinaryName) v, _ := godartsass.Version(dartSassEmbeddedBinaryName)
return v return v
} }
// DartSassBinaryName is the name of the Dart Sass binary to use.
// TODO(bep) find a better place for this.
var DartSassBinaryName string
func init() {
DartSassBinaryName = os.Getenv("DART_SASS_BINARY")
if DartSassBinaryName == "" {
for _, name := range dartSassBinaryNamesV2 {
if hexec.InPath(name) {
DartSassBinaryName = name
break
}
}
if DartSassBinaryName == "" {
if hexec.InPath(dartSassBinaryNameV1) {
DartSassBinaryName = dartSassBinaryNameV1
}
}
}
}
var (
dartSassBinaryNameV1 = "dart-sass-embedded"
dartSassBinaryNamesV2 = []string{"dart-sass", "sass"}
)
// TODO(bep) we eventually want to remove this, but keep it for a while to throw an informative error.
// We stopped supporting the old binary in Hugo 0.139.0.
func IsDartSassGeV2() bool {
// dart-sass-embedded was the first version of the embedded Dart Sass before it was moved into the main project.
return !strings.Contains(DartSassBinaryName, "embedded")
}
// Deprecate informs about a deprecation starting at the given version.
//
// A deprecation typically needs a simple change in the template, but doing so will make the template incompatible with older versions.
// Theme maintainers generally want
// 1. No warnings or errors in the console when building a Hugo site.
// 2. Their theme to work for at least the last few Hugo versions.
func Deprecate(item, alternative string, version string) {
level := deprecationLogLevelFromVersion(version)
deprecateLevel(item, alternative, version, level)
}
// See Deprecate for details.
func DeprecateWithLogger(item, alternative string, version string, log logg.Logger) {
level := deprecationLogLevelFromVersion(version)
deprecateLevelWithLogger(item, alternative, version, level, log)
}
// DeprecateLevelMin informs about a deprecation starting at the given version, but with a minimum log level.
func DeprecateLevelMin(item, alternative string, version string, minLevel logg.Level) {
level := max(deprecationLogLevelFromVersion(version), minLevel)
deprecateLevel(item, alternative, version, level)
}
// deprecateLevel informs about a deprecation logging at the given level.
func deprecateLevel(item, alternative, version string, level logg.Level) {
deprecateLevelWithLogger(item, alternative, version, level, loggers.Log().Logger())
}
// DeprecateLevel informs about a deprecation logging at the given level.
func deprecateLevelWithLogger(item, alternative, version string, level logg.Level, log logg.Logger) {
var msg string
if level == logg.LevelError {
msg = fmt.Sprintf("%s was deprecated in Hugo %s and subsequently removed. %s", item, version, alternative)
} else {
msg = fmt.Sprintf("%s was deprecated in Hugo %s and will be removed in a future release. %s", item, version, alternative)
}
log.WithLevel(level).WithField(loggers.FieldNameCmd, "deprecated").Logf("%s", msg)
}
// We usually do about one minor version a month.
// We want people to run at least the current and previous version without any warnings.
// We want people who don't update Hugo that often to see the warnings and errors before we remove the feature.
func deprecationLogLevelFromVersion(ver string) logg.Level {
from := MustParseVersion(ver)
to := CurrentVersion
minorDiff := to.Minor - from.Minor
switch {
case minorDiff >= 15:
// Start failing the build after about 15 months.
return logg.LevelError
case minorDiff >= 3:
// Start printing warnings after about 3 months.
return logg.LevelWarn
default:
return logg.LevelInfo
}
}

View file

@ -1,77 +0,0 @@
// Copyright 2024 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 hugo_test
import (
"strings"
"testing"
"github.com/gohugoio/hugo/hugolib"
)
func TestIsMultilingualAndIsMultihost(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
disableKinds = ['page','rss','section','sitemap','taxonomy','term']
defaultContentLanguageInSubdir = true
[languages.de]
baseURL = 'https://de.example.org/'
[languages.en]
baseURL = 'https://en.example.org/'
-- content/_index.md --
---
title: home
---
-- layouts/index.html --
multilingual={{ hugo.IsMultilingual }}
multihost={{ hugo.IsMultihost }}
`
b := hugolib.Test(t, files)
b.AssertFileContent("public/de/index.html",
"multilingual=true",
"multihost=true",
)
b.AssertFileContent("public/en/index.html",
"multilingual=true",
"multihost=true",
)
files = strings.ReplaceAll(files, "baseURL = 'https://de.example.org/'", "")
files = strings.ReplaceAll(files, "baseURL = 'https://en.example.org/'", "")
b = hugolib.Test(t, files)
b.AssertFileContent("public/de/index.html",
"multilingual=true",
"multihost=false",
)
b.AssertFileContent("public/en/index.html",
"multilingual=true",
"multihost=false",
)
files = strings.ReplaceAll(files, "[languages.de]", "")
files = strings.ReplaceAll(files, "[languages.en]", "")
b = hugolib.Test(t, files)
b.AssertFileContent("public/en/index.html",
"multilingual=false",
"multihost=false",
)
}

View file

@ -14,18 +14,16 @@
package hugo package hugo
import ( import (
"context"
"fmt" "fmt"
"testing" "testing"
"github.com/bep/logg"
qt "github.com/frankban/quicktest" qt "github.com/frankban/quicktest"
) )
func TestHugoInfo(t *testing.T) { func TestHugoInfo(t *testing.T) {
c := qt.New(t) c := qt.New(t)
conf := testConfig{environment: "production", workingDir: "/mywork", running: false} conf := testConfig{environment: "production", workingDir: "/mywork"}
hugoInfo := NewInfo(conf, nil) hugoInfo := NewInfo(conf, nil)
c.Assert(hugoInfo.Version(), qt.Equals, CurrentVersion.Version()) c.Assert(hugoInfo.Version(), qt.Equals, CurrentVersion.Version())
@ -40,72 +38,22 @@ func TestHugoInfo(t *testing.T) {
} }
c.Assert(hugoInfo.Environment, qt.Equals, "production") c.Assert(hugoInfo.Environment, qt.Equals, "production")
c.Assert(string(hugoInfo.Generator()), qt.Contains, fmt.Sprintf("Hugo %s", hugoInfo.Version())) c.Assert(string(hugoInfo.Generator()), qt.Contains, fmt.Sprintf("Hugo %s", hugoInfo.Version()))
c.Assert(hugoInfo.IsDevelopment(), qt.Equals, false)
c.Assert(hugoInfo.IsProduction(), qt.Equals, true) c.Assert(hugoInfo.IsProduction(), qt.Equals, true)
c.Assert(hugoInfo.IsExtended(), qt.Equals, IsExtended) c.Assert(hugoInfo.IsExtended(), qt.Equals, IsExtended)
c.Assert(hugoInfo.IsServer(), qt.Equals, false)
devHugoInfo := NewInfo(testConfig{environment: "development", running: true}, nil) devHugoInfo := NewInfo(testConfig{environment: "development"}, nil)
c.Assert(devHugoInfo.IsDevelopment(), qt.Equals, true)
c.Assert(devHugoInfo.IsProduction(), qt.Equals, false) c.Assert(devHugoInfo.IsProduction(), qt.Equals, false)
c.Assert(devHugoInfo.IsServer(), qt.Equals, true)
}
func TestDeprecationLogLevelFromVersion(t *testing.T) {
c := qt.New(t)
c.Assert(deprecationLogLevelFromVersion("0.55.0"), qt.Equals, logg.LevelError)
ver := CurrentVersion
c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelInfo)
ver.Minor -= 3
c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelWarn)
ver.Minor -= 4
c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelWarn)
ver.Minor -= 13
c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelError)
// Added just to find the threshold for where we can remove deprecated items.
// Subtract 5 from the minor version of the first ERRORed version => 0.122.0.
c.Assert(deprecationLogLevelFromVersion("0.127.0"), qt.Equals, logg.LevelError)
}
func TestMarkupScope(t *testing.T) {
c := qt.New(t)
conf := testConfig{environment: "production", workingDir: "/mywork", running: false}
info := NewInfo(conf, nil)
ctx := context.Background()
ctx = SetMarkupScope(ctx, "foo")
c.Assert(info.Context.MarkupScope(ctx), qt.Equals, "foo")
} }
type testConfig struct { type testConfig struct {
environment string environment string
running bool
workingDir string workingDir string
multihost bool
multilingual bool
} }
func (c testConfig) Environment() string { func (c testConfig) Environment() string {
return c.environment return c.environment
} }
func (c testConfig) Running() bool {
return c.running
}
func (c testConfig) WorkingDir() string { func (c testConfig) WorkingDir() string {
return c.workingDir return c.workingDir
} }
func (c testConfig) IsMultihost() bool {
return c.multihost
}
func (c testConfig) IsMultilingual() bool {
return c.multilingual
}

View file

@ -12,6 +12,7 @@
// limitations under the License. // limitations under the License.
//go:build extended //go:build extended
// +build extended
package hugo package hugo

View file

@ -12,6 +12,7 @@
// limitations under the License. // limitations under the License.
//go:build !extended //go:build !extended
// +build !extended
package hugo package hugo

View file

@ -1,18 +0,0 @@
// Copyright 2024 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.
//go:build withdeploy
package hugo
var IsWithdeploy = true

View file

@ -1,18 +0,0 @@
// Copyright 2024 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.
//go:build !withdeploy
package hugo
var IsWithdeploy = false

View file

@ -67,11 +67,8 @@ func (h VersionString) String() string {
// Compare implements the compare.Comparer interface. // Compare implements the compare.Comparer interface.
func (h VersionString) Compare(other any) int { func (h VersionString) Compare(other any) int {
return compareVersions(h.Version(), other) v := MustParseVersion(h.String())
} return compareVersions(v, other)
func (h VersionString) Version() Version {
return MustParseVersion(h.String())
} }
// Eq implements the compare.Eqer interface. // Eq implements the compare.Eqer interface.
@ -152,9 +149,6 @@ func BuildVersionString() string {
if IsExtended { if IsExtended {
version += "+extended" version += "+extended"
} }
if IsWithdeploy {
version += "+withdeploy"
}
osArch := bi.GoOS + "/" + bi.GoArch osArch := bi.GoOS + "/" + bi.GoArch
@ -270,6 +264,7 @@ func compareFloatWithVersion(v1 float64, v2 Version) int {
if v1maj > v2.Major { if v1maj > v2.Major {
return 1 return 1
} }
if v1maj < v2.Major { if v1maj < v2.Major {
@ -281,6 +276,7 @@ func compareFloatWithVersion(v1 float64, v2 Version) int {
} }
return -1 return -1
} }
func GoMinorVersion() int { func GoMinorVersion() int {

View file

@ -17,7 +17,7 @@ package hugo
// This should be the only one. // This should be the only one.
var CurrentVersion = Version{ var CurrentVersion = Version{
Major: 0, Major: 0,
Minor: 148, Minor: 112,
PatchLevel: 0, PatchLevel: 3,
Suffix: "-DEV", Suffix: "",
} }

View file

@ -1,106 +0,0 @@
// Copyright 2024 The Hugo Authors. All rights reserved.
// Some functions in this file (see comments) is based on the Go source code,
// copyright The Go Authors and governed by a BSD-style license.
//
// 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 loggers contains some basic logging setup.
package loggers
import (
"fmt"
"io"
"strings"
"sync"
"github.com/bep/logg"
"github.com/fatih/color"
)
// levelColor mapping.
var levelColor = [...]*color.Color{
logg.LevelTrace: color.New(color.FgWhite),
logg.LevelDebug: color.New(color.FgWhite),
logg.LevelInfo: color.New(color.FgBlue),
logg.LevelWarn: color.New(color.FgYellow),
logg.LevelError: color.New(color.FgRed),
}
// levelString mapping.
var levelString = [...]string{
logg.LevelTrace: "TRACE",
logg.LevelDebug: "DEBUG",
logg.LevelInfo: "INFO ",
logg.LevelWarn: "WARN ",
logg.LevelError: "ERROR",
}
// newDefaultHandler handler.
func newDefaultHandler(outWriter, errWriter io.Writer) logg.Handler {
return &defaultHandler{
outWriter: outWriter,
errWriter: errWriter,
Padding: 0,
}
}
// Default Handler implementation.
// Based on https://github.com/apex/log/blob/master/handlers/cli/cli.go
type defaultHandler struct {
mu sync.Mutex
outWriter io.Writer // Defaults to os.Stdout.
errWriter io.Writer // Defaults to os.Stderr.
Padding int
}
// HandleLog implements logg.Handler.
func (h *defaultHandler) HandleLog(e *logg.Entry) error {
color := levelColor[e.Level]
level := levelString[e.Level]
h.mu.Lock()
defer h.mu.Unlock()
var w io.Writer
if e.Level > logg.LevelInfo {
w = h.errWriter
} else {
w = h.outWriter
}
var prefix string
for _, field := range e.Fields {
if field.Name == FieldNameCmd {
prefix = fmt.Sprint(field.Value)
break
}
}
if prefix != "" {
prefix = prefix + ": "
}
color.Fprintf(w, "%s %s%s", fmt.Sprintf("%*s", h.Padding+1, level), color.Sprint(prefix), e.Message)
for _, field := range e.Fields {
if strings.HasPrefix(field.Name, reservedFieldNamePrefix) {
continue
}
fmt.Fprintf(w, " %s %v", color.Sprint(field.Name), field.Value)
}
fmt.Fprintln(w)
return nil
}

View file

@ -1,145 +0,0 @@
// Copyright 2024 The Hugo Authors. All rights reserved.
// Some functions in this file (see comments) is based on the Go source code,
// copyright The Go Authors and governed by a BSD-style license.
//
// 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 loggers
import (
"fmt"
"strings"
"sync"
"github.com/bep/logg"
"github.com/gohugoio/hugo/common/hashing"
)
// PanicOnWarningHook panics on warnings.
var PanicOnWarningHook = func(e *logg.Entry) error {
if e.Level != logg.LevelWarn {
return nil
}
panic(e.Message)
}
func newLogLevelCounter() *logLevelCounter {
return &logLevelCounter{
counters: make(map[logg.Level]int),
}
}
func newLogOnceHandler(threshold logg.Level) *logOnceHandler {
return &logOnceHandler{
threshold: threshold,
seen: make(map[uint64]bool),
}
}
func newStopHandler(h ...logg.Handler) *stopHandler {
return &stopHandler{
handlers: h,
}
}
func newSuppressStatementsHandler(statements map[string]bool) *suppressStatementsHandler {
return &suppressStatementsHandler{
statements: statements,
}
}
type logLevelCounter struct {
mu sync.RWMutex
counters map[logg.Level]int
}
func (h *logLevelCounter) HandleLog(e *logg.Entry) error {
h.mu.Lock()
defer h.mu.Unlock()
h.counters[e.Level]++
return nil
}
var errStop = fmt.Errorf("stop")
type logOnceHandler struct {
threshold logg.Level
mu sync.Mutex
seen map[uint64]bool
}
func (h *logOnceHandler) HandleLog(e *logg.Entry) error {
if e.Level < h.threshold {
// We typically only want to enable this for warnings and above.
// The common use case is that many go routines may log the same error.
return nil
}
h.mu.Lock()
defer h.mu.Unlock()
hash := hashing.HashUint64(e.Level, e.Message, e.Fields)
if h.seen[hash] {
return errStop
}
h.seen[hash] = true
return nil
}
func (h *logOnceHandler) reset() {
h.mu.Lock()
defer h.mu.Unlock()
h.seen = make(map[uint64]bool)
}
type stopHandler struct {
handlers []logg.Handler
}
// HandleLog implements logg.Handler.
func (h *stopHandler) HandleLog(e *logg.Entry) error {
for _, handler := range h.handlers {
if err := handler.HandleLog(e); err != nil {
if err == errStop {
return nil
}
return err
}
}
return nil
}
type suppressStatementsHandler struct {
statements map[string]bool
}
func (h *suppressStatementsHandler) HandleLog(e *logg.Entry) error {
for _, field := range e.Fields {
if field.Name == FieldNameStatementID {
if h.statements[field.Value.(string)] {
return errStop
}
}
}
return nil
}
// whiteSpaceTrimmer creates a new log handler that trims whitespace from log messages and string fields.
func whiteSpaceTrimmer() logg.Handler {
return logg.HandlerFunc(func(e *logg.Entry) error {
e.Message = strings.TrimSpace(e.Message)
for i, field := range e.Fields {
if s, ok := field.Value.(string); ok {
e.Fields[i].Value = strings.TrimSpace(s)
}
}
return nil
})
}

View file

@ -1,100 +0,0 @@
// Copyright 2024 The Hugo Authors. All rights reserved.
// Some functions in this file (see comments) is based on the Go source code,
// copyright The Go Authors and governed by a BSD-style license.
//
// 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 loggers
import (
"fmt"
"io"
"regexp"
"strings"
"sync"
"github.com/bep/logg"
)
// newNoAnsiEscapeHandler creates a new noAnsiEscapeHandler
func newNoAnsiEscapeHandler(outWriter, errWriter io.Writer, noLevelPrefix bool, predicate func(*logg.Entry) bool) *noAnsiEscapeHandler {
if predicate == nil {
predicate = func(e *logg.Entry) bool { return true }
}
return &noAnsiEscapeHandler{
noLevelPrefix: noLevelPrefix,
outWriter: outWriter,
errWriter: errWriter,
predicate: predicate,
}
}
type noAnsiEscapeHandler struct {
mu sync.Mutex
outWriter io.Writer
errWriter io.Writer
predicate func(*logg.Entry) bool
noLevelPrefix bool
}
func (h *noAnsiEscapeHandler) HandleLog(e *logg.Entry) error {
if !h.predicate(e) {
return nil
}
h.mu.Lock()
defer h.mu.Unlock()
var w io.Writer
if e.Level > logg.LevelInfo {
w = h.errWriter
} else {
w = h.outWriter
}
var prefix string
for _, field := range e.Fields {
if field.Name == FieldNameCmd {
prefix = fmt.Sprint(field.Value)
break
}
}
if prefix != "" {
prefix = prefix + ": "
}
msg := stripANSI(e.Message)
if h.noLevelPrefix {
fmt.Fprintf(w, "%s%s", prefix, msg)
} else {
fmt.Fprintf(w, "%s %s%s", levelString[e.Level], prefix, msg)
}
for _, field := range e.Fields {
if strings.HasPrefix(field.Name, reservedFieldNamePrefix) {
continue
}
fmt.Fprintf(w, " %s %v", field.Name, field.Value)
}
fmt.Fprintln(w)
return nil
}
var ansiRe = regexp.MustCompile(`\x1b\[[0-9;]*m`)
// stripANSI removes ANSI escape codes from s.
func stripANSI(s string) string {
return ansiRe.ReplaceAllString(s, "")
}

View file

@ -1,40 +0,0 @@
// Copyright 2024 The Hugo Authors. All rights reserved.
// Some functions in this file (see comments) is based on the Go source code,
// copyright The Go Authors and governed by a BSD-style license.
//
// 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 loggers
import (
"bytes"
"testing"
"github.com/bep/logg"
qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/common/terminal"
)
func TestNoAnsiEscapeHandler(t *testing.T) {
c := qt.New(t)
test := func(s string) {
c.Assert(stripANSI(terminal.Notice(s)), qt.Equals, s)
}
test(`error in "file.md:1:2"`)
var buf bytes.Buffer
h := newNoAnsiEscapeHandler(&buf, &buf, false, nil)
h.HandleLog(&logg.Entry{Message: terminal.Notice(`error in "file.md:1:2"`), Level: logg.LevelInfo})
c.Assert(buf.String(), qt.Equals, "INFO error in \"file.md:1:2\"\n")
}

View file

@ -0,0 +1,63 @@
// Copyright 2020 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 loggers
import (
"fmt"
)
// IgnorableLogger is a logger that ignores certain log statements.
type IgnorableLogger interface {
Logger
Errorsf(statementID, format string, v ...any)
Apply(logger Logger) IgnorableLogger
}
type ignorableLogger struct {
Logger
statements map[string]bool
}
// NewIgnorableLogger wraps the given logger and ignores the log statement IDs given.
func NewIgnorableLogger(logger Logger, statements map[string]bool) IgnorableLogger {
if statements == nil {
statements = make(map[string]bool)
}
return ignorableLogger{
Logger: logger,
statements: statements,
}
}
// Errorsf logs statementID as an ERROR if not configured as ignoreable.
func (l ignorableLogger) Errorsf(statementID, format string, v ...any) {
if l.statements[statementID] {
// Ignore.
return
}
ignoreMsg := fmt.Sprintf(`
If you feel that this should not be logged as an ERROR, you can ignore it by adding this to your site config:
ignoreErrors = [%q]`, statementID)
format += ignoreMsg
l.Errorf(format, v...)
}
func (l ignorableLogger) Apply(logger Logger) IgnorableLogger {
return ignorableLogger{
Logger: logger,
statements: l.statements,
}
}

View file

@ -1,385 +0,0 @@
// Copyright 2024 The Hugo Authors. All rights reserved.
// Some functions in this file (see comments) is based on the Go source code,
// copyright The Go Authors and governed by a BSD-style license.
//
// 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 loggers
import (
"fmt"
"io"
"os"
"strings"
"time"
"github.com/bep/logg"
"github.com/bep/logg/handlers/multi"
"github.com/gohugoio/hugo/common/terminal"
)
var (
reservedFieldNamePrefix = "__h_field_"
// FieldNameCmd is the name of the field that holds the command name.
FieldNameCmd = reservedFieldNamePrefix + "_cmd"
// Used to suppress statements.
FieldNameStatementID = reservedFieldNamePrefix + "__h_field_statement_id"
)
// Options defines options for the logger.
type Options struct {
Level logg.Level
StdOut io.Writer
StdErr io.Writer
DistinctLevel logg.Level
StoreErrors bool
HandlerPost func(e *logg.Entry) error
SuppressStatements map[string]bool
}
// New creates a new logger with the given options.
func New(opts Options) Logger {
if opts.StdOut == nil {
opts.StdOut = os.Stdout
}
if opts.StdErr == nil {
opts.StdErr = os.Stderr
}
if opts.Level == 0 {
opts.Level = logg.LevelWarn
}
var logHandler logg.Handler
if terminal.PrintANSIColors(os.Stderr) {
logHandler = newDefaultHandler(opts.StdErr, opts.StdErr)
} else {
logHandler = newNoAnsiEscapeHandler(opts.StdErr, opts.StdErr, false, nil)
}
errorsw := &strings.Builder{}
logCounters := newLogLevelCounter()
handlers := []logg.Handler{
logCounters,
}
if opts.Level == logg.LevelTrace {
// Trace is used during development only, and it's useful to
// only see the trace messages.
handlers = append(handlers,
logg.HandlerFunc(func(e *logg.Entry) error {
if e.Level != logg.LevelTrace {
return logg.ErrStopLogEntry
}
return nil
}),
)
}
handlers = append(handlers, whiteSpaceTrimmer(), logHandler)
if opts.HandlerPost != nil {
var hookHandler logg.HandlerFunc = func(e *logg.Entry) error {
opts.HandlerPost(e)
return nil
}
handlers = append(handlers, hookHandler)
}
if opts.StoreErrors {
h := newNoAnsiEscapeHandler(io.Discard, errorsw, true, func(e *logg.Entry) bool {
return e.Level >= logg.LevelError
})
handlers = append(handlers, h)
}
logHandler = multi.New(handlers...)
var logOnce *logOnceHandler
if opts.DistinctLevel != 0 {
logOnce = newLogOnceHandler(opts.DistinctLevel)
logHandler = newStopHandler(logOnce, logHandler)
}
if len(opts.SuppressStatements) > 0 {
logHandler = newStopHandler(newSuppressStatementsHandler(opts.SuppressStatements), logHandler)
}
logger := logg.New(
logg.Options{
Level: opts.Level,
Handler: logHandler,
},
)
l := logger.WithLevel(opts.Level)
reset := func() {
logCounters.mu.Lock()
defer logCounters.mu.Unlock()
logCounters.counters = make(map[logg.Level]int)
errorsw.Reset()
if logOnce != nil {
logOnce.reset()
}
}
return &logAdapter{
logCounters: logCounters,
errors: errorsw,
reset: reset,
stdOut: opts.StdOut,
stdErr: opts.StdErr,
level: opts.Level,
logger: logger,
tracel: l.WithLevel(logg.LevelTrace),
debugl: l.WithLevel(logg.LevelDebug),
infol: l.WithLevel(logg.LevelInfo),
warnl: l.WithLevel(logg.LevelWarn),
errorl: l.WithLevel(logg.LevelError),
}
}
// NewDefault creates a new logger with the default options.
func NewDefault() Logger {
opts := Options{
DistinctLevel: logg.LevelWarn,
Level: logg.LevelWarn,
}
return New(opts)
}
func NewTrace() Logger {
opts := Options{
DistinctLevel: logg.LevelWarn,
Level: logg.LevelTrace,
}
return New(opts)
}
func LevelLoggerToWriter(l logg.LevelLogger) io.Writer {
return logWriter{l: l}
}
type Logger interface {
Debug() logg.LevelLogger
Debugf(format string, v ...any)
Debugln(v ...any)
Error() logg.LevelLogger
Errorf(format string, v ...any)
Erroridf(id, format string, v ...any)
Errorln(v ...any)
Errors() string
Info() logg.LevelLogger
InfoCommand(command string) logg.LevelLogger
Infof(format string, v ...any)
Infoln(v ...any)
Level() logg.Level
LoggCount(logg.Level) int
Logger() logg.Logger
StdOut() io.Writer
StdErr() io.Writer
Printf(format string, v ...any)
Println(v ...any)
PrintTimerIfDelayed(start time.Time, name string)
Reset()
Warn() logg.LevelLogger
WarnCommand(command string) logg.LevelLogger
Warnf(format string, v ...any)
Warnidf(id, format string, v ...any)
Warnln(v ...any)
Deprecatef(fail bool, format string, v ...any)
Trace(s logg.StringFunc)
}
type logAdapter struct {
logCounters *logLevelCounter
errors *strings.Builder
reset func()
stdOut io.Writer
stdErr io.Writer
level logg.Level
logger logg.Logger
tracel logg.LevelLogger
debugl logg.LevelLogger
infol logg.LevelLogger
warnl logg.LevelLogger
errorl logg.LevelLogger
}
func (l *logAdapter) Debug() logg.LevelLogger {
return l.debugl
}
func (l *logAdapter) Debugf(format string, v ...any) {
l.debugl.Logf(format, v...)
}
func (l *logAdapter) Debugln(v ...any) {
l.debugl.Logf(l.sprint(v...))
}
func (l *logAdapter) Info() logg.LevelLogger {
return l.infol
}
func (l *logAdapter) InfoCommand(command string) logg.LevelLogger {
return l.infol.WithField(FieldNameCmd, command)
}
func (l *logAdapter) Infof(format string, v ...any) {
l.infol.Logf(format, v...)
}
func (l *logAdapter) Infoln(v ...any) {
l.infol.Logf(l.sprint(v...))
}
func (l *logAdapter) Level() logg.Level {
return l.level
}
func (l *logAdapter) LoggCount(level logg.Level) int {
l.logCounters.mu.RLock()
defer l.logCounters.mu.RUnlock()
return l.logCounters.counters[level]
}
func (l *logAdapter) Logger() logg.Logger {
return l.logger
}
func (l *logAdapter) StdOut() io.Writer {
return l.stdOut
}
func (l *logAdapter) StdErr() io.Writer {
return l.stdErr
}
// PrintTimerIfDelayed prints a time statement to the FEEDBACK logger
// if considerable time is spent.
func (l *logAdapter) PrintTimerIfDelayed(start time.Time, name string) {
elapsed := time.Since(start)
milli := int(1000 * elapsed.Seconds())
if milli < 500 {
return
}
fmt.Fprintf(l.stdErr, "%s in %v ms", name, milli)
}
func (l *logAdapter) Printf(format string, v ...any) {
// Add trailing newline if not present.
if !strings.HasSuffix(format, "\n") {
format += "\n"
}
fmt.Fprintf(l.stdOut, format, v...)
}
func (l *logAdapter) Println(v ...any) {
fmt.Fprintln(l.stdOut, v...)
}
func (l *logAdapter) Reset() {
l.reset()
}
func (l *logAdapter) Warn() logg.LevelLogger {
return l.warnl
}
func (l *logAdapter) Warnf(format string, v ...any) {
l.warnl.Logf(format, v...)
}
func (l *logAdapter) WarnCommand(command string) logg.LevelLogger {
return l.warnl.WithField(FieldNameCmd, command)
}
func (l *logAdapter) Warnln(v ...any) {
l.warnl.Logf(l.sprint(v...))
}
func (l *logAdapter) Error() logg.LevelLogger {
return l.errorl
}
func (l *logAdapter) Errorf(format string, v ...any) {
l.errorl.Logf(format, v...)
}
func (l *logAdapter) Errorln(v ...any) {
l.errorl.Logf(l.sprint(v...))
}
func (l *logAdapter) Errors() string {
return l.errors.String()
}
func (l *logAdapter) Erroridf(id, format string, v ...any) {
id = strings.ToLower(id)
format += l.idfInfoStatement("error", id, format)
l.errorl.WithField(FieldNameStatementID, id).Logf(format, v...)
}
func (l *logAdapter) Warnidf(id, format string, v ...any) {
id = strings.ToLower(id)
format += l.idfInfoStatement("warning", id, format)
l.warnl.WithField(FieldNameStatementID, id).Logf(format, v...)
}
func (l *logAdapter) idfInfoStatement(what, id, format string) string {
return fmt.Sprintf("\nYou can suppress this %s by adding the following to your site configuration:\nignoreLogs = ['%s']", what, id)
}
func (l *logAdapter) Trace(s logg.StringFunc) {
l.tracel.Log(s)
}
func (l *logAdapter) sprint(v ...any) string {
return strings.TrimRight(fmt.Sprintln(v...), "\n")
}
func (l *logAdapter) Deprecatef(fail bool, format string, v ...any) {
format = "DEPRECATED: " + format
if fail {
l.errorl.Logf(format, v...)
} else {
l.warnl.Logf(format, v...)
}
}
type logWriter struct {
l logg.LevelLogger
}
func (w logWriter) Write(p []byte) (n int, err error) {
w.l.Log(logg.String(string(p)))
return len(p), nil
}
func TimeTrackf(l logg.LevelLogger, start time.Time, fields logg.Fields, format string, a ...any) {
elapsed := time.Since(start)
if fields != nil {
l = l.WithFields(fields)
}
l.WithField("duration", elapsed).Logf(format, a...)
}
func TimeTrackfn(fn func() (logg.LevelLogger, error)) error {
start := time.Now()
l, err := fn()
elapsed := time.Since(start)
l.WithField("duration", elapsed).Logf("")
return err
}

View file

@ -1,154 +0,0 @@
// Copyright 2024 The Hugo Authors. All rights reserved.
// Some functions in this file (see comments) is based on the Go source code,
// copyright The Go Authors and governed by a BSD-style license.
//
// 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 loggers_test
import (
"io"
"strings"
"testing"
"github.com/bep/logg"
qt "github.com/frankban/quicktest"
"github.com/gohugoio/hugo/common/loggers"
)
func TestLogDistinct(t *testing.T) {
c := qt.New(t)
opts := loggers.Options{
DistinctLevel: logg.LevelWarn,
StoreErrors: true,
StdOut: io.Discard,
StdErr: io.Discard,
}
l := loggers.New(opts)
for range 10 {
l.Errorln("error 1")
l.Errorln("error 2")
l.Warnln("warn 1")
}
c.Assert(strings.Count(l.Errors(), "error 1"), qt.Equals, 1)
c.Assert(l.LoggCount(logg.LevelError), qt.Equals, 2)
c.Assert(l.LoggCount(logg.LevelWarn), qt.Equals, 1)
}
func TestHookLast(t *testing.T) {
c := qt.New(t)
opts := loggers.Options{
HandlerPost: func(e *logg.Entry) error {
panic(e.Message)
},
StdOut: io.Discard,
StdErr: io.Discard,
}
l := loggers.New(opts)
c.Assert(func() { l.Warnln("warn 1") }, qt.PanicMatches, "warn 1")
}
func TestOptionStoreErrors(t *testing.T) {
c := qt.New(t)
var sb strings.Builder
opts := loggers.Options{
StoreErrors: true,
StdErr: &sb,
StdOut: &sb,
}
l := loggers.New(opts)
l.Errorln("error 1")
l.Errorln("error 2")
errorsStr := l.Errors()
c.Assert(errorsStr, qt.Contains, "error 1")
c.Assert(errorsStr, qt.Not(qt.Contains), "ERROR")
c.Assert(sb.String(), qt.Contains, "error 1")
c.Assert(sb.String(), qt.Contains, "ERROR")
}
func TestLogCount(t *testing.T) {
c := qt.New(t)
opts := loggers.Options{
StoreErrors: true,
}
l := loggers.New(opts)
l.Errorln("error 1")
l.Errorln("error 2")
l.Warnln("warn 1")
c.Assert(l.LoggCount(logg.LevelError), qt.Equals, 2)
c.Assert(l.LoggCount(logg.LevelWarn), qt.Equals, 1)
c.Assert(l.LoggCount(logg.LevelInfo), qt.Equals, 0)
}
func TestSuppressStatements(t *testing.T) {
c := qt.New(t)
opts := loggers.Options{
StoreErrors: true,
SuppressStatements: map[string]bool{
"error-1": true,
},
}
l := loggers.New(opts)
l.Error().WithField(loggers.FieldNameStatementID, "error-1").Logf("error 1")
l.Errorln("error 2")
errorsStr := l.Errors()
c.Assert(errorsStr, qt.Not(qt.Contains), "error 1")
c.Assert(errorsStr, qt.Contains, "error 2")
c.Assert(l.LoggCount(logg.LevelError), qt.Equals, 1)
}
func TestReset(t *testing.T) {
c := qt.New(t)
opts := loggers.Options{
StoreErrors: true,
DistinctLevel: logg.LevelWarn,
StdOut: io.Discard,
StdErr: io.Discard,
}
l := loggers.New(opts)
for range 3 {
l.Errorln("error 1")
l.Errorln("error 2")
l.Errorln("error 1")
c.Assert(l.LoggCount(logg.LevelError), qt.Equals, 2)
l.Reset()
errorsStr := l.Errors()
c.Assert(errorsStr, qt.Equals, "")
c.Assert(l.LoggCount(logg.LevelError), qt.Equals, 0)
}
}

View file

@ -1,62 +0,0 @@
// Copyright 2024 The Hugo Authors. All rights reserved.
// Some functions in this file (see comments) is based on the Go source code,
// copyright The Go Authors and governed by a BSD-style license.
//
// 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 loggers
import (
"sync"
"github.com/bep/logg"
)
// SetGlobalLogger sets the global logger.
// This is used in a few places in Hugo, e.g. deprecated functions.
func SetGlobalLogger(logger Logger) {
logMu.Lock()
defer logMu.Unlock()
log = logger
}
func initGlobalLogger(level logg.Level, panicOnWarnings bool) {
logMu.Lock()
defer logMu.Unlock()
var logHookLast func(e *logg.Entry) error
if panicOnWarnings {
logHookLast = PanicOnWarningHook
}
log = New(
Options{
Level: level,
DistinctLevel: logg.LevelInfo,
HandlerPost: logHookLast,
},
)
}
var logMu sync.Mutex
func Log() Logger {
logMu.Lock()
defer logMu.Unlock()
return log
}
// The global logger.
var log Logger
func init() {
initGlobalLogger(logg.LevelWarn, false)
}

355
common/loggers/loggers.go Normal file
View file

@ -0,0 +1,355 @@
// Copyright 2020 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 loggers
import (
"bytes"
"fmt"
"io"
"log"
"os"
"regexp"
"runtime"
"sync/atomic"
"time"
"github.com/gohugoio/hugo/common/terminal"
jww "github.com/spf13/jwalterweatherman"
)
var (
// Counts ERROR logs to the global jww logger.
GlobalErrorCounter *jww.Counter
PanicOnWarning atomic.Bool
)
func init() {
GlobalErrorCounter = &jww.Counter{}
jww.SetLogListeners(jww.LogCounter(GlobalErrorCounter, jww.LevelError))
}
func LoggerToWriterWithPrefix(logger *log.Logger, prefix string) io.Writer {
return prefixWriter{
logger: logger,
prefix: prefix,
}
}
type prefixWriter struct {
logger *log.Logger
prefix string
}
func (w prefixWriter) Write(p []byte) (n int, err error) {
w.logger.Printf("%s: %s", w.prefix, p)
return len(p), nil
}
type Logger interface {
Printf(format string, v ...any)
Println(v ...any)
PrintTimerIfDelayed(start time.Time, name string)
Debug() *log.Logger
Debugf(format string, v ...any)
Debugln(v ...any)
Info() *log.Logger
Infof(format string, v ...any)
Infoln(v ...any)
Warn() *log.Logger
Warnf(format string, v ...any)
Warnln(v ...any)
Error() *log.Logger
Errorf(format string, v ...any)
Errorln(v ...any)
Errors() string
Out() io.Writer
Reset()
// Used in tests.
LogCounters() *LogCounters
}
type LogCounters struct {
ErrorCounter *jww.Counter
WarnCounter *jww.Counter
}
type logger struct {
*jww.Notepad
// The writer that represents stdout.
// Will be io.Discard when in quiet mode.
out io.Writer
logCounters *LogCounters
// This is only set in server mode.
errors *bytes.Buffer
}
func (l *logger) Printf(format string, v ...any) {
l.FEEDBACK.Printf(format, v...)
}
func (l *logger) Println(v ...any) {
l.FEEDBACK.Println(v...)
}
func (l *logger) Debug() *log.Logger {
return l.DEBUG
}
func (l *logger) Debugf(format string, v ...any) {
l.DEBUG.Printf(format, v...)
}
func (l *logger) Debugln(v ...any) {
l.DEBUG.Println(v...)
}
func (l *logger) Infof(format string, v ...any) {
l.INFO.Printf(format, v...)
}
func (l *logger) Infoln(v ...any) {
l.INFO.Println(v...)
}
func (l *logger) Info() *log.Logger {
return l.INFO
}
const panicOnWarningMessage = "Warning trapped. Remove the --panicOnWarning flag to continue."
func (l *logger) Warnf(format string, v ...any) {
l.WARN.Printf(format, v...)
if PanicOnWarning.Load() {
panic(panicOnWarningMessage)
}
}
func (l *logger) Warnln(v ...any) {
l.WARN.Println(v...)
if PanicOnWarning.Load() {
panic(panicOnWarningMessage)
}
}
func (l *logger) Warn() *log.Logger {
return l.WARN
}
func (l *logger) Errorf(format string, v ...any) {
l.ERROR.Printf(format, v...)
}
func (l *logger) Errorln(v ...any) {
l.ERROR.Println(v...)
}
func (l *logger) Error() *log.Logger {
return l.ERROR
}
func (l *logger) LogCounters() *LogCounters {
return l.logCounters
}
func (l *logger) Out() io.Writer {
return l.out
}
// PrintTimerIfDelayed prints a time statement to the FEEDBACK logger
// if considerable time is spent.
func (l *logger) PrintTimerIfDelayed(start time.Time, name string) {
elapsed := time.Since(start)
milli := int(1000 * elapsed.Seconds())
if milli < 500 {
return
}
l.Printf("%s in %v ms", name, milli)
}
func (l *logger) PrintTimer(start time.Time, name string) {
elapsed := time.Since(start)
milli := int(1000 * elapsed.Seconds())
l.Printf("%s in %v ms", name, milli)
}
func (l *logger) Errors() string {
if l.errors == nil {
return ""
}
return ansiColorRe.ReplaceAllString(l.errors.String(), "")
}
// Reset resets the logger's internal state.
func (l *logger) Reset() {
l.logCounters.ErrorCounter.Reset()
if l.errors != nil {
l.errors.Reset()
}
}
// NewLogger creates a new Logger for the given thresholds
func NewLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, logHandle io.Writer, saveErrors bool) Logger {
return newLogger(stdoutThreshold, logThreshold, outHandle, logHandle, saveErrors)
}
// NewDebugLogger is a convenience function to create a debug logger.
func NewDebugLogger() Logger {
return NewBasicLogger(jww.LevelDebug)
}
// NewWarningLogger is a convenience function to create a warning logger.
func NewWarningLogger() Logger {
return NewBasicLogger(jww.LevelWarn)
}
// NewInfoLogger is a convenience function to create a info logger.
func NewInfoLogger() Logger {
return NewBasicLogger(jww.LevelInfo)
}
// NewErrorLogger is a convenience function to create an error logger.
func NewErrorLogger() Logger {
return NewBasicLogger(jww.LevelError)
}
// NewBasicLogger creates a new basic logger writing to Stdout.
func NewBasicLogger(t jww.Threshold) Logger {
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, io.Discard, false)
}
// RemoveANSIColours removes all ANSI colours from the given string.
func RemoveANSIColours(s string) string {
return ansiColorRe.ReplaceAllString(s, "")
}
var (
ansiColorRe = regexp.MustCompile("(?s)\\033\\[\\d*(;\\d*)*m")
errorRe = regexp.MustCompile("^(ERROR|FATAL|WARN)")
)
type ansiCleaner struct {
w io.Writer
}
func (a ansiCleaner) Write(p []byte) (n int, err error) {
return a.w.Write(ansiColorRe.ReplaceAll(p, []byte("")))
}
type labelColorizer struct {
w io.Writer
}
func (a labelColorizer) Write(p []byte) (n int, err error) {
replaced := errorRe.ReplaceAllStringFunc(string(p), func(m string) string {
switch m {
case "ERROR", "FATAL":
return terminal.Error(m)
case "WARN":
return terminal.Warning(m)
default:
return m
}
})
// io.MultiWriter will abort if we return a bigger write count than input
// bytes, so we lie a little.
_, err = a.w.Write([]byte(replaced))
return len(p), err
}
// InitGlobalLogger initializes the global logger, used in some rare cases.
func InitGlobalLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, logHandle io.Writer) {
outHandle, logHandle = getLogWriters(outHandle, logHandle)
jww.SetStdoutOutput(outHandle)
jww.SetLogOutput(logHandle)
jww.SetLogThreshold(logThreshold)
jww.SetStdoutThreshold(stdoutThreshold)
}
func getLogWriters(outHandle, logHandle io.Writer) (io.Writer, io.Writer) {
isTerm := terminal.PrintANSIColors(os.Stdout)
if logHandle != io.Discard && isTerm {
// Remove any Ansi coloring from log output
logHandle = ansiCleaner{w: logHandle}
}
if isTerm {
outHandle = labelColorizer{w: outHandle}
}
return outHandle, logHandle
}
type fatalLogWriter int
func (s fatalLogWriter) Write(p []byte) (n int, err error) {
trace := make([]byte, 1500)
runtime.Stack(trace, true)
fmt.Printf("\n===========\n\n%s\n", trace)
os.Exit(-1)
return 0, nil
}
var fatalLogListener = func(t jww.Threshold) io.Writer {
if t != jww.LevelError {
// Only interested in ERROR
return nil
}
return new(fatalLogWriter)
}
func newLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, logHandle io.Writer, saveErrors bool) *logger {
errorCounter := &jww.Counter{}
warnCounter := &jww.Counter{}
outHandle, logHandle = getLogWriters(outHandle, logHandle)
listeners := []jww.LogListener{jww.LogCounter(errorCounter, jww.LevelError), jww.LogCounter(warnCounter, jww.LevelWarn)}
var errorBuff *bytes.Buffer
if saveErrors {
errorBuff = new(bytes.Buffer)
errorCapture := func(t jww.Threshold) io.Writer {
if t != jww.LevelError {
// Only interested in ERROR
return nil
}
return errorBuff
}
listeners = append(listeners, errorCapture)
}
return &logger{
Notepad: jww.NewNotepad(stdoutThreshold, logThreshold, outHandle, logHandle, "", log.Ldate|log.Ltime, listeners...),
out: outHandle,
logCounters: &LogCounters{
ErrorCounter: errorCounter,
WarnCounter: warnCounter,
},
errors: errorBuff,
}
}

View file

@ -0,0 +1,60 @@
// Copyright 2018 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package loggers
import (
"bytes"
"fmt"
"log"
"testing"
qt "github.com/frankban/quicktest"
)
func TestLogger(t *testing.T) {
c := qt.New(t)
l := NewWarningLogger()
l.Errorln("One error")
l.Errorln("Two error")
l.Warnln("A warning")
c.Assert(l.LogCounters().ErrorCounter.Count(), qt.Equals, uint64(2))
}
func TestLoggerToWriterWithPrefix(t *testing.T) {
c := qt.New(t)
var b bytes.Buffer
logger := log.New(&b, "", 0)
w := LoggerToWriterWithPrefix(logger, "myprefix")
fmt.Fprint(w, "Hello Hugo!")
c.Assert(b.String(), qt.Equals, "myprefix: Hello Hugo!\n")
}
func TestRemoveANSIColours(t *testing.T) {
c := qt.New(t)
c.Assert(RemoveANSIColours(""), qt.Equals, "")
c.Assert(RemoveANSIColours("\033[31m"), qt.Equals, "")
c.Assert(RemoveANSIColours("\033[31mHello"), qt.Equals, "Hello")
c.Assert(RemoveANSIColours("\033[31mHello\033[0m"), qt.Equals, "Hello")
c.Assert(RemoveANSIColours("\033[31mHello\033[0m World"), qt.Equals, "Hello World")
c.Assert(RemoveANSIColours("\033[31mHello\033[0m World\033[31m!"), qt.Equals, "Hello World!")
c.Assert(RemoveANSIColours("\x1b[90m 5 |"), qt.Equals, " 5 |")
}

Some files were not shown because too many files have changed in this diff Show more