all: Rework page store, add a dynacache, improve partial rebuilds, and some general spring cleaning

There are some breaking changes in this commit, see #11455.

Closes #11455
Closes #11549

This fixes a set of bugs (see issue list) and it is also paying some technical debt accumulated over the years. We now build with Staticcheck enabled in the CI build.

The performance should be about the same as before for regular sized Hugo sites, but it should perform and scale much better to larger data sets, as objects that uses lots of memory (e.g. rendered Markdown, big JSON files read into maps with transform.Unmarshal etc.) will now get automatically garbage collected if needed. Performance on partial rebuilds when running the server in fast render mode should be the same, but the change detection should be much more accurate.

A list of the notable new features:

* A new dependency tracker that covers (almost) all of Hugo's API and is used to do fine grained partial rebuilds when running the server.
* A new and simpler tree document store which allows fast lookups and prefix-walking in all dimensions (e.g. language) concurrently.
* You can now configure an upper memory limit allowing for much larger data sets and/or running on lower specced PCs.
We have lifted the "no resources in sub folders" restriction for branch bundles (e.g. sections).
Memory Limit
* Hugos will, by default, set aside a quarter of the total system memory, but you can set this via the OS environment variable HUGO_MEMORYLIMIT (in gigabytes). This is backed by a partitioned LRU cache used throughout Hugo. A cache that gets dynamically resized in low memory situations, allowing Go's Garbage Collector to free the memory.

New Dependency Tracker: Hugo has had a rule based coarse grained approach to server rebuilds that has worked mostly pretty well, but there have been some surprises (e.g. stale content). This is now revamped with a new dependency tracker that can quickly calculate the delta given a changed resource (e.g. a content file, template, JS file etc.). This handles transitive relations, e.g. $page -> js.Build -> JS import, or $page1.Content -> render hook -> site.GetPage -> $page2.Title, or $page1.Content -> shortcode -> partial -> site.RegularPages -> $page2.Content -> shortcode ..., and should also handle changes to aggregated values (e.g. site.Lastmod) effectively.

This covers all of Hugo's API with 2 known exceptions (a list that may not be fully exhaustive):

Changes to files loaded with template func os.ReadFile may not be handled correctly. We recommend loading resources with resources.Get
Changes to Hugo objects (e.g. Page) passed in the template context to lang.Translate may not be detected correctly. We recommend having simple i18n templates without too much data context passed in other than simple types such as strings and numbers.
Note that the cachebuster configuration (when A changes then rebuild B) works well with the above, but we recommend that you revise that configuration, as it in most situations should not be needed. One example where it is still needed is with TailwindCSS and using changes to hugo_stats.json to trigger new CSS rebuilds.

Document Store: Previously, a little simplified, we split the document store (where we store pages and resources) in a tree per language. This worked pretty well, but the structure made some operations harder than they needed to be. We have now restructured it into one Radix tree for all languages. Internally the language is considered to be a dimension of that tree, and the tree can be viewed in all dimensions concurrently. This makes some operations re. language simpler (e.g. finding translations is just a slice range), but the idea is that it should also be relatively inexpensive to add more dimensions if needed (e.g. role).

Fixes #10169
Fixes #10364
Fixes #10482
Fixes #10630
Fixes #10656
Fixes #10694
Fixes #10918
Fixes #11262
Fixes #11439
Fixes #11453
Fixes #11457
Fixes #11466
Fixes #11540
Fixes #11551
Fixes #11556
Fixes #11654
Fixes #11661
Fixes #11663
Fixes #11664
Fixes #11669
Fixes #11671
Fixes #11807
Fixes #11808
Fixes #11809
Fixes #11815
Fixes #11840
Fixes #11853
Fixes #11860
Fixes #11883
Fixes #11904
Fixes #7388
Fixes #7425
Fixes #7436
Fixes #7544
Fixes #7882
Fixes #7960
Fixes #8255
Fixes #8307
Fixes #8863
Fixes #8927
Fixes #9192
Fixes #9324

.circleci/config.yml

@@ -4,7 +4,7 @@ parameters:
 defaults: &defaults
   resource_class: large
   docker:
-      - image: bepsays/ci-hugoreleaser:1.21900.20003
+      - image: bepsays/ci-hugoreleaser:1.22100.20600
 environment: &buildenv
       GOMODCACHE: /root/project/gomodcache
 version: 2
@@ -60,7 +60,7 @@ jobs:
     environment:
         <<: [*buildenv]
     docker:
-    - image: bepsays/ci-hugoreleaser-linux-arm64:1.21900.20003
+    - image: bepsays/ci-hugoreleaser-linux-arm64:1.22100.20600
     steps:
       - *restore-cache
       - &attach-workspace
@@ -80,6 +80,9 @@ jobs:
       - *restore-cache
       - *attach-workspace
       - *git-config
+      - run:
+          name: Add github.com to known hosts
+          command: ssh-keyscan github.com >> ~/.ssh/known_hosts
       - run:
           command: |
             cp -a /tmp/workspace/dist1/. ./hugo/dist

.github/ISSUE_TEMPLATE/bug_report.md

@@ -5,7 +5,12 @@ assignees: ''
 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! -->
 
 ### What version of Hugo are you using (`hugo version`)?

.github/workflows/test-dart-sass-v1.yml

@@ -0,0 +1,73 @@
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+name: TestDartSassV1
+env:
+    GOPROXY: https://proxy.golang.org
+    GO111MODULE: on
+    DART_SASS_VERSION: 1.62.1
+    DART_SASS_SHA_LINUX: 3574da75a7322a539034648b8ff84ff2cca162eb924d72b663d718cd3936f075
+permissions:
+  contents: read
+jobs:
+  test:
+    strategy:
+      matrix:
+        go-version: [1.21.x]
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
+    - name: Install Go
+      uses: actions/setup-go@fac708d6674e30b6ba41289acaab6d4b75aa0753
+      with:
+        go-version: ${{ matrix.go-version }}
+        check-latest: true
+        cache: true
+        cache-dependency-path: |
+          **/go.sum
+          **/go.mod
+    - name: Install Ruby
+      uses: ruby/setup-ruby@036ef458ddccddb148a2b9fb67e95a22fdbf728b
+      with:
+        ruby-version: '2.7' 
+        bundler-cache: true #
+    - name: Install Python
+      uses: actions/setup-python@3105fb18c05ddd93efea5f9e0bef7a03a6e9e7df
+      with:
+        python-version: '3.x'
+    - name: Install Mage
+      run: go install github.com/magefile/mage@v1.15.0
+    - name: Install asciidoctor
+      uses: reitzig/actions-asciidoctor@7570212ae20b63653481675fb1ff62d1073632b0
+    - name: Install docutils
+      run: |
+        pip install docutils
+        rst2html.py --version
+    - if: matrix.os == 'ubuntu-latest'
+      name: Install pandoc on Linux
+      run: |
+          sudo apt-get update -y
+          sudo apt-get install -y pandoc
+    - if: matrix.os == 'macos-latest'
+      run: |
+        brew install pandoc
+    - if: matrix.os == 'windows-latest'
+      run: |
+        Choco-Install -PackageName pandoc
+    - run: pandoc -v
+    - name: Install dart-sass-embedded Linux
+      run: |
+        echo "Install Dart Sass version ${DART_SASS_VERSION} ..."
+        curl -LJO "https://github.com/sass/dart-sass-embedded/releases/download/${DART_SASS_VERSION}/sass_embedded-${DART_SASS_VERSION}-linux-x64.tar.gz";
+        echo "${DART_SASS_SHA_LINUX}  sass_embedded-${DART_SASS_VERSION}-linux-x64.tar.gz" | sha256sum -c;
+        tar -xvf "sass_embedded-${DART_SASS_VERSION}-linux-x64.tar.gz";
+        echo "$GITHUB_WORKSPACE/sass_embedded/" >> $GITHUB_PATH
+    - name: Check
+      run: |
+        dart-sass-embedded --version
+        mage -v check;
+      env:
+        HUGO_BUILD_TAGS: extended

.github/workflows/test.yml

@@ -1,40 +1,49 @@
-on: [push, pull_request]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
 name: Test
+env:
+    GOPROXY: https://proxy.golang.org
+    GO111MODULE: on
+    SASS_VERSION: 1.63.2
+    DART_SASS_SHA_LINUX: 3ea33c95ad5c35fda6e9a0956199eef38a398f496cfb8750e02479d7d1dd42af
+    DART_SASS_SHA_MACOS: 11c70f259836b250b44a9cb57fed70e030f21f45069b467d371685855f1eb4f0
+    DART_SASS_SHA_WINDOWS: cd8cd36a619dd8e27f93d3186c52d70eb7d69472aa6c85f5094b29693e773f64
 permissions:
   contents: read
 jobs:
   test:
-    env:
-      GOPROXY: https://proxy.golang.org
-      GO111MODULE: on
     strategy:
       matrix:
-        # Note: We upgraded to Go 1.18 in Hugo v0.95.0
-        # Go 1.18 had some breaking changes on the source level which means Hugo cannot be built
-        # with older Go versions, but the improvements in Go 1.18 were too good to pass on (e.g. break and continue).
-        # Note that you don't need Go (or Go 1.18) to run a pre-built binary.
-        go-version: [1.18.x,1.19.x]
+        go-version: [1.20.x,1.21.x]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
+    - name: Checkout code
+      uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
     - name: Install Go
-      uses: actions/setup-go@37335c7bb261b353407cff977110895fa0b4f7d8
+      uses: actions/setup-go@fac708d6674e30b6ba41289acaab6d4b75aa0753
       with:
         go-version: ${{ matrix.go-version }}
+        check-latest: true
+        cache: true
+        cache-dependency-path: |
+          **/go.sum
+          **/go.mod
     - name: Install Ruby
-      uses: actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526
+      uses: ruby/setup-ruby@036ef458ddccddb148a2b9fb67e95a22fdbf728b
       with:
         ruby-version: '2.7'
+        bundler-cache: true #
     - name: Install Python
       uses: actions/setup-python@3105fb18c05ddd93efea5f9e0bef7a03a6e9e7df
       with:
         python-version: '3.x'
     - name: Install Mage
-      run: go install github.com/magefile/mage@07afc7d24f4d6d6442305d49552f04fbda5ccb3e
+      run: go install github.com/magefile/mage@v1.15.0
     - name: Install asciidoctor
       uses: reitzig/actions-asciidoctor@7570212ae20b63653481675fb1ff62d1073632b0
-    - name: Checkout code
-      uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
     - name: Install docutils
       run: |
         pip install docutils
@@ -49,44 +58,62 @@ jobs:
         brew install pandoc
     - if: matrix.os == 'windows-latest'
       run: |
-        Choco-Install -PackageName pandoc
+        choco install pandoc
     - run: pandoc -v
     - if: matrix.os == 'windows-latest'
       run: |
-        Choco-Install -PackageName mingw -ArgumentList "--version","10.2.0","--allow-downgrade"
+        choco install mingw
     - if: matrix.os == 'ubuntu-latest'
-      name: Install dart-sass-embedded Linux
+      name: Install dart-sass Linux
       run: |
-        curl -LJO https://github.com/sass/dart-sass-embedded/releases/download/1.0.0-beta.6/sass_embedded-1.0.0-beta.6-linux-x64.tar.gz;
-        echo "04fc1e5e28d29a4585a701941b6dace56771d94bfbe7f9e4db28d24417ceeec3  sass_embedded-1.0.0-beta.6-linux-x64.tar.gz" | sha256sum -c;
-        tar -xvf sass_embedded-1.0.0-beta.6-linux-x64.tar.gz;
-        echo "$GITHUB_WORKSPACE/sass_embedded/" >> $GITHUB_PATH
+        echo "Install Dart Sass version ${SASS_VERSION} ..."
+        curl -LJO "https://github.com/sass/dart-sass/releases/download/${SASS_VERSION}/dart-sass-${SASS_VERSION}-linux-x64.tar.gz";
+        echo "${DART_SASS_SHA_LINUX}  dart-sass-${SASS_VERSION}-linux-x64.tar.gz" | sha256sum -c;
+        tar -xvf "dart-sass-${SASS_VERSION}-linux-x64.tar.gz";
+        echo "$GOBIN"
+        echo "$GITHUB_WORKSPACE/dart-sass/" >> $GITHUB_PATH
     - if: matrix.os == 'macos-latest'
-      name: Install dart-sass-embedded MacOS
+      name: Install dart-sass MacOS
       run: |
-        curl -LJO https://github.com/sass/dart-sass-embedded/releases/download/1.0.0-beta.6/sass_embedded-1.0.0-beta.6-macos-x64.tar.gz;
-        echo "b3b984675a9b04aa22f6f2302dda4191b507ac2ca124467db2dfe7e58e72fbad  sass_embedded-1.0.0-beta.6-macos-x64.tar.gz" | shasum -a 256 -c;
-        tar -xvf sass_embedded-1.0.0-beta.6-macos-x64.tar.gz;
-        echo "$GITHUB_WORKSPACE/sass_embedded/" >> $GITHUB_PATH
+        echo "Install Dart Sass version ${SASS_VERSION} ..."
+        curl -LJO "https://github.com/sass/dart-sass/releases/download/${SASS_VERSION}/dart-sass-${SASS_VERSION}-macos-x64.tar.gz";
+        echo "${DART_SASS_SHA_MACOS}  dart-sass-${SASS_VERSION}-macos-x64.tar.gz" | shasum -a 256 -c;
+        tar -xvf "dart-sass-${SASS_VERSION}-macos-x64.tar.gz";
+        echo "$GITHUB_WORKSPACE/dart-sass/" >> $GITHUB_PATH
     - if: matrix.os == 'windows-latest'
-      name: Install dart-sass-embedded Windows
+      name: Install dart-sass Windows
       run: |
-        curl -LJO https://github.com/sass/dart-sass-embedded/releases/download/1.0.0-beta.6/sass_embedded-1.0.0-beta.6-windows-x64.zip;
-        echo "6ae442129dbb3334bc21ef851261da6c0c1b560da790ca2e1350871d00ab816d  sass_embedded-1.0.0-beta.6-windows-x64.zip" | sha256sum -c;
-        unzip sass_embedded-1.0.0-beta.6-windows-x64.zip;
-        echo  "$env:GITHUB_WORKSPACE/sass_embedded/" | Out-File -FilePath $Env:GITHUB_PATH -Encoding utf-8 -Append
-    - name: Check
+        echo "Install Dart Sass version ${env:SASS_VERSION} ..."
+        curl -LJO "https://github.com/sass/dart-sass/releases/download/${env:SASS_VERSION}/dart-sass-${env:SASS_VERSION}-windows-x64.zip";
+        Expand-Archive -Path "dart-sass-${env:SASS_VERSION}-windows-x64.zip" -DestinationPath .;
+        echo  "$env:GITHUB_WORKSPACE/dart-sass/" | Out-File -FilePath $Env:GITHUB_PATH -Encoding utf-8 -Append
+    - if: matrix.os == 'ubuntu-latest'
+      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: |
+        sass --version;
         mage -v check;
       env:
         HUGO_BUILD_TAGS: extended
-    - name: Build Docs
+    - 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
-        HUGO_TIMEOUT: 31000
-        HUGO_IGNOREERRORS: error-remote-getjson
-        HUGO_SERVICES_INSTAGRAM_ACCESSTOKEN: dummytoken
+    - name: Build tags
       run: |
-        mage -v hugo
-        ./hugo -s docs/
-        ./hugo --renderToMemory -s docs/
+        go install -tags extended,nodeploy
+    - if: matrix.os == 'ubuntu-latest'
+      name: Build for dragonfly
+      run: |
+        go install
+      env:
+        GOARCH: amd64
+        GOOS: dragonfly

.gitignore

@@ -1,29 +1,3 @@
-/hugo
-docs/public*
-/.idea
-.vscode/*
-hugo.exe
+
 *.test
-*.prof
-nohup.out
-cover.out
-*.swp
-*.swo
-.DS_Store
-*~
-vendor/*/
-*.bench
-*.debug
-coverage*.out
-
-dock.sh
-
-GoBuilds
-dist
-
-hugolib/hugo_stats.json
-resources/sunset.jpg
-
-vendor
-
-.hugo_build.lock
+imports.*

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to Hugo
+>**Note:** We would apprecitate if you hold on with any big refactorings (like renaming deprecated Go packages), mainly because of potential for extra merge work for future coming in in the near future.
 
-**Note  March 16th 2022:** We are currently very constrained on human resources to do code reviews, so we currently require any new Pull Requests to be limited to bug fixes closing an existing issue. Also, we have updated to Go 1.18, but we will currently not accept any generic rewrites, "interface{} to any" replacements and similar.
+# Contributing to Hugo
 
 We welcome contributions to Hugo of any kind including documentation, themes,
 organization, tutorials, blog posts, bug reports, issues, feature requests,
@@ -52,8 +52,6 @@ Hugo has become a fully featured static site generator, so any new functionality
 
 If it is of some complexity, the contributor is expected to maintain and support the new feature in the future (answer questions on the forum, fix any bugs etc.).
 
-It is recommended to open up a discussion on the [Hugo Forum](https://discourse.gohugo.io/) to get feedback on your idea before you begin. 
-
 Any non-trivial code change needs to update an open [issue](https://github.com/gohugoio/hugo/issues). A non-trivial code change without an issue reference with one of the labels `bug` or `enhancement` will not be merged.
 
 Note that we do not accept new features that require [CGO](https://github.com/golang/go/wiki/cgo).
@@ -124,8 +122,6 @@ cd hugo
 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:
 
 ```bash

Dockerfile

@@ -2,7 +2,7 @@
 # Twitter:      https://twitter.com/gohugoio
 # Website:      https://gohugo.io/
 
-FROM golang:1.18-alpine AS build
+FROM golang:1.21-alpine AS build
 
 # Optionally set HUGO_BUILD_TAGS to "extended" or "nodeploy" when building like so:
 #   docker build --build-arg HUGO_BUILD_TAGS=extended .
@@ -26,7 +26,7 @@ RUN mage hugo && mage install
 
 # ---
 
-FROM alpine:3.12
+FROM alpine:3.18
 
 COPY --from=build /go/bin/hugo /usr/bin/hugo
 

README.md

@@ -1,250 +1,292 @@
+[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
+[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/
+[twitter]: https://twitter.com/gohugoio
+[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 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/).
+A fast and flexible static site generator built with love by [bep], [spf13], and [friends] in [Go].
 
-[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)
 [![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)
 
-* [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 Binaries from Source (Advanced Install)](#build-and-install-the-binaries-from-source-advanced-install)
-* [The Hugo Documentation](#the-hugo-documentation)
-* [Contributing to Hugo](#contributing-code-to-hugo)
-* [Dependencies](#dependencies)
+[Website] | [Installation] | [Documentation] | [Support] | [Contributing] | <a rel="me" href="https://fosstodon.org/@gohugoio">Mastodon</a>
 
 ## Overview
 
-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.
+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 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 don’t have a privileged account.
+Due to its flexible framework, multilingual support, and powerful taxonomy system, Hugo is widely used to create:
 
-Hugo renders a typical website of moderate size in a fraction of a second.
-A good rule of thumb is that each piece of content renders in around 1 millisecond.
+- Corporate, government, nonprofit, education, news, event, and project sites
+- Documentation sites
+- Image portfolios
+- Landing pages
+- Business, professional, and personal blogs
+- Resumes and CVs
 
-Hugo is designed to work well for any kind of website including blogs, tumbles, and docs.
+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's fast asset pipelines include:
+
+- CSS bundling &ndash; transpilation (Sass), tree shaking, minification, source maps, SRI hashing, and PostCSS integration
+- JavaScript bundling &ndash; transpilation (TypeScript, JSX), tree shaking, minification, source maps, and SRI hashing
+- Image processing &ndash; convert, resize, crop, rotate,  adjust colors, apply filters, overlay text and images, and extract EXIF data
+
+And with [Hugo Modules], you can share content, assets, data, translations, themes, templates, and configuration with other projects via public or private Git repositories.
+
+## Sponsors
 
-## Banner Sponsors
 <p>&nbsp;</p>
 <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/gohugoioTheme/master/static/images/sponsors/linode-logo_standard_light_medium.png" width="200" alt="Linode"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-<a href="https://esolia.com/post/why-did-esolia-choose-hugo/?utm_campaign=hugosponsor&utm_medium=banner&utm_source=hugogithub" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/static/images/sponsors/esolia-logo.svg?sanitize=true" width="200" alt="eSOLIA"></a>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://buttercms.com/hugo-cms/?utm_campaign=sponsorship&utm_medium=banner&utm_source=hugogithub" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/static/images/sponsors/butter-dark.svg?sanitize=true" width="280" alt="ButterCMS"></a>
-</p>
+  <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;
+  <a href="https://cloudcannon.com/hugo-cms/?utm_campaign=HugoSponsorship&utm_source=sponsor&utm_content=gohugo" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/cloudcannon-blue.svg" width="220" alt="CloudCannon"></a>
 <p>&nbsp;</p>
 
-## Supported Architectures
+## Installation
 
-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.
+Install Hugo from a [prebuilt binary], package manager, or package repository. Please see the installation instructions for your operating system:
 
-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.
+- [macOS]
+- [Linux]
+- [Windows]
+- [DragonFly BSD, FreeBSD, NetBSD, and OpenBSD]
 
-**Complete documentation is available at [Hugo Documentation](https://gohugo.io/getting-started/).**
+## Build from source
 
-## Choose How to Install
+Hugo is available in two editions: standard and extended. With the extended edition you can:
 
-If you want to use Hugo as your site generator, simply install the Hugo binaries.
+- Encode to the WebP format when processing images. You can decode WebP images with either edition.
+- Transpile Sass to CSS using the embedded LibSass transpiler. The extended edition is not required to use the Dart Sass transpiler.
 
-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.
+Prerequisites to build Hugo from source:
 
-Finally, you can install the Hugo source code with `go`, build the binaries yourself, and run Hugo that way.
-Building the binaries is an easy task for an experienced `go` getter.
+- Standard edition: Go 1.20 or later
+- Extended edition: Go 1.20 or later, and GCC
 
-### Install Hugo as Your Site Generator (Binary Install)
+Build the standard edition:
 
-Use the [installation instructions in the Hugo documentation](https://gohugo.io/getting-started/installing/).
-
-### Build and Install the Binaries from Source (Advanced Install)
-
-#### Prerequisite Tools
-
-* [Git](https://git-scm.com/)
-* [Go (we test it with the last 2 major versions; but note that Hugo 0.95.0 only builds with >= Go 1.18.)](https://golang.org/dl/)
-
-#### Fetch from GitHub
-
-To fetch and build the source from GitHub:
-
-```bash
-mkdir $HOME/src
-cd $HOME/src
-git clone https://github.com/gohugoio/hugo.git
-cd hugo
-go install
+```text
+go install github.com/gohugoio/hugo@latest
 ```
 
-**If you are a Windows user, substitute the `$HOME` environment variable above with `%USERPROFILE%`.**
+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:
-
-```bash
-CGO_ENABLED=1 go install --tags extended
+```text
+CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest
 ```
 
-## The Hugo Documentation
+## Documentation
 
-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:
+Hugo's [documentation] includes installation instructions, a quick start guide, conceptual explanations, reference information, and examples.
 
-```bash
-git clone git@github.com:gohugoio/hugo.git
-```
-## Contributing code to Hugo
+Please submit documentation issues and pull requests to the [documentation repository].
 
-**Note  March 16th 2022:** We are currently very constrained on human resources to do code reviews, so we currently require any new Pull Requests to be limited to bug fixes closing an existing issue. Also, we have updated to Go 1.18, but we will currently not accept any generic rewrites, "interface{} to any" replacements and similar.
+## 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].
+
+Hugo’s [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).
 
-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
 
-Hugo stands on the shoulder of many great open source libraries.
+Hugo stands on the shoulders of great open source libraries. Run `hugo env --logLevel info` to display a list of dependencies.
 
-If you run `hugo env -v` you will get a complete and up to date list.
+<details>
+<summary>See current dependencies</summary>
 
-In Hugo 0.100.1 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"
+```text
+cloud.google.com/go/compute/metadata="v0.2.3"
+cloud.google.com/go/iam="v1.1.3"
+cloud.google.com/go/storage="v1.31.0"
+cloud.google.com/go="v0.110.8"
+github.com/Azure/azure-sdk-for-go/sdk/azcore="v1.7.0"
+github.com/Azure/azure-sdk-for-go/sdk/azidentity="v1.3.0"
+github.com/Azure/azure-sdk-for-go/sdk/internal="v1.3.0"
+github.com/Azure/azure-sdk-for-go/sdk/storage/azblob="v1.1.0"
+github.com/Azure/go-autorest/autorest/to="v0.4.0"
+github.com/AzureAD/microsoft-authentication-library-for-go="v1.0.0"
 github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
 github.com/PuerkitoBio/purell="v1.1.1"
 github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578"
-github.com/alecthomas/chroma="v0.10.0"
+github.com/alecthomas/chroma/v2="v2.11.1"
 github.com/armon/go-radix="v1.0.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/aws/aws-sdk-go-v2/aws/protocol/eventstream="v1.4.11"
+github.com/aws/aws-sdk-go-v2/config="v1.18.32"
+github.com/aws/aws-sdk-go-v2/credentials="v1.13.31"
+github.com/aws/aws-sdk-go-v2/feature/ec2/imds="v1.13.7"
+github.com/aws/aws-sdk-go-v2/feature/s3/manager="v1.11.76"
+github.com/aws/aws-sdk-go-v2/internal/configsources="v1.1.37"
+github.com/aws/aws-sdk-go-v2/internal/endpoints/v2="v2.4.31"
+github.com/aws/aws-sdk-go-v2/internal/ini="v1.3.38"
+github.com/aws/aws-sdk-go-v2/internal/v4a="v1.1.0"
+github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding="v1.9.12"
+github.com/aws/aws-sdk-go-v2/service/internal/checksum="v1.1.32"
+github.com/aws/aws-sdk-go-v2/service/internal/presigned-url="v1.9.31"
+github.com/aws/aws-sdk-go-v2/service/internal/s3shared="v1.15.0"
+github.com/aws/aws-sdk-go-v2/service/s3="v1.38.1"
+github.com/aws/aws-sdk-go-v2/service/sso="v1.13.1"
+github.com/aws/aws-sdk-go-v2/service/ssooidc="v1.15.1"
+github.com/aws/aws-sdk-go-v2/service/sts="v1.21.1"
+github.com/aws/aws-sdk-go-v2="v1.20.0"
+github.com/aws/aws-sdk-go="v1.48.2"
+github.com/aws/smithy-go="v1.14.0"
+github.com/bep/clocks="v0.5.0"
 github.com/bep/debounce="v1.2.0"
 github.com/bep/gitmap="v1.1.2"
 github.com/bep/goat="v0.5.0"
-github.com/bep/godartsass="v0.14.0"
-github.com/bep/golibsass="v1.1.0"
-github.com/bep/gowebp="v0.1.0"
+github.com/bep/godartsass/v2="v2.0.0"
+github.com/bep/godartsass="v1.2.0"
+github.com/bep/golibsass="v1.1.1"
+github.com/bep/gowebp="v0.3.0"
+github.com/bep/lazycache="v0.2.0"
+github.com/bep/logg="v0.3.0"
+github.com/bep/mclib="v1.20400.20402"
 github.com/bep/overlayfs="v0.6.0"
+github.com/bep/simplecobra="v0.3.2"
 github.com/bep/tmc="v0.5.1"
-github.com/clbanning/mxj/v2="v2.5.5"
-github.com/cli/safeexec="v1.0.0"
-github.com/cpuguy83/go-md2man/v2="v2.0.1"
+github.com/clbanning/mxj/v2="v2.7.0"
+github.com/cli/safeexec="v1.0.1"
+github.com/cpuguy83/go-md2man/v2="v2.0.2"
 github.com/disintegration/gift="v1.2.1"
-github.com/dlclark/regexp2="v1.4.0"
-github.com/dustin/go-humanize="v1.0.0"
-github.com/evanw/esbuild="v0.14.42"
-github.com/frankban/quicktest="v1.14.3"
-github.com/fsnotify/fsnotify="v1.5.4"
-github.com/getkin/kin-openapi="v0.94.0"
+github.com/dlclark/regexp2="v1.10.0"
+github.com/dustin/go-humanize="v1.0.1"
+github.com/evanw/esbuild="v0.19.7"
+github.com/fatih/color="v1.16.0"
+github.com/frankban/quicktest="v1.14.6"
+github.com/fsnotify/fsnotify="v1.7.0"
+github.com/getkin/kin-openapi="v0.120.0"
 github.com/ghodss/yaml="v1.0.0"
-github.com/go-openapi/jsonpointer="v0.19.5"
-github.com/go-openapi/swag="v0.19.5"
-github.com/gobuffalo/flect="v0.2.5"
+github.com/go-openapi/jsonpointer="v0.19.6"
+github.com/go-openapi/swag="v0.22.4"
+github.com/gobuffalo/flect="v1.0.2"
 github.com/gobwas/glob="v0.2.3"
-github.com/gohugoio/go-i18n/v2="v2.1.3-0.20210430103248-4c28c89f8013"
+github.com/gohugoio/go-i18n/v2="v2.1.3-0.20230805085216-e63c13218d0e"
 github.com/gohugoio/locales="v0.14.0"
 github.com/gohugoio/localescompressed="v1.0.1"
-github.com/golang-jwt/jwt/v4="v4.0.0"
+github.com/golang-jwt/jwt/v4="v4.5.0"
 github.com/golang/groupcache="v0.0.0-20210331224755-41bb18bfe9da"
-github.com/golang/protobuf="v1.5.2"
-github.com/google/go-cmp="v0.5.8"
-github.com/google/uuid="v1.3.0"
+github.com/golang/protobuf="v1.5.3"
+github.com/google/go-cmp="v0.6.0"
+github.com/google/s2a-go="v0.1.7"
+github.com/google/uuid="v1.4.0"
 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/inconshreveable/mousetrap="v1.0.0"
+github.com/googleapis/enterprise-certificate-proxy="v0.3.2"
+github.com/googleapis/gax-go/v2="v2.12.0"
+github.com/gorilla/websocket="v1.5.1"
+github.com/hairyhenderson/go-codeowners="v0.4.0"
+github.com/hashicorp/golang-lru/v2="v2.0.1"
+github.com/invopop/yaml="v0.2.0"
 github.com/jdkato/prose="v1.2.1"
 github.com/jmespath/go-jmespath="v0.4.0"
-github.com/kr/pretty="v0.3.0"
+github.com/josharian/intern="v1.0.0"
+github.com/kr/pretty="v0.3.1"
 github.com/kr/text="v0.2.0"
-github.com/kyokomi/emoji/v2="v2.2.9"
-github.com/mailru/easyjson="v0.0.0-20190626092158-b2ccc519800e"
-github.com/mattn/go-ieproxy="v0.0.1"
-github.com/mattn/go-isatty="v0.0.14"
+github.com/kylelemons/godebug="v1.1.0"
+github.com/kyokomi/emoji/v2="v2.2.12"
+github.com/mailru/easyjson="v0.7.7"
+github.com/marekm4/color-extractor="v1.2.1"
+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/mitchellh/hashstructure="v1.1.0"
 github.com/mitchellh/mapstructure="v1.5.0"
+github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826"
 github.com/muesli/smartcrop="v0.3.0"
-github.com/niklasfasching/go-org="v1.6.2"
+github.com/niklasfasching/go-org="v1.7.0"
 github.com/olekukonko/tablewriter="v0.0.5"
-github.com/pelletier/go-toml/v2="v2.0.0-beta.7.0.20220408132554-2377ac4bc04c"
-github.com/rogpeppe/go-internal="v1.8.1"
+github.com/pelletier/go-toml/v2="v2.1.0"
+github.com/perimeterx/marshmallow="v1.1.5"
+github.com/pkg/browser="v0.0.0-20210911075715-681adbf594b8"
+github.com/pkg/errors="v0.9.1"
+github.com/rogpeppe/go-internal="v1.11.0"
 github.com/russross/blackfriday/v2="v2.1.0"
 github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
 github.com/sanity-io/litter="v1.5.5"
+github.com/sass/dart-sass/compiler="1.63.2"
+github.com/sass/dart-sass/implementation="1.63.2"
+github.com/sass/dart-sass/protocol="2.0.0"
 github.com/sass/libsass="3.6.5"
-github.com/spf13/afero="v1.8.2"
-github.com/spf13/cast="v1.5.0"
-github.com/spf13/cobra="v1.4.0"
+github.com/spf13/afero="v1.10.0"
+github.com/spf13/cast="v1.5.1"
+github.com/spf13/cobra="v1.7.0"
 github.com/spf13/fsync="v0.9.0"
-github.com/spf13/jwalterweatherman="v1.1.0"
 github.com/spf13/pflag="v1.0.5"
-github.com/tdewolff/minify/v2="v2.11.5"
-github.com/tdewolff/parse/v2="v2.5.31"
-github.com/webmproject/libwebp="v1.2.0"
-github.com/yuin/goldmark="v1.4.12"
-go.opencensus.io="v0.23.0"
-go.uber.org/atomic="v1.9.0"
-gocloud.dev="v0.24.0"
-golang.org/x/crypto="v0.0.0-20211108221036-ceb1ce70b4fa"
-golang.org/x/image="v0.0.0-20211028202545-6944b10bf410"
-golang.org/x/net="v0.0.0-20220425223048-2871e0cb64e4"
-golang.org/x/oauth2="v0.0.0-20220411215720-9780585627b5"
-golang.org/x/sync="v0.0.0-20210220032951-036812b2e83c"
-golang.org/x/sys="v0.0.0-20220422013727-9388b58f7150"
-golang.org/x/text="v0.3.7"
-golang.org/x/tools="v0.1.10"
-golang.org/x/xerrors="v0.0.0-20220411194840-2f41105eb62f"
-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.0"
+github.com/tdewolff/minify/v2="v2.20.7"
+github.com/tdewolff/parse/v2="v2.7.5"
+github.com/webmproject/libwebp="v1.3.2"
+github.com/yuin/goldmark-emoji="v1.0.2"
+github.com/yuin/goldmark="v1.6.0"
+go.opencensus.io="v0.24.0"
+go.uber.org/atomic="v1.11.0"
+go.uber.org/automaxprocs="v1.5.3"
+gocloud.dev="v0.34.0"
+golang.org/x/crypto="v0.15.0"
+golang.org/x/exp="v0.0.0-20221031165847-c99f073a8326"
+golang.org/x/image="v0.13.0"
+golang.org/x/mod="v0.14.0"
+golang.org/x/net="v0.18.0"
+golang.org/x/oauth2="v0.13.0"
+golang.org/x/sync="v0.5.0"
+golang.org/x/sys="v0.14.0"
+golang.org/x/text="v0.14.0"
+golang.org/x/time="v0.3.0"
+golang.org/x/tools="v0.15.0"
+golang.org/x/xerrors="v0.0.0-20220907171357-04be3eba64a2"
+google.golang.org/api="v0.151.0"
+google.golang.org/genproto/googleapis/api="v0.0.0-20231016165738-49dd2c1f3d0b"
+google.golang.org/genproto/googleapis/rpc="v0.0.0-20231030173426-d783a09b4405"
+google.golang.org/genproto="v0.0.0-20231016165738-49dd2c1f3d0b"
+google.golang.org/grpc="v1.59.0"
+google.golang.org/protobuf="v1.31.0"
 gopkg.in/yaml.v2="v2.4.0"
+gopkg.in/yaml.v3="v3.0.1"
+howett.net/plist="v1.0.0"
+software.sslmate.com/src/go-pkcs12="v0.2.0"
 ```
-
+</details>

cache/docs.go

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

cache/dynacache/dynacache.go

@@ -0,0 +1,550 @@
+// 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/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
+
+// 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")
+
+	c := &Cache{
+		partitions: make(map[string]PartitionManager),
+		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
+	Running       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
+	opts       Options
+	infol      logg.LevelLogger
+
+	stats    *stats
+	stopOnce sync.Once
+	stop     func()
+}
+
+// ClearMatching clears all partition for which the predicate returns true.
+func (c *Cache) ClearMatching(predicate func(k, v any) bool) {
+	g := rungroup.Run[PartitionManager](context.Background(), rungroup.Config[PartitionManager]{
+		NumWorkers: len(c.partitions),
+		Handle: func(ctx context.Context, partition PartitionManager) error {
+			partition.clearMatching(predicate)
+			return nil
+		},
+	})
+
+	for _, p := range c.partitions {
+		g.Enqueue(p)
+	}
+
+	g.Wait()
+}
+
+// ClearOnRebuild prepares the cache for a new rebuild taking the given changeset into account.
+func (c *Cache) ClearOnRebuild(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(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()
+			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 the number of partitions or their configuration, but
+	// this will be re-adjusted later.
+	const numberOfPartitionsEstimate = 10
+	maxSize := opts.CalculateMaxSize(c.opts.MaxSize / numberOfPartitionsEstimate)
+
+	// Create a new partition and cache it.
+	partition := &Partition[K, V]{
+		c:       lazycache.New(lazycache.Options[K, V]{MaxEntries: maxSize}),
+		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.c.GetOrCreate(key, 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]) GetOrCreateWitTimeout(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() {
+		v, _, err := p.c.GetOrCreate(key, create)
+		if err != nil {
+			errch <- err
+			return
+		}
+		resultch <- v
+	}()
+
+	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(changeset ...identity.Identity) {
+	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.IsStaleAny(v) {
+			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 shouldDelete(key, v) {
+			p.trace.Log(
+				logg.StringFunc(
+					func() string {
+						return fmt.Sprintf("first pass: clearing cache key %v", key)
+					},
+				),
+			)
+			resource.MarkStale(v)
+			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 {
+		isStale := resource.IsStaleAny(v)
+		if isStale {
+			p.trace.Log(
+				logg.StringFunc(
+					func() string {
+						return fmt.Sprintf("second pass: clearing cache key %v", key)
+					},
+				),
+			)
+		}
+
+		return isStale
+	})
+}
+
+// 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
+	}
+	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(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.MaxSize {
+		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))
+}

cache/dynacache/dynacache_test.go

@@ -0,0 +1,175 @@
+// 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 (
+	"path/filepath"
+	"testing"
+
+	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
+	isStale bool
+}
+
+func (t testItem) IsStale() bool {
+	return t.isStale
+}
+
+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{
+			isStale: true,
+		}, nil
+	})
+
+	p2.GetOrCreate("clearBecauseIdentityChanged", func(string) (testItem, error) {
+		return testItem{
+			name: "changed",
+		}, nil
+	})
+
+	p2.GetOrCreate("clearNever", func(string) (testItem, error) {
+		return testItem{
+			isStale: false,
+		}, 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()
+
+	// Stale items are always cleared.
+	c.Assert(cache.Keys(predicateAll), qt.HasLen, 2)
+
+	cache = newTestCache(t)
+	cache.ClearOnRebuild(identity.StringIdentity("changed"))
+
+	c.Assert(cache.Keys(nil), qt.HasLen, 1)
+
+	cache = newTestCache(t)
+
+	cache.ClearMatching(func(k, v any) bool {
+		return k.(string) == "clearOnRebuild"
+	})
+
+	c.Assert(cache.Keys(predicateAll), qt.HasLen, 3)
+
+	cache.adjustCurrentMaxSize()
+}
+
+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)
+}

cache/filecache/filecache.go

@@ -17,7 +17,6 @@ import (
 	"bytes"
 	"errors"
 	"io"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
@@ -25,6 +24,7 @@ import (
 	"time"
 
 	"github.com/gohugoio/hugo/common/hugio"
+	"github.com/gohugoio/hugo/hugofs"
 
 	"github.com/gohugoio/hugo/helpers"
 
@@ -36,7 +36,7 @@ import (
 var ErrFatal = errors.New("fatal filecache error")
 
 const (
-	filecacheRootDirname = "filecache"
+	FilecacheRootDirname = "filecache"
 )
 
 // Cache caches a set of files in a directory. This is usually a file on
@@ -52,6 +52,9 @@ type Cache struct {
 	pruneAllRootDir string
 
 	nlocker *lockTracker
+
+	initOnce sync.Once
+	initErr  error
 }
 
 type lockTracker struct {
@@ -104,9 +107,23 @@ func (l *lockedFile) Close() error {
 	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.
 // It's important that it's closed when done.
 func (c *Cache) WriteCloser(id string) (ItemInfo, io.WriteCloser, error) {
+	if err := c.init(); err != nil {
+		return ItemInfo{}, nil, err
+	}
+
 	id = cleanID(id)
 	c.nlocker.Lock(id)
 
@@ -130,7 +147,12 @@ func (c *Cache) WriteCloser(id string) (ItemInfo, io.WriteCloser, error) {
 // it when done.
 func (c *Cache) ReadOrCreate(id string,
 	read func(info ItemInfo, r io.ReadSeeker) error,
-	create func(info ItemInfo, w io.WriteCloser) error) (info ItemInfo, err error) {
+	create func(info ItemInfo, w io.WriteCloser) error,
+) (info ItemInfo, err error) {
+	if err := c.init(); err != nil {
+		return ItemInfo{}, err
+	}
+
 	id = cleanID(id)
 
 	c.nlocker.Lock(id)
@@ -164,6 +186,9 @@ func (c *Cache) ReadOrCreate(id string,
 // be invoked and the result cached.
 // 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) {
+	if err := c.init(); err != nil {
+		return ItemInfo{}, nil, err
+	}
 	id = cleanID(id)
 
 	c.nlocker.Lock(id)
@@ -198,6 +223,9 @@ func (c *Cache) GetOrCreate(id string, create func() (io.ReadCloser, error)) (It
 
 // GetOrCreateBytes is the same as GetOrCreate, but produces a byte slice.
 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)
 
 	c.nlocker.Lock(id)
@@ -207,7 +235,7 @@ func (c *Cache) GetOrCreateBytes(id string, create func() ([]byte, error)) (Item
 
 	if r := c.getOrRemove(id); r != nil {
 		defer r.Close()
-		b, err := ioutil.ReadAll(r)
+		b, err := io.ReadAll(r)
 		return info, b, err
 	}
 
@@ -233,6 +261,9 @@ func (c *Cache) GetOrCreateBytes(id string, create func() ([]byte, error)) (Item
 
 // 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) {
+	if err := c.init(); err != nil {
+		return ItemInfo{}, nil, err
+	}
 	id = cleanID(id)
 
 	c.nlocker.Lock(id)
@@ -242,15 +273,18 @@ func (c *Cache) GetBytes(id string) (ItemInfo, []byte, error) {
 
 	if r := c.getOrRemove(id); r != nil {
 		defer r.Close()
-		b, err := ioutil.ReadAll(r)
+		b, err := io.ReadAll(r)
 		return info, b, err
 	}
 
 	return info, nil, nil
 }
 
-// Get gets the file with the given id from the cahce, nil if none found.
+// Get gets the file with the given id from the cache, nil if none found.
 func (c *Cache) Get(id string) (ItemInfo, io.ReadCloser, error) {
+	if err := c.init(); err != nil {
+		return ItemInfo{}, nil, err
+	}
 	id = cleanID(id)
 
 	c.nlocker.Lock(id)
@@ -302,7 +336,7 @@ func (c *Cache) isExpired(modTime time.Time) bool {
 }
 
 // For testing
-func (c *Cache) getString(id string) string {
+func (c *Cache) GetString(id string) string {
 	id = cleanID(id)
 
 	c.nlocker.Lock(id)
@@ -314,7 +348,7 @@ func (c *Cache) getString(id string) string {
 	}
 	defer f.Close()
 
-	b, _ := ioutil.ReadAll(f)
+	b, _ := io.ReadAll(f)
 	return string(b)
 }
 
@@ -329,47 +363,29 @@ func (f Caches) Get(name string) *Cache {
 // NewCaches creates a new set of file caches from the given
 // configuration.
 func NewCaches(p *helpers.PathSpec) (Caches, error) {
-	var dcfg Configs
-	if c, ok := p.Cfg.Get("filecacheConfigs").(Configs); ok {
-		dcfg = c
-	} else {
-		var err error
-		dcfg, err = DecodeConfig(p.Fs.Source, p.Cfg)
-		if err != nil {
-			return nil, err
-		}
-	}
-
+	dcfg := p.Cfg.GetConfigSection("caches").(Configs)
 	fs := p.Fs.Source
 
 	m := make(Caches)
 	for k, v := range dcfg {
 		var cfs afero.Fs
 
-		if v.isResourceDir {
+		if v.IsResourceDir {
 			cfs = p.BaseFs.ResourcesCache
 		} else {
 			cfs = fs
 		}
 
 		if cfs == nil {
-			// TODO(bep) we still have some places that do not initialize the
-			// full dependencies of a site, e.g. the import Jekyll command.
-			// That command does not need these caches, so let us just continue
-			// for now.
-			continue
+			panic("nil fs")
 		}
 
-		baseDir := v.Dir
+		baseDir := v.DirCompiled
 
-		if err := cfs.MkdirAll(baseDir, 0777); err != nil && !os.IsExist(err) {
-			return nil, err
-		}
-
-		bfs := afero.NewBasePathFs(cfs, baseDir)
+		bfs := hugofs.NewBasePathFs(cfs, baseDir)
 
 		var pruneAllRootDir string
-		if k == cacheKeyModules {
+		if k == CacheKeyModules {
 			pruneAllRootDir = "pkg"
 		}
 

cache/filecache/filecache_config.go

@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package filecache provides a file based cache for Hugo.
 package filecache
 
 import (
@@ -21,11 +22,8 @@ import (
 	"time"
 
 	"github.com/gohugoio/hugo/common/maps"
-
 	"github.com/gohugoio/hugo/config"
 
-	"github.com/gohugoio/hugo/helpers"
-
 	"errors"
 
 	"github.com/mitchellh/mapstructure"
@@ -33,98 +31,102 @@ import (
 )
 
 const (
-	cachesConfigKey = "caches"
-
 	resourcesGenDir = ":resourceDir/_gen"
 	cacheDirProject = ":cacheDir/:project"
 )
 
-var defaultCacheConfig = Config{
+var defaultCacheConfig = FileCacheConfig{
 	MaxAge: -1, // Never expire
 	Dir:    cacheDirProject,
 }
 
 const (
-	cacheKeyGetJSON     = "getjson"
-	cacheKeyGetCSV      = "getcsv"
-	cacheKeyImages      = "images"
-	cacheKeyAssets      = "assets"
-	cacheKeyModules     = "modules"
-	cacheKeyGetResource = "getresource"
+	CacheKeyGetJSON     = "getjson"
+	CacheKeyGetCSV      = "getcsv"
+	CacheKeyImages      = "images"
+	CacheKeyAssets      = "assets"
+	CacheKeyModules     = "modules"
+	CacheKeyGetResource = "getresource"
 )
 
-type Configs map[string]Config
+type Configs map[string]FileCacheConfig
 
+// For internal use.
 func (c Configs) CacheDirModules() string {
-	return c[cacheKeyModules].Dir
+	return c[CacheKeyModules].DirCompiled
 }
 
 var defaultCacheConfigs = Configs{
-	cacheKeyModules: {
+	CacheKeyModules: {
 		MaxAge: -1,
 		Dir:    ":cacheDir/modules",
 	},
-	cacheKeyGetJSON: defaultCacheConfig,
-	cacheKeyGetCSV:  defaultCacheConfig,
-	cacheKeyImages: {
+	CacheKeyGetJSON: defaultCacheConfig,
+	CacheKeyGetCSV:  defaultCacheConfig,
+	CacheKeyImages: {
 		MaxAge: -1,
 		Dir:    resourcesGenDir,
 	},
-	cacheKeyAssets: {
+	CacheKeyAssets: {
 		MaxAge: -1,
 		Dir:    resourcesGenDir,
 	},
-	cacheKeyGetResource: Config{
+	CacheKeyGetResource: FileCacheConfig{
 		MaxAge: -1, // Never expire
 		Dir:    cacheDirProject,
 	},
 }
 
-type Config struct {
+type FileCacheConfig struct {
 	// Max age of cache entries in this cache. Any items older than this will
 	// 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
+	// a duration string, a sequence of  decimal numbers, each with optional fraction and a unit suffix,
+	// such as "300ms", "1.5h" or "2h45m".
+	// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
 	MaxAge time.Duration
 
 	// The directory where files are stored.
-	Dir string
+	Dir         string
+	DirCompiled string `json:"-"`
 
 	// Will resources/_gen will get its own composite filesystem that
 	// also checks any theme.
-	isResourceDir bool
+	IsResourceDir bool `json:"-"`
 }
 
 // GetJSONCache gets the file cache for getJSON.
 func (f Caches) GetJSONCache() *Cache {
-	return f[cacheKeyGetJSON]
+	return f[CacheKeyGetJSON]
 }
 
 // GetCSVCache gets the file cache for getCSV.
 func (f Caches) GetCSVCache() *Cache {
-	return f[cacheKeyGetCSV]
+	return f[CacheKeyGetCSV]
 }
 
 // ImageCache gets the file cache for processed images.
 func (f Caches) ImageCache() *Cache {
-	return f[cacheKeyImages]
+	return f[CacheKeyImages]
 }
 
 // ModulesCache gets the file cache for Hugo Modules.
 func (f Caches) ModulesCache() *Cache {
-	return f[cacheKeyModules]
+	return f[CacheKeyModules]
 }
 
 // AssetsCache gets the file cache for assets (processed resources, SCSS etc.).
 func (f Caches) AssetsCache() *Cache {
-	return f[cacheKeyAssets]
+	return f[CacheKeyAssets]
 }
 
 // GetResourceCache gets the file cache for remote resources.
 func (f Caches) GetResourceCache() *Cache {
-	return f[cacheKeyGetResource]
+	return f[CacheKeyGetResource]
 }
 
-func DecodeConfig(fs afero.Fs, cfg config.Provider) (Configs, error) {
+func DecodeConfig(fs afero.Fs, bcfg config.BaseConfig, m map[string]any) (Configs, error) {
 	c := make(Configs)
 	valid := make(map[string]bool)
 	// Add defaults
@@ -133,8 +135,6 @@ func DecodeConfig(fs afero.Fs, cfg config.Provider) (Configs, error) {
 		valid[k] = true
 	}
 
-	m := cfg.GetStringMap(cachesConfigKey)
-
 	_, isOsFs := fs.(*afero.OsFs)
 
 	for k, v := range m {
@@ -170,9 +170,6 @@ func DecodeConfig(fs afero.Fs, cfg config.Provider) (Configs, error) {
 		c[name] = cc
 	}
 
-	// This is a very old flag in Hugo, but we need to respect it.
-	disabled := cfg.GetBool("ignoreCache")
-
 	for k, v := range c {
 		dir := filepath.ToSlash(filepath.Clean(v.Dir))
 		hadSlash := strings.HasPrefix(dir, "/")
@@ -180,12 +177,12 @@ func DecodeConfig(fs afero.Fs, cfg config.Provider) (Configs, error) {
 
 		for i, part := range parts {
 			if strings.HasPrefix(part, ":") {
-				resolved, isResource, err := resolveDirPlaceholder(fs, cfg, part)
+				resolved, isResource, err := resolveDirPlaceholder(fs, bcfg, part)
 				if err != nil {
 					return c, err
 				}
 				if isResource {
-					v.isResourceDir = true
+					v.IsResourceDir = true
 				}
 				parts[i] = resolved
 			}
@@ -195,33 +192,29 @@ func DecodeConfig(fs afero.Fs, cfg config.Provider) (Configs, error) {
 		if hadSlash {
 			dir = "/" + dir
 		}
-		v.Dir = filepath.Clean(filepath.FromSlash(dir))
+		v.DirCompiled = filepath.Clean(filepath.FromSlash(dir))
 
-		if !v.isResourceDir {
-			if isOsFs && !filepath.IsAbs(v.Dir) {
-				return c, fmt.Errorf("%q must resolve to an absolute directory", v.Dir)
+		if !v.IsResourceDir {
+			if isOsFs && !filepath.IsAbs(v.DirCompiled) {
+				return c, fmt.Errorf("%q must resolve to an absolute directory", v.DirCompiled)
 			}
 
 			// Avoid cache in root, e.g. / (Unix) or c:\ (Windows)
-			if len(strings.TrimPrefix(v.Dir, filepath.VolumeName(v.Dir))) == 1 {
-				return c, fmt.Errorf("%q is a root folder and not allowed as cache dir", v.Dir)
+			if len(strings.TrimPrefix(v.DirCompiled, filepath.VolumeName(v.DirCompiled))) == 1 {
+				return c, fmt.Errorf("%q is a root folder and not allowed as cache dir", v.DirCompiled)
 			}
 		}
 
-		if !strings.HasPrefix(v.Dir, "_gen") {
+		if !strings.HasPrefix(v.DirCompiled, "_gen") {
 			// We do cache eviction (file removes) and since the user can set
 			// his/hers own cache directory, we really want to make sure
 			// we do not delete any files that do not belong to this cache.
 			// We do add the cache name as the root, but this is an extra safe
 			// guard. We skip the files inside /resources/_gen/ because
 			// that would be breaking.
-			v.Dir = filepath.Join(v.Dir, filecacheRootDirname, k)
+			v.DirCompiled = filepath.Join(v.DirCompiled, FilecacheRootDirname, k)
 		} else {
-			v.Dir = filepath.Join(v.Dir, k)
-		}
-
-		if disabled {
-			v.MaxAge = 0
+			v.DirCompiled = filepath.Join(v.DirCompiled, k)
 		}
 
 		c[k] = v
@@ -231,17 +224,15 @@ func DecodeConfig(fs afero.Fs, cfg config.Provider) (Configs, error) {
 }
 
 // Resolves :resourceDir => /myproject/resources etc., :cacheDir => ...
-func resolveDirPlaceholder(fs afero.Fs, cfg config.Provider, placeholder string) (cacheDir string, isResource bool, err error) {
-	workingDir := cfg.GetString("workingDir")
+func resolveDirPlaceholder(fs afero.Fs, bcfg config.BaseConfig, placeholder string) (cacheDir string, isResource bool, err error) {
 
 	switch strings.ToLower(placeholder) {
 	case ":resourcedir":
 		return "", true, nil
 	case ":cachedir":
-		d, err := helpers.GetCacheDir(fs, cfg)
-		return d, false, err
+		return bcfg.CacheDir, false, nil
 	case ":project":
-		return filepath.Base(workingDir), false, nil
+		return filepath.Base(bcfg.WorkingDir), false, nil
 	}
 
 	return "", false, fmt.Errorf("%q is not a valid placeholder (valid values are :cacheDir or :resourceDir)", placeholder)

cache/filecache/filecache_config_test.go

@@ -11,18 +11,19 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package filecache
+package filecache_test
 
 import (
 	"path/filepath"
 	"runtime"
-	"strings"
 	"testing"
 	"time"
 
 	"github.com/spf13/afero"
 
+	"github.com/gohugoio/hugo/cache/filecache"
 	"github.com/gohugoio/hugo/config"
+	"github.com/gohugoio/hugo/config/testconfig"
 
 	qt "github.com/frankban/quicktest"
 )
@@ -57,22 +58,20 @@ dir = "/path/to/c4"
 	cfg, err := config.FromConfigString(configStr, "toml")
 	c.Assert(err, qt.IsNil)
 	fs := afero.NewMemMapFs()
-	decoded, err := DecodeConfig(fs, cfg)
-	c.Assert(err, qt.IsNil)
-
+	decoded := testconfig.GetTestConfigs(fs, cfg).Base.Caches
 	c.Assert(len(decoded), qt.Equals, 6)
 
 	c2 := decoded["getcsv"]
 	c.Assert(c2.MaxAge.String(), qt.Equals, "11h0m0s")
-	c.Assert(c2.Dir, qt.Equals, filepath.FromSlash("/path/to/c2/filecache/getcsv"))
+	c.Assert(c2.DirCompiled, qt.Equals, filepath.FromSlash("/path/to/c2/filecache/getcsv"))
 
 	c3 := decoded["images"]
 	c.Assert(c3.MaxAge, qt.Equals, time.Duration(-1))
-	c.Assert(c3.Dir, qt.Equals, filepath.FromSlash("/path/to/c3/filecache/images"))
+	c.Assert(c3.DirCompiled, qt.Equals, filepath.FromSlash("/path/to/c3/filecache/images"))
 
 	c4 := decoded["getresource"]
 	c.Assert(c4.MaxAge, qt.Equals, time.Duration(-1))
-	c.Assert(c4.Dir, qt.Equals, filepath.FromSlash("/path/to/c4/filecache/getresource"))
+	c.Assert(c4.DirCompiled, qt.Equals, filepath.FromSlash("/path/to/c4/filecache/getresource"))
 }
 
 func TestDecodeConfigIgnoreCache(t *testing.T) {
@@ -106,9 +105,7 @@ dir = "/path/to/c4"
 	cfg, err := config.FromConfigString(configStr, "toml")
 	c.Assert(err, qt.IsNil)
 	fs := afero.NewMemMapFs()
-	decoded, err := DecodeConfig(fs, cfg)
-	c.Assert(err, qt.IsNil)
-
+	decoded := testconfig.GetTestConfigs(fs, cfg).Base.Caches
 	c.Assert(len(decoded), qt.Equals, 6)
 
 	for _, v := range decoded {
@@ -118,7 +115,7 @@ dir = "/path/to/c4"
 
 func TestDecodeConfigDefault(t *testing.T) {
 	c := qt.New(t)
-	cfg := newTestConfig()
+	cfg := config.New()
 
 	if runtime.GOOS == "windows" {
 		cfg.Set("resourceDir", "c:\\cache\\resources")
@@ -128,71 +125,22 @@ func TestDecodeConfigDefault(t *testing.T) {
 		cfg.Set("resourceDir", "/cache/resources")
 		cfg.Set("cacheDir", "/cache/thecache")
 	}
+	cfg.Set("workingDir", filepath.FromSlash("/my/cool/hugoproject"))
 
 	fs := afero.NewMemMapFs()
-
-	decoded, err := DecodeConfig(fs, cfg)
-
-	c.Assert(err, qt.IsNil)
-
+	decoded := testconfig.GetTestConfigs(fs, cfg).Base.Caches
 	c.Assert(len(decoded), qt.Equals, 6)
 
-	imgConfig := decoded[cacheKeyImages]
-	jsonConfig := decoded[cacheKeyGetJSON]
+	imgConfig := decoded[filecache.CacheKeyImages]
+	jsonConfig := decoded[filecache.CacheKeyGetJSON]
 
 	if runtime.GOOS == "windows" {
-		c.Assert(imgConfig.Dir, qt.Equals, filepath.FromSlash("_gen/images"))
+		c.Assert(imgConfig.DirCompiled, qt.Equals, filepath.FromSlash("_gen/images"))
 	} else {
-		c.Assert(imgConfig.Dir, qt.Equals, "_gen/images")
-		c.Assert(jsonConfig.Dir, qt.Equals, "/cache/thecache/hugoproject/filecache/getjson")
+		c.Assert(imgConfig.DirCompiled, qt.Equals, "_gen/images")
+		c.Assert(jsonConfig.DirCompiled, qt.Equals, "/cache/thecache/hugoproject/filecache/getjson")
 	}
 
-	c.Assert(imgConfig.isResourceDir, qt.Equals, true)
-	c.Assert(jsonConfig.isResourceDir, qt.Equals, false)
-}
-
-func TestDecodeConfigInvalidDir(t *testing.T) {
-	t.Parallel()
-
-	c := qt.New(t)
-
-	configStr := `
-resourceDir = "myresources"
-contentDir = "content"
-dataDir = "data"
-i18nDir = "i18n"
-layoutDir = "layouts"
-assetDir = "assets"
-archeTypedir = "archetypes"
-
-[caches]
-[caches.getJSON]
-maxAge = "10m"
-dir = "/"
-
-`
-	if runtime.GOOS == "windows" {
-		configStr = strings.Replace(configStr, "/", "c:\\\\", 1)
-	}
-
-	cfg, err := config.FromConfigString(configStr, "toml")
-	c.Assert(err, qt.IsNil)
-	fs := afero.NewMemMapFs()
-
-	_, err = DecodeConfig(fs, cfg)
-	c.Assert(err, qt.Not(qt.IsNil))
-}
-
-func newTestConfig() config.Provider {
-	cfg := config.NewWithTestDefaults()
-	cfg.Set("workingDir", filepath.FromSlash("/my/cool/hugoproject"))
-	cfg.Set("contentDir", "content")
-	cfg.Set("dataDir", "data")
-	cfg.Set("resourceDir", "resources")
-	cfg.Set("i18nDir", "i18n")
-	cfg.Set("layoutDir", "layouts")
-	cfg.Set("archetypeDir", "archetypes")
-	cfg.Set("assetDir", "assets")
-
-	return cfg
+	c.Assert(imgConfig.IsResourceDir, qt.Equals, true)
+	c.Assert(jsonConfig.IsResourceDir, qt.Equals, false)
 }

cache/filecache/filecache_pruner.go

@@ -18,6 +18,7 @@ import (
 	"io"
 	"os"
 
+	"github.com/gohugoio/hugo/common/herrors"
 	"github.com/gohugoio/hugo/hugofs"
 
 	"github.com/spf13/afero"
@@ -30,13 +31,12 @@ import (
 func (c Caches) Prune() (int, error) {
 	counter := 0
 	for k, cache := range c {
-
 		count, err := cache.Prune(false)
 
 		counter += count
 
 		if err != nil {
-			if os.IsNotExist(err) {
+			if herrors.IsNotExist(err) {
 				continue
 			}
 			return counter, fmt.Errorf("failed to prune cache %q: %w", k, err)
@@ -53,10 +53,14 @@ func (c *Cache) Prune(force bool) (int, error) {
 	if c.pruneAllRootDir != "" {
 		return c.pruneRootDir(force)
 	}
+	if err := c.init(); err != nil {
+		return 0, err
+	}
 
 	counter := 0
 
 	err := afero.Walk(c.Fs, "", func(name string, info os.FileInfo, err error) error {
+
 		if info == nil {
 			return nil
 		}
@@ -65,18 +69,24 @@ func (c *Cache) Prune(force bool) (int, error) {
 
 		if info.IsDir() {
 			f, err := c.Fs.Open(name)
+
 			if err != nil {
 				// This cache dir may not exist.
 				return nil
 			}
-			defer f.Close()
 			_, err = f.Readdirnames(1)
+			f.Close()
 			if err == io.EOF {
 				// Empty dir.
-				err = c.Fs.Remove(name)
+				if name == "." {
+					// e.g. /_gen/images -- keep it even if empty.
+					err = nil
+				} else {
+					err = c.Fs.Remove(name)
+				}
 			}
 
-			if err != nil && !os.IsNotExist(err) {
+			if err != nil && !herrors.IsNotExist(err) {
 				return err
 			}
 
@@ -97,7 +107,7 @@ func (c *Cache) Prune(force bool) (int, error) {
 				counter++
 			}
 
-			if err != nil && !os.IsNotExist(err) {
+			if err != nil && !herrors.IsNotExist(err) {
 				return err
 			}
 
@@ -110,9 +120,12 @@ func (c *Cache) Prune(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)
 	if err != nil {
-		if os.IsNotExist(err) {
+		if herrors.IsNotExist(err) {
 			return 0, nil
 		}
 		return 0, err

cache/filecache/filecache_pruner_test.go

@@ -11,13 +11,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package filecache
+package filecache_test
 
 import (
 	"fmt"
 	"testing"
 	"time"
 
+	"github.com/gohugoio/hugo/cache/filecache"
 	"github.com/spf13/afero"
 
 	qt "github.com/frankban/quicktest"
@@ -52,10 +53,10 @@ maxAge = "200ms"
 dir = ":resourceDir/_gen"
 `
 
-	for _, name := range []string{cacheKeyGetCSV, cacheKeyGetJSON, cacheKeyAssets, cacheKeyImages} {
+	for _, name := range []string{filecache.CacheKeyGetCSV, filecache.CacheKeyGetJSON, filecache.CacheKeyAssets, filecache.CacheKeyImages} {
 		msg := qt.Commentf("cache: %s", name)
 		p := newPathsSpec(t, afero.NewMemMapFs(), configStr)
-		caches, err := NewCaches(p)
+		caches, err := filecache.NewCaches(p)
 		c.Assert(err, qt.IsNil)
 		cache := caches[name]
 		for i := 0; i < 10; i++ {
@@ -75,7 +76,7 @@ dir = ":resourceDir/_gen"
 
 		for i := 0; i < 10; i++ {
 			id := fmt.Sprintf("i%d", i)
-			v := cache.getString(id)
+			v := cache.GetString(id)
 			if i < 5 {
 				c.Assert(v, qt.Equals, "")
 			} else {
@@ -83,7 +84,7 @@ dir = ":resourceDir/_gen"
 			}
 		}
 
-		caches, err = NewCaches(p)
+		caches, err = filecache.NewCaches(p)
 		c.Assert(err, qt.IsNil)
 		cache = caches[name]
 		// Touch one and then prune.
@@ -98,7 +99,7 @@ dir = ":resourceDir/_gen"
 		// Now only the i5 should be left.
 		for i := 0; i < 10; i++ {
 			id := fmt.Sprintf("i%d", i)
-			v := cache.getString(id)
+			v := cache.GetString(id)
 			if i != 5 {
 				c.Assert(v, qt.Equals, "")
 			} else {

cache/filecache/filecache_test.go

@@ -1,4 +1,4 @@
-// Copyright 2018 The Hugo Authors. All rights reserved.
+// 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.
@@ -11,27 +11,21 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package filecache
+package filecache_test
 
 import (
 	"errors"
 	"fmt"
 	"io"
-	"io/ioutil"
-	"os"
-	"path/filepath"
 	"strings"
 	"sync"
 	"testing"
 	"time"
 
-	"github.com/gobwas/glob"
-
-	"github.com/gohugoio/hugo/langs"
-	"github.com/gohugoio/hugo/modules"
-
+	"github.com/gohugoio/hugo/cache/filecache"
 	"github.com/gohugoio/hugo/common/hugio"
 	"github.com/gohugoio/hugo/config"
+	"github.com/gohugoio/hugo/config/testconfig"
 	"github.com/gohugoio/hugo/helpers"
 
 	"github.com/gohugoio/hugo/hugofs"
@@ -44,13 +38,8 @@ func TestFileCache(t *testing.T) {
 	t.Parallel()
 	c := qt.New(t)
 
-	tempWorkingDir, err := ioutil.TempDir("", "hugo_filecache_test_work")
-	c.Assert(err, qt.IsNil)
-	defer os.Remove(tempWorkingDir)
-
-	tempCacheDir, err := ioutil.TempDir("", "hugo_filecache_test_cache")
-	c.Assert(err, qt.IsNil)
-	defer os.Remove(tempCacheDir)
+	tempWorkingDir := t.TempDir()
+	tempCacheDir := t.TempDir()
 
 	osfs := afero.NewOsFs()
 
@@ -90,31 +79,14 @@ dir = ":cacheDir/c"
 
 		p := newPathsSpec(t, osfs, configStr)
 
-		caches, err := NewCaches(p)
+		caches, err := filecache.NewCaches(p)
 		c.Assert(err, qt.IsNil)
 
 		cache := caches.Get("GetJSON")
 		c.Assert(cache, qt.Not(qt.IsNil))
-		c.Assert(cache.maxAge.String(), qt.Equals, "10h0m0s")
-
-		bfs, ok := cache.Fs.(*afero.BasePathFs)
-		c.Assert(ok, qt.Equals, true)
-		filename, err := bfs.RealPath("key")
-		c.Assert(err, qt.IsNil)
-		if test.cacheDir != "" {
-			c.Assert(filename, qt.Equals, filepath.Join(test.cacheDir, "c/"+filecacheRootDirname+"/getjson/key"))
-		} else {
-			// Temp dir.
-			c.Assert(filename, qt.Matches, ".*hugo_cache.*"+filecacheRootDirname+".*key")
-		}
 
 		cache = caches.Get("Images")
 		c.Assert(cache, qt.Not(qt.IsNil))
-		c.Assert(cache.maxAge, qt.Equals, time.Duration(-1))
-		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) {
 			return func() (io.ReadCloser, error) {
@@ -123,7 +95,7 @@ dir = ":cacheDir/c"
 					io.Closer
 				}{
 					strings.NewReader(s),
-					ioutil.NopCloser(nil),
+					io.NopCloser(nil),
 				}, nil
 			}
 		}
@@ -132,13 +104,13 @@ dir = ":cacheDir/c"
 			return []byte("bcd"), nil
 		}
 
-		for _, ca := range []*Cache{caches.ImageCache(), caches.AssetsCache(), caches.GetJSONCache(), caches.GetCSVCache()} {
+		for _, ca := range []*filecache.Cache{caches.ImageCache(), caches.AssetsCache(), caches.GetJSONCache(), caches.GetCSVCache()} {
 			for i := 0; i < 2; i++ {
 				info, r, err := ca.GetOrCreate("a", rf("abc"))
 				c.Assert(err, qt.IsNil)
 				c.Assert(r, qt.Not(qt.IsNil))
 				c.Assert(info.Name, qt.Equals, "a")
-				b, _ := ioutil.ReadAll(r)
+				b, _ := io.ReadAll(r)
 				r.Close()
 				c.Assert(string(b), qt.Equals, "abc")
 
@@ -154,7 +126,7 @@ dir = ":cacheDir/c"
 
 				_, r, err = ca.GetOrCreate("a", rf("bcd"))
 				c.Assert(err, qt.IsNil)
-				b, _ = ioutil.ReadAll(r)
+				b, _ = io.ReadAll(r)
 				r.Close()
 				c.Assert(string(b), qt.Equals, "abc")
 			}
@@ -167,13 +139,13 @@ dir = ":cacheDir/c"
 		c.Assert(info.Name, qt.Equals, "mykey")
 		io.WriteString(w, "Hugo is great!")
 		w.Close()
-		c.Assert(caches.ImageCache().getString("mykey"), qt.Equals, "Hugo is great!")
+		c.Assert(caches.ImageCache().GetString("mykey"), qt.Equals, "Hugo is great!")
 
 		info, r, err := caches.ImageCache().Get("mykey")
 		c.Assert(err, qt.IsNil)
 		c.Assert(r, qt.Not(qt.IsNil))
 		c.Assert(info.Name, qt.Equals, "mykey")
-		b, _ := ioutil.ReadAll(r)
+		b, _ := io.ReadAll(r)
 		r.Close()
 		c.Assert(string(b), qt.Equals, "Hugo is great!")
 
@@ -208,7 +180,7 @@ dir = "/cache/c"
 
 	p := newPathsSpec(t, afero.NewMemMapFs(), configStr)
 
-	caches, err := NewCaches(p)
+	caches, err := filecache.NewCaches(p)
 	c.Assert(err, qt.IsNil)
 
 	const cacheName = "getjson"
@@ -233,7 +205,7 @@ dir = "/cache/c"
 					return hugio.ToReadCloser(strings.NewReader(data)), nil
 				})
 				c.Assert(err, qt.IsNil)
-				b, _ := ioutil.ReadAll(r)
+				b, _ := io.ReadAll(r)
 				r.Close()
 				c.Assert(string(b), qt.Equals, data)
 				// Trigger some expiration.
@@ -251,24 +223,24 @@ func TestFileCacheReadOrCreateErrorInRead(t *testing.T) {
 
 	var result string
 
-	rf := func(failLevel int) func(info ItemInfo, r io.ReadSeeker) error {
-		return func(info ItemInfo, r io.ReadSeeker) error {
+	rf := func(failLevel int) func(info filecache.ItemInfo, r io.ReadSeeker) error {
+		return func(info filecache.ItemInfo, r io.ReadSeeker) error {
 			if failLevel > 0 {
 				if failLevel > 1 {
-					return ErrFatal
+					return filecache.ErrFatal
 				}
 				return errors.New("fail")
 			}
 
-			b, _ := ioutil.ReadAll(r)
+			b, _ := io.ReadAll(r)
 			result = string(b)
 
 			return nil
 		}
 	}
 
-	bf := func(s string) func(info ItemInfo, w io.WriteCloser) error {
-		return func(info ItemInfo, w io.WriteCloser) error {
+	bf := func(s string) func(info filecache.ItemInfo, w io.WriteCloser) error {
+		return func(info filecache.ItemInfo, w io.WriteCloser) error {
 			defer w.Close()
 			result = s
 			_, err := w.Write([]byte(s))
@@ -276,7 +248,7 @@ func TestFileCacheReadOrCreateErrorInRead(t *testing.T) {
 		}
 	}
 
-	cache := NewCache(afero.NewMemMapFs(), 100*time.Hour, "")
+	cache := filecache.NewCache(afero.NewMemMapFs(), 100*time.Hour, "")
 
 	const id = "a32"
 
@@ -290,60 +262,15 @@ func TestFileCacheReadOrCreateErrorInRead(t *testing.T) {
 	c.Assert(err, qt.IsNil)
 	c.Assert(result, qt.Equals, "v3")
 	_, err = cache.ReadOrCreate(id, rf(2), bf("v3"))
-	c.Assert(err, qt.Equals, ErrFatal)
-}
-
-func TestCleanID(t *testing.T) {
-	c := qt.New(t)
-	c.Assert(cleanID(filepath.FromSlash("/a/b//c.txt")), qt.Equals, filepath.FromSlash("a/b/c.txt"))
-	c.Assert(cleanID(filepath.FromSlash("a/b//c.txt")), qt.Equals, filepath.FromSlash("a/b/c.txt"))
-}
-
-func initConfig(fs afero.Fs, cfg config.Provider) error {
-	if _, err := langs.LoadLanguageSettings(cfg, nil); err != nil {
-		return err
-	}
-
-	modConfig, err := modules.DecodeConfig(cfg)
-	if err != nil {
-		return err
-	}
-
-	workingDir := cfg.GetString("workingDir")
-	themesDir := cfg.GetString("themesDir")
-	if !filepath.IsAbs(themesDir) {
-		themesDir = filepath.Join(workingDir, themesDir)
-	}
-	globAll := glob.MustCompile("**", '/')
-	modulesClient := modules.NewClient(modules.ClientConfig{
-		Fs:           fs,
-		WorkingDir:   workingDir,
-		ThemesDir:    themesDir,
-		ModuleConfig: modConfig,
-		IgnoreVendor: globAll,
-	})
-
-	moduleConfig, err := modulesClient.Collect()
-	if err != nil {
-		return err
-	}
-
-	if err := modules.ApplyProjectConfigDefaults(cfg, moduleConfig.ActiveModules[len(moduleConfig.ActiveModules)-1]); err != nil {
-		return err
-	}
-
-	cfg.Set("allModules", moduleConfig.ActiveModules)
-
-	return nil
+	c.Assert(err, qt.Equals, filecache.ErrFatal)
 }
 
 func newPathsSpec(t *testing.T, fs afero.Fs, configStr string) *helpers.PathSpec {
 	c := qt.New(t)
 	cfg, err := config.FromConfigString(configStr, "toml")
 	c.Assert(err, qt.IsNil)
-	initConfig(fs, cfg)
-	config.SetBaseTestDefaults(cfg)
-	p, err := helpers.NewPathSpec(hugofs.NewFrom(fs, cfg), cfg, nil)
+	acfg := testconfig.GetTestConfig(fs, cfg)
+	p, err := helpers.NewPathSpec(hugofs.NewFrom(fs, acfg.BaseConfig()), acfg, nil)
 	c.Assert(err, qt.IsNil)
 	return p
 }

cache/filecache/integration_test.go

@@ -0,0 +1,106 @@
+// 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)
+}

cache/namedmemcache/named_cache.go

@@ -1,78 +0,0 @@
-// 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
-}

cache/namedmemcache/named_cache_test.go

@@ -1,80 +0,0 @@
-// 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()
-}

codegen/methods.go

@@ -452,12 +452,16 @@ func collectMethodsRecursive(pkg string, f []*ast.Field) []string {
 		}
 
 		if ident, ok := m.Type.(*ast.Ident); ok && ident.Obj != nil {
-			// Embedded interface
-			methodNames = append(
-				methodNames,
-				collectMethodsRecursive(
-					pkg,
-					ident.Obj.Decl.(*ast.TypeSpec).Type.(*ast.InterfaceType).Methods.List)...)
+			switch tt := ident.Obj.Decl.(*ast.TypeSpec).Type.(type) {
+			case *ast.InterfaceType:
+				// Embedded interface
+				methodNames = append(
+					methodNames,
+					collectMethodsRecursive(
+						pkg,
+						tt.Methods.List)...)
+			}
+
 		} else {
 			// Embedded, but in a different file/package. Return the
 			// package.Name and deal with that later.

commands/commands.go

@@ -1,4 +1,4 @@
-// Copyright 2019 The Hugo Authors. All rights reserved.
+// 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.
@@ -14,330 +14,27 @@
 package commands
 
 import (
-	"fmt"
-	"os"
-	"time"
-
-	"github.com/gohugoio/hugo/common/hugo"
-	"github.com/gohugoio/hugo/common/loggers"
-	hpaths "github.com/gohugoio/hugo/common/paths"
-	"github.com/gohugoio/hugo/config"
-	"github.com/gohugoio/hugo/helpers"
-	"github.com/spf13/cobra"
+	"github.com/bep/simplecobra"
 )
 
-type commandsBuilder struct {
-	hugoBuilderCommon
-
-	commands []cmder
-}
-
-func newCommandsBuilder() *commandsBuilder {
-	return &commandsBuilder{}
-}
-
-func (b *commandsBuilder) addCommands(commands ...cmder) *commandsBuilder {
-	b.commands = append(b.commands, commands...)
-	return b
-}
-
-func (b *commandsBuilder) addAll() *commandsBuilder {
-	b.addCommands(
-		b.newServerCmd(),
-		newVersionCmd(),
-		newEnvCmd(),
-		b.newConfigCmd(),
-		b.newDeployCmd(),
-		b.newConvertCmd(),
-		b.newNewCmd(),
-		b.newListCmd(),
-		newImportCmd(),
-		newGenCmd(),
-		createReleaser(),
-		b.newModCmd(),
-	)
-
-	return b
-}
-
-func (b *commandsBuilder) build() *hugoCmd {
-	h := b.newHugoCmd()
-	addCommands(h.getCommand(), b.commands...)
-	return h
-}
-
-func addCommands(root *cobra.Command, commands ...cmder) {
-	for _, command := range commands {
-		cmd := command.getCommand()
-		if cmd == nil {
-			continue
-		}
-		root.AddCommand(cmd)
-	}
-}
-
-type baseCmd struct {
-	cmd *cobra.Command
-}
-
-var _ commandsBuilderGetter = (*baseBuilderCmd)(nil)
-
-// Used in tests.
-type commandsBuilderGetter interface {
-	getCommandsBuilder() *commandsBuilder
-}
-
-type baseBuilderCmd struct {
-	*baseCmd
-	*commandsBuilder
-}
-
-func (b *baseBuilderCmd) getCommandsBuilder() *commandsBuilder {
-	return b.commandsBuilder
-}
-
-func (c *baseCmd) getCommand() *cobra.Command {
-	return c.cmd
-}
-
-func newBaseCmd(cmd *cobra.Command) *baseCmd {
-	return &baseCmd{cmd: cmd}
-}
-
-func (b *commandsBuilder) newBuilderCmd(cmd *cobra.Command) *baseBuilderCmd {
-	bcmd := &baseBuilderCmd{commandsBuilder: b, baseCmd: &baseCmd{cmd: cmd}}
-	bcmd.hugoBuilderCommon.handleFlags(cmd)
-	return bcmd
-}
-
-func (b *commandsBuilder) newBuilderBasicCmd(cmd *cobra.Command) *baseBuilderCmd {
-	bcmd := &baseBuilderCmd{commandsBuilder: b, baseCmd: &baseCmd{cmd: cmd}}
-	bcmd.hugoBuilderCommon.handleCommonBuilderFlags(cmd)
-	return bcmd
-}
-
-func (c *baseCmd) flagsToConfig(cfg config.Provider) {
-	initializeFlags(c.cmd, cfg)
-}
-
-type hugoCmd struct {
-	*baseBuilderCmd
-
-	// Need to get the sites once built.
-	c *commandeer
-}
-
-var _ cmder = (*nilCommand)(nil)
-
-type nilCommand struct{}
-
-func (c *nilCommand) getCommand() *cobra.Command {
-	return nil
-}
-
-func (c *nilCommand) flagsToConfig(cfg config.Provider) {
-}
-
-func (b *commandsBuilder) newHugoCmd() *hugoCmd {
-	cc := &hugoCmd{}
-
-	cc.baseBuilderCmd = b.newBuilderCmd(&cobra.Command{
-		Use:   "hugo",
-		Short: "hugo builds your site",
-		Long: `hugo is the main command, used to build your Hugo site.
-
-Hugo is a Fast and Flexible Static Site Generator
-built with love by spf13 and friends in Go.
-
-Complete documentation is available at https://gohugo.io/.`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			defer cc.timeTrack(time.Now(), "Total")
-			cfgInit := func(c *commandeer) error {
-				if cc.buildWatch {
-					c.Set("disableLiveReload", true)
-				}
-				return nil
-			}
-
-			// prevent cobra printing error so it can be handled here (before the timeTrack prints)
-			cmd.SilenceErrors = true
-
-			c, err := initializeConfig(true, true, cc.buildWatch, &cc.hugoBuilderCommon, cc, cfgInit)
-			if err != nil {
-				cmd.PrintErrln("Error:", err.Error())
-				return err
-			}
-			cc.c = c
-
-			err = c.build()
-			if err != nil {
-				cmd.PrintErrln("Error:", err.Error())
-			}
-			return err
+// newExec wires up all of Hugo's CLI.
+func newExec() (*simplecobra.Exec, error) {
+	rootCmd := &rootCommand{
+		commands: []simplecobra.Commander{
+			newVersionCmd(),
+			newEnvCommand(),
+			newServerCommand(),
+			newDeployCommand(),
+			newConfigCommand(),
+			newNewCommand(),
+			newConvertCommand(),
+			newImportCommand(),
+			newListCommand(),
+			newModCommands(),
+			newGenCommand(),
+			newReleaseCommand(),
 		},
-	})
+	}
 
-	cc.cmd.PersistentFlags().StringVar(&cc.cfgFile, "config", "", "config file (default is path/config.yaml|json|toml)")
-	cc.cmd.PersistentFlags().StringVar(&cc.cfgDir, "configDir", "config", "config dir")
-	cc.cmd.PersistentFlags().BoolVar(&cc.quiet, "quiet", false, "build in quiet mode")
-
-	// Set bash-completion
-	_ = cc.cmd.PersistentFlags().SetAnnotation("config", cobra.BashCompFilenameExt, config.ValidConfigFileExtensions)
-
-	cc.cmd.PersistentFlags().BoolVarP(&cc.verbose, "verbose", "v", false, "verbose output")
-	cc.cmd.PersistentFlags().BoolVarP(&cc.debug, "debug", "", false, "debug output")
-	cc.cmd.PersistentFlags().BoolVar(&cc.logging, "log", false, "enable Logging")
-	cc.cmd.PersistentFlags().StringVar(&cc.logFile, "logFile", "", "log File path (if set, logging enabled automatically)")
-	cc.cmd.PersistentFlags().BoolVar(&cc.verboseLog, "verboseLog", false, "verbose logging")
-
-	cc.cmd.Flags().BoolVarP(&cc.buildWatch, "watch", "w", false, "watch filesystem for changes and recreate as needed")
-
-	cc.cmd.Flags().Bool("renderToMemory", false, "render to memory (only useful for benchmark testing)")
-
-	// Set bash-completion
-	_ = cc.cmd.PersistentFlags().SetAnnotation("logFile", cobra.BashCompFilenameExt, []string{})
-
-	cc.cmd.SetGlobalNormalizationFunc(helpers.NormalizeHugoFlags)
-	cc.cmd.SilenceUsage = true
-
-	return cc
-}
-
-type hugoBuilderCommon struct {
-	source      string
-	baseURL     string
-	environment string
-
-	buildWatch bool
-	poll       string
-	clock      string
-
-	gc bool
-
-	// Profile flags (for debugging of performance problems)
-	cpuprofile   string
-	memprofile   string
-	mutexprofile string
-	traceprofile string
-	printm       bool
-
-	// TODO(bep) var vs string
-	logging    bool
-	verbose    bool
-	verboseLog bool
-	debug      bool
-	quiet      bool
-
-	cfgFile string
-	cfgDir  string
-	logFile string
-}
-
-func (cc *hugoBuilderCommon) timeTrack(start time.Time, name string) {
-	if cc.quiet {
-		return
-	}
-	elapsed := time.Since(start)
-	fmt.Printf("%s in %v ms\n", name, int(1000*elapsed.Seconds()))
-}
-
-func (cc *hugoBuilderCommon) getConfigDir(baseDir string) string {
-	if cc.cfgDir != "" {
-		return hpaths.AbsPathify(baseDir, cc.cfgDir)
-	}
-
-	if v, found := os.LookupEnv("HUGO_CONFIGDIR"); found {
-		return hpaths.AbsPathify(baseDir, v)
-	}
-
-	return hpaths.AbsPathify(baseDir, "config")
-}
-
-func (cc *hugoBuilderCommon) getEnvironment(isServer bool) string {
-	if cc.environment != "" {
-		return cc.environment
-	}
-
-	if v, found := os.LookupEnv("HUGO_ENVIRONMENT"); found {
-		return v
-	}
-
-	//  Used by Netlify and Forestry
-	if v, found := os.LookupEnv("HUGO_ENV"); found {
-		return v
-	}
-
-	if isServer {
-		return hugo.EnvironmentDevelopment
-	}
-
-	return hugo.EnvironmentProduction
-}
-
-func (cc *hugoBuilderCommon) handleCommonBuilderFlags(cmd *cobra.Command) {
-	cmd.PersistentFlags().StringVarP(&cc.source, "source", "s", "", "filesystem path to read files relative from")
-	cmd.PersistentFlags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{})
-	cmd.PersistentFlags().StringVarP(&cc.environment, "environment", "e", "", "build environment")
-	cmd.PersistentFlags().StringP("themesDir", "", "", "filesystem path to themes directory")
-	cmd.PersistentFlags().StringP("ignoreVendorPaths", "", "", "ignores any _vendor for module paths matching the given Glob pattern")
-	cmd.PersistentFlags().StringVar(&cc.clock, "clock", "", "set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00")
-}
-
-func (cc *hugoBuilderCommon) handleFlags(cmd *cobra.Command) {
-	cc.handleCommonBuilderFlags(cmd)
-	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("buildFuture", "F", false, "include content with publishdate in the future")
-	cmd.Flags().BoolP("buildExpired", "E", false, "include expired content")
-	cmd.Flags().StringP("contentDir", "c", "", "filesystem path to content directory")
-	cmd.Flags().StringP("layoutDir", "l", "", "filesystem path to layout directory")
-	cmd.Flags().StringP("cacheDir", "", "", "filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/")
-	cmd.Flags().BoolP("ignoreCache", "", false, "ignores the cache directory")
-	cmd.Flags().StringP("destination", "d", "", "filesystem path to write files to")
-	cmd.Flags().StringSliceP("theme", "t", []string{}, "themes to use (located in /themes/THEMENAME/)")
-	cmd.Flags().StringVarP(&cc.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(&cc.gc, "gc", false, "enable to run some cleanup tasks (remove unused cache files) after the build")
-	cmd.Flags().StringVar(&cc.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().BoolVar(&loggers.PanicOnWarning, "panicOnWarning", false, "panic on first WARNING log")
-	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().BoolP("forceSyncStatic", "", false, "copy all files when static is changed.")
-	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("noBuildLock", "", false, "don't create .hugo_build.lock file")
-	cmd.Flags().BoolP("printI18nWarnings", "", false, "print missing translations")
-	cmd.Flags().BoolP("printPathWarnings", "", false, "print warnings on duplicate target paths etc.")
-	cmd.Flags().BoolP("printUnusedTemplates", "", false, "print warnings on unused templates.")
-	cmd.Flags().StringVarP(&cc.cpuprofile, "profile-cpu", "", "", "write cpu profile to `file`")
-	cmd.Flags().StringVarP(&cc.memprofile, "profile-mem", "", "", "write memory profile to `file`")
-	cmd.Flags().BoolVarP(&cc.printm, "printMemoryUsage", "", false, "print memory usage to screen at intervals")
-	cmd.Flags().StringVarP(&cc.mutexprofile, "profile-mutex", "", "", "write Mutex profile to `file`")
-	cmd.Flags().StringVarP(&cc.traceprofile, "trace", "", "", "write trace to `file` (not useful in general)")
-
-	// Hide these for now.
-	cmd.Flags().MarkHidden("profile-cpu")
-	cmd.Flags().MarkHidden("profile-mem")
-	cmd.Flags().MarkHidden("profile-mutex")
-
-	cmd.Flags().StringSlice("disableKinds", []string{}, "disable different kind of pages (home, RSS etc.)")
-
-	cmd.Flags().Bool("minify", false, "minify any supported output format (HTML, XML etc.)")
-
-	// Set bash-completion.
-	// Each flag must first be defined before using the SetAnnotation() call.
-	_ = cmd.Flags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{})
-	_ = cmd.Flags().SetAnnotation("cacheDir", cobra.BashCompSubdirsInDir, []string{})
-	_ = cmd.Flags().SetAnnotation("destination", cobra.BashCompSubdirsInDir, []string{})
-	_ = cmd.Flags().SetAnnotation("theme", cobra.BashCompSubdirsInDir, []string{"themes"})
-}
-
-func checkErr(logger loggers.Logger, err error, s ...string) {
-	if err == nil {
-		return
-	}
-	for _, message := range s {
-		logger.Errorln(message)
-	}
-	logger.Errorln(err)
+	return simplecobra.New(rootCmd)
 }

commands/commands_test.go

@@ -1,410 +0,0 @@
-// Copyright 2019 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 (
-	"fmt"
-	"io/ioutil"
-	"os"
-	"path/filepath"
-	"testing"
-
-	"github.com/gohugoio/hugo/config"
-
-	"github.com/spf13/afero"
-
-	"github.com/gohugoio/hugo/hugofs"
-
-	"github.com/gohugoio/hugo/common/types"
-
-	"github.com/spf13/cobra"
-
-	qt "github.com/frankban/quicktest"
-)
-
-func TestExecute(t *testing.T) {
-	c := qt.New(t)
-
-	createSite := func(c *qt.C) string {
-		dir := createSimpleTestSite(t, testSiteConfig{})
-		return dir
-	}
-
-	c.Run("hugo", func(c *qt.C) {
-		dir := createSite(c)
-		resp := Execute([]string{"-s=" + dir})
-		c.Assert(resp.Err, qt.IsNil)
-		result := resp.Result
-		c.Assert(len(result.Sites) == 1, qt.Equals, true)
-		c.Assert(len(result.Sites[0].RegularPages()) == 2, qt.Equals, true)
-		c.Assert(result.Sites[0].Info.Params()["myparam"], qt.Equals, "paramproduction")
-	})
-
-	c.Run("hugo, set environment", func(c *qt.C) {
-		dir := createSite(c)
-		resp := Execute([]string{"-s=" + dir, "-e=staging"})
-		c.Assert(resp.Err, qt.IsNil)
-		result := resp.Result
-		c.Assert(result.Sites[0].Info.Params()["myparam"], qt.Equals, "paramstaging")
-	})
-
-	c.Run("convert toJSON", func(c *qt.C) {
-		dir := createSite(c)
-		output := filepath.Join(dir, "myjson")
-		resp := Execute([]string{"convert", "toJSON", "-s=" + dir, "-e=staging", "-o=" + output})
-		c.Assert(resp.Err, qt.IsNil)
-		converted := readFileFrom(c, filepath.Join(output, "content", "p1.md"))
-		c.Assert(converted, qt.Equals, "{\n   \"title\": \"P1\",\n   \"weight\": 1\n}\n\nContent\n\n", qt.Commentf(converted))
-	})
-
-	c.Run("config, set environment", func(c *qt.C) {
-		dir := createSite(c)
-		out, err := captureStdout(func() error {
-			resp := Execute([]string{"config", "-s=" + dir, "-e=staging"})
-			return resp.Err
-		})
-		c.Assert(err, qt.IsNil)
-		c.Assert(out, qt.Contains, "params = map[myparam:paramstaging]", qt.Commentf(out))
-	})
-
-	c.Run("deploy, environment set", func(c *qt.C) {
-		dir := createSite(c)
-		resp := Execute([]string{"deploy", "-s=" + dir, "-e=staging", "--target=mydeployment", "--dryRun"})
-		c.Assert(resp.Err, qt.Not(qt.IsNil))
-		c.Assert(resp.Err.Error(), qt.Contains, `no driver registered for "hugocloud"`)
-	})
-
-	c.Run("list", func(c *qt.C) {
-		dir := createSite(c)
-		out, err := captureStdout(func() error {
-			resp := Execute([]string{"list", "all", "-s=" + dir, "-e=staging"})
-			return resp.Err
-		})
-		c.Assert(err, qt.IsNil)
-		c.Assert(out, qt.Contains, "p1.md")
-	})
-
-	c.Run("new theme", func(c *qt.C) {
-		dir := createSite(c)
-		themesDir := filepath.Join(dir, "mythemes")
-		resp := Execute([]string{"new", "theme", "mytheme", "-s=" + dir, "-e=staging", "--themesDir=" + themesDir})
-		c.Assert(resp.Err, qt.IsNil)
-		themeTOML := readFileFrom(c, filepath.Join(themesDir, "mytheme", "theme.toml"))
-		c.Assert(themeTOML, qt.Contains, "name = \"Mytheme\"")
-	})
-
-	c.Run("new site", func(c *qt.C) {
-		dir := createSite(c)
-		siteDir := filepath.Join(dir, "mysite")
-		resp := Execute([]string{"new", "site", siteDir, "-e=staging"})
-		c.Assert(resp.Err, qt.IsNil)
-		config := readFileFrom(c, filepath.Join(siteDir, "config.toml"))
-		c.Assert(config, qt.Contains, "baseURL = 'http://example.org/'")
-		checkNewSiteInited(c, siteDir)
-	})
-}
-
-func checkNewSiteInited(c *qt.C, basepath string) {
-	paths := []string{
-		filepath.Join(basepath, "layouts"),
-		filepath.Join(basepath, "content"),
-		filepath.Join(basepath, "archetypes"),
-		filepath.Join(basepath, "static"),
-		filepath.Join(basepath, "data"),
-		filepath.Join(basepath, "config.toml"),
-	}
-
-	for _, path := range paths {
-		_, err := os.Stat(path)
-		c.Assert(err, qt.IsNil)
-	}
-}
-
-func readFileFrom(c *qt.C, filename string) string {
-	c.Helper()
-	filename = filepath.Clean(filename)
-	b, err := afero.ReadFile(hugofs.Os, filename)
-	c.Assert(err, qt.IsNil)
-	return string(b)
-}
-
-func TestFlags(t *testing.T) {
-	c := qt.New(t)
-
-	noOpRunE := func(cmd *cobra.Command, args []string) error {
-		return nil
-	}
-
-	tests := []struct {
-		name  string
-		args  []string
-		check func(c *qt.C, cmd *serverCmd)
-	}{
-		{
-			// https://github.com/gohugoio/hugo/issues/7642
-			name: "ignoreVendorPaths",
-			args: []string{"server", "--ignoreVendorPaths=github.com/**"},
-			check: func(c *qt.C, cmd *serverCmd) {
-				cfg := config.NewWithTestDefaults()
-				cmd.flagsToConfig(cfg)
-				c.Assert(cfg.Get("ignoreVendorPaths"), qt.Equals, "github.com/**")
-			},
-		},
-		{
-			name: "Persistent flags",
-			args: []string{
-				"server",
-				"--config=myconfig.toml",
-				"--configDir=myconfigdir",
-				"--contentDir=mycontent",
-				"--disableKinds=page,home",
-				"--environment=testing",
-				"--configDir=myconfigdir",
-				"--layoutDir=mylayouts",
-				"--theme=mytheme",
-				"--gc",
-				"--themesDir=mythemes",
-				"--cleanDestinationDir",
-				"--navigateToChanged",
-				"--disableLiveReload",
-				"--noHTTPCache",
-				"--printI18nWarnings",
-				"--destination=/tmp/mydestination",
-				"-b=https://example.com/b/",
-				"--port=1366",
-				"--renderToDisk",
-				"--source=mysource",
-				"--printPathWarnings",
-				"--printUnusedTemplates",
-			},
-			check: func(c *qt.C, sc *serverCmd) {
-				c.Assert(sc, qt.Not(qt.IsNil))
-				c.Assert(sc.navigateToChanged, qt.Equals, true)
-				c.Assert(sc.disableLiveReload, qt.Equals, true)
-				c.Assert(sc.noHTTPCache, qt.Equals, true)
-				c.Assert(sc.renderToDisk, qt.Equals, true)
-				c.Assert(sc.serverPort, qt.Equals, 1366)
-				c.Assert(sc.environment, qt.Equals, "testing")
-
-				cfg := config.NewWithTestDefaults()
-				sc.flagsToConfig(cfg)
-				c.Assert(cfg.GetString("publishDir"), qt.Equals, "/tmp/mydestination")
-				c.Assert(cfg.GetString("contentDir"), qt.Equals, "mycontent")
-				c.Assert(cfg.GetString("layoutDir"), qt.Equals, "mylayouts")
-				c.Assert(cfg.GetStringSlice("theme"), qt.DeepEquals, []string{"mytheme"})
-				c.Assert(cfg.GetString("themesDir"), qt.Equals, "mythemes")
-				c.Assert(cfg.GetString("baseURL"), qt.Equals, "https://example.com/b/")
-
-				c.Assert(cfg.Get("disableKinds"), qt.DeepEquals, []string{"page", "home"})
-
-				c.Assert(cfg.GetBool("gc"), qt.Equals, true)
-
-				// The flag is named printPathWarnings
-				c.Assert(cfg.GetBool("logPathWarnings"), qt.Equals, true)
-
-				// The flag is named printI18nWarnings
-				c.Assert(cfg.GetBool("logI18nWarnings"), qt.Equals, true)
-			},
-		},
-	}
-
-	for _, test := range tests {
-		c.Run(test.name, func(c *qt.C) {
-			b := newCommandsBuilder()
-			root := b.addAll().build()
-
-			for _, cmd := range b.commands {
-				if cmd.getCommand() == nil {
-					continue
-				}
-				// We are only intereseted in the flag handling here.
-				cmd.getCommand().RunE = noOpRunE
-			}
-			rootCmd := root.getCommand()
-			rootCmd.SetArgs(test.args)
-			c.Assert(rootCmd.Execute(), qt.IsNil)
-			test.check(c, b.commands[0].(*serverCmd))
-		})
-	}
-}
-
-func TestCommandsExecute(t *testing.T) {
-	c := qt.New(t)
-
-	dir := createSimpleTestSite(t, testSiteConfig{})
-	dirOut := t.TempDir()
-
-	sourceFlag := fmt.Sprintf("-s=%s", dir)
-
-	tests := []struct {
-		commands           []string
-		flags              []string
-		expectErrToContain string
-	}{
-		// TODO(bep) permission issue on my OSX? "operation not permitted" {[]string{"check", "ulimit"}, nil, false},
-		{[]string{"env"}, nil, ""},
-		{[]string{"version"}, nil, ""},
-		// no args = hugo build
-		{nil, []string{sourceFlag}, ""},
-		{nil, []string{sourceFlag, "--renderToMemory"}, ""},
-		{[]string{"completion", "bash"}, nil, ""},
-		{[]string{"completion", "fish"}, nil, ""},
-		{[]string{"completion", "powershell"}, nil, ""},
-		{[]string{"completion", "zsh"}, nil, ""},
-		{[]string{"config"}, []string{sourceFlag}, ""},
-		{[]string{"convert", "toTOML"}, []string{sourceFlag, "-o=" + filepath.Join(dirOut, "toml")}, ""},
-		{[]string{"convert", "toYAML"}, []string{sourceFlag, "-o=" + filepath.Join(dirOut, "yaml")}, ""},
-		{[]string{"convert", "toJSON"}, []string{sourceFlag, "-o=" + filepath.Join(dirOut, "json")}, ""},
-		{[]string{"gen", "chromastyles"}, []string{"--style=manni"}, ""},
-		{[]string{"gen", "doc"}, []string{"--dir=" + filepath.Join(dirOut, "doc")}, ""},
-		{[]string{"gen", "man"}, []string{"--dir=" + filepath.Join(dirOut, "man")}, ""},
-		{[]string{"list", "drafts"}, []string{sourceFlag}, ""},
-		{[]string{"list", "expired"}, []string{sourceFlag}, ""},
-		{[]string{"list", "future"}, []string{sourceFlag}, ""},
-		{[]string{"new", "new-page.md"}, []string{sourceFlag}, ""},
-		{[]string{"new", "site", filepath.Join(dirOut, "new-site")}, nil, ""},
-		{[]string{"unknowncommand"}, nil, "unknown command"},
-		// TODO(bep) cli refactor fix https://github.com/gohugoio/hugo/issues/4450
-		//{[]string{"new", "theme", filepath.Join(dirOut, "new-theme")}, nil,false},
-	}
-
-	for _, test := range tests {
-		name := "hugo"
-		if len(test.commands) > 0 {
-			name = test.commands[0]
-		}
-		c.Run(name, func(c *qt.C) {
-			b := newCommandsBuilder().addAll().build()
-			hugoCmd := b.getCommand()
-			test.flags = append(test.flags, "--quiet")
-			hugoCmd.SetArgs(append(test.commands, test.flags...))
-
-			// TODO(bep) capture output and add some simple asserts
-			// TODO(bep) misspelled subcommands does not return an error. We should investigate this
-			// but before that, check for "Error: unknown command".
-
-			_, err := hugoCmd.ExecuteC()
-			if test.expectErrToContain != "" {
-				c.Assert(err, qt.Not(qt.IsNil))
-				c.Assert(err.Error(), qt.Contains, test.expectErrToContain)
-			} else {
-				c.Assert(err, qt.IsNil)
-			}
-
-			// Assert that we have not left any development debug artifacts in
-			// the code.
-			if b.c != nil {
-				_, ok := b.c.publishDirFs.(types.DevMarker)
-				c.Assert(ok, qt.Equals, false)
-			}
-		})
-
-	}
-}
-
-type testSiteConfig struct {
-	configTOML string
-	contentDir string
-}
-
-func createSimpleTestSite(t testing.TB, cfg testSiteConfig) string {
-	dir := t.TempDir()
-
-	cfgStr := `
-
-baseURL = "https://example.org"
-title = "Hugo Commands"
-
-
-`
-
-	contentDir := "content"
-
-	if cfg.configTOML != "" {
-		cfgStr = cfg.configTOML
-	}
-	if cfg.contentDir != "" {
-		contentDir = cfg.contentDir
-	}
-
-	os.MkdirAll(filepath.Join(dir, "public"), 0777)
-
-	// Just the basic. These are for CLI tests, not site testing.
-	writeFile(t, filepath.Join(dir, "config.toml"), cfgStr)
-	writeFile(t, filepath.Join(dir, "config", "staging", "params.toml"), `myparam="paramstaging"`)
-	writeFile(t, filepath.Join(dir, "config", "staging", "deployment.toml"), `
-[[targets]]
-name = "mydeployment"
-URL = "hugocloud://hugotestbucket"
-`)
-
-	writeFile(t, filepath.Join(dir, "config", "testing", "params.toml"), `myparam="paramtesting"`)
-	writeFile(t, filepath.Join(dir, "config", "production", "params.toml"), `myparam="paramproduction"`)
-
-	writeFile(t, filepath.Join(dir, "static", "myfile.txt"), `Hello World!`)
-
-	writeFile(t, filepath.Join(dir, contentDir, "p1.md"), `
----
-title: "P1"
-weight: 1
----
-
-Content
-
-`)
-
-	writeFile(t, filepath.Join(dir, contentDir, "hügö.md"), `
----
-weight: 2
----
-
-This is hügö.
-
-`)
-
-	writeFile(t, filepath.Join(dir, "layouts", "_default", "single.html"), `
-
-Single: {{ .Title }}|{{ .Content }}
-
-`)
-
-	writeFile(t, filepath.Join(dir, "layouts", "404.html"), `
-404: {{ .Title }}|Not Found.
-
-`)
-
-	writeFile(t, filepath.Join(dir, "layouts", "_default", "list.html"), `
-
-List: {{ .Title }}
-Environment: {{ hugo.Environment }}
-
-For issue 9788:
-{{ $foo :="abc" | resources.FromString "foo.css" | minify | resources.PostProcess }}
-PostProcess: {{ $foo.RelPermalink }}
-
-`)
-
-	return dir
-}
-
-func writeFile(t testing.TB, filename, content string) {
-	must(t, os.MkdirAll(filepath.Dir(filename), os.FileMode(0755)))
-	must(t, ioutil.WriteFile(filename, []byte(content), os.FileMode(0755)))
-}
-
-func must(t testing.TB, err error) {
-	if err != nil {
-		t.Fatal(err)
-	}
-}

commands/config.go

@@ -1,4 +1,4 @@
-// Copyright 2015 The Hugo Authors. All rights reserved.
+// 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.
@@ -9,128 +9,136 @@
 // 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.Print the version number of Hug
+// limitations under the License.
 
 package commands
 
 import (
+	"bytes"
+	"context"
 	"encoding/json"
 	"fmt"
 	"os"
-	"reflect"
-	"regexp"
-	"sort"
 	"strings"
 	"time"
 
+	"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/parser"
 	"github.com/gohugoio/hugo/parser/metadecoders"
-
-	"github.com/gohugoio/hugo/modules"
-
-	"github.com/spf13/cobra"
 )
 
-var _ cmder = (*configCmd)(nil)
-
-type configCmd struct {
-	*baseBuilderCmd
+// newConfigCommand creates a new config command and its subcommands.
+func newConfigCommand() *configCommand {
+	return &configCommand{
+		commands: []simplecobra.Commander{
+			&configMountsCommand{},
+		},
+	}
 }
 
-func (b *commandsBuilder) newConfigCmd() *configCmd {
-	cc := &configCmd{}
-	cmd := &cobra.Command{
-		Use:   "config",
-		Short: "Print the site configuration",
-		Long:  `Print the site configuration, both default and custom settings.`,
-		RunE:  cc.printConfig,
-	}
+type configCommand struct {
+	r *rootCommand
 
-	printMountsCmd := &cobra.Command{
-		Use:   "mounts",
-		Short: "Print the configured file mounts",
-		RunE:  cc.printMounts,
-	}
+	format string
+	lang   string
 
-	cmd.AddCommand(printMountsCmd)
-
-	cc.baseBuilderCmd = b.newBuilderBasicCmd(cmd)
-
-	return cc
+	commands []simplecobra.Commander
 }
 
-func (c *configCmd) printMounts(cmd *cobra.Command, args []string) error {
-	cfg, err := initializeConfig(true, false, false, &c.hugoBuilderCommon, c, nil)
+func (c *configCommand) Commands() []simplecobra.Commander {
+	return c.commands
+}
+
+func (c *configCommand) Name() string {
+	return "config"
+}
+
+func (c *configCommand) 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
 	}
+	var config *allconfig.Config
+	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]
+	}
 
-	allModules := cfg.Cfg.Get("allmodules").(modules.Modules)
+	var buf bytes.Buffer
+	dec := json.NewEncoder(&buf)
+	dec.SetIndent("", "  ")
+	dec.SetEscapeHTML(false)
 
-	for _, m := range allModules {
-		if err := parser.InterfaceToConfig(&modMounts{m: m, verbose: c.verbose}, metadecoders.JSON, os.Stdout); err != nil {
+	if err := dec.Encode(parser.ReplacingJSONMarshaller{Value: config, KeysToLower: true, OmitEmpty: true}); err != nil {
+		return err
+	}
+
+	format := strings.ToLower(c.format)
+
+	switch format {
+	case "json":
+		os.Stdout.Write(buf.Bytes())
+	default:
+		// Decode the JSON to a map[string]interface{} and then unmarshal it again to the correct format.
+		var m map[string]interface{}
+		if err := json.Unmarshal(buf.Bytes(), &m); err != nil {
 			return err
 		}
-	}
-	return nil
-}
-
-func (c *configCmd) printConfig(cmd *cobra.Command, args []string) error {
-	cfg, err := initializeConfig(true, false, false, &c.hugoBuilderCommon, c, nil)
-	if err != nil {
-		return err
-	}
-
-	allSettings := cfg.Cfg.Get("").(maps.Params)
-
-	// We need to clean up this, but we store objects in the config that
-	// isn't really interesting to the end user, so filter these.
-	ignoreKeysRe := regexp.MustCompile("client|sorted|filecacheconfigs|allmodules|multilingual")
-
-	separator := ": "
-
-	if len(cfg.configFiles) > 0 && strings.HasSuffix(cfg.configFiles[0], ".toml") {
-		separator = " = "
-	}
-
-	var keys []string
-	for k := range allSettings {
-		if ignoreKeysRe.MatchString(k) {
-			continue
-		}
-		keys = append(keys, k)
-	}
-	sort.Strings(keys)
-	for _, k := range keys {
-		kv := reflect.ValueOf(allSettings[k])
-		if kv.Kind() == reflect.String {
-			fmt.Printf("%s%s\"%+v\"\n", k, separator, allSettings[k])
-		} else {
-			fmt.Printf("%s%s%+v\n", k, separator, allSettings[k])
+		maps.ConvertFloat64WithNoDecimalsToInt(m)
+		switch format {
+		case "yaml":
+			return parser.InterfaceToConfig(m, metadecoders.YAML, os.Stdout)
+		case "toml":
+			return parser.InterfaceToConfig(m, metadecoders.TOML, os.Stdout)
+		default:
+			return fmt.Errorf("unsupported format: %q", format)
 		}
 	}
 
 	return nil
 }
 
-type modMounts struct {
-	verbose bool
-	m       modules.Module
+func (c *configCommand) Init(cd *simplecobra.Commandeer) error {
+	c.r = cd.Root.Command.(*rootCommand)
+	cmd := cd.CobraCommand
+	cmd.Short = "Print the site configuration"
+	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.Flags().StringVar(&c.lang, "lang", "", "the language to display config for. Defaults to the first language defined.")
+	applyLocalFlagsBuildConfig(cmd, c.r)
+
+	return nil
 }
 
-type modMount struct {
+func (c *configCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
+	return nil
+}
+
+type configModMount struct {
 	Source string `json:"source"`
 	Target string `json:"target"`
 	Lang   string `json:"lang,omitempty"`
 }
 
-func (m *modMounts) MarshalJSON() ([]byte, error) {
-	var mounts []modMount
+type configModMounts struct {
+	verbose bool
+	m       modules.Module
+}
+
+// MarshalJSON is for internal use only.
+func (m *configModMounts) MarshalJSON() ([]byte, error) {
+	var mounts []configModMount
 
 	for _, mount := range m.m.Mounts() {
-		mounts = append(mounts, modMount{
+		mounts = append(mounts, configModMount{
 			Source: mount.Source,
 			Target: mount.Target,
 			Lang:   mount.Lang,
@@ -153,7 +161,7 @@ func (m *modMounts) MarshalJSON() ([]byte, error) {
 			Meta        map[string]any      `json:"meta"`
 			HugoVersion modules.HugoVersion `json:"hugoVersion"`
 
-			Mounts []modMount `json:"mounts"`
+			Mounts []configModMount `json:"mounts"`
 		}{
 			Path:        m.m.Path(),
 			Version:     m.m.Version(),
@@ -167,12 +175,12 @@ func (m *modMounts) MarshalJSON() ([]byte, error) {
 	}
 
 	return json.Marshal(&struct {
-		Path    string     `json:"path"`
-		Version string     `json:"version"`
-		Time    time.Time  `json:"time"`
-		Owner   string     `json:"owner"`
-		Dir     string     `json:"dir"`
-		Mounts  []modMount `json:"mounts"`
+		Path    string           `json:"path"`
+		Version string           `json:"version"`
+		Time    time.Time        `json:"time"`
+		Owner   string           `json:"owner"`
+		Dir     string           `json:"dir"`
+		Mounts  []configModMount `json:"mounts"`
 	}{
 		Path:    m.m.Path(),
 		Version: m.m.Version(),
@@ -181,5 +189,45 @@ func (m *modMounts) MarshalJSON() ([]byte, error) {
 		Dir:     m.m.Dir(),
 		Mounts:  mounts,
 	})
-
+}
+
+type configMountsCommand struct {
+	r         *rootCommand
+	configCmd *configCommand
+}
+
+func (c *configMountsCommand) Commands() []simplecobra.Commander {
+	return nil
+}
+
+func (c *configMountsCommand) Name() string {
+	return "mounts"
+}
+
+func (c *configMountsCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
+	r := c.configCmd.r
+	conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, nil))
+	if err != nil {
+		return err
+	}
+
+	for _, m := range conf.configs.Modules {
+		if err := parser.InterfaceToConfig(&configModMounts{m: m, verbose: r.isVerbose()}, metadecoders.JSON, os.Stdout); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func (c *configMountsCommand) Init(cd *simplecobra.Commandeer) error {
+	c.r = cd.Root.Command.(*rootCommand)
+	cmd := cd.CobraCommand
+	cmd.Short = "Print the configured file mounts"
+	applyLocalFlagsBuildConfig(cmd, c.r)
+	return nil
+}
+
+func (c *configMountsCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
+	c.configCmd = cd.Parent.Command.(*configCommand)
+	return nil
 }

commands/convert.go

@@ -1,4 +1,4 @@
-// Copyright 2019 The Hugo Authors. All rights reserved.
+// 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.
@@ -15,134 +15,133 @@ package commands
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"path/filepath"
 	"strings"
 	"time"
 
-	"github.com/gohugoio/hugo/parser/pageparser"
-
-	"github.com/gohugoio/hugo/resources/page"
-
-	"github.com/gohugoio/hugo/hugofs"
-
+	"github.com/bep/simplecobra"
+	"github.com/gohugoio/hugo/config"
 	"github.com/gohugoio/hugo/helpers"
-
+	"github.com/gohugoio/hugo/hugofs"
+	"github.com/gohugoio/hugo/hugolib"
 	"github.com/gohugoio/hugo/parser"
 	"github.com/gohugoio/hugo/parser/metadecoders"
-
-	"github.com/gohugoio/hugo/hugolib"
-
+	"github.com/gohugoio/hugo/parser/pageparser"
+	"github.com/gohugoio/hugo/resources/page"
 	"github.com/spf13/cobra"
 )
 
-var _ cmder = (*convertCmd)(nil)
+func newConvertCommand() *convertCommand {
+	var c *convertCommand
+	c = &convertCommand{
+		commands: []simplecobra.Commander{
+			&simpleCommand{
+				name:  "toJSON",
+				short: "Convert front matter to JSON",
+				long: `toJSON converts all front matter in the content directory
+to use JSON for the front matter.`,
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					return c.convertContents(metadecoders.JSON)
+				},
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+				},
+			},
+			&simpleCommand{
+				name:  "toTOML",
+				short: "Convert front matter to TOML",
+				long: `toTOML converts all front matter in the content directory
+to use TOML for the front matter.`,
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					return c.convertContents(metadecoders.TOML)
+				},
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+				},
+			},
+			&simpleCommand{
+				name:  "toYAML",
+				short: "Convert front matter to YAML",
+				long: `toYAML converts all front matter in the content directory
+to use YAML for the front matter.`,
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					return c.convertContents(metadecoders.YAML)
+				},
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+				},
+			},
+		},
+	}
+	return c
+}
 
-type convertCmd struct {
+type convertCommand struct {
+	// Flags.
 	outputDir string
 	unsafe    bool
 
-	*baseBuilderCmd
+	// Deps.
+	r *rootCommand
+	h *hugolib.HugoSites
+
+	// Commands.
+	commands []simplecobra.Commander
 }
 
-func (b *commandsBuilder) newConvertCmd() *convertCmd {
-	cc := &convertCmd{}
-
-	cmd := &cobra.Command{
-		Use:   "convert",
-		Short: "Convert your content to different formats",
-		Long: `Convert your content (e.g. front matter) to different formats.
-
-See convert's subcommands toJSON, toTOML and toYAML for more information.`,
-		RunE: nil,
-	}
-
-	cmd.AddCommand(
-		&cobra.Command{
-			Use:   "toJSON",
-			Short: "Convert front matter to JSON",
-			Long: `toJSON converts all front matter in the content directory
-to use JSON for the front matter.`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				return cc.convertContents(metadecoders.JSON)
-			},
-		},
-		&cobra.Command{
-			Use:   "toTOML",
-			Short: "Convert front matter to TOML",
-			Long: `toTOML converts all front matter in the content directory
-to use TOML for the front matter.`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				return cc.convertContents(metadecoders.TOML)
-			},
-		},
-		&cobra.Command{
-			Use:   "toYAML",
-			Short: "Convert front matter to YAML",
-			Long: `toYAML converts all front matter in the content directory
-to use YAML for the front matter.`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				return cc.convertContents(metadecoders.YAML)
-			},
-		},
-	)
-
-	cmd.PersistentFlags().StringVarP(&cc.outputDir, "output", "o", "", "filesystem path to write files to")
-	cmd.PersistentFlags().BoolVar(&cc.unsafe, "unsafe", false, "enable less safe operations, please backup first")
-
-	cc.baseBuilderCmd = b.newBuilderBasicCmd(cmd)
-
-	return cc
+func (c *convertCommand) Commands() []simplecobra.Commander {
+	return c.commands
 }
 
-func (cc *convertCmd) convertContents(format metadecoders.Format) error {
-	if cc.outputDir == "" && !cc.unsafe {
-		return newUserError("Unsafe operation not allowed, use --unsafe or set a different output path")
-	}
+func (c *convertCommand) Name() string {
+	return "convert"
+}
 
-	c, err := initializeConfig(true, false, false, &cc.hugoBuilderCommon, cc, nil)
-	if err != nil {
-		return err
-	}
-
-	c.Cfg.Set("buildDrafts", true)
-
-	h, err := hugolib.NewHugoSites(*c.DepsCfg)
-	if err != nil {
-		return err
-	}
-
-	if err := h.Build(hugolib.BuildCfg{SkipRender: true}); err != nil {
-		return err
-	}
-
-	site := h.Sites[0]
-
-	site.Log.Println("processing", len(site.AllPages()), "content files")
-	for _, p := range site.AllPages() {
-		if err := cc.convertAndSavePage(p, site, format); err != nil {
-			return err
-		}
-	}
+func (c *convertCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
 	return nil
 }
 
-func (cc *convertCmd) convertAndSavePage(p page.Page, site *hugolib.Site, targetFormat metadecoders.Format) error {
+func (c *convertCommand) Init(cd *simplecobra.Commandeer) error {
+	cmd := cd.CobraCommand
+	cmd.Short = "Convert your content to different formats"
+	cmd.Long = `Convert your content (e.g. front matter) to different formats.
+
+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().BoolVar(&c.unsafe, "unsafe", false, "enable less safe operations, please backup first")
+
+	cmd.RunE = nil
+	return nil
+}
+
+func (c *convertCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
+	c.r = cd.Root.Command.(*rootCommand)
+	cfg := config.New()
+	cfg.Set("buildDrafts", true)
+	h, err := c.r.Hugo(flagsToCfg(cd, cfg))
+	if err != nil {
+		return err
+	}
+	c.h = h
+	return nil
+}
+
+func (c *convertCommand) convertAndSavePage(p page.Page, site *hugolib.Site, targetFormat metadecoders.Format) error {
 	// The resources are not in .Site.AllPages.
 	for _, r := range p.Resources().ByType("page") {
-		if err := cc.convertAndSavePage(r.(page.Page), site, targetFormat); err != nil {
+		if err := c.convertAndSavePage(r.(page.Page), site, targetFormat); err != nil {
 			return err
 		}
 	}
 
-	if p.File().IsZero() {
+	if p.File() == nil {
 		// No content file.
 		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("attempting to convert", p.File().Filename())
 
 	f := p.File()
 	file, err := f.FileInfo().Meta().Open()
@@ -182,26 +181,45 @@ func (cc *convertCmd) convertAndSavePage(p page.Page, site *hugolib.Site, target
 
 	newFilename := p.File().Filename()
 
-	if cc.outputDir != "" {
+	if c.outputDir != "" {
 		contentDir := strings.TrimSuffix(newFilename, p.File().Path())
 		contentDir = filepath.Base(contentDir)
 
-		newFilename = filepath.Join(cc.outputDir, contentDir, p.File().Path())
+		newFilename = filepath.Join(c.outputDir, contentDir, p.File().Path())
 	}
 
 	fs := hugofs.Os
 	if err := helpers.WriteToDisk(newFilename, &newContent, fs); err != nil {
-		return fmt.Errorf("Failed to save file %q:: %w", newFilename, err)
+		return fmt.Errorf("failed to save file %q:: %w", newFilename, err)
 	}
 
 	return nil
 }
 
-type parsedFile struct {
-	frontMatterFormat metadecoders.Format
-	frontMatterSource []byte
-	frontMatter       map[string]any
+func (c *convertCommand) convertContents(format metadecoders.Format) error {
+	if c.outputDir == "" && !c.unsafe {
+		return newUserError("Unsafe operation not allowed, use --unsafe or set a different output path")
+	}
 
-	// Everything after Front Matter
-	content []byte
+	if err := c.h.Build(hugolib.BuildCfg{SkipRender: true}); err != nil {
+		return err
+	}
+
+	site := c.h.Sites[0]
+
+	var pagesBackedByFile page.Pages
+	for _, p := range site.AllPages() {
+		if p.File() == nil {
+			continue
+		}
+		pagesBackedByFile = append(pagesBackedByFile, p)
+	}
+
+	site.Log.Println("processing", len(pagesBackedByFile), "content files")
+	for _, p := range site.AllPages() {
+		if err := c.convertAndSavePage(p, site, format); err != nil {
+			return err
+		}
+	}
+	return nil
 }

commands/deploy.go

@@ -1,4 +1,4 @@
-// Copyright 2019 The Hugo Authors. All rights reserved.
+// 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.
@@ -14,73 +14,57 @@
 //go:build !nodeploy
 // +build !nodeploy
 
+// 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 (
 	"context"
 
+	"github.com/bep/simplecobra"
 	"github.com/gohugoio/hugo/deploy"
 	"github.com/spf13/cobra"
 )
 
-var _ cmder = (*deployCmd)(nil)
-
-// deployCmd supports deploying sites to Cloud providers.
-type deployCmd struct {
-	*baseBuilderCmd
-
-	invalidateCDN bool
-	maxDeletes    int
-}
-
-// TODO: In addition to the "deploy" command, consider adding a "--deploy"
-// flag for the default command; this would build the site and then deploy it.
-// It's not obvious how to do this; would all of the deploy-specific flags
-// have to exist at the top level as well?
-
-// TODO:  The output files change every time "hugo" is executed, it looks
-// like because of map order randomization. This means that you can
-// run "hugo && hugo deploy" again and again and upload new stuff every time. Is
-// this intended?
-
-func (b *commandsBuilder) newDeployCmd() *deployCmd {
-	cc := &deployCmd{}
-
-	cmd := &cobra.Command{
-		Use:   "deploy",
-		Short: "Deploy your site to a Cloud provider.",
-		Long: `Deploy your site to a Cloud provider.
+func newDeployCommand() simplecobra.Commander {
+	return &simpleCommand{
+		name:  "deploy",
+		short: "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
 documentation.
 `,
-
-		RunE: func(cmd *cobra.Command, args []string) error {
-			cfgInit := func(c *commandeer) error {
-				c.Set("invalidateCDN", cc.invalidateCDN)
-				c.Set("maxDeletes", cc.maxDeletes)
-				return nil
-			}
-			comm, err := initializeConfig(true, true, false, &cc.hugoBuilderCommon, cc, cfgInit)
+		run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+			h, err := r.Hugo(flagsToCfgWithAdditionalConfigBase(cd, nil, "deployment"))
 			if err != nil {
 				return err
 			}
-			deployer, err := deploy.New(comm.Cfg, comm.hugo().PathSpec.PublishFs)
+			deployer, err := deploy.New(h.Configs.GetFirstLanguageConfig(), h.Log, h.PathSpec.PublishFs)
 			if err != nil {
 				return err
 			}
-			return deployer.Deploy(context.Background())
+			return deployer.Deploy(ctx)
+		},
+		withc: func(cmd *cobra.Command, r *rootCommand) {
+			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", deploy.DefaultConfig.InvalidateCDN, "invalidate the CDN cache listed in the deployment target")
+			cmd.Flags().Int("maxDeletes", deploy.DefaultConfig.MaxDeletes, "maximum # of files to delete, or -1 to disable")
+			cmd.Flags().Int("workers", deploy.DefaultConfig.Workers, "number of workers to transfer files. defaults to 10")
 		},
 	}
-
-	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().BoolVar(&cc.invalidateCDN, "invalidateCDN", true, "invalidate the CDN cache listed in the deployment target")
-	cmd.Flags().IntVar(&cc.maxDeletes, "maxDeletes", 256, "maximum # of files to delete, or -1 to disable")
-
-	cc.baseBuilderCmd = b.newBuilderBasicCmd(cmd)
-
-	return cc
 }

commands/deploy_off.go

@@ -0,0 +1,49 @@
+// 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 nodeploy
+// +build nodeploy
+
+// 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 (
+	"context"
+
+	"github.com/bep/simplecobra"
+	"github.com/spf13/cobra"
+)
+
+func newDeployCommand() simplecobra.Commander {
+	return &simpleCommand{
+		name: "deploy",
+		run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+			return nil
+		},
+		withc: func(cmd *cobra.Command, r *rootCommand) {
+			cmd.Hidden = true
+		},
+	}
+}

commands/env.go

@@ -1,4 +1,4 @@
-// Copyright 2016 The Hugo Authors. All rights reserved.
+// 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.
@@ -14,47 +14,50 @@
 package commands
 
 import (
+	"context"
 	"runtime"
 
+	"github.com/bep/simplecobra"
 	"github.com/gohugoio/hugo/common/hugo"
-
-	"github.com/spf13/cobra"
-	jww "github.com/spf13/jwalterweatherman"
 )
 
-var _ cmder = (*envCmd)(nil)
+func newEnvCommand() simplecobra.Commander {
+	return &simpleCommand{
+		name:  "env",
+		short: "Print Hugo version and environment info",
+		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 {
+			r.Printf("%s\n", hugo.BuildVersionString())
+			r.Printf("GOOS=%q\n", runtime.GOOS)
+			r.Printf("GOARCH=%q\n", runtime.GOARCH)
+			r.Printf("GOVERSION=%q\n", runtime.Version())
 
-type envCmd struct {
-	*baseCmd
-}
-
-func newEnvCmd() *envCmd {
-	return &envCmd{
-		baseCmd: newBaseCmd(&cobra.Command{
-			Use:   "env",
-			Short: "Print Hugo version and environment info",
-			Long: `Print Hugo version and environment info. This is useful in Hugo bug reports.
-
-If you add the -v flag, you will get a full dependency list.
-`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				printHugoVersion()
-				jww.FEEDBACK.Printf("GOOS=%q\n", runtime.GOOS)
-				jww.FEEDBACK.Printf("GOARCH=%q\n", runtime.GOARCH)
-				jww.FEEDBACK.Printf("GOVERSION=%q\n", runtime.Version())
-
-				isVerbose, _ := cmd.Flags().GetBool("verbose")
-
-				if isVerbose {
-					deps := hugo.GetDependencyList()
-					for _, dep := range deps {
-						jww.FEEDBACK.Printf("%s\n", dep)
-					}
+			if r.isVerbose() {
+				deps := hugo.GetDependencyList()
+				for _, dep := range deps {
+					r.Printf("%s\n", dep)
 				}
-
-				return nil
-			},
-		}),
+			} else {
+				// These are also included in the GetDependencyList above;
+				// always print these as these are most likely the most useful to know about.
+				deps := hugo.GetDependencyListNonGo()
+				for _, dep := range deps {
+					r.Printf("%s\n", dep)
+				}
+			}
+			return nil
+		},
+	}
+}
+
+func newVersionCmd() simplecobra.Commander {
+	return &simpleCommand{
+		name: "version",
+		run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+			r.Println(hugo.BuildVersionString())
+			return nil
+		},
+		short: "Print Hugo version and environment info",
+		long:  "Print Hugo version and environment info. This is useful in Hugo bug reports.",
 	}
-
 }

commands/gen.go

@@ -1,4 +1,4 @@
-// Copyright 2015 The Hugo Authors. All rights reserved.
+// 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.
@@ -14,27 +14,261 @@
 package commands
 
 import (
+	"bytes"
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+	"path"
+	"path/filepath"
+	"strings"
+
+	"github.com/alecthomas/chroma/v2"
+	"github.com/alecthomas/chroma/v2/formatters/html"
+	"github.com/alecthomas/chroma/v2/styles"
+	"github.com/bep/simplecobra"
+	"github.com/gohugoio/hugo/common/hugo"
+	"github.com/gohugoio/hugo/docshelper"
+	"github.com/gohugoio/hugo/helpers"
+	"github.com/gohugoio/hugo/hugofs"
+	"github.com/gohugoio/hugo/hugolib"
+	"github.com/gohugoio/hugo/parser"
 	"github.com/spf13/cobra"
+	"github.com/spf13/cobra/doc"
+	"gopkg.in/yaml.v2"
 )
 
-var _ cmder = (*genCmd)(nil)
+func newGenCommand() *genCommand {
+	var (
+		// Flags.
+		gendocdir string
+		genmandir string
 
-type genCmd struct {
-	*baseCmd
+		// Chroma flags.
+		style          string
+		highlightStyle string
+		linesStyle     string
+	)
+
+	newChromaStyles := func() simplecobra.Commander {
+		return &simpleCommand{
+			name:  "chromastyles",
+			short: "Generate CSS stylesheet for the Chroma code highlighter",
+			long: `Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if markup.highlight.noClasses is disabled in config.
+
+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 {
+				builder := styles.Get(style).Builder()
+				if highlightStyle != "" {
+					builder.Add(chroma.LineHighlight, highlightStyle)
+				}
+				if linesStyle != "" {
+					builder.Add(chroma.LineNumbers, linesStyle)
+				}
+				style, err := builder.Build()
+				if err != nil {
+					return err
+				}
+				formatter := html.New(html.WithAllClasses(true))
+				formatter.WriteCSS(os.Stdout, style)
+				return nil
+			},
+			withc: func(cmd *cobra.Command, r *rootCommand) {
+				cmd.PersistentFlags().StringVar(&style, "style", "friendly", "highlighter style (see https://xyproto.github.io/splash/docs/)")
+				cmd.PersistentFlags().StringVar(&highlightStyle, "highlightStyle", "", "style used for highlighting lines (see https://github.com/alecthomas/chroma)")
+				cmd.PersistentFlags().StringVar(&linesStyle, "linesStyle", "", "style used for line numbers (see https://github.com/alecthomas/chroma)")
+			},
+		}
+	}
+
+	newMan := func() simplecobra.Commander {
+		return &simpleCommand{
+			name:  "man",
+			short: "Generate man pages for the Hugo CLI",
+			long: `This command automatically generates up-to-date man pages of Hugo's
+	command-line interface.  By default, it creates the man page files
+	in the "man" directory under the current directory.`,
+
+			run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+				header := &doc.GenManHeader{
+					Section: "1",
+					Manual:  "Hugo Manual",
+					Source:  fmt.Sprintf("Hugo %s", hugo.CurrentVersion),
+				}
+				if !strings.HasSuffix(genmandir, helpers.FilePathSeparator) {
+					genmandir += helpers.FilePathSeparator
+				}
+				if found, _ := helpers.Exists(genmandir, hugofs.Os); !found {
+					r.Println("Directory", genmandir, "does not exist, creating...")
+					if err := hugofs.Os.MkdirAll(genmandir, 0o777); err != nil {
+						return err
+					}
+				}
+				cd.CobraCommand.Root().DisableAutoGenTag = true
+
+				r.Println("Generating Hugo man pages in", genmandir, "...")
+				doc.GenManTree(cd.CobraCommand.Root(), header, genmandir)
+
+				r.Println("Done.")
+
+				return nil
+			},
+			withc: func(cmd *cobra.Command, r *rootCommand) {
+				cmd.PersistentFlags().StringVar(&genmandir, "dir", "man/", "the directory to write the man pages.")
+				// For bash-completion
+				cmd.PersistentFlags().SetAnnotation("dir", cobra.BashCompSubdirsInDir, []string{})
+			},
+		}
+	}
+
+	newGen := func() simplecobra.Commander {
+		const gendocFrontmatterTemplate = `---
+title: "%s"
+slug: %s
+url: %s
+---
+`
+
+		return &simpleCommand{
+			name:  "doc",
+			short: "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
+	of Hugo's command-line interface for https://gohugo.io/.
+
+	It creates one Markdown file per command with front matter suitable
+	for rendering in Hugo.`,
+			run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+				cd.CobraCommand.VisitParents(func(c *cobra.Command) {
+					// Disable the "Auto generated by spf13/cobra on DATE"
+					// as it creates a lot of diffs.
+					c.DisableAutoGenTag = true
+				})
+				if !strings.HasSuffix(gendocdir, helpers.FilePathSeparator) {
+					gendocdir += helpers.FilePathSeparator
+				}
+				if found, _ := helpers.Exists(gendocdir, hugofs.Os); !found {
+					r.Println("Directory", gendocdir, "does not exist, creating...")
+					if err := hugofs.Os.MkdirAll(gendocdir, 0o777); err != nil {
+						return err
+					}
+				}
+				prepender := func(filename string) string {
+					name := filepath.Base(filename)
+					base := strings.TrimSuffix(name, path.Ext(name))
+					url := "/commands/" + strings.ToLower(base) + "/"
+					return fmt.Sprintf(gendocFrontmatterTemplate, strings.Replace(base, "_", " ", -1), base, url)
+				}
+
+				linkHandler := func(name string) string {
+					base := strings.TrimSuffix(name, path.Ext(name))
+					return "/commands/" + strings.ToLower(base) + "/"
+				}
+				r.Println("Generating Hugo command-line documentation in", gendocdir, "...")
+				doc.GenMarkdownTreeCustom(cd.CobraCommand.Root(), gendocdir, prepender, linkHandler)
+				r.Println("Done.")
+
+				return nil
+			},
+			withc: func(cmd *cobra.Command, r *rootCommand) {
+				cmd.PersistentFlags().StringVar(&gendocdir, "dir", "/tmp/hugodoc/", "the directory to write the doc.")
+				// For bash-completion
+				cmd.PersistentFlags().SetAnnotation("dir", cobra.BashCompSubdirsInDir, []string{})
+			},
+		}
+	}
+
+	var docsHelperTarget string
+
+	newDocsHelper := func() simplecobra.Commander {
+		return &simpleCommand{
+			name:  "docshelper",
+			short: "Generate some data files for the Hugo docs.",
+
+			run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+				r.Println("Generate docs data to", docsHelperTarget)
+
+				var buf bytes.Buffer
+				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.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]interface{}
+				if err := json.Unmarshal(buf.Bytes(), &m); err != nil {
+					return err
+				}
+
+				targetFile := filepath.Join(docsHelperTarget, "docs.yaml")
+
+				f, err := os.Create(targetFile)
+				if err != nil {
+					return err
+				}
+				defer f.Close()
+				yamlEnc := yaml.NewEncoder(f)
+				if err := yamlEnc.Encode(m); err != nil {
+					return err
+				}
+
+				r.Println("Done!")
+				return nil
+			},
+			withc: func(cmd *cobra.Command, r *rootCommand) {
+				cmd.Hidden = true
+				cmd.PersistentFlags().StringVarP(&docsHelperTarget, "dir", "", "docs/data", "data dir")
+			},
+		}
+	}
+
+	return &genCommand{
+		commands: []simplecobra.Commander{
+			newChromaStyles(),
+			newGen(),
+			newMan(),
+			newDocsHelper(),
+		},
+	}
 }
 
-func newGenCmd() *genCmd {
-	cc := &genCmd{}
-	cc.baseCmd = newBaseCmd(&cobra.Command{
-		Use:   "gen",
-		Short: "A collection of several useful generators.",
-	})
+type genCommand struct {
+	rootCmd *rootCommand
 
-	cc.cmd.AddCommand(
-		newGenDocCmd().getCommand(),
-		newGenManCmd().getCommand(),
-		createGenDocsHelper().getCommand(),
-		createGenChromaStyles().getCommand())
-
-	return cc
+	commands []simplecobra.Commander
+}
+
+func (c *genCommand) Commands() []simplecobra.Commander {
+	return c.commands
+}
+
+func (c *genCommand) Name() string {
+	return "gen"
+}
+
+func (c *genCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
+	return nil
+}
+
+func (c *genCommand) Init(cd *simplecobra.Commandeer) error {
+	cmd := cd.CobraCommand
+	cmd.Short = "A collection of several useful generators."
+
+	cmd.RunE = nil
+	return nil
+}
+
+func (c *genCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
+	c.rootCmd = cd.Root.Command.(*rootCommand)
+	return nil
 }

commands/genchromastyles.go

@@ -1,72 +0,0 @@
-// Copyright 2017-present The Hugo Authors. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package commands
-
-import (
-	"os"
-
-	"github.com/alecthomas/chroma/v2"
-	"github.com/alecthomas/chroma/v2/formatters/html"
-	"github.com/alecthomas/chroma/v2/styles"
-	"github.com/spf13/cobra"
-)
-
-var _ cmder = (*genChromaStyles)(nil)
-
-type genChromaStyles struct {
-	style          string
-	highlightStyle string
-	linesStyle     string
-	*baseCmd
-}
-
-// TODO(bep) highlight
-func createGenChromaStyles() *genChromaStyles {
-	g := &genChromaStyles{
-		baseCmd: newBaseCmd(&cobra.Command{
-			Use:   "chromastyles",
-			Short: "Generate CSS stylesheet for the Chroma code highlighter",
-			Long: `Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if markup.highlight.noClasses is disabled in config.
-
-See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles`,
-		}),
-	}
-
-	g.cmd.RunE = func(cmd *cobra.Command, args []string) error {
-		return g.generate()
-	}
-
-	g.cmd.PersistentFlags().StringVar(&g.style, "style", "friendly", "highlighter style (see https://xyproto.github.io/splash/docs/)")
-	g.cmd.PersistentFlags().StringVar(&g.highlightStyle, "highlightStyle", "bg:#ffffcc", "style used for highlighting lines (see https://github.com/alecthomas/chroma)")
-	g.cmd.PersistentFlags().StringVar(&g.linesStyle, "linesStyle", "", "style used for line numbers (see https://github.com/alecthomas/chroma)")
-
-	return g
-}
-
-func (g *genChromaStyles) generate() error {
-	builder := styles.Get(g.style).Builder()
-	if g.highlightStyle != "" {
-		builder.Add(chroma.LineHighlight, g.highlightStyle)
-	}
-	if g.linesStyle != "" {
-		builder.Add(chroma.LineNumbers, g.linesStyle)
-	}
-	style, err := builder.Build()
-	if err != nil {
-		return err
-	}
-	formatter := html.New(html.WithAllClasses(true))
-	formatter.WriteCSS(os.Stdout, style)
-	return nil
-}

commands/gendoc.go

@@ -1,98 +0,0 @@
-// Copyright 2016 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 (
-	"fmt"
-	"path"
-	"path/filepath"
-	"strings"
-
-	"github.com/gohugoio/hugo/helpers"
-	"github.com/gohugoio/hugo/hugofs"
-	"github.com/spf13/cobra"
-	"github.com/spf13/cobra/doc"
-	jww "github.com/spf13/jwalterweatherman"
-)
-
-var _ cmder = (*genDocCmd)(nil)
-
-type genDocCmd struct {
-	gendocdir string
-	*baseCmd
-}
-
-func newGenDocCmd() *genDocCmd {
-	const gendocFrontmatterTemplate = `---
-title: "%s"
-slug: %s
-url: %s
----
-`
-
-	cc := &genDocCmd{}
-
-	cc.baseCmd = newBaseCmd(&cobra.Command{
-		Use:   "doc",
-		Short: "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
-of Hugo's command-line interface for https://gohugo.io/.
-
-It creates one Markdown file per command with front matter suitable
-for rendering in Hugo.`,
-
-		RunE: func(cmd *cobra.Command, args []string) error {
-			cmd.VisitParents(func(c *cobra.Command) {
-				// Disable the "Auto generated by spf13/cobra on DATE"
-				// as it creates a lot of diffs.
-				c.DisableAutoGenTag = true
-			})
-
-			if !strings.HasSuffix(cc.gendocdir, helpers.FilePathSeparator) {
-				cc.gendocdir += helpers.FilePathSeparator
-			}
-			if found, _ := helpers.Exists(cc.gendocdir, hugofs.Os); !found {
-				jww.FEEDBACK.Println("Directory", cc.gendocdir, "does not exist, creating...")
-				if err := hugofs.Os.MkdirAll(cc.gendocdir, 0777); err != nil {
-					return err
-				}
-			}
-			prepender := func(filename string) string {
-				name := filepath.Base(filename)
-				base := strings.TrimSuffix(name, path.Ext(name))
-				url := "/commands/" + strings.ToLower(base) + "/"
-				return fmt.Sprintf(gendocFrontmatterTemplate, strings.Replace(base, "_", " ", -1), base, url)
-			}
-
-			linkHandler := func(name string) string {
-				base := strings.TrimSuffix(name, path.Ext(name))
-				return "/commands/" + strings.ToLower(base) + "/"
-			}
-			jww.FEEDBACK.Println("Generating Hugo command-line documentation in", cc.gendocdir, "...")
-			doc.GenMarkdownTreeCustom(cmd.Root(), cc.gendocdir, prepender, linkHandler)
-			jww.FEEDBACK.Println("Done.")
-
-			return nil
-		},
-	})
-
-	cc.cmd.PersistentFlags().StringVar(&cc.gendocdir, "dir", "/tmp/hugodoc/", "the directory to write the doc.")
-
-	// For bash-completion
-	cc.cmd.PersistentFlags().SetAnnotation("dir", cobra.BashCompSubdirsInDir, []string{})
-
-	return cc
-}

commands/gendocshelper.go

@@ -1,71 +0,0 @@
-// Copyright 2017-present The Hugo Authors. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package commands
-
-import (
-	"encoding/json"
-	"fmt"
-	"os"
-	"path/filepath"
-
-	"github.com/gohugoio/hugo/docshelper"
-	"github.com/spf13/cobra"
-)
-
-var _ cmder = (*genDocsHelper)(nil)
-
-type genDocsHelper struct {
-	target string
-	*baseCmd
-}
-
-func createGenDocsHelper() *genDocsHelper {
-	g := &genDocsHelper{
-		baseCmd: newBaseCmd(&cobra.Command{
-			Use:    "docshelper",
-			Short:  "Generate some data files for the Hugo docs.",
-			Hidden: true,
-		}),
-	}
-
-	g.cmd.RunE = func(cmd *cobra.Command, args []string) error {
-		return g.generate()
-	}
-
-	g.cmd.PersistentFlags().StringVarP(&g.target, "dir", "", "docs/data", "data dir")
-
-	return g
-}
-
-func (g *genDocsHelper) generate() error {
-	fmt.Println("Generate docs data to", g.target)
-
-	targetFile := filepath.Join(g.target, "docs.json")
-
-	f, err := os.Create(targetFile)
-	if err != nil {
-		return err
-	}
-	defer f.Close()
-
-	enc := json.NewEncoder(f)
-	enc.SetIndent("", "  ")
-
-	if err := enc.Encode(docshelper.GetDocProvider()); err != nil {
-		return err
-	}
-
-	fmt.Println("Done!")
-	return nil
-}

commands/genman.go

@@ -1,77 +0,0 @@
-// Copyright 2016 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 (
-	"fmt"
-	"strings"
-
-	"github.com/gohugoio/hugo/common/hugo"
-	"github.com/gohugoio/hugo/helpers"
-	"github.com/gohugoio/hugo/hugofs"
-	"github.com/spf13/cobra"
-	"github.com/spf13/cobra/doc"
-	jww "github.com/spf13/jwalterweatherman"
-)
-
-var _ cmder = (*genManCmd)(nil)
-
-type genManCmd struct {
-	genmandir string
-	*baseCmd
-}
-
-func newGenManCmd() *genManCmd {
-	cc := &genManCmd{}
-
-	cc.baseCmd = newBaseCmd(&cobra.Command{
-		Use:   "man",
-		Short: "Generate man pages for the Hugo CLI",
-		Long: `This command automatically generates up-to-date man pages of Hugo's
-command-line interface.  By default, it creates the man page files
-in the "man" directory under the current directory.`,
-
-		RunE: func(cmd *cobra.Command, args []string) error {
-			header := &doc.GenManHeader{
-				Section: "1",
-				Manual:  "Hugo Manual",
-				Source:  fmt.Sprintf("Hugo %s", hugo.CurrentVersion),
-			}
-			if !strings.HasSuffix(cc.genmandir, helpers.FilePathSeparator) {
-				cc.genmandir += helpers.FilePathSeparator
-			}
-			if found, _ := helpers.Exists(cc.genmandir, hugofs.Os); !found {
-				jww.FEEDBACK.Println("Directory", cc.genmandir, "does not exist, creating...")
-				if err := hugofs.Os.MkdirAll(cc.genmandir, 0777); err != nil {
-					return err
-				}
-			}
-			cmd.Root().DisableAutoGenTag = true
-
-			jww.FEEDBACK.Println("Generating Hugo man pages in", cc.genmandir, "...")
-			doc.GenManTree(cmd.Root(), header, cc.genmandir)
-
-			jww.FEEDBACK.Println("Done.")
-
-			return nil
-		},
-	})
-
-	cc.cmd.PersistentFlags().StringVar(&cc.genmandir, "dir", "man/", "the directory to write the man pages.")
-
-	// For bash-completion
-	cc.cmd.PersistentFlags().SetAnnotation("dir", cobra.BashCompSubdirsInDir, []string{})
-
-	return cc
-}

commands/helpers.go

@@ -1,4 +1,4 @@
-// Copyright 2018 The Hugo Authors. All rights reserved.
+// 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.
@@ -11,16 +11,19 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package commands defines and implements command-line commands and flags
-// used by Hugo. Commands and flags are implemented using Cobra.
 package commands
 
 import (
+	"errors"
 	"fmt"
-	"regexp"
+	"log"
+	"os"
+	"path/filepath"
+	"strings"
 
+	"github.com/bep/simplecobra"
 	"github.com/gohugoio/hugo/config"
-	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 )
 
 const (
@@ -30,50 +33,89 @@ const (
 	showCursor = ansiEsc + "[?25h"
 )
 
-type flagsToConfigHandler interface {
-	flagsToConfig(cfg config.Provider)
+func newUserError(a ...any) *simplecobra.CommandError {
+	return &simplecobra.CommandError{Err: errors.New(fmt.Sprint(a...))}
 }
 
-type cmder interface {
-	flagsToConfigHandler
-	getCommand() *cobra.Command
+func setValueFromFlag(flags *pflag.FlagSet, key string, cfg config.Provider, targetKey string, force bool) {
+	key = strings.TrimSpace(key)
+	if (force && flags.Lookup(key) != nil) || flags.Changed(key) {
+		f := flags.Lookup(key)
+		configKey := key
+		if targetKey != "" {
+			configKey = targetKey
+		}
+		// Gotta love this API.
+		switch f.Value.Type() {
+		case "bool":
+			bv, _ := flags.GetBool(key)
+			cfg.Set(configKey, bv)
+		case "string":
+			cfg.Set(configKey, f.Value.String())
+		case "stringSlice":
+			bv, _ := flags.GetStringSlice(key)
+			cfg.Set(configKey, bv)
+		case "int":
+			iv, _ := flags.GetInt(key)
+			cfg.Set(configKey, iv)
+		default:
+			panic(fmt.Sprintf("update switch with %s", f.Value.Type()))
+		}
+
+	}
 }
 
-// commandError is an error used to signal different error situations in command handling.
-type commandError struct {
-	s         string
-	userError bool
+func flagsToCfg(cd *simplecobra.Commandeer, cfg config.Provider) config.Provider {
+	return flagsToCfgWithAdditionalConfigBase(cd, cfg, "")
 }
 
-func (c commandError) Error() string {
-	return c.s
-}
-
-func (c commandError) isUserError() bool {
-	return c.userError
-}
-
-func newUserError(a ...any) commandError {
-	return commandError{s: fmt.Sprintln(a...), userError: true}
-}
-
-func newSystemError(a ...any) commandError {
-	return commandError{s: fmt.Sprintln(a...), userError: false}
-}
-
-func newSystemErrorF(format string, a ...any) commandError {
-	return commandError{s: fmt.Sprintf(format, a...), userError: false}
-}
-
-// Catch some of the obvious user errors from Cobra.
-// We don't want to show the usage message for every error.
-// The below may be to generic. Time will show.
-var userErrorRegexp = regexp.MustCompile("unknown flag")
-
-func isUserError(err error) bool {
-	if cErr, ok := err.(commandError); ok && cErr.isUserError() {
-		return true
+func flagsToCfgWithAdditionalConfigBase(cd *simplecobra.Commandeer, cfg config.Provider, additionalConfigBase string) config.Provider {
+	if cfg == nil {
+		cfg = config.New()
 	}
 
-	return userErrorRegexp.MatchString(err.Error())
+	// Flags with a different name in the config.
+	keyMap := map[string]string{
+		"minify":      "minifyOutput",
+		"destination": "publishDir",
+		"editor":      "newContentEditor",
+	}
+
+	// Flags that we for some reason don't want to expose in the site config.
+	internalKeySet := map[string]bool{
+		"quiet":          true,
+		"verbose":        true,
+		"watch":          true,
+		"liveReloadPort": true,
+		"renderToMemory": true,
+		"clock":          true,
+	}
+
+	cmd := cd.CobraCommand
+	flags := cmd.Flags()
+
+	flags.VisitAll(func(f *pflag.Flag) {
+		if f.Changed {
+			targetKey := f.Name
+			if internalKeySet[targetKey] {
+				targetKey = "internal." + targetKey
+			} else if mapped, ok := keyMap[targetKey]; ok {
+				targetKey = mapped
+			}
+			setValueFromFlag(flags, f.Name, cfg, targetKey, false)
+			if additionalConfigBase != "" {
+				setValueFromFlag(flags, f.Name, cfg, additionalConfigBase+"."+targetKey, true)
+			}
+		}
+	})
+
+	return cfg
+}
+
+func mkdir(x ...string) {
+	p := filepath.Join(x...)
+	err := os.MkdirAll(p, 0o777) // before umask
+	if err != nil {
+		log.Fatal(err)
+	}
 }

commands/hugo_test.go

@@ -1,206 +0,0 @@
-// Copyright 2019 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 (
-	"bytes"
-	"fmt"
-	"math/rand"
-	"path/filepath"
-	"strings"
-	"testing"
-
-	"github.com/bep/clock"
-	qt "github.com/frankban/quicktest"
-	"github.com/gohugoio/hugo/common/htime"
-	"github.com/gohugoio/hugo/hugofs"
-	"github.com/spf13/afero"
-	"golang.org/x/tools/txtar"
-)
-
-// Issue #5662
-func TestHugoWithContentDirOverride(t *testing.T) {
-	t.Parallel()
-	c := qt.New(t)
-
-	files := `
--- config.toml --
-baseURL = "https://example.org"
-title = "Hugo Commands"
--- mycontent/p1.md --
----
-title: "P1"
----
--- layouts/_default/single.html --
-Page: {{ .Title }}|
-
-`
-	s := newTestHugoCmdBuilder(c, files, []string{"-c", "mycontent"}).Build()
-	s.AssertFileContent("public/p1/index.html", `Page: P1|`)
-
-}
-
-// Issue #9794
-func TestHugoStaticFilesMultipleStaticAndManyFolders(t *testing.T) {
-	t.Parallel()
-	c := qt.New(t)
-
-	files := `
--- config.toml --
-baseURL = "https://example.org"
-theme = "mytheme"
--- layouts/index.html --
-Home.
-
-`
-	const (
-		numDirs     = 33
-		numFilesMax = 12
-	)
-
-	r := rand.New(rand.NewSource(32))
-
-	for i := 0; i < numDirs; i++ {
-		for j := 0; j < r.Intn(numFilesMax); j++ {
-			if j%3 == 0 {
-				files += fmt.Sprintf("-- themes/mytheme/static/d%d/f%d.txt --\nHellot%d-%d\n", i, j, i, j)
-				files += fmt.Sprintf("-- themes/mytheme/static/d%d/ft%d.txt --\nHellot%d-%d\n", i, j, i, j)
-			}
-			files += fmt.Sprintf("-- static/d%d/f%d.txt --\nHello%d-%d\n", i, j, i, j)
-		}
-	}
-
-	r = rand.New(rand.NewSource(32))
-
-	s := newTestHugoCmdBuilder(c, files, []string{"-c", "mycontent"}).Build()
-	for i := 0; i < numDirs; i++ {
-		for j := 0; j < r.Intn(numFilesMax); j++ {
-			if j%3 == 0 {
-				if j%3 == 0 {
-					s.AssertFileContent(fmt.Sprintf("public/d%d/ft%d.txt", i, j), fmt.Sprintf("Hellot%d-%d", i, j))
-				}
-				s.AssertFileContent(fmt.Sprintf("public/d%d/f%d.txt", i, j), fmt.Sprintf("Hello%d-%d", i, j))
-			}
-		}
-	}
-
-}
-
-// Issue #8787
-func TestHugoListCommandsWithClockFlag(t *testing.T) {
-	t.Cleanup(func() { htime.Clock = clock.System() })
-
-	c := qt.New(t)
-
-	files := `
--- config.toml --
-baseURL = "https://example.org"
-title = "Hugo Commands"
-timeZone = "UTC"
--- content/past.md --
----
-title: "Past"
-date: 2000-11-06
----
--- content/future.md --
----
-title: "Future"
-date: 2200-11-06
----
--- layouts/_default/single.html --
-Page: {{ .Title }}|
-
-`
-	s := newTestHugoCmdBuilder(c, files, []string{"list", "future"})
-	s.captureOut = true
-	s.Build()
-	p := filepath.Join("content", "future.md")
-	s.AssertStdout(p + ",2200-11-06T00:00:00Z")
-
-	s = newTestHugoCmdBuilder(c, files, []string{"list", "future", "--clock", "2300-11-06"}).Build()
-	s.AssertStdout("")
-}
-
-type testHugoCmdBuilder struct {
-	*qt.C
-
-	fs    afero.Fs
-	dir   string
-	files string
-	args  []string
-
-	captureOut bool
-	out        string
-}
-
-func newTestHugoCmdBuilder(c *qt.C, files string, args []string) *testHugoCmdBuilder {
-	s := &testHugoCmdBuilder{C: c, files: files, args: args}
-	s.dir = s.TempDir()
-	s.fs = afero.NewBasePathFs(hugofs.Os, s.dir)
-
-	return s
-}
-
-func (s *testHugoCmdBuilder) Build() *testHugoCmdBuilder {
-	data := txtar.Parse([]byte(s.files))
-
-	for _, f := range data.Files {
-		filename := filepath.Clean(f.Name)
-		data := bytes.TrimSuffix(f.Data, []byte("\n"))
-		s.Assert(s.fs.MkdirAll(filepath.Dir(filename), 0777), qt.IsNil)
-		s.Assert(afero.WriteFile(s.fs, filename, data, 0666), qt.IsNil)
-	}
-
-	hugoCmd := newCommandsBuilder().addAll().build()
-	cmd := hugoCmd.getCommand()
-	args := append(s.args, "-s="+s.dir, "--quiet")
-	cmd.SetArgs(args)
-
-	if s.captureOut {
-		out, err := captureStdout(func() error {
-			_, err := cmd.ExecuteC()
-			return err
-		})
-		s.Assert(err, qt.IsNil)
-		s.out = out
-	} else {
-		_, err := cmd.ExecuteC()
-		s.Assert(err, qt.IsNil)
-	}
-
-	return s
-}
-
-func (s *testHugoCmdBuilder) AssertFileContent(filename string, matches ...string) {
-	s.Helper()
-	data, err := afero.ReadFile(s.fs, filename)
-	s.Assert(err, qt.IsNil)
-	content := strings.TrimSpace(string(data))
-	for _, m := range matches {
-		lines := strings.Split(m, "\n")
-		for _, match := range lines {
-			match = strings.TrimSpace(match)
-			if match == "" || strings.HasPrefix(match, "#") {
-				continue
-			}
-			s.Assert(content, qt.Contains, match, qt.Commentf(m))
-		}
-	}
-}
-
-func (s *testHugoCmdBuilder) AssertStdout(match string) {
-	s.Helper()
-	content := strings.TrimSpace(s.out)
-	s.Assert(content, qt.Contains, strings.TrimSpace(match))
-}

commands/hugo_windows.go

@@ -1,4 +1,4 @@
-// Copyright 2015 The Hugo Authors. All rights reserved.
+// 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.
@@ -25,9 +25,9 @@ func init() {
 	// This message to show to Windows users if Hugo is opened from explorer.exe
 	cobra.MousetrapHelpText = `
 
-  Hugo is a command-line tool for generating static website.
+  Hugo is a command-line tool for generating static websites.
+
+  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.`
 }

commands/import.go

@@ -1,4 +1,4 @@
-// Copyright 2019 The Hugo Authors. All rights reserved.
+// 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.
@@ -15,9 +15,11 @@ package commands
 
 import (
 	"bytes"
+	"context"
 	"errors"
 	"fmt"
-	"io/ioutil"
+	"io"
+	"log"
 	"os"
 	"path/filepath"
 	"regexp"
@@ -26,241 +28,82 @@ import (
 	"time"
 	"unicode"
 
-	"github.com/gohugoio/hugo/parser/pageparser"
-
+	"github.com/bep/simplecobra"
 	"github.com/gohugoio/hugo/common/htime"
 	"github.com/gohugoio/hugo/common/hugio"
-
-	"github.com/gohugoio/hugo/parser/metadecoders"
-
 	"github.com/gohugoio/hugo/common/maps"
 	"github.com/gohugoio/hugo/helpers"
 	"github.com/gohugoio/hugo/hugofs"
 	"github.com/gohugoio/hugo/parser"
+	"github.com/gohugoio/hugo/parser/metadecoders"
+	"github.com/gohugoio/hugo/parser/pageparser"
 	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
-	jww "github.com/spf13/jwalterweatherman"
 )
 
-var _ cmder = (*importCmd)(nil)
-
-type importCmd struct {
-	*baseCmd
-}
-
-func newImportCmd() *importCmd {
-	cc := &importCmd{}
-
-	cc.baseCmd = newBaseCmd(&cobra.Command{
-		Use:   "import",
-		Short: "Import your site from others.",
-		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`.",
-		RunE: nil,
-	})
-
-	importJekyllCmd := &cobra.Command{
-		Use:   "jekyll",
-		Short: "hugo import from Jekyll",
-		Long: `hugo import from Jekyll.
-
+func newImportCommand() *importCommand {
+	var c *importCommand
+	c = &importCommand{
+		commands: []simplecobra.Commander{
+			&simpleCommand{
+				name:  "jekyll",
+				short: "hugo import from Jekyll",
+				long: `hugo import from Jekyll.
+		
 Import from Jekyll requires two paths, e.g. ` + "`hugo import jekyll jekyll_root_path target_path`.",
-		RunE: cc.importFromJekyll,
-	}
-
-	importJekyllCmd.Flags().Bool("force", false, "allow import into non-empty target directory")
-
-	cc.cmd.AddCommand(importJekyllCmd)
-
-	return cc
-}
-
-func (i *importCmd) importFromJekyll(cmd *cobra.Command, args []string) error {
-	if len(args) < 2 {
-		return newUserError(`import from jekyll requires two paths, e.g. ` + "`hugo import jekyll jekyll_root_path target_path`.")
-	}
-
-	jekyllRoot, err := filepath.Abs(filepath.Clean(args[0]))
-	if err != nil {
-		return newUserError("path error:", args[0])
-	}
-
-	targetDir, err := filepath.Abs(filepath.Clean(args[1]))
-	if err != nil {
-		return newUserError("path error:", args[1])
-	}
-
-	jww.INFO.Println("Import Jekyll from:", jekyllRoot, "to:", targetDir)
-
-	if strings.HasPrefix(filepath.Dir(targetDir), jekyllRoot) {
-		return newUserError("abort: target path should not be inside the Jekyll root")
-	}
-
-	forceImport, _ := cmd.Flags().GetBool("force")
-
-	fs := afero.NewOsFs()
-	jekyllPostDirs, hasAnyPost := i.getJekyllDirInfo(fs, jekyllRoot)
-	if !hasAnyPost {
-		return errors.New("abort: jekyll root contains neither posts nor drafts")
-	}
-
-	err = i.createSiteFromJekyll(jekyllRoot, targetDir, jekyllPostDirs, forceImport)
-
-	if err != nil {
-		return newUserError(err)
-	}
-
-	jww.FEEDBACK.Println("Importing...")
-
-	fileCount := 0
-	callback := func(path string, fi hugofs.FileMetaInfo, err error) error {
-		if err != nil {
-			return err
-		}
-
-		if fi.IsDir() {
-			return nil
-		}
-
-		relPath, err := filepath.Rel(jekyllRoot, path)
-		if err != nil {
-			return newUserError("get rel path error:", path)
-		}
-
-		relPath = filepath.ToSlash(relPath)
-		draft := false
-
-		switch {
-		case strings.Contains(relPath, "_posts/"):
-			relPath = filepath.Join("content/post", strings.Replace(relPath, "_posts/", "", -1))
-		case strings.Contains(relPath, "_drafts/"):
-			relPath = filepath.Join("content/draft", strings.Replace(relPath, "_drafts/", "", -1))
-			draft = true
-		default:
-			return nil
-		}
-
-		fileCount++
-		return convertJekyllPost(path, relPath, targetDir, draft)
-	}
-
-	for jekyllPostDir, hasAnyPostInDir := range jekyllPostDirs {
-		if hasAnyPostInDir {
-			if err = helpers.SymbolicWalk(hugofs.Os, filepath.Join(jekyllRoot, jekyllPostDir), callback); err != nil {
-				return err
-			}
-		}
-	}
-
-	jww.FEEDBACK.Println("Congratulations!", fileCount, "post(s) imported!")
-	jww.FEEDBACK.Println("Now, start Hugo by yourself:\n" +
-		"$ git clone https://github.com/spf13/herring-cove.git " + args[1] + "/themes/herring-cove")
-	jww.FEEDBACK.Println("$ cd " + args[1] + "\n$ hugo server --theme=herring-cove")
-
-	return nil
-}
-
-func (i *importCmd) getJekyllDirInfo(fs afero.Fs, jekyllRoot string) (map[string]bool, bool) {
-	postDirs := make(map[string]bool)
-	hasAnyPost := false
-	if entries, err := ioutil.ReadDir(jekyllRoot); err == nil {
-		for _, entry := range entries {
-			if entry.IsDir() {
-				subDir := filepath.Join(jekyllRoot, entry.Name())
-				if isPostDir, hasAnyPostInDir := i.retrieveJekyllPostDir(fs, subDir); isPostDir {
-					postDirs[entry.Name()] = hasAnyPostInDir
-					if hasAnyPostInDir {
-						hasAnyPost = true
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					if len(args) < 2 {
+						return newUserError(`import from jekyll requires two paths, e.g. ` + "`hugo import jekyll jekyll_root_path target_path`.")
 					}
-				}
-			}
-		}
-	}
-	return postDirs, hasAnyPost
-}
-
-func (i *importCmd) retrieveJekyllPostDir(fs afero.Fs, dir string) (bool, bool) {
-	if strings.HasSuffix(dir, "_posts") || strings.HasSuffix(dir, "_drafts") {
-		isEmpty, _ := helpers.IsEmpty(dir, fs)
-		return true, !isEmpty
-	}
-
-	if entries, err := ioutil.ReadDir(dir); err == nil {
-		for _, entry := range entries {
-			if entry.IsDir() {
-				subDir := filepath.Join(dir, entry.Name())
-				if isPostDir, hasAnyPost := i.retrieveJekyllPostDir(fs, subDir); isPostDir {
-					return isPostDir, hasAnyPost
-				}
-			}
-		}
-	}
-
-	return false, true
-}
-
-func (i *importCmd) createSiteFromJekyll(jekyllRoot, targetDir string, jekyllPostDirs map[string]bool, force bool) error {
-	fs := &afero.OsFs{}
-	if exists, _ := helpers.Exists(targetDir, fs); exists {
-		if isDir, _ := helpers.IsDir(targetDir, fs); !isDir {
-			return errors.New("target path \"" + targetDir + "\" exists but is not a directory")
-		}
-
-		isEmpty, _ := helpers.IsEmpty(targetDir, fs)
-
-		if !isEmpty && !force {
-			return errors.New("target path \"" + targetDir + "\" exists and is not empty")
-		}
-	}
-
-	jekyllConfig := i.loadJekyllConfig(fs, jekyllRoot)
-
-	mkdir(targetDir, "layouts")
-	mkdir(targetDir, "content")
-	mkdir(targetDir, "archetypes")
-	mkdir(targetDir, "static")
-	mkdir(targetDir, "data")
-	mkdir(targetDir, "themes")
-
-	i.createConfigFromJekyll(fs, targetDir, "yaml", jekyllConfig)
-
-	i.copyJekyllFilesAndFolders(jekyllRoot, filepath.Join(targetDir, "static"), jekyllPostDirs)
-
-	return nil
-}
-
-func (i *importCmd) loadJekyllConfig(fs afero.Fs, jekyllRoot string) map[string]any {
-	path := filepath.Join(jekyllRoot, "_config.yml")
-
-	exists, err := helpers.Exists(path, fs)
-
-	if err != nil || !exists {
-		jww.WARN.Println("_config.yaml not found: Is the specified Jekyll root correct?")
-		return nil
-	}
-
-	f, err := fs.Open(path)
-	if err != nil {
-		return nil
-	}
-
-	defer f.Close()
-
-	b, err := ioutil.ReadAll(f)
-	if err != nil {
-		return nil
-	}
-
-	c, err := metadecoders.Default.UnmarshalToMap(b, metadecoders.YAML)
-	if err != nil {
-		return nil
+					return c.importFromJekyll(args)
+				},
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					cmd.Flags().BoolVar(&c.force, "force", false, "allow import into non-empty target directory")
+				},
+			},
+		},
 	}
 
 	return c
 }
 
-func (i *importCmd) createConfigFromJekyll(fs afero.Fs, inpath string, kind metadecoders.Format, jekyllConfig map[string]any) (err error) {
+type importCommand struct {
+	r *rootCommand
+
+	force bool
+
+	commands []simplecobra.Commander
+}
+
+func (c *importCommand) Commands() []simplecobra.Commander {
+	return c.commands
+}
+
+func (c *importCommand) Name() string {
+	return "import"
+}
+
+func (c *importCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
+	return nil
+}
+
+func (c *importCommand) Init(cd *simplecobra.Commandeer) error {
+	cmd := cd.CobraCommand
+	cmd.Short = "Import your site from others."
+	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`."
+
+	cmd.RunE = nil
+	return nil
+}
+
+func (c *importCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
+	c.r = cd.Root.Command.(*rootCommand)
+	return nil
+}
+
+func (i *importCommand) createConfigFromJekyll(fs afero.Fs, inpath string, kind metadecoders.Format, jekyllConfig map[string]any) (err error) {
 	title := "My New Hugo Site"
 	baseURL := "http://example.org/"
 
@@ -293,132 +136,115 @@ func (i *importCmd) createConfigFromJekyll(fs afero.Fs, inpath string, kind meta
 		return err
 	}
 
-	return helpers.WriteToDisk(filepath.Join(inpath, "config."+string(kind)), &buf, fs)
+	return helpers.WriteToDisk(filepath.Join(inpath, "hugo."+string(kind)), &buf, fs)
 }
 
-func (i *importCmd) copyJekyllFilesAndFolders(jekyllRoot, dest string, jekyllPostDirs map[string]bool) (err error) {
-	fs := hugofs.Os
-
-	fi, err := fs.Stat(jekyllRoot)
-	if err != nil {
-		return err
-	}
-	if !fi.IsDir() {
-		return errors.New(jekyllRoot + " is not a directory")
-	}
-	err = os.MkdirAll(dest, fi.Mode())
-	if err != nil {
-		return err
-	}
-	entries, err := ioutil.ReadDir(jekyllRoot)
-	if err != nil {
-		return err
-	}
-
-	for _, entry := range entries {
-		sfp := filepath.Join(jekyllRoot, entry.Name())
-		dfp := filepath.Join(dest, entry.Name())
-		if entry.IsDir() {
-			if entry.Name()[0] != '_' && entry.Name()[0] != '.' {
-				if _, ok := jekyllPostDirs[entry.Name()]; !ok {
-					err = hugio.CopyDir(fs, sfp, dfp, nil)
-					if err != nil {
-						jww.ERROR.Println(err)
+func (c *importCommand) getJekyllDirInfo(fs afero.Fs, jekyllRoot string) (map[string]bool, bool) {
+	postDirs := make(map[string]bool)
+	hasAnyPost := false
+	if entries, err := os.ReadDir(jekyllRoot); err == nil {
+		for _, entry := range entries {
+			if entry.IsDir() {
+				subDir := filepath.Join(jekyllRoot, entry.Name())
+				if isPostDir, hasAnyPostInDir := c.retrieveJekyllPostDir(fs, subDir); isPostDir {
+					postDirs[entry.Name()] = hasAnyPostInDir
+					if hasAnyPostInDir {
+						hasAnyPost = true
 					}
 				}
 			}
-		} else {
-			lowerEntryName := strings.ToLower(entry.Name())
-			exceptSuffix := []string{
-				".md", ".markdown", ".html", ".htm",
-				".xml", ".textile", "rakefile", "gemfile", ".lock",
-			}
-			isExcept := false
-			for _, suffix := range exceptSuffix {
-				if strings.HasSuffix(lowerEntryName, suffix) {
-					isExcept = true
-					break
-				}
-			}
+		}
+	}
+	return postDirs, hasAnyPost
+}
 
-			if !isExcept && entry.Name()[0] != '.' && entry.Name()[0] != '_' {
-				err = hugio.CopyFile(fs, sfp, dfp)
-				if err != nil {
-					jww.ERROR.Println(err)
-				}
-			}
+func (c *importCommand) createSiteFromJekyll(jekyllRoot, targetDir string, jekyllPostDirs map[string]bool) error {
+	fs := &afero.OsFs{}
+	if exists, _ := helpers.Exists(targetDir, fs); exists {
+		if isDir, _ := helpers.IsDir(targetDir, fs); !isDir {
+			return errors.New("target path \"" + targetDir + "\" exists but is not a directory")
 		}
 
-	}
-	return nil
-}
+		isEmpty, _ := helpers.IsEmpty(targetDir, fs)
 
-func parseJekyllFilename(filename string) (time.Time, string, error) {
-	re := regexp.MustCompile(`(\d+-\d+-\d+)-(.+)\..*`)
-	r := re.FindAllStringSubmatch(filename, -1)
-	if len(r) == 0 {
-		return htime.Now(), "", errors.New("filename not match")
+		if !isEmpty && !c.force {
+			return errors.New("target path \"" + targetDir + "\" exists and is not empty")
+		}
 	}
 
-	postDate, err := time.Parse("2006-1-2", r[0][1])
-	if err != nil {
-		return htime.Now(), "", err
-	}
+	jekyllConfig := c.loadJekyllConfig(fs, jekyllRoot)
 
-	postName := r[0][2]
+	mkdir(targetDir, "layouts")
+	mkdir(targetDir, "content")
+	mkdir(targetDir, "archetypes")
+	mkdir(targetDir, "static")
+	mkdir(targetDir, "data")
+	mkdir(targetDir, "themes")
 
-	return postDate, postName, nil
-}
+	c.createConfigFromJekyll(fs, targetDir, "yaml", jekyllConfig)
 
-func convertJekyllPost(path, relPath, targetDir string, draft bool) error {
-	jww.TRACE.Println("Converting", path)
-
-	filename := filepath.Base(path)
-	postDate, postName, err := parseJekyllFilename(filename)
-	if err != nil {
-		jww.WARN.Printf("Failed to parse filename '%s': %s. Skipping.", filename, err)
-		return nil
-	}
-
-	jww.TRACE.Println(filename, postDate, postName)
-
-	targetFile := filepath.Join(targetDir, relPath)
-	targetParentDir := filepath.Dir(targetFile)
-	os.MkdirAll(targetParentDir, 0777)
-
-	contentBytes, err := ioutil.ReadFile(path)
-	if err != nil {
-		jww.ERROR.Println("Read file error:", path)
-		return err
-	}
-
-	pf, err := pageparser.ParseFrontMatterAndContent(bytes.NewReader(contentBytes))
-	if err != nil {
-		jww.ERROR.Println("Parse file error:", path)
-		return err
-	}
-
-	newmetadata, err := convertJekyllMetaData(pf.FrontMatter, postName, postDate, draft)
-	if err != nil {
-		jww.ERROR.Println("Convert metadata error:", path)
-		return err
-	}
-
-	content, err := convertJekyllContent(newmetadata, string(pf.Content))
-	if err != nil {
-		jww.ERROR.Println("Converting Jekyll error:", path)
-		return err
-	}
-
-	fs := hugofs.Os
-	if err := helpers.WriteToDisk(targetFile, strings.NewReader(content), fs); err != nil {
-		return fmt.Errorf("failed to save file %q: %s", filename, err)
-	}
+	c.copyJekyllFilesAndFolders(jekyllRoot, filepath.Join(targetDir, "static"), jekyllPostDirs)
 
 	return nil
 }
 
-func convertJekyllMetaData(m any, postName string, postDate time.Time, draft bool) (any, error) {
+func (c *importCommand) convertJekyllContent(m any, content string) (string, error) {
+	metadata, _ := maps.ToStringMapE(m)
+
+	lines := strings.Split(content, "\n")
+	var resultLines []string
+	for _, line := range lines {
+		resultLines = append(resultLines, strings.Trim(line, "\r\n"))
+	}
+
+	content = strings.Join(resultLines, "\n")
+
+	excerptSep := "<!--more-->"
+	if value, ok := metadata["excerpt_separator"]; ok {
+		if str, strOk := value.(string); strOk {
+			content = strings.Replace(content, strings.TrimSpace(str), excerptSep, -1)
+		}
+	}
+
+	replaceList := []struct {
+		re      *regexp.Regexp
+		replace string
+	}{
+		{regexp.MustCompile("(?i)<!-- more -->"), "<!--more-->"},
+		{regexp.MustCompile(`\{%\s*raw\s*%\}\s*(.*?)\s*\{%\s*endraw\s*%\}`), "$1"},
+		{regexp.MustCompile(`{%\s*endhighlight\s*%}`), "{{< / highlight >}}"},
+	}
+
+	for _, replace := range replaceList {
+		content = replace.re.ReplaceAllString(content, replace.replace)
+	}
+
+	replaceListFunc := []struct {
+		re      *regexp.Regexp
+		replace func(string) string
+	}{
+		// Octopress image tag: http://octopress.org/docs/plugins/image-tag/
+		{regexp.MustCompile(`{%\s+img\s*(.*?)\s*%}`), c.replaceImageTag},
+		{regexp.MustCompile(`{%\s*highlight\s*(.*?)\s*%}`), c.replaceHighlightTag},
+	}
+
+	for _, replace := range replaceListFunc {
+		content = replace.re.ReplaceAllStringFunc(content, replace.replace)
+	}
+
+	var buf bytes.Buffer
+	if len(metadata) != 0 {
+		err := parser.InterfaceToFrontMatter(m, metadecoders.YAML, &buf)
+		if err != nil {
+			return "", err
+		}
+	}
+	buf.WriteString(content)
+
+	return buf.String(), nil
+}
+
+func (c *importCommand) convertJekyllMetaData(m any, postName string, postDate time.Time, draft bool) (any, error) {
 	metadata, err := maps.ToStringMapE(m)
 	if err != nil {
 		return nil, err
@@ -470,63 +296,230 @@ func convertJekyllMetaData(m any, postName string, postDate time.Time, draft boo
 	return metadata, nil
 }
 
-func convertJekyllContent(m any, content string) (string, error) {
-	metadata, _ := maps.ToStringMapE(m)
+func (c *importCommand) convertJekyllPost(path, relPath, targetDir string, draft bool) error {
+	log.Println("Converting", path)
 
-	lines := strings.Split(content, "\n")
-	var resultLines []string
-	for _, line := range lines {
-		resultLines = append(resultLines, strings.Trim(line, "\r\n"))
+	filename := filepath.Base(path)
+	postDate, postName, err := c.parseJekyllFilename(filename)
+	if err != nil {
+		c.r.Printf("Failed to parse filename '%s': %s. Skipping.", filename, err)
+		return nil
 	}
 
-	content = strings.Join(resultLines, "\n")
+	log.Println(filename, postDate, postName)
 
-	excerptSep := "<!--more-->"
-	if value, ok := metadata["excerpt_separator"]; ok {
-		if str, strOk := value.(string); strOk {
-			content = strings.Replace(content, strings.TrimSpace(str), excerptSep, -1)
-		}
+	targetFile := filepath.Join(targetDir, relPath)
+	targetParentDir := filepath.Dir(targetFile)
+	os.MkdirAll(targetParentDir, 0o777)
+
+	contentBytes, err := os.ReadFile(path)
+	if err != nil {
+		c.r.logger.Errorln("Read file error:", path)
+		return err
+	}
+	pf, err := pageparser.ParseFrontMatterAndContent(bytes.NewReader(contentBytes))
+	if err != nil {
+		return fmt.Errorf("failed to parse file %q: %s", filename, err)
+	}
+	newmetadata, err := c.convertJekyllMetaData(pf.FrontMatter, postName, postDate, draft)
+	if err != nil {
+		return fmt.Errorf("failed to convert metadata for file %q: %s", filename, err)
 	}
 
-	replaceList := []struct {
-		re      *regexp.Regexp
-		replace string
-	}{
-		{regexp.MustCompile("(?i)<!-- more -->"), "<!--more-->"},
-		{regexp.MustCompile(`\{%\s*raw\s*%\}\s*(.*?)\s*\{%\s*endraw\s*%\}`), "$1"},
-		{regexp.MustCompile(`{%\s*endhighlight\s*%}`), "{{< / highlight >}}"},
+	content, err := c.convertJekyllContent(newmetadata, string(pf.Content))
+	if err != nil {
+		return fmt.Errorf("failed to convert content for file %q: %s", filename, err)
 	}
 
-	for _, replace := range replaceList {
-		content = replace.re.ReplaceAllString(content, replace.replace)
+	fs := hugofs.Os
+	if err := helpers.WriteToDisk(targetFile, strings.NewReader(content), fs); err != nil {
+		return fmt.Errorf("failed to save file %q: %s", filename, err)
 	}
-
-	replaceListFunc := []struct {
-		re      *regexp.Regexp
-		replace func(string) string
-	}{
-		// Octopress image tag: http://octopress.org/docs/plugins/image-tag/
-		{regexp.MustCompile(`{%\s+img\s*(.*?)\s*%}`), replaceImageTag},
-		{regexp.MustCompile(`{%\s*highlight\s*(.*?)\s*%}`), replaceHighlightTag},
-	}
-
-	for _, replace := range replaceListFunc {
-		content = replace.re.ReplaceAllStringFunc(content, replace.replace)
-	}
-
-	var buf bytes.Buffer
-	if len(metadata) != 0 {
-		err := parser.InterfaceToFrontMatter(m, metadecoders.YAML, &buf)
-		if err != nil {
-			return "", err
-		}
-	}
-	buf.WriteString(content)
-
-	return buf.String(), nil
+	return nil
 }
 
-func replaceHighlightTag(match string) string {
+func (c *importCommand) copyJekyllFilesAndFolders(jekyllRoot, dest string, jekyllPostDirs map[string]bool) (err error) {
+	fs := hugofs.Os
+
+	fi, err := fs.Stat(jekyllRoot)
+	if err != nil {
+		return err
+	}
+	if !fi.IsDir() {
+		return errors.New(jekyllRoot + " is not a directory")
+	}
+	err = os.MkdirAll(dest, fi.Mode())
+	if err != nil {
+		return err
+	}
+	entries, err := os.ReadDir(jekyllRoot)
+	if err != nil {
+		return err
+	}
+
+	for _, entry := range entries {
+		sfp := filepath.Join(jekyllRoot, entry.Name())
+		dfp := filepath.Join(dest, entry.Name())
+		if entry.IsDir() {
+			if entry.Name()[0] != '_' && entry.Name()[0] != '.' {
+				if _, ok := jekyllPostDirs[entry.Name()]; !ok {
+					err = hugio.CopyDir(fs, sfp, dfp, nil)
+					if err != nil {
+						c.r.logger.Errorln(err)
+					}
+				}
+			}
+		} else {
+			lowerEntryName := strings.ToLower(entry.Name())
+			exceptSuffix := []string{
+				".md", ".markdown", ".html", ".htm",
+				".xml", ".textile", "rakefile", "gemfile", ".lock",
+			}
+			isExcept := false
+			for _, suffix := range exceptSuffix {
+				if strings.HasSuffix(lowerEntryName, suffix) {
+					isExcept = true
+					break
+				}
+			}
+
+			if !isExcept && entry.Name()[0] != '.' && entry.Name()[0] != '_' {
+				err = hugio.CopyFile(fs, sfp, dfp)
+				if err != nil {
+					c.r.logger.Errorln(err)
+				}
+			}
+		}
+
+	}
+	return nil
+}
+
+func (c *importCommand) importFromJekyll(args []string) error {
+	jekyllRoot, err := filepath.Abs(filepath.Clean(args[0]))
+	if err != nil {
+		return newUserError("path error:", args[0])
+	}
+
+	targetDir, err := filepath.Abs(filepath.Clean(args[1]))
+	if err != nil {
+		return newUserError("path error:", args[1])
+	}
+
+	c.r.Println("Import Jekyll from:", jekyllRoot, "to:", targetDir)
+
+	if strings.HasPrefix(filepath.Dir(targetDir), jekyllRoot) {
+		return newUserError("abort: target path should not be inside the Jekyll root")
+	}
+
+	fs := afero.NewOsFs()
+	jekyllPostDirs, hasAnyPost := c.getJekyllDirInfo(fs, jekyllRoot)
+	if !hasAnyPost {
+		return errors.New("abort: jekyll root contains neither posts nor drafts")
+	}
+
+	err = c.createSiteFromJekyll(jekyllRoot, targetDir, jekyllPostDirs)
+	if err != nil {
+		return newUserError(err)
+	}
+
+	c.r.Println("Importing...")
+
+	fileCount := 0
+	callback := func(path string, fi hugofs.FileMetaInfo) error {
+		if fi.IsDir() {
+			return nil
+		}
+
+		relPath, err := filepath.Rel(jekyllRoot, path)
+		if err != nil {
+			return newUserError("get rel path error:", path)
+		}
+
+		relPath = filepath.ToSlash(relPath)
+		draft := false
+
+		switch {
+		case strings.Contains(relPath, "_posts/"):
+			relPath = filepath.Join("content/post", strings.Replace(relPath, "_posts/", "", -1))
+		case strings.Contains(relPath, "_drafts/"):
+			relPath = filepath.Join("content/draft", strings.Replace(relPath, "_drafts/", "", -1))
+			draft = true
+		default:
+			return nil
+		}
+
+		fileCount++
+		return c.convertJekyllPost(path, relPath, targetDir, draft)
+	}
+
+	for jekyllPostDir, hasAnyPostInDir := range jekyllPostDirs {
+		if hasAnyPostInDir {
+			if err = helpers.Walk(hugofs.Os, filepath.Join(jekyllRoot, jekyllPostDir), callback); err != nil {
+				return err
+			}
+		}
+	}
+
+	c.r.Println("Congratulations!", fileCount, "post(s) imported!")
+	c.r.Println("Now, start Hugo by yourself:\n")
+	c.r.Println("cd " + args[1])
+	c.r.Println("git init")
+	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
+}
+
+func (c *importCommand) loadJekyllConfig(fs afero.Fs, jekyllRoot string) map[string]any {
+	path := filepath.Join(jekyllRoot, "_config.yml")
+
+	exists, err := helpers.Exists(path, fs)
+
+	if err != nil || !exists {
+		c.r.Println("_config.yaml not found: Is the specified Jekyll root correct?")
+		return nil
+	}
+
+	f, err := fs.Open(path)
+	if err != nil {
+		return nil
+	}
+
+	defer f.Close()
+
+	b, err := io.ReadAll(f)
+	if err != nil {
+		return nil
+	}
+
+	m, err := metadecoders.Default.UnmarshalToMap(b, metadecoders.YAML)
+	if err != nil {
+		return nil
+	}
+
+	return m
+}
+
+func (c *importCommand) parseJekyllFilename(filename string) (time.Time, string, error) {
+	re := regexp.MustCompile(`(\d+-\d+-\d+)-(.+)\..*`)
+	r := re.FindAllStringSubmatch(filename, -1)
+	if len(r) == 0 {
+		return htime.Now(), "", errors.New("filename not match")
+	}
+
+	postDate, err := time.Parse("2006-1-2", r[0][1])
+	if err != nil {
+		return htime.Now(), "", err
+	}
+
+	postName := r[0][2]
+
+	return postDate, postName, nil
+}
+
+func (c *importCommand) replaceHighlightTag(match string) string {
 	r := regexp.MustCompile(`{%\s*highlight\s*(.*?)\s*%}`)
 	parts := r.FindStringSubmatch(match)
 	lastQuote := rune(0)
@@ -570,35 +563,55 @@ func replaceHighlightTag(match string) string {
 	return result.String()
 }
 
-func replaceImageTag(match string) string {
+func (c *importCommand) replaceImageTag(match string) string {
 	r := regexp.MustCompile(`{%\s+img\s*(\p{L}*)\s+([\S]*/[\S]+)\s+(\d*)\s*(\d*)\s*(.*?)\s*%}`)
 	result := bytes.NewBufferString("{{< figure ")
 	parts := r.FindStringSubmatch(match)
 	// Index 0 is the entire string, ignore
-	replaceOptionalPart(result, "class", parts[1])
-	replaceOptionalPart(result, "src", parts[2])
-	replaceOptionalPart(result, "width", parts[3])
-	replaceOptionalPart(result, "height", parts[4])
+	c.replaceOptionalPart(result, "class", parts[1])
+	c.replaceOptionalPart(result, "src", parts[2])
+	c.replaceOptionalPart(result, "width", parts[3])
+	c.replaceOptionalPart(result, "height", parts[4])
 	// title + alt
 	part := parts[5]
 	if len(part) > 0 {
 		splits := strings.Split(part, "'")
 		lenSplits := len(splits)
 		if lenSplits == 1 {
-			replaceOptionalPart(result, "title", splits[0])
+			c.replaceOptionalPart(result, "title", splits[0])
 		} else if lenSplits == 3 {
-			replaceOptionalPart(result, "title", splits[1])
+			c.replaceOptionalPart(result, "title", splits[1])
 		} else if lenSplits == 5 {
-			replaceOptionalPart(result, "title", splits[1])
-			replaceOptionalPart(result, "alt", splits[3])
+			c.replaceOptionalPart(result, "title", splits[1])
+			c.replaceOptionalPart(result, "alt", splits[3])
 		}
 	}
 	result.WriteString(">}}")
 	return result.String()
 }
 
-func replaceOptionalPart(buffer *bytes.Buffer, partName string, part string) {
+func (c *importCommand) replaceOptionalPart(buffer *bytes.Buffer, partName string, part string) {
 	if len(part) > 0 {
 		buffer.WriteString(partName + "=\"" + part + "\" ")
 	}
 }
+
+func (c *importCommand) retrieveJekyllPostDir(fs afero.Fs, dir string) (bool, bool) {
+	if strings.HasSuffix(dir, "_posts") || strings.HasSuffix(dir, "_drafts") {
+		isEmpty, _ := helpers.IsEmpty(dir, fs)
+		return true, !isEmpty
+	}
+
+	if entries, err := os.ReadDir(dir); err == nil {
+		for _, entry := range entries {
+			if entry.IsDir() {
+				subDir := filepath.Join(dir, entry.Name())
+				if isPostDir, hasAnyPost := c.retrieveJekyllPostDir(fs, subDir); isPostDir {
+					return isPostDir, hasAnyPost
+				}
+			}
+		}
+	}
+
+	return false, true
+}

commands/import_jekyll_test.go

@@ -1,177 +0,0 @@
-// Copyright 2015 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 (
-	"encoding/json"
-	"testing"
-	"time"
-
-	qt "github.com/frankban/quicktest"
-)
-
-func TestParseJekyllFilename(t *testing.T) {
-	c := qt.New(t)
-	filenameArray := []string{
-		"2015-01-02-test.md",
-		"2012-03-15-中文.markup",
-	}
-
-	expectResult := []struct {
-		postDate time.Time
-		postName string
-	}{
-		{time.Date(2015, time.January, 2, 0, 0, 0, 0, time.UTC), "test"},
-		{time.Date(2012, time.March, 15, 0, 0, 0, 0, time.UTC), "中文"},
-	}
-
-	for i, filename := range filenameArray {
-		postDate, postName, err := parseJekyllFilename(filename)
-		c.Assert(err, qt.IsNil)
-		c.Assert(expectResult[i].postDate.Format("2006-01-02"), qt.Equals, postDate.Format("2006-01-02"))
-		c.Assert(expectResult[i].postName, qt.Equals, postName)
-	}
-}
-
-func TestConvertJekyllMetadata(t *testing.T) {
-	c := qt.New(t)
-	testDataList := []struct {
-		metadata any
-		postName string
-		postDate time.Time
-		draft    bool
-		expect   string
-	}{
-		{
-			map[any]any{},
-			"testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false,
-			`{"date":"2015-10-01T00:00:00Z"}`,
-		},
-		{
-			map[any]any{},
-			"testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), true,
-			`{"date":"2015-10-01T00:00:00Z","draft":true}`,
-		},
-		{
-			map[any]any{"Permalink": "/permalink.html", "layout": "post"},
-			"testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false,
-			`{"date":"2015-10-01T00:00:00Z","url":"/permalink.html"}`,
-		},
-		{
-			map[any]any{"permalink": "/permalink.html"},
-			"testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false,
-			`{"date":"2015-10-01T00:00:00Z","url":"/permalink.html"}`,
-		},
-		{
-			map[any]any{"category": nil, "permalink": 123},
-			"testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false,
-			`{"date":"2015-10-01T00:00:00Z"}`,
-		},
-		{
-			map[any]any{"Excerpt_Separator": "sep"},
-			"testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false,
-			`{"date":"2015-10-01T00:00:00Z","excerpt_separator":"sep"}`,
-		},
-		{
-			map[any]any{"category": "book", "layout": "post", "Others": "Goods", "Date": "2015-10-01 12:13:11"},
-			"testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false,
-			`{"Others":"Goods","categories":["book"],"date":"2015-10-01T12:13:11Z"}`,
-		},
-	}
-
-	for _, data := range testDataList {
-		result, err := convertJekyllMetaData(data.metadata, data.postName, data.postDate, data.draft)
-		c.Assert(err, qt.IsNil)
-		jsonResult, err := json.Marshal(result)
-		c.Assert(err, qt.IsNil)
-		c.Assert(string(jsonResult), qt.Equals, data.expect)
-	}
-}
-
-func TestConvertJekyllContent(t *testing.T) {
-	c := qt.New(t)
-	testDataList := []struct {
-		metadata any
-		content  string
-		expect   string
-	}{
-		{
-			map[any]any{},
-			"Test content\r\n<!-- more -->\npart2 content", "Test content\n<!--more-->\npart2 content",
-		},
-		{
-			map[any]any{},
-			"Test content\n<!-- More -->\npart2 content", "Test content\n<!--more-->\npart2 content",
-		},
-		{
-			map[any]any{"excerpt_separator": "<!--sep-->"},
-			"Test content\n<!--sep-->\npart2 content",
-			"---\nexcerpt_separator: <!--sep-->\n---\nTest content\n<!--more-->\npart2 content",
-		},
-		{map[any]any{}, "{% raw %}text{% endraw %}", "text"},
-		{map[any]any{}, "{%raw%} text2 {%endraw %}", "text2"},
-		{
-			map[any]any{},
-			"{% highlight go %}\nvar s int\n{% endhighlight %}",
-			"{{< highlight go >}}\nvar s int\n{{< / highlight >}}",
-		},
-		{
-			map[any]any{},
-			"{% highlight go linenos hl_lines=\"1 2\" %}\nvar s string\nvar i int\n{% endhighlight %}",
-			"{{< highlight go \"linenos=table,hl_lines=1 2\" >}}\nvar s string\nvar i int\n{{< / highlight >}}",
-		},
-
-		// Octopress image tag
-		{
-			map[any]any{},
-			"{% img http://placekitten.com/890/280 %}",
-			"{{< figure src=\"http://placekitten.com/890/280\" >}}",
-		},
-		{
-			map[any]any{},
-			"{% img left http://placekitten.com/320/250 Place Kitten #2 %}",
-			"{{< figure class=\"left\" src=\"http://placekitten.com/320/250\" title=\"Place Kitten #2\" >}}",
-		},
-		{
-			map[any]any{},
-			"{% img right http://placekitten.com/300/500 150 250 'Place Kitten #3' %}",
-			"{{< figure class=\"right\" src=\"http://placekitten.com/300/500\" width=\"150\" height=\"250\" title=\"Place Kitten #3\" >}}",
-		},
-		{
-			map[any]any{},
-			"{% img right http://placekitten.com/300/500 150 250 'Place Kitten #4' 'An image of a very cute kitten' %}",
-			"{{< figure class=\"right\" src=\"http://placekitten.com/300/500\" width=\"150\" height=\"250\" title=\"Place Kitten #4\" alt=\"An image of a very cute kitten\" >}}",
-		},
-		{
-			map[any]any{},
-			"{% img http://placekitten.com/300/500 150 250 'Place Kitten #4' 'An image of a very cute kitten' %}",
-			"{{< figure src=\"http://placekitten.com/300/500\" width=\"150\" height=\"250\" title=\"Place Kitten #4\" alt=\"An image of a very cute kitten\" >}}",
-		},
-		{
-			map[any]any{},
-			"{% img right /placekitten/300/500 'Place Kitten #4' 'An image of a very cute kitten' %}",
-			"{{< figure class=\"right\" src=\"/placekitten/300/500\" title=\"Place Kitten #4\" alt=\"An image of a very cute kitten\" >}}",
-		},
-		{
-			map[any]any{"category": "book", "layout": "post", "Date": "2015-10-01 12:13:11"},
-			"somecontent",
-			"---\nDate: \"2015-10-01 12:13:11\"\ncategory: book\nlayout: post\n---\nsomecontent",
-		},
-	}
-	for _, data := range testDataList {
-		result, err := convertJekyllContent(data.metadata, data.content)
-		c.Assert(result, qt.Equals, data.expect)
-		c.Assert(err, qt.IsNil)
-	}
-}

commands/limit_darwin.go

@@ -1,84 +0,0 @@
-// 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 commands
-
-import (
-	"syscall"
-
-	"github.com/spf13/cobra"
-	jww "github.com/spf13/jwalterweatherman"
-)
-
-var _ cmder = (*limitCmd)(nil)
-
-type limitCmd struct {
-	*baseCmd
-}
-
-func newLimitCmd() *limitCmd {
-	ccmd := &cobra.Command{
-		Use:   "ulimit",
-		Short: "Check system ulimit settings",
-		Long: `Hugo will inspect the current ulimit settings on the system.
-This is primarily to ensure that Hugo can watch enough files on some OSs`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			var rLimit syscall.Rlimit
-			err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit)
-			if err != nil {
-				return newSystemError("Error Getting rlimit ", err)
-			}
-
-			jww.FEEDBACK.Println("Current rLimit:", rLimit)
-
-			if rLimit.Cur >= newRlimit {
-				return nil
-			}
-
-			jww.FEEDBACK.Println("Attempting to increase limit")
-			rLimit.Cur = newRlimit
-			err = syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit)
-			if err != nil {
-				return newSystemError("Error Setting rLimit ", err)
-			}
-			err = syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit)
-			if err != nil {
-				return newSystemError("Error Getting rLimit ", err)
-			}
-			jww.FEEDBACK.Println("rLimit after change:", rLimit)
-
-			return nil
-		},
-	}
-
-	return &limitCmd{baseCmd: newBaseCmd(ccmd)}
-}
-
-const newRlimit = 10240
-
-func tweakLimit() {
-	var rLimit syscall.Rlimit
-	err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit)
-	if err != nil {
-		jww.WARN.Println("Unable to get rlimit:", err)
-		return
-	}
-	if rLimit.Cur < newRlimit {
-		rLimit.Cur = newRlimit
-		err = syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit)
-		if err != nil {
-			// This may not succeed, see https://github.com/golang/go/issues/30401
-			jww.INFO.Println("Unable to increase number of open files limit:", err)
-		}
-	}
-}

commands/list.go

@@ -1,4 +1,4 @@
-// Copyright 2019 The Hugo Authors. All rights reserved.
+// 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.
@@ -14,197 +14,173 @@
 package commands
 
 import (
+	"context"
 	"encoding/csv"
 	"os"
+	"path/filepath"
 	"strconv"
 	"strings"
 	"time"
 
+	"github.com/bep/simplecobra"
+	"github.com/gohugoio/hugo/config"
 	"github.com/gohugoio/hugo/hugolib"
+	"github.com/gohugoio/hugo/resources/page"
 	"github.com/gohugoio/hugo/resources/resource"
-	"github.com/spf13/cobra"
-	jww "github.com/spf13/jwalterweatherman"
 )
 
-var _ cmder = (*listCmd)(nil)
-
-type listCmd struct {
-	*baseBuilderCmd
-}
-
-func (lc *listCmd) buildSites(config map[string]any) (*hugolib.HugoSites, error) {
-	cfgInit := func(c *commandeer) error {
-		for key, value := range config {
-			c.Set(key, value)
+// newListCommand creates a new list command and its subcommands.
+func newListCommand() *listCommand {
+	createRecord := func(workingDir string, p page.Page) []string {
+		return []string{
+			filepath.ToSlash(strings.TrimPrefix(p.File().Filename(), workingDir+string(os.PathSeparator))),
+			p.Slug(),
+			p.Title(),
+			p.Date().Format(time.RFC3339),
+			p.ExpiryDate().Format(time.RFC3339),
+			p.PublishDate().Format(time.RFC3339),
+			strconv.FormatBool(p.Draft()),
+			p.Permalink(),
 		}
+	}
+
+	list := func(cd *simplecobra.Commandeer, r *rootCommand, shouldInclude func(page.Page) bool, opts ...any) error {
+		bcfg := hugolib.BuildCfg{SkipRender: true}
+		cfg := config.New()
+		for i := 0; i < len(opts); i += 2 {
+			cfg.Set(opts[i].(string), opts[i+1])
+		}
+		h, err := r.Build(cd, bcfg, cfg)
+		if err != nil {
+			return err
+		}
+
+		writer := csv.NewWriter(r.Out)
+		defer writer.Flush()
+
+		writer.Write([]string{
+			"path",
+			"slug",
+			"title",
+			"date",
+			"expiryDate",
+			"publishDate",
+			"draft",
+			"permalink",
+		})
+
+		for _, p := range h.Pages() {
+			if shouldInclude(p) {
+				record := createRecord(h.Conf.BaseConfig().WorkingDir, p)
+				if err := writer.Write(record); err != nil {
+					return err
+				}
+				if err != nil {
+					return err
+				}
+			}
+		}
+
 		return nil
 	}
 
-	c, err := initializeConfig(true, true, false, &lc.hugoBuilderCommon, lc, cfgInit)
-	if err != nil {
-		return nil, err
+	return &listCommand{
+		commands: []simplecobra.Commander{
+			&simpleCommand{
+				name:  "drafts",
+				short: "List all drafts",
+				long:  `List all of the drafts in your content directory.`,
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					shouldInclude := func(p page.Page) bool {
+						if !p.Draft() || p.File() == nil {
+							return false
+						}
+						return true
+					}
+					return list(cd, r, shouldInclude,
+						"buildDrafts", true,
+						"buildFuture", true,
+						"buildExpired", true,
+					)
+				},
+			},
+			&simpleCommand{
+				name:  "future",
+				short: "List all posts dated in the future",
+				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 {
+					shouldInclude := func(p page.Page) bool {
+						if !resource.IsFuture(p) || p.File() == nil {
+							return false
+						}
+						return true
+					}
+					return list(cd, r, shouldInclude,
+						"buildFuture", true,
+						"buildDrafts", true,
+					)
+				},
+			},
+			&simpleCommand{
+				name:  "expired",
+				short: "List all posts already expired",
+				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 {
+					shouldInclude := func(p page.Page) bool {
+						if !resource.IsExpired(p) || p.File() == nil {
+							return false
+						}
+						return true
+					}
+					return list(cd, r, shouldInclude,
+						"buildExpired", true,
+						"buildDrafts", true,
+					)
+				},
+			},
+			&simpleCommand{
+				name:  "all",
+				short: "List all posts",
+				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 {
+					shouldInclude := func(p page.Page) bool {
+						return p.File() != nil
+					}
+					return list(cd, r, shouldInclude, "buildDrafts", true, "buildFuture", true, "buildExpired", true)
+				},
+			},
+		},
 	}
-
-	sites, err := hugolib.NewHugoSites(*c.DepsCfg)
-	if err != nil {
-		return nil, newSystemError("Error creating sites", err)
-	}
-
-	if err := sites.Build(hugolib.BuildCfg{SkipRender: true}); err != nil {
-		return nil, newSystemError("Error Processing Source Content", err)
-	}
-
-	return sites, nil
 }
 
-func (b *commandsBuilder) newListCmd() *listCmd {
-	cc := &listCmd{}
-
-	cmd := &cobra.Command{
-		Use:   "list",
-		Short: "Listing out various types of content",
-		Long: `Listing out various types of content.
-
-List requires a subcommand, e.g. ` + "`hugo list drafts`.",
-		RunE: nil,
-	}
-
-	cmd.AddCommand(
-		&cobra.Command{
-			Use:   "drafts",
-			Short: "List all drafts",
-			Long:  `List all of the drafts in your content directory.`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				sites, err := cc.buildSites(map[string]any{"buildDrafts": true})
-				if err != nil {
-					return newSystemError("Error building sites", err)
-				}
-
-				for _, p := range sites.Pages() {
-					if p.Draft() {
-						jww.FEEDBACK.Println(strings.TrimPrefix(p.File().Filename(), sites.WorkingDir+string(os.PathSeparator)))
-					}
-				}
-
-				return nil
-			},
-		},
-		&cobra.Command{
-			Use:   "future",
-			Short: "List all posts dated in the future",
-			Long:  `List all of the posts in your content directory which will be posted in the future.`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				sites, err := cc.buildSites(map[string]any{"buildFuture": true})
-				if err != nil {
-					return newSystemError("Error building sites", err)
-				}
-
-				if err != nil {
-					return newSystemError("Error building sites", err)
-				}
-
-				writer := csv.NewWriter(os.Stdout)
-				defer writer.Flush()
-
-				for _, p := range sites.Pages() {
-					if resource.IsFuture(p) {
-						err := writer.Write([]string{
-							strings.TrimPrefix(p.File().Filename(), sites.WorkingDir+string(os.PathSeparator)),
-							p.PublishDate().Format(time.RFC3339),
-						})
-						if err != nil {
-							return newSystemError("Error writing future posts to stdout", err)
-						}
-					}
-				}
-
-				return nil
-			},
-		},
-		&cobra.Command{
-			Use:   "expired",
-			Short: "List all posts already expired",
-			Long:  `List all of the posts in your content directory which has already expired.`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				sites, err := cc.buildSites(map[string]any{"buildExpired": true})
-				if err != nil {
-					return newSystemError("Error building sites", err)
-				}
-
-				if err != nil {
-					return newSystemError("Error building sites", err)
-				}
-
-				writer := csv.NewWriter(os.Stdout)
-				defer writer.Flush()
-
-				for _, p := range sites.Pages() {
-					if resource.IsExpired(p) {
-						err := writer.Write([]string{
-							strings.TrimPrefix(p.File().Filename(), sites.WorkingDir+string(os.PathSeparator)),
-							p.ExpiryDate().Format(time.RFC3339),
-						})
-						if err != nil {
-							return newSystemError("Error writing expired posts to stdout", err)
-						}
-					}
-				}
-
-				return nil
-			},
-		},
-		&cobra.Command{
-			Use:   "all",
-			Short: "List all posts",
-			Long:  `List all of the posts in your content directory, include drafts, future and expired pages.`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				sites, err := cc.buildSites(map[string]any{
-					"buildExpired": true,
-					"buildDrafts":  true,
-					"buildFuture":  true,
-				})
-				if err != nil {
-					return newSystemError("Error building sites", err)
-				}
-
-				writer := csv.NewWriter(os.Stdout)
-				defer writer.Flush()
-
-				writer.Write([]string{
-					"path",
-					"slug",
-					"title",
-					"date",
-					"expiryDate",
-					"publishDate",
-					"draft",
-					"permalink",
-				})
-				for _, p := range sites.Pages() {
-					if !p.IsPage() {
-						continue
-					}
-					err := writer.Write([]string{
-						strings.TrimPrefix(p.File().Filename(), sites.WorkingDir+string(os.PathSeparator)),
-						p.Slug(),
-						p.Title(),
-						p.Date().Format(time.RFC3339),
-						p.ExpiryDate().Format(time.RFC3339),
-						p.PublishDate().Format(time.RFC3339),
-						strconv.FormatBool(p.Draft()),
-						p.Permalink(),
-					})
-					if err != nil {
-						return newSystemError("Error writing posts to stdout", err)
-					}
-				}
-
-				return nil
-			},
-		},
-	)
-
-	cc.baseBuilderCmd = b.newBuilderBasicCmd(cmd)
-
-	return cc
+type listCommand struct {
+	commands []simplecobra.Commander
+}
+
+func (c *listCommand) Commands() []simplecobra.Commander {
+	return c.commands
+}
+
+func (c *listCommand) Name() string {
+	return "list"
+}
+
+func (c *listCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
+	// Do nothing.
+	return nil
+}
+
+func (c *listCommand) Init(cd *simplecobra.Commandeer) error {
+	cmd := cd.CobraCommand
+	cmd.Short = "Listing out various types of content"
+	cmd.Long = `Listing out various types of content.
+
+List requires a subcommand, e.g. hugo list drafts`
+
+	cmd.RunE = nil
+	return nil
+}
+
+func (c *listCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
+	return nil
 }

commands/list_test.go

@@ -1,68 +0,0 @@
-package commands
-
-import (
-	"bytes"
-	"encoding/csv"
-	"io"
-	"os"
-	"path/filepath"
-	"strings"
-	"testing"
-
-	qt "github.com/frankban/quicktest"
-)
-
-func captureStdout(f func() error) (string, error) {
-	old := os.Stdout
-	r, w, _ := os.Pipe()
-	os.Stdout = w
-
-	err := f()
-
-	w.Close()
-	os.Stdout = old
-
-	var buf bytes.Buffer
-	io.Copy(&buf, r)
-	return buf.String(), err
-}
-
-func TestListAll(t *testing.T) {
-	c := qt.New(t)
-	dir := createSimpleTestSite(t, testSiteConfig{})
-
-	hugoCmd := newCommandsBuilder().addAll().build()
-	cmd := hugoCmd.getCommand()
-
-	t.Cleanup(func() {
-		os.RemoveAll(dir)
-	})
-
-	cmd.SetArgs([]string{"-s=" + dir, "list", "all"})
-
-	out, err := captureStdout(func() error {
-		_, err := cmd.ExecuteC()
-		return err
-	})
-	c.Assert(err, qt.IsNil)
-
-	r := csv.NewReader(strings.NewReader(out))
-
-	header, err := r.Read()
-
-	c.Assert(err, qt.IsNil)
-	c.Assert(header, qt.DeepEquals, []string{
-		"path", "slug", "title",
-		"date", "expiryDate", "publishDate",
-		"draft", "permalink",
-	})
-
-	record, err := r.Read()
-
-	c.Assert(err, qt.IsNil)
-	c.Assert(record, qt.DeepEquals, []string{
-		filepath.Join("content", "p1.md"), "", "P1",
-		"0001-01-01T00:00:00Z", "0001-01-01T00:00:00Z", "0001-01-01T00:00:00Z",
-		"false", "https://example.org/p1/",
-	})
-}

commands/mod.go

@@ -1,4 +1,4 @@
-// Copyright 2020 The Hugo Authors. All rights reserved.
+// 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.
@@ -14,87 +14,18 @@
 package commands
 
 import (
+	"context"
 	"errors"
-	"fmt"
 	"os"
 	"path/filepath"
-	"regexp"
 
-	"github.com/gohugoio/hugo/hugolib"
-
-	"github.com/gohugoio/hugo/modules"
+	"github.com/bep/simplecobra"
+	"github.com/gohugoio/hugo/config"
+	"github.com/gohugoio/hugo/modules/npm"
 	"github.com/spf13/cobra"
 )
 
-var _ cmder = (*modCmd)(nil)
-
-type modCmd struct {
-	*baseBuilderCmd
-}
-
-func (c *modCmd) newVerifyCmd() *cobra.Command {
-	var clean bool
-
-	verifyCmd := &cobra.Command{
-		Use:   "verify",
-		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.
-`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			return c.withModsClient(true, func(c *modules.Client) error {
-				return c.Verify(clean)
-			})
-		},
-	}
-
-	verifyCmd.Flags().BoolVarP(&clean, "clean", "", false, "delete module cache for dependencies that fail verification")
-
-	return verifyCmd
-}
-
-var moduleNotFoundRe = regexp.MustCompile("module.*not found")
-
-func (c *modCmd) newCleanCmd() *cobra.Command {
-	var pattern string
-	var all bool
-	cmd := &cobra.Command{
-		Use:   "clean",
-		Short: "Delete the Hugo Module cache for the current project.",
-		Long: `Delete the Hugo Module cache for the current project.
-
-Note that after you run this command, all of your dependencies will be re-downloaded next time you run "hugo".
-
-Also note that if you configure a positive maxAge for the "modules" file cache, it will also be cleaned as part of "hugo --gc".
- 
-`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			if all {
-				com, err := c.initConfig(false)
-
-				if err != nil && com == nil {
-					return err
-				}
-
-				count, err := com.hugo().FileCaches.ModulesCache().Prune(true)
-				com.logger.Printf("Deleted %d files from module cache.", count)
-				return err
-			}
-			return c.withModsClient(true, func(c *modules.Client) error {
-				return c.Clean(pattern)
-			})
-		},
-	}
-
-	cmd.Flags().StringVarP(&pattern, "pattern", "", "", `pattern matching module paths to clean (all if not set), e.g. "**hugo*"`)
-	cmd.Flags().BoolVarP(&all, "all", "", false, "clean entire module cache")
-
-	return cmd
-}
-
-func (b *commandsBuilder) newModCmd() *modCmd {
-	c := &modCmd{}
-
-	const commonUsage = `
+const commonUsageMod = `
 Note that Hugo will always start out by resolving the components defined in the site
 configuration, provided by a _vendor directory (if no --ignoreVendorPaths flag provided),
 Go Modules, or a folder inside the themes directory, in that order.
@@ -103,27 +34,171 @@ See https://gohugo.io/hugo-modules/ for more information.
 
 `
 
-	cmd := &cobra.Command{
-		Use:   "mod",
-		Short: "Various Hugo Modules helpers.",
-		Long: `Various helpers to help manage the modules in your project's dependency graph.
+// buildConfigCommands creates a new config command and its subcommands.
+func newModCommands() *modCommands {
+	var (
+		clean   bool
+		pattern string
+		all     bool
+	)
 
-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".
+	npmCommand := &simpleCommand{
+		name:  "npm",
+		short: "Various npm helpers.",
+		long:  `Various npm (Node package manager) helpers.`,
+		commands: []simplecobra.Commander{
+			&simpleCommand{
+				name:  "pack",
+				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.
 
-` + commonUsage,
+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
+with the base dependency set. 
 
-		RunE: nil,
+This set will be merged with all "package.hugo.json" files found in the dependency tree, picking the version closest to the project.
+
+This command is marked as 'Experimental'. We think it's a great idea, so it's not likely to be
+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.
+`,
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					applyLocalFlagsBuildConfig(cmd, r)
+				},
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					h, err := r.Hugo(flagsToCfg(cd, nil))
+					if err != nil {
+						return err
+					}
+					return npm.Pack(h.BaseFs.ProjectSourceFs, h.BaseFs.AssetsWithDuplicatesPreserved.Fs)
+				},
+			},
+		},
 	}
 
-	cmd.AddCommand(newModNPMCmd(c))
+	return &modCommands{
+		commands: []simplecobra.Commander{
+			&simpleCommand{
+				name:  "init",
+				short: "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:
+	
+		hugo mod init github.com/gohugoio/testshortcodes
+	
+	Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module
+	inside a subfolder on GitHub, as one example.
+	`,
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					applyLocalFlagsBuildConfig(cmd, r)
+				},
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					h, err := r.Hugo(flagsToCfg(cd, nil))
+					if err != nil {
+						return err
+					}
+					var initPath string
+					if len(args) >= 1 {
+						initPath = args[0]
+					}
+					return h.Configs.ModulesClient.Init(initPath)
+				},
+			},
+			&simpleCommand{
+				name:  "verify",
+				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.`,
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					applyLocalFlagsBuildConfig(cmd, r)
+					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 {
+					conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, nil))
+					if err != nil {
+						return err
+					}
+					client := conf.configs.ModulesClient
+					return client.Verify(clean)
+				},
+			},
+			&simpleCommand{
+				name:  "graph",
+				short: "Print a module dependency graph.",
+				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.
+`,
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					applyLocalFlagsBuildConfig(cmd, r)
+					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 {
+					conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, nil))
+					if err != nil {
+						return err
+					}
+					client := conf.configs.ModulesClient
+					return client.Graph(os.Stdout)
+				},
+			},
+			&simpleCommand{
+				name:  "clean",
+				short: "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) {
+					applyLocalFlagsBuildConfig(cmd, r)
+					cmd.Flags().StringVarP(&pattern, "pattern", "", "", `pattern matching module paths to clean (all if not set), e.g. "**hugo*"`)
+					cmd.Flags().BoolVarP(&all, "all", "", false, "clean entire module cache")
+				},
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					h, err := r.Hugo(flagsToCfg(cd, nil))
+					if err != nil {
+						return err
+					}
+					if all {
+						modCache := h.ResourceSpec.FileCaches.ModulesCache()
+						count, err := modCache.Prune(true)
+						r.Printf("Deleted %d files from module cache.", count)
+						return err
+					}
 
-	cmd.AddCommand(
-		&cobra.Command{
-			Use:                "get",
-			DisableFlagParsing: true,
-			Short:              "Resolves dependencies in your current Hugo Project.",
-			Long: `
+					return h.Configs.ModulesClient.Clean(pattern)
+				},
+			},
+			&simpleCommand{
+				name:  "tidy",
+				short: "Remove unused entries in go.mod and go.sum.",
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					applyLocalFlagsBuildConfig(cmd, r)
+				},
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					h, err := r.Hugo(flagsToCfg(cd, nil))
+					if err != nil {
+						return err
+					}
+					return h.Configs.ModulesClient.Tidy()
+				},
+			},
+			&simpleCommand{
+				name:  "vendor",
+				short: "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.
+	`,
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					applyLocalFlagsBuildConfig(cmd, r)
+				},
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					h, err := r.Hugo(flagsToCfg(cd, nil))
+					if err != nil {
+						return err
+					}
+					return h.Configs.ModulesClient.Vendor()
+				},
+			},
+
+			&simpleCommand{
+				name:  "get",
+				short: "Resolves dependencies in your current Hugo Project.",
+				long: `
 Resolves dependencies in your current Hugo Project.
 
 Some examples:
@@ -136,158 +211,120 @@ Install a specific version:
 
     hugo mod get github.com/gohugoio/testshortcodes@v0.3.0
 
-Install the latest versions of all module dependencies:
+Install the latest versions of all direct 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 ./... (recursive)
 
 Run "go help get" for more information. All flags available for "go get" is also relevant here.
-` + commonUsage,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				// We currently just pass on the flags we get to Go and
-				// need to do the flag handling manually.
-				if len(args) == 1 && args[0] == "-h" {
-					return cmd.Help()
-				}
-
-				var lastArg string
-				if len(args) != 0 {
-					lastArg = args[len(args)-1]
-				}
-
-				if lastArg == "./..." {
-					args = args[:len(args)-1]
-					// Do a recursive update.
-					dirname, err := os.Getwd()
-					if err != nil {
-						return err
+` + commonUsageMod,
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					cmd.DisableFlagParsing = true
+				},
+				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
+					// need to do the flag handling manually.
+					if len(args) == 1 && (args[0] == "-h" || args[0] == "--help") {
+						return errHelp
 					}
 
-					// Sanity check. We do recursive walking and want to avoid
-					// accidents.
-					if len(dirname) < 5 {
-						return errors.New("must not be run from the file system root")
+					var lastArg string
+					if len(args) != 0 {
+						lastArg = args[len(args)-1]
 					}
 
-					filepath.Walk(dirname, func(path string, info os.FileInfo, err error) error {
-						if info.IsDir() {
-							return nil
+					if lastArg == "./..." {
+						args = args[:len(args)-1]
+						// Do a recursive update.
+						dirname, err := os.Getwd()
+						if err != nil {
+							return err
 						}
 
-						if info.Name() == "go.mod" {
-							// Found a module.
-							dir := filepath.Dir(path)
-							fmt.Println("Update module in", dir)
-							c.source = dir
-							err := c.withModsClient(false, func(c *modules.Client) error {
-								if len(args) == 1 && args[0] == "-h" {
-									return cmd.Help()
-								}
-								return c.Get(args...)
-							})
-							if err != nil {
-								return err
+						// Sanity chesimplecobra. We do recursive walking and want to avoid
+						// accidents.
+						if len(dirname) < 5 {
+							return errors.New("must not be run from the file system root")
+						}
+
+						filepath.Walk(dirname, func(path string, info os.FileInfo, err error) error {
+							if info.IsDir() {
+								return nil
 							}
+							if info.Name() == "go.mod" {
+								// Found a module.
+								dir := filepath.Dir(path)
+								r.Println("Update module in", dir)
+								cfg := config.New()
+								cfg.Set("workingDir", dir)
+								conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, cfg))
+								if err != nil {
+									return err
+								}
+								client := conf.configs.ModulesClient
+								return client.Get(args...)
 
-						}
-
+							}
+							return nil
+						})
 						return nil
-					})
-
-					return nil
-				}
-
-				return c.withModsClient(false, func(c *modules.Client) error {
-					return c.Get(args...)
-				})
+					} else {
+						conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, nil))
+						if err != nil {
+							return err
+						}
+						client := conf.configs.ModulesClient
+						return client.Get(args...)
+					}
+				},
 			},
+			npmCommand,
 		},
-		&cobra.Command{
-			Use:   "graph",
-			Short: "Print a module dependency graph.",
-			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.
-`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				return c.withModsClient(true, func(c *modules.Client) error {
-					return c.Graph(os.Stdout)
-				})
-			},
-		},
-		&cobra.Command{
-			Use:   "init",
-			Short: "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:
-
-    hugo mod init github.com/gohugoio/testshortcodes
-
-Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module
-inside a subfolder on GitHub, as one example.
-`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				var path string
-				if len(args) >= 1 {
-					path = args[0]
-				}
-				return c.withModsClient(false, func(c *modules.Client) error {
-					return c.Init(path)
-				})
-			},
-		},
-		&cobra.Command{
-			Use:   "vendor",
-			Short: "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.
-`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				return c.withModsClient(true, func(c *modules.Client) error {
-					return c.Vendor()
-				})
-			},
-		},
-		c.newVerifyCmd(),
-		&cobra.Command{
-			Use:   "tidy",
-			Short: "Remove unused entries in go.mod and go.sum.",
-			RunE: func(cmd *cobra.Command, args []string) error {
-				return c.withModsClient(true, func(c *modules.Client) error {
-					return c.Tidy()
-				})
-			},
-		},
-		c.newCleanCmd(),
-	)
-
-	c.baseBuilderCmd = b.newBuilderCmd(cmd)
-
-	return c
+	}
 }
 
-func (c *modCmd) withModsClient(failOnMissingConfig bool, f func(*modules.Client) error) error {
-	com, err := c.initConfig(failOnMissingConfig)
+type modCommands struct {
+	r *rootCommand
+
+	commands []simplecobra.Commander
+}
+
+func (c *modCommands) Commands() []simplecobra.Commander {
+	return c.commands
+}
+
+func (c *modCommands) Name() string {
+	return "mod"
+}
+
+func (c *modCommands) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
+	_, err := c.r.ConfigFromProvider(c.r.configVersionID.Load(), nil)
 	if err != nil {
 		return err
 	}
+	// config := conf.configs.Base
 
-	return f(com.hugo().ModulesClient)
+	return nil
 }
 
-func (c *modCmd) withHugo(f func(*hugolib.HugoSites) error) error {
-	com, err := c.initConfig(true)
-	if err != nil {
-		return err
-	}
+func (c *modCommands) Init(cd *simplecobra.Commandeer) error {
+	cmd := cd.CobraCommand
+	cmd.Short = "Various Hugo Modules helpers."
+	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).
+This is not needed if you only operate on modules inside /themes or if you have vendored them via "hugo mod vendor".
 
-	return f(com.hugo())
+` + commonUsageMod
+	cmd.RunE = nil
+	return nil
 }
 
-func (c *modCmd) initConfig(failOnNoConfig bool) (*commandeer, error) {
-	com, err := initializeConfig(failOnNoConfig, false, false, &c.hugoBuilderCommon, c, nil)
-	if err != nil {
-		return nil, err
-	}
-	return com, nil
+func (c *modCommands) PreRun(cd, runner *simplecobra.Commandeer) error {
+	c.r = cd.Root.Command.(*rootCommand)
+	return nil
 }

commands/mod_npm.go

@@ -1,56 +0,0 @@
-// 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 commands
-
-import (
-	"github.com/gohugoio/hugo/hugolib"
-	"github.com/gohugoio/hugo/modules/npm"
-	"github.com/spf13/cobra"
-)
-
-func newModNPMCmd(c *modCmd) *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "npm",
-		Short: "Various npm helpers.",
-		Long:  `Various npm (Node package manager) helpers.`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			return c.withHugo(func(h *hugolib.HugoSites) error {
-				return nil
-			})
-		},
-	}
-
-	cmd.AddCommand(&cobra.Command{
-		Use:   "pack",
-		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.
-
-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
-with the base dependency set. 
-
-This set will be merged with all "package.hugo.json" files found in the dependency tree, picking the version closest to the project.
-
-This command is marked as 'Experimental'. We think it's a great idea, so it's not likely to be
-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.
-`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			return c.withHugo(func(h *hugolib.HugoSites) error {
-				return npm.Pack(h.BaseFs.SourceFs, h.BaseFs.Assets.Dirs)
-			})
-		},
-	})
-
-	return cmd
-}

commands/new.go

@@ -1,4 +1,4 @@
-// Copyright 2018 The Hugo Authors. All rights reserved.
+// 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.
@@ -15,33 +15,33 @@ package commands
 
 import (
 	"bytes"
-	"os"
+	"context"
 	"path/filepath"
 	"strings"
 
+	"github.com/bep/simplecobra"
+	"github.com/gohugoio/hugo/common/paths"
+	"github.com/gohugoio/hugo/config"
 	"github.com/gohugoio/hugo/create"
-	"github.com/gohugoio/hugo/helpers"
-	"github.com/gohugoio/hugo/hugolib"
-	"github.com/spf13/afero"
+	"github.com/gohugoio/hugo/create/skeletons"
 	"github.com/spf13/cobra"
-	jww "github.com/spf13/jwalterweatherman"
 )
 
-var _ cmder = (*newCmd)(nil)
+func newNewCommand() *newCommand {
+	var (
+		force       bool
+		contentType string
+		format      string
+	)
 
-type newCmd struct {
-	contentEditor string
-	contentType   string
-	force         bool
-
-	*baseBuilderCmd
-}
-
-func (b *commandsBuilder) newNewCmd() *newCmd {
-	cmd := &cobra.Command{
-		Use:   "new [path]",
-		Short: "Create new content for your site",
-		Long: `Create a new content file and automatically set the date and title.
+	var c *newCommand
+	c = &newCommand{
+		commands: []simplecobra.Commander{
+			&simpleCommand{
+				name:  "content",
+				use:   "content [path]",
+				short: "Create new content for your site",
+				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.
 
 You can also specify the kind with ` + "`-k KIND`" + `.
@@ -49,80 +49,159 @@ You can also specify the kind with ` + "`-k KIND`" + `.
 If archetypes are provided in your theme or site, they will be used.
 
 Ensure you run this within the root directory of your site.`,
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					if len(args) < 1 {
+						return newUserError("path needs to be provided")
+					}
+					h, err := r.Hugo(flagsToCfg(cd, nil))
+					if err != nil {
+						return err
+					}
+					return create.NewContent(h, contentType, args[0], force)
+				},
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					cmd.Flags().StringVarP(&contentType, "kind", "k", "", "content type to create")
+					cmd.Flags().String("editor", "", "edit new content with this editor, if provided")
+					cmd.Flags().BoolVarP(&force, "force", "f", false, "overwrite file if it already exists")
+					applyLocalFlagsBuildConfig(cmd, r)
+				},
+			},
+			&simpleCommand{
+				name:  "site",
+				use:   "site [path]",
+				short: "Create a new site (skeleton)",
+				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 {
+					if len(args) < 1 {
+						return newUserError("path needs to be provided")
+					}
+					createpath, err := filepath.Abs(filepath.Clean(args[0]))
+					if err != nil {
+						return err
+					}
+
+					cfg := config.New()
+					cfg.Set("workingDir", createpath)
+					cfg.Set("publishDir", "public")
+
+					conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, cfg))
+					if err != nil {
+						return err
+					}
+					sourceFs := conf.fs.Source
+
+					err = skeletons.CreateSite(createpath, sourceFs, force, format)
+					if err != nil {
+						return err
+					}
+
+					r.Printf("Congratulations! Your new Hugo site was created in %s.\n\n", createpath)
+					r.Println(c.newSiteNextStepsText(createpath, format))
+
+					return nil
+				},
+				withc: func(cmd *cobra.Command, r *rootCommand) {
+					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)")
+				},
+			},
+			&simpleCommand{
+				name:  "theme",
+				use:   "theme [name]",
+				short: "Create a new theme (skeleton)",
+				long: `Create a new theme (skeleton) called [name] in ./themes.
+New theme is a skeleton. Please add content to the touched files. Add your
+name to the copyright line in the license and adjust the theme.toml file
+according to your needs.`,
+				run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+					if len(args) < 1 {
+						return newUserError("theme name needs to be provided")
+					}
+					cfg := config.New()
+					cfg.Set("publishDir", "public")
+
+					conf, err := r.ConfigFromProvider(r.configVersionID.Load(), flagsToCfg(cd, cfg))
+					if err != nil {
+						return err
+					}
+					sourceFs := conf.fs.Source
+					createpath := paths.AbsPathify(conf.configs.Base.WorkingDir, filepath.Join(conf.configs.Base.ThemesDir, args[0]))
+					r.Println("Creating new theme in", createpath)
+
+					err = skeletons.CreateTheme(createpath, sourceFs)
+					if err != nil {
+						return err
+					}
+
+					return nil
+				},
+			},
+		},
 	}
 
-	cc := &newCmd{baseBuilderCmd: b.newBuilderCmd(cmd)}
-
-	cmd.Flags().StringVarP(&cc.contentType, "kind", "k", "", "content type to create")
-	cmd.Flags().StringVar(&cc.contentEditor, "editor", "", "edit new content with this editor, if provided")
-	cmd.Flags().BoolVarP(&cc.force, "force", "f", false, "overwrite file if it already exists")
-
-	cmd.AddCommand(b.newNewSiteCmd().getCommand())
-	cmd.AddCommand(b.newNewThemeCmd().getCommand())
-
-	cmd.RunE = cc.newContent
-
-	return cc
+	return c
 }
 
-func (n *newCmd) newContent(cmd *cobra.Command, args []string) error {
-	cfgInit := func(c *commandeer) error {
-		if cmd.Flags().Changed("editor") {
-			c.Set("newContentEditor", n.contentEditor)
-		}
-		return nil
-	}
+type newCommand struct {
+	rootCmd *rootCommand
 
-	c, err := initializeConfig(true, true, false, &n.hugoBuilderCommon, n, cfgInit)
-	if err != nil {
-		return err
-	}
-
-	if len(args) < 1 {
-		return newUserError("path needs to be provided")
-	}
-
-	return create.NewContent(c.hugo(), n.contentType, args[0], n.force)
+	commands []simplecobra.Commander
 }
 
-func mkdir(x ...string) {
-	p := filepath.Join(x...)
-
-	err := os.MkdirAll(p, 0777) // before umask
-	if err != nil {
-		jww.FATAL.Fatalln(err)
-	}
+func (c *newCommand) Commands() []simplecobra.Commander {
+	return c.commands
 }
 
-func touchFile(fs afero.Fs, x ...string) {
-	inpath := filepath.Join(x...)
-	mkdir(filepath.Dir(inpath))
-	err := helpers.WriteToDisk(inpath, bytes.NewReader([]byte{}), fs)
-	if err != nil {
-		jww.FATAL.Fatalln(err)
-	}
+func (c *newCommand) Name() string {
+	return "new"
 }
 
-func newContentPathSection(h *hugolib.HugoSites, path string) (string, string) {
-	// Forward slashes is used in all examples. Convert if needed.
-	// Issue #1133
-	createpath := filepath.FromSlash(path)
-
-	if h != nil {
-		for _, dir := range h.BaseFs.Content.Dirs {
-			createpath = strings.TrimPrefix(createpath, dir.Meta().Filename)
-		}
-	}
-
-	var section string
-	// assume the first directory is the section (kind)
-	if strings.Contains(createpath[1:], helpers.FilePathSeparator) {
-		parts := strings.Split(strings.TrimPrefix(createpath, helpers.FilePathSeparator), helpers.FilePathSeparator)
-		if len(parts) > 0 {
-			section = parts[0]
-		}
-
-	}
-
-	return createpath, section
+func (c *newCommand) Run(ctx context.Context, cd *simplecobra.Commandeer, args []string) error {
+	return nil
+}
+
+func (c *newCommand) Init(cd *simplecobra.Commandeer) error {
+	cmd := cd.CobraCommand
+	cmd.Short = "Create new content for your site"
+	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.
+
+You can also specify the kind with ` + "`-k KIND`" + `.
+
+If archetypes are provided in your theme or site, they will be used.
+
+Ensure you run this within the root directory of your site.`
+
+	cmd.RunE = nil
+	return nil
+}
+
+func (c *newCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
+	c.rootCmd = cd.Root.Command.(*rootCommand)
+	return nil
+}
+
+func (c *newCommand) newSiteNextStepsText(path string, format string) string {
+	format = strings.ToLower(format)
+	var nextStepsText bytes.Buffer
+
+	nextStepsText.WriteString(`Just a few more steps...
+
+1. Change the current directory to ` + path + `.
+2. Create or install a theme:
+   - Create a new theme with the command "hugo new theme <THEMENAME>"
+   - Install a theme from https://themes.gohugo.io/
+3. Edit hugo.` + format + `, setting the "theme" property to the theme name.
+4. Create new content with the command "hugo new content `)
+
+	nextStepsText.WriteString(filepath.Join("<SECTIONNAME>", "<FILENAME>.<FORMAT>"))
+
+	nextStepsText.WriteString(`".
+5. Start the embedded web server with the command "hugo server --buildDrafts".
+
+See documentation at https://gohugo.io/.`)
+
+	return nextStepsText.String()
 }

commands/new_site.go

@@ -1,165 +0,0 @@
-// 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 commands
-
-import (
-	"bytes"
-	"errors"
-	"fmt"
-	"path/filepath"
-	"strings"
-
-	"github.com/gohugoio/hugo/config"
-	"github.com/gohugoio/hugo/parser/metadecoders"
-
-	"github.com/gohugoio/hugo/create"
-	"github.com/gohugoio/hugo/helpers"
-	"github.com/gohugoio/hugo/hugofs"
-	"github.com/gohugoio/hugo/parser"
-	"github.com/spf13/cobra"
-	jww "github.com/spf13/jwalterweatherman"
-)
-
-var _ cmder = (*newSiteCmd)(nil)
-
-type newSiteCmd struct {
-	configFormat string
-
-	*baseBuilderCmd
-}
-
-func (b *commandsBuilder) newNewSiteCmd() *newSiteCmd {
-	cc := &newSiteCmd{}
-
-	cmd := &cobra.Command{
-		Use:   "site [path]",
-		Short: "Create a new site (skeleton)",
-		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.`,
-		RunE: cc.newSite,
-	}
-
-	cmd.Flags().StringVarP(&cc.configFormat, "format", "f", "toml", "config file format")
-	cmd.Flags().Bool("force", false, "init inside non-empty directory")
-
-	cc.baseBuilderCmd = b.newBuilderBasicCmd(cmd)
-
-	return cc
-}
-
-func (n *newSiteCmd) doNewSite(fs *hugofs.Fs, basepath string, force bool) error {
-	archeTypePath := filepath.Join(basepath, "archetypes")
-	dirs := []string{
-		filepath.Join(basepath, "layouts"),
-		filepath.Join(basepath, "content"),
-		archeTypePath,
-		filepath.Join(basepath, "static"),
-		filepath.Join(basepath, "data"),
-		filepath.Join(basepath, "themes"),
-	}
-
-	if exists, _ := helpers.Exists(basepath, fs.Source); exists {
-		if isDir, _ := helpers.IsDir(basepath, fs.Source); !isDir {
-			return errors.New(basepath + " already exists but not a directory")
-		}
-
-		isEmpty, _ := helpers.IsEmpty(basepath, fs.Source)
-
-		switch {
-		case !isEmpty && !force:
-			return errors.New(basepath + " already exists and is not empty. See --force.")
-
-		case !isEmpty && force:
-			all := append(dirs, filepath.Join(basepath, "config."+n.configFormat))
-			for _, path := range all {
-				if exists, _ := helpers.Exists(path, fs.Source); exists {
-					return errors.New(path + " already exists")
-				}
-			}
-		}
-	}
-
-	for _, dir := range dirs {
-		if err := fs.Source.MkdirAll(dir, 0777); err != nil {
-			return fmt.Errorf("Failed to create dir: %w", err)
-		}
-	}
-
-	createConfig(fs, basepath, n.configFormat)
-
-	// Create a default archetype file.
-	helpers.SafeWriteToDisk(filepath.Join(archeTypePath, "default.md"),
-		strings.NewReader(create.DefaultArchetypeTemplateTemplate), fs.Source)
-
-	jww.FEEDBACK.Printf("Congratulations! Your new Hugo site is created in %s.\n\n", basepath)
-	jww.FEEDBACK.Println(nextStepsText())
-
-	return nil
-}
-
-// newSite creates a new Hugo site and initializes a structured Hugo directory.
-func (n *newSiteCmd) newSite(cmd *cobra.Command, args []string) error {
-	if len(args) < 1 {
-		return newUserError("path needs to be provided")
-	}
-
-	createpath, err := filepath.Abs(filepath.Clean(args[0]))
-	if err != nil {
-		return newUserError(err)
-	}
-
-	forceNew, _ := cmd.Flags().GetBool("force")
-	cfg := config.New()
-	cfg.Set("workingDir", createpath)
-	cfg.Set("publishDir", "public")
-	return n.doNewSite(hugofs.NewDefault(cfg), createpath, forceNew)
-}
-
-func createConfig(fs *hugofs.Fs, inpath string, kind string) (err error) {
-	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, "config."+kind), &buf, fs.Source)
-}
-
-func nextStepsText() string {
-	var nextStepsText bytes.Buffer
-
-	nextStepsText.WriteString(`Just a few more steps and you're ready to go:
-
-1. Download a theme into the same-named folder.
-   Choose a theme from https://themes.gohugo.io/ or
-   create your own with the "hugo new theme <THEMENAME>" command.
-2. Perhaps you want to add some content. You can add single files
-   with "hugo new `)
-
-	nextStepsText.WriteString(filepath.Join("<SECTIONNAME>", "<FILENAME>.<FORMAT>"))
-
-	nextStepsText.WriteString(`".
-3. Start the built-in live server via "hugo server".
-
-Visit https://gohugo.io/ for quickstart guide and full documentation.`)
-
-	return nextStepsText.String()
-}

commands/new_theme.go

@@ -1,176 +0,0 @@
-// 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 commands
-
-import (
-	"bytes"
-	"errors"
-	"path/filepath"
-	"strings"
-
-	"github.com/gohugoio/hugo/common/htime"
-	"github.com/gohugoio/hugo/helpers"
-	"github.com/gohugoio/hugo/hugofs"
-	"github.com/spf13/cobra"
-	jww "github.com/spf13/jwalterweatherman"
-)
-
-var _ cmder = (*newThemeCmd)(nil)
-
-type newThemeCmd struct {
-	*baseBuilderCmd
-}
-
-func (b *commandsBuilder) newNewThemeCmd() *newThemeCmd {
-	cc := &newThemeCmd{}
-
-	cmd := &cobra.Command{
-		Use:   "theme [name]",
-		Short: "Create a new theme",
-		Long: `Create a new theme (skeleton) called [name] in ./themes.
-New theme is a skeleton. Please add content to the touched files. Add your
-name to the copyright line in the license and adjust the theme.toml file
-as you see fit.`,
-		RunE: cc.newTheme,
-	}
-
-	cc.baseBuilderCmd = b.newBuilderBasicCmd(cmd)
-
-	return cc
-}
-
-// newTheme creates a new Hugo theme template
-func (n *newThemeCmd) newTheme(cmd *cobra.Command, args []string) error {
-	c, err := initializeConfig(false, false, false, &n.hugoBuilderCommon, n, nil)
-	if err != nil {
-		return err
-	}
-
-	if len(args) < 1 {
-		return newUserError("theme name needs to be provided")
-	}
-
-	createpath := c.hugo().PathSpec.AbsPathify(filepath.Join(c.Cfg.GetString("themesDir"), args[0]))
-	jww.FEEDBACK.Println("Creating theme at", createpath)
-
-	cfg := c.DepsCfg
-
-	if x, _ := helpers.Exists(createpath, cfg.Fs.Source); x {
-		return errors.New(createpath + " already exists")
-	}
-
-	mkdir(createpath, "layouts", "_default")
-	mkdir(createpath, "layouts", "partials")
-
-	touchFile(cfg.Fs.Source, createpath, "layouts", "index.html")
-	touchFile(cfg.Fs.Source, createpath, "layouts", "404.html")
-	touchFile(cfg.Fs.Source, createpath, "layouts", "_default", "list.html")
-	touchFile(cfg.Fs.Source, createpath, "layouts", "_default", "single.html")
-
-	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), cfg.Fs.Source)
-	if err != nil {
-		return err
-	}
-
-	touchFile(cfg.Fs.Source, createpath, "layouts", "partials", "head.html")
-	touchFile(cfg.Fs.Source, createpath, "layouts", "partials", "header.html")
-	touchFile(cfg.Fs.Source, createpath, "layouts", "partials", "footer.html")
-
-	mkdir(createpath, "archetypes")
-
-	archDefault := []byte("+++\n+++\n")
-
-	err = helpers.WriteToDisk(filepath.Join(createpath, "archetypes", "default.md"), bytes.NewReader(archDefault), cfg.Fs.Source)
-	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), cfg.Fs.Source)
-	if err != nil {
-		return err
-	}
-
-	n.createThemeMD(cfg.Fs, createpath)
-
-	return nil
-}
-
-func (n *newThemeCmd) createThemeMD(fs *hugofs.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.41.0"
-
-[author]
-  name = ""
-  homepage = ""
-
-# If porting an existing theme
-[original]
-  name = ""
-  homepage = ""
-  repo = ""
-`)
-
-	err = helpers.WriteToDisk(filepath.Join(inpath, "theme.toml"), bytes.NewReader(by), fs.Source)
-	if err != nil {
-		return
-	}
-
-	return nil
-}

commands/nodeploy.go

@@ -1,51 +0,0 @@
-// Copyright 2019 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 nodeploy
-// +build nodeploy
-
-package commands
-
-import (
-	"errors"
-
-	"github.com/spf13/cobra"
-)
-
-var _ cmder = (*deployCmd)(nil)
-
-// deployCmd supports deploying sites to Cloud providers.
-type deployCmd struct {
-	*baseBuilderCmd
-}
-
-func (b *commandsBuilder) newDeployCmd() *deployCmd {
-	cc := &deployCmd{}
-
-	cmd := &cobra.Command{
-		Use:   "deploy",
-		Short: "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
-documentation.
-`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			return errors.New("build without HUGO_BUILD_TAGS=nodeploy to use this command")
-		},
-	}
-
-	cc.baseBuilderCmd = b.newBuilderBasicCmd(cmd)
-
-	return cc
-}

commands/release.go

@@ -1,7 +1,4 @@
-//go:build release
-// +build release
-
-// Copyright 2017-present The Hugo Authors. All rights reserved.
+// 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.
@@ -17,55 +14,38 @@
 package commands
 
 import (
-	"github.com/gohugoio/hugo/config"
+	"context"
+
+	"github.com/bep/simplecobra"
 	"github.com/gohugoio/hugo/releaser"
 	"github.com/spf13/cobra"
 )
 
-var _ cmder = (*releaseCommandeer)(nil)
+// 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.
+func newReleaseCommand() simplecobra.Commander {
+	var (
+		step     int
+		skipPush bool
+		try      bool
+	)
 
-type releaseCommandeer struct {
-	cmd *cobra.Command
+	return &simpleCommand{
+		name:  "release",
+		short: "Release a new version of Hugo.",
+		run: func(ctx context.Context, cd *simplecobra.Commandeer, r *rootCommand, args []string) error {
+			rel, err := releaser.New(skipPush, try, step)
+			if err != nil {
+				return err
+			}
 
-	step     int
-	skipPush bool
-	try      bool
-}
-
-func createReleaser() cmder {
-	// 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.
-	r := &releaseCommandeer{
-		cmd: &cobra.Command{
-			Use:    "release",
-			Short:  "Release a new version of Hugo.",
-			Hidden: true,
+			return rel.Run()
+		},
+		withc: func(cmd *cobra.Command, r *rootCommand) {
+			cmd.Hidden = true
+			cmd.PersistentFlags().BoolVarP(&skipPush, "skip-push", "", false, "skip pushing to remote")
+			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)")
 		},
 	}
-
-	r.cmd.RunE = func(cmd *cobra.Command, args []string) error {
-		return r.release()
-	}
-
-	r.cmd.PersistentFlags().BoolVarP(&r.skipPush, "skip-push", "", false, "skip pushing to remote")
-	r.cmd.PersistentFlags().BoolVarP(&r.try, "try", "", false, "no changes")
-	r.cmd.PersistentFlags().IntVarP(&r.step, "step", "", 0, "step to run (1: set new version 2: prepare next dev version)")
-
-	return r
-}
-
-func (c *releaseCommandeer) getCommand() *cobra.Command {
-	return c.cmd
-}
-
-func (c *releaseCommandeer) flagsToConfig(cfg config.Provider) {
-}
-
-func (r *releaseCommandeer) release() error {
-	rel, err := releaser.New(r.skipPush, r.try, r.step)
-	if err != nil {
-		return err
-	}
-
-	return rel.Run()
 }

commands/server_test.go

@@ -1,430 +0,0 @@
-// Copyright 2015 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 (
-	"fmt"
-	"net/http"
-	"os"
-	"path/filepath"
-	"runtime"
-	"strings"
-	"testing"
-	"time"
-
-	"github.com/gohugoio/hugo/config"
-	"github.com/gohugoio/hugo/helpers"
-	"github.com/gohugoio/hugo/htesting"
-	"golang.org/x/net/context"
-	"golang.org/x/sync/errgroup"
-
-	qt "github.com/frankban/quicktest"
-)
-
-// Issue 9518
-func TestServerPanicOnConfigError(t *testing.T) {
-	c := qt.New(t)
-
-	config := `
-[markup]
-[markup.highlight]
-linenos='table'
-`
-
-	r := runServerTest(c,
-		serverTestOptions{
-			config: config,
-		},
-	)
-
-	c.Assert(r.err, qt.IsNotNil)
-	c.Assert(r.err.Error(), qt.Contains, "cannot parse 'Highlight.LineNos' as bool:")
-}
-
-func TestServer404(t *testing.T) {
-	c := qt.New(t)
-
-	r := runServerTest(c,
-		serverTestOptions{
-			pathsToGet:  []string{"this/does/not/exist"},
-			getNumHomes: 1,
-		},
-	)
-
-	c.Assert(r.err, qt.IsNil)
-	pr := r.pathsResults["this/does/not/exist"]
-	c.Assert(pr.statusCode, qt.Equals, http.StatusNotFound)
-	c.Assert(pr.body, qt.Contains, "404: 404 Page not found|Not Found.")
-}
-
-func TestServerPathEncodingIssues(t *testing.T) {
-	if htesting.IsGitHubAction() {
-		// This test is flaky on CI for some reason. Run it on Windows only for now.
-		// TODO(bep)
-		if runtime.GOOS != "windows" {
-			t.Skip("Skipping test on CI")
-		}
-	}
-	c := qt.New(t)
-
-	// Issue 10287
-	c.Run("Unicode paths", func(c *qt.C) {
-		r := runServerTest(c,
-			serverTestOptions{
-				pathsToGet: []string{"hügö/"},
-			},
-		)
-
-		c.Assert(r.err, qt.IsNil)
-		c.Assert(r.pathsResults["hügö/"].body, qt.Contains, "This is hügö")
-	})
-
-	// Issue 10314
-	c.Run("Windows multilingual 404", func(c *qt.C) {
-		config := `
-baseURL = 'https://example.org/'
-title = 'Hugo Forum Topic #40568'
-
-defaultContentLanguageInSubdir = true
-
-[languages.en]
-contentDir = 'content/en'
-languageCode = 'en-US'
-languageName = 'English'
-weight = 1
-
-[languages.es]
-contentDir = 'content/es'
-languageCode = 'es-ES'
-languageName = 'Espanol'
-weight = 2
-
-[server]
-[[server.redirects]]
-from = '/en/**'
-to = '/en/404.html'
-status = 404
-
-[[server.redirects]]
-from = '/es/**'
-to = '/es/404.html'
-status = 404
-`
-		r := runServerTest(c,
-			serverTestOptions{
-				config:     config,
-				pathsToGet: []string{"en/this/does/not/exist", "es/this/does/not/exist"},
-			},
-		)
-
-		c.Assert(r.err, qt.IsNil)
-		pr1 := r.pathsResults["en/this/does/not/exist"]
-		pr2 := r.pathsResults["es/this/does/not/exist"]
-		c.Assert(pr1.statusCode, qt.Equals, http.StatusNotFound)
-		c.Assert(pr2.statusCode, qt.Equals, http.StatusNotFound)
-		c.Assert(pr1.body, qt.Contains, "404: 404 Page not found|Not Found.")
-		c.Assert(pr2.body, qt.Contains, "404: 404 Page not found|Not Found.")
-
-	})
-
-}
-func TestServerFlags(t *testing.T) {
-	c := qt.New(t)
-
-	assertPublic := func(c *qt.C, r serverTestResult, renderStaticToDisk bool) {
-		c.Assert(r.err, qt.IsNil)
-		c.Assert(r.homesContent[0], qt.Contains, "Environment: development")
-		c.Assert(r.publicDirnames["myfile.txt"], qt.Equals, renderStaticToDisk)
-
-	}
-
-	for _, test := range []struct {
-		flag   string
-		assert func(c *qt.C, r serverTestResult)
-	}{
-		{"", func(c *qt.C, r serverTestResult) {
-			assertPublic(c, r, false)
-		}},
-		{"--renderToDisk", func(c *qt.C, r serverTestResult) {
-			assertPublic(c, r, true)
-		}},
-		{"--renderStaticToDisk", func(c *qt.C, r serverTestResult) {
-			assertPublic(c, r, true)
-		}},
-	} {
-		c.Run(test.flag, func(c *qt.C) {
-			config := `
-baseURL="https://example.org"
-`
-
-			var args []string
-			if test.flag != "" {
-				args = strings.Split(test.flag, "=")
-			}
-
-			opts := serverTestOptions{
-				config:      config,
-				args:        args,
-				getNumHomes: 1,
-			}
-
-			r := runServerTest(c, opts)
-
-			test.assert(c, r)
-
-		})
-
-	}
-
-}
-
-func TestServerBugs(t *testing.T) {
-	c := qt.New(t)
-
-	for _, test := range []struct {
-		name       string
-		config     string
-		flag       string
-		numservers int
-		assert     func(c *qt.C, r serverTestResult)
-	}{
-		{"PostProcess, memory", "", "", 1, func(c *qt.C, r serverTestResult) {
-			c.Assert(r.err, qt.IsNil)
-			c.Assert(r.homesContent[0], qt.Contains, "PostProcess: /foo.min.css")
-		}},
-		// Issue 9788
-		{"PostProcess, memory", "", "", 1, func(c *qt.C, r serverTestResult) {
-			c.Assert(r.err, qt.IsNil)
-			c.Assert(r.homesContent[0], qt.Contains, "PostProcess: /foo.min.css")
-		}},
-		{"PostProcess, disk", "", "--renderToDisk", 1, func(c *qt.C, r serverTestResult) {
-			c.Assert(r.err, qt.IsNil)
-			c.Assert(r.homesContent[0], qt.Contains, "PostProcess: /foo.min.css")
-		}},
-		// Isue 9901
-		{"Multihost", `
-defaultContentLanguage = 'en'
-[languages]
-[languages.en]
-baseURL = 'https://example.com'
-title = 'My blog'
-weight = 1
-[languages.fr]
-baseURL = 'https://example.fr'
-title = 'Mon blogue'
-weight = 2
-`, "", 2, func(c *qt.C, r serverTestResult) {
-			c.Assert(r.err, qt.IsNil)
-			for i, s := range []string{"My blog", "Mon blogue"} {
-				c.Assert(r.homesContent[i], qt.Contains, s)
-			}
-		}},
-	} {
-		c.Run(test.name, func(c *qt.C) {
-			if test.config == "" {
-				test.config = `
-baseURL="https://example.org"
-`
-			}
-
-			var args []string
-			if test.flag != "" {
-				args = strings.Split(test.flag, "=")
-			}
-
-			opts := serverTestOptions{
-				config:      test.config,
-				getNumHomes: test.numservers,
-				pathsToGet:  []string{"this/does/not/exist"},
-				args:        args,
-			}
-
-			r := runServerTest(c, opts)
-			pr := r.pathsResults["this/does/not/exist"]
-			c.Assert(pr.statusCode, qt.Equals, http.StatusNotFound)
-			c.Assert(pr.body, qt.Contains, "404: 404 Page not found|Not Found.")
-			test.assert(c, r)
-
-		})
-
-	}
-
-}
-
-type serverTestResult struct {
-	err            error
-	homesContent   []string
-	content404     string
-	publicDirnames map[string]bool
-	pathsResults   map[string]pathResult
-}
-
-type pathResult struct {
-	statusCode int
-	body       string
-}
-
-type serverTestOptions struct {
-	getNumHomes int
-	config      string
-	pathsToGet  []string
-	args        []string
-}
-
-func runServerTest(c *qt.C, opts serverTestOptions) serverTestResult {
-	dir := createSimpleTestSite(c, testSiteConfig{configTOML: opts.config})
-	result := serverTestResult{
-		publicDirnames: make(map[string]bool),
-		pathsResults:   make(map[string]pathResult),
-	}
-
-	sp, err := helpers.FindAvailablePort()
-	c.Assert(err, qt.IsNil)
-	port := sp.Port
-
-	defer func() {
-		os.RemoveAll(dir)
-	}()
-
-	stop := make(chan bool)
-
-	b := newCommandsBuilder()
-	scmd := b.newServerCmdSignaled(stop)
-
-	cmd := scmd.getCommand()
-	args := append([]string{"-s=" + dir, fmt.Sprintf("-p=%d", port)}, opts.args...)
-	cmd.SetArgs(args)
-
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
-	defer cancel()
-	wg, ctx := errgroup.WithContext(ctx)
-
-	wg.Go(func() error {
-		_, err := cmd.ExecuteC()
-		return err
-	})
-
-	if opts.getNumHomes > 0 {
-		// Esp. on slow CI machines, we need to wait a little before the web
-		// server is ready.
-		wait := 567 * time.Millisecond
-		if os.Getenv("CI") != "" {
-			wait = 2 * time.Second
-		}
-		time.Sleep(wait)
-		result.homesContent = make([]string, opts.getNumHomes)
-		for i := 0; i < opts.getNumHomes; i++ {
-			func() {
-				resp, err := http.Get(fmt.Sprintf("http://localhost:%d/", port+i))
-				c.Assert(err, qt.IsNil)
-				c.Assert(resp.StatusCode, qt.Equals, http.StatusOK)
-				if err == nil {
-					defer resp.Body.Close()
-					result.homesContent[i] = helpers.ReaderToString(resp.Body)
-				}
-			}()
-		}
-	}
-
-	for _, path := range opts.pathsToGet {
-		func() {
-			resp, err := http.Get(fmt.Sprintf("http://localhost:%d/%s", port, path))
-			c.Assert(err, qt.IsNil)
-			pr := pathResult{
-				statusCode: resp.StatusCode,
-			}
-
-			if err == nil {
-				defer resp.Body.Close()
-				pr.body = helpers.ReaderToString(resp.Body)
-			}
-			result.pathsResults[path] = pr
-		}()
-	}
-
-	time.Sleep(1 * time.Second)
-
-	select {
-	case <-stop:
-	case stop <- true:
-	}
-
-	pubFiles, err := os.ReadDir(filepath.Join(dir, "public"))
-	c.Assert(err, qt.IsNil)
-	for _, f := range pubFiles {
-		result.publicDirnames[f.Name()] = true
-	}
-
-	result.err = wg.Wait()
-
-	return result
-
-}
-
-func TestFixURL(t *testing.T) {
-	type data struct {
-		TestName   string
-		CLIBaseURL string
-		CfgBaseURL string
-		AppendPort bool
-		Port       int
-		Result     string
-	}
-	tests := []data{
-		{"Basic http localhost", "", "http://foo.com", true, 1313, "http://localhost:1313/"},
-		{"Basic https production, http localhost", "", "https://foo.com", true, 1313, "http://localhost:1313/"},
-		{"Basic subdir", "", "http://foo.com/bar", true, 1313, "http://localhost:1313/bar/"},
-		{"Basic production", "http://foo.com", "http://foo.com", false, 80, "http://foo.com/"},
-		{"Production subdir", "http://foo.com/bar", "http://foo.com/bar", false, 80, "http://foo.com/bar/"},
-		{"No http", "", "foo.com", true, 1313, "//localhost:1313/"},
-		{"Override configured port", "", "foo.com:2020", true, 1313, "//localhost:1313/"},
-		{"No http production", "foo.com", "foo.com", false, 80, "//foo.com/"},
-		{"No http production with port", "foo.com", "foo.com", true, 2020, "//foo.com:2020/"},
-		{"No config", "", "", true, 1313, "//localhost:1313/"},
-	}
-
-	for _, test := range tests {
-		t.Run(test.TestName, func(t *testing.T) {
-			b := newCommandsBuilder()
-			s := b.newServerCmd()
-			v := config.NewWithTestDefaults()
-			baseURL := test.CLIBaseURL
-			v.Set("baseURL", test.CfgBaseURL)
-			s.serverAppend = test.AppendPort
-			s.serverPort = test.Port
-			result, err := s.fixURL(v, baseURL, s.serverPort)
-			if err != nil {
-				t.Errorf("Unexpected error %s", err)
-			}
-			if result != test.Result {
-				t.Errorf("Expected %q, got %q", test.Result, result)
-			}
-		})
-	}
-}
-
-func TestRemoveErrorPrefixFromLog(t *testing.T) {
-	c := qt.New(t)
-	content := `ERROR 2018/10/07 13:11:12 Error while rendering "home": template: _default/baseof.html:4:3: executing "main" at <partial "logo" .>: error calling partial: template: partials/logo.html:5:84: executing "partials/logo.html" at <$resized.AHeight>: can't evaluate field AHeight in type *resource.Image
-ERROR 2018/10/07 13:11:12 Rebuild failed: logged 1 error(s)
-`
-
-	withoutError := removeErrorPrefixFromLog(content)
-
-	c.Assert(strings.Contains(withoutError, "ERROR"), qt.Equals, false)
-}
-
-func isWindowsCI() bool {
-	return runtime.GOOS == "windows" && os.Getenv("CI") != ""
-}

commands/static_syncer.go

@@ -1,129 +0,0 @@
-// Copyright 2017 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 (
-	"os"
-	"path/filepath"
-
-	"github.com/gohugoio/hugo/hugolib/filesystems"
-
-	"github.com/fsnotify/fsnotify"
-	"github.com/gohugoio/hugo/helpers"
-	"github.com/spf13/fsync"
-)
-
-type staticSyncer struct {
-	c *commandeer
-}
-
-func newStaticSyncer(c *commandeer) (*staticSyncer, error) {
-	return &staticSyncer{c: c}, nil
-}
-
-func (s *staticSyncer) isStatic(filename string) bool {
-	return s.c.hugo().BaseFs.SourceFilesystems.IsStatic(filename)
-}
-
-func (s *staticSyncer) syncsStaticEvents(staticEvents []fsnotify.Event) error {
-	c := s.c
-
-	syncFn := func(sourceFs *filesystems.SourceFilesystem) (uint64, error) {
-		publishDir := helpers.FilePathSeparator
-
-		if sourceFs.PublishFolder != "" {
-			publishDir = filepath.Join(publishDir, sourceFs.PublishFolder)
-		}
-
-		syncer := fsync.NewSyncer()
-		syncer.NoTimes = c.Cfg.GetBool("noTimes")
-		syncer.NoChmod = c.Cfg.GetBool("noChmod")
-		syncer.ChmodFilter = chmodFilter
-		syncer.SrcFs = sourceFs.Fs
-		syncer.DestFs = c.Fs.PublishDir
-		if c.renderStaticToDisk {
-			syncer.DestFs = c.Fs.PublishDirStatic
-		}
-
-		// prevent spamming the log on changes
-		logger := helpers.NewDistinctErrorLogger()
-
-		for _, ev := range staticEvents {
-			// Due to our approach of layering both directories and the content's rendered output
-			// into one we can't accurately remove a file not in one of the source directories.
-			// If a file is in the local static dir and also in the theme static dir and we remove
-			// it from one of those locations we expect it to still exist in the destination
-			//
-			// If Hugo generates a file (from the content dir) over a static file
-			// the content generated file should take precedence.
-			//
-			// Because we are now watching and handling individual events it is possible that a static
-			// event that occupies the same path as a content generated file will take precedence
-			// until a regeneration of the content takes places.
-			//
-			// Hugo assumes that these cases are very rare and will permit this bad behavior
-			// The alternative is to track every single file and which pipeline rendered it
-			// and then to handle conflict resolution on every event.
-
-			fromPath := ev.Name
-
-			relPath, found := sourceFs.MakePathRelative(fromPath)
-
-			if !found {
-				// Not member of this virtual host.
-				continue
-			}
-
-			// Remove || rename is harder and will require an assumption.
-			// Hugo takes the following approach:
-			// If the static file exists in any of the static source directories after this event
-			// Hugo will re-sync it.
-			// If it does not exist in all of the static directories Hugo will remove it.
-			//
-			// This assumes that Hugo has not generated content on top of a static file and then removed
-			// the source of that static file. In this case Hugo will incorrectly remove that file
-			// from the published directory.
-			if ev.Op&fsnotify.Rename == fsnotify.Rename || ev.Op&fsnotify.Remove == fsnotify.Remove {
-				if _, err := sourceFs.Fs.Stat(relPath); os.IsNotExist(err) {
-					// If file doesn't exist in any static dir, remove it
-					logger.Println("File no longer exists in static dir, removing", relPath)
-					_ = c.Fs.PublishDirStatic.RemoveAll(relPath)
-
-				} else if err == nil {
-					// If file still exists, sync it
-					logger.Println("Syncing", relPath, "to", publishDir)
-
-					if err := syncer.Sync(relPath, relPath); err != nil {
-						c.logger.Errorln(err)
-					}
-				} else {
-					c.logger.Errorln(err)
-				}
-
-				continue
-			}
-
-			// For all other event operations Hugo will sync static.
-			logger.Println("Syncing", relPath, "to", publishDir)
-			if err := syncer.Sync(filepath.Join(publishDir, relPath), relPath); err != nil {
-				c.logger.Errorln(err)
-			}
-		}
-
-		return 0, nil
-	}
-
-	_, err := c.doWithPublishDirs(syncFn)
-	return err
-}

commands/version.go

@@ -1,44 +0,0 @@
-// Copyright 2015 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/common/hugo"
-	"github.com/spf13/cobra"
-	jww "github.com/spf13/jwalterweatherman"
-)
-
-var _ cmder = (*versionCmd)(nil)
-
-type versionCmd struct {
-	*baseCmd
-}
-
-func newVersionCmd() *versionCmd {
-	return &versionCmd{
-		newBaseCmd(&cobra.Command{
-			Use:   "version",
-			Short: "Print the version number of Hugo",
-			Long:  `All software has versions. This is Hugo's.`,
-			RunE: func(cmd *cobra.Command, args []string) error {
-				printHugoVersion()
-				return nil
-			},
-		}),
-	}
-}
-
-func printHugoVersion() {
-	jww.FEEDBACK.Println(hugo.BuildVersionString())
-}

common/collections/append.go

@@ -22,29 +22,64 @@ import (
 // If length of from is one and the only element is a slice of same type as to,
 // it will be appended.
 func Append(to any, from ...any) (any, error) {
+	if len(from) == 0 {
+		return to, nil
+	}
 	tov, toIsNil := indirect(reflect.ValueOf(to))
 
 	toIsNil = toIsNil || to == nil
 	var tot reflect.Type
 
 	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 {
 			return nil, fmt.Errorf("expected a slice, got %T", to)
 		}
 
 		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
 
 		if len(from) == 1 {
 			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 toIsNil {
 					// If we get nil []string, we just return the []string
 					return from[0], nil
 				}
 
-				fromt := reflect.TypeOf(from[0]).Elem()
-
 				// If we get []string []string, we append the from slice to to
 				if tot == fromt {
 					return reflect.AppendSlice(tov, fromv).Interface(), nil
@@ -52,6 +87,7 @@ func Append(to any, from ...any) (any, error) {
 					// Fall back to a []interface{} slice.
 					return appendToInterfaceSliceFromValues(tov, fromv)
 				}
+
 			}
 		}
 	}
@@ -62,7 +98,7 @@ func Append(to any, from ...any) (any, error) {
 
 	for _, f := range from {
 		fv := reflect.ValueOf(f)
-		if !fv.Type().AssignableTo(tot) {
+		if !fv.IsValid() || !fv.Type().AssignableTo(tot) {
 			// Fall back to a []interface{} slice.
 			tov, _ := indirect(reflect.ValueOf(to))
 			return appendToInterfaceSlice(tov, from...)
@@ -77,6 +113,10 @@ func appendToInterfaceSliceFromValues(slice1, slice2 reflect.Value) ([]any, erro
 	var tos []any
 
 	for _, slice := range []reflect.Value{slice1, slice2} {
+		if !slice.IsValid() {
+			tos = append(tos, nil)
+			continue
+		}
 		for i := 0; i < slice.Len(); i++ {
 			tos = append(tos, slice.Index(i).Interface())
 		}

common/collections/append_test.go

@@ -24,7 +24,7 @@ func TestAppend(t *testing.T) {
 	t.Parallel()
 	c := qt.New(t)
 
-	for _, test := range []struct {
+	for i, test := range []struct {
 		start    any
 		addend   []any
 		expected any
@@ -74,6 +74,9 @@ func TestAppend(t *testing.T) {
 			[]any{"c"},
 			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"}},
 	} {
 
 		result, err := Append(test.start, test.addend...)
@@ -85,6 +88,59 @@ func TestAppend(t *testing.T) {
 		}
 
 		c.Assert(err, qt.IsNil)
-		c.Assert(result, qt.DeepEquals, test.expected)
+		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(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"})
+}

common/collections/slice.go

@@ -15,6 +15,7 @@ package collections
 
 import (
 	"reflect"
+	"sort"
 )
 
 // Slicer defines a very generic way to create a typed slice. This is used
@@ -74,3 +75,22 @@ func StringSliceToInterfaceSlice(ss []string) []any {
 	return result
 
 }
+
+type SortedStringSlice []string
+
+// Contains returns true if s is in ss.
+func (ss SortedStringSlice) Contains(s string) bool {
+	i := sort.SearchStrings(ss, s)
+	return i < len(ss) && ss[i] == s
+}
+
+// Count returns the number of times s is in ss.
+func (ss SortedStringSlice) Count(s string) int {
+	var count int
+	i := sort.SearchStrings(ss, s)
+	for i < len(ss) && ss[i] == s {
+		count++
+		i++
+	}
+	return count
+}

common/collections/slice_test.go

@@ -122,3 +122,18 @@ func TestSlice(t *testing.T) {
 		c.Assert(test.expected, qt.DeepEquals, result, errMsg)
 	}
 }
+
+func TestSortedStringSlice(t *testing.T) {
+	t.Parallel()
+	c := qt.New(t)
+
+	var s SortedStringSlice = []string{"a", "b", "b", "b", "c", "d"}
+
+	c.Assert(s.Contains("a"), qt.IsTrue)
+	c.Assert(s.Contains("b"), qt.IsTrue)
+	c.Assert(s.Contains("z"), qt.IsFalse)
+	c.Assert(s.Count("b"), qt.Equals, 3)
+	c.Assert(s.Count("z"), qt.Equals, 0)
+	c.Assert(s.Count("a"), qt.Equals, 1)
+
+}

common/constants/constants.go

@@ -16,10 +16,28 @@ package constants
 // Error IDs.
 // Do not change these values.
 const (
-	ErrIDAmbigousDisableKindTaxonomy = "error-disable-taxonomy"
-	ErrIDAmbigousOutputKindTaxonomy  = "error-output-taxonomy"
-
 	// IDs for remote errors in tpl/data.
 	ErrRemoteGetJSON = "error-remote-getjson"
 	ErrRemoteGetCSV  = "error-remote-getcsv"
 )
+
+// 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"
+)
+
+// IsResourceTransformationLinkChange 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
+}

common/docs.go

@@ -0,0 +1,2 @@
+// Package common provides common helper functionality for Hugo.
+package common

common/hcontext/context.go

@@ -0,0 +1,46 @@
+// 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)
+}

common/herrors/error_locator.go

@@ -1,4 +1,4 @@
-// Copyright 2022 The Hugo Authors. All rights reserved.
+// 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.
@@ -16,7 +16,6 @@ package herrors
 
 import (
 	"io"
-	"io/ioutil"
 	"path/filepath"
 	"strings"
 
@@ -34,7 +33,7 @@ type LineMatcher struct {
 }
 
 // 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 determinde. Returns -1 if no line match.
+// It returns the column number or 0 if the line was found, but column could not be determined. Returns -1 if no line match.
 type LineMatcherFn func(m LineMatcher) int
 
 // SimpleLineMatcher simply matches by line number.
@@ -62,10 +61,19 @@ var OffsetMatcher = func(m LineMatcher) int {
 	return -1
 }
 
+// ContainsMatcher is a line matcher that matches by line content.
+func ContainsMatcher(text string) func(m LineMatcher) int {
+	return func(m LineMatcher) int {
+		if idx := strings.Index(m.Line, text); idx != -1 {
+			return idx + 1
+		}
+		return -1
+	}
+}
+
 // ErrorContext contains contextual information about an error. This will
 // typically be the lines surrounding some problem in a file.
 type ErrorContext struct {
-
 	// If a match will contain the matched line and up to 2 lines before and after.
 	// Will be empty if no match.
 	Lines []string
@@ -114,7 +122,7 @@ func locateError(r io.Reader, le FileError, matches LineMatcherFn) *ErrorContext
 
 	ectx := &ErrorContext{LinesPos: -1, Position: text.Position{Offset: -1}}
 
-	b, err := ioutil.ReadAll(r)
+	b, err := io.ReadAll(r)
 	if err != nil {
 		return ectx
 	}

common/herrors/error_locator_test.go

@@ -1,4 +1,4 @@
-// Copyright 2022 The Hugo Authors. All rights reserved.
+// 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.

common/herrors/errors.go

@@ -1,4 +1,4 @@
-// Copyright 2018 The Hugo Authors. All rights reserved.
+// 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.
@@ -15,13 +15,13 @@
 package herrors
 
 import (
-	"bytes"
 	"errors"
 	"fmt"
 	"io"
+	"os"
 	"runtime"
 	"runtime/debug"
-	"strconv"
+	"time"
 )
 
 // PrintStackTrace prints the current stacktrace to w.
@@ -38,7 +38,8 @@ type ErrorSender interface {
 
 // Recover is a helper function that can be used to capture panics.
 // Put this at the top of a method/function that crashes in a template:
-//     defer herrors.Recover()
+//
+//	defer herrors.Recover()
 func Recover(args ...any) {
 	if r := recover(); r != nil {
 		fmt.Println("ERR:", r)
@@ -47,21 +48,52 @@ func Recover(args ...any) {
 	}
 }
 
-// Get the current goroutine id. Used only for debugging.
-func GetGID() uint64 {
-	b := make([]byte, 64)
-	b = b[:runtime.Stack(b, false)]
-	b = bytes.TrimPrefix(b, []byte("goroutine "))
-	b = b[:bytes.IndexByte(b, ' ')]
-	n, _ := strconv.ParseUint(string(b), 10, 64)
-	return n
+// IsTimeoutError returns true if the given error is or contains a TimeoutError.
+func IsTimeoutError(err error) bool {
+	return errors.Is(err, &TimeoutError{})
+}
+
+type TimeoutError struct {
+	Duration time.Duration
+}
+
+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
+}
+
+// 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.
 //
 // We will, at least to begin with, make some Hugo features (SCSS with libsass) optional,
 // and this error is used to signal those situations.
-var ErrFeatureNotAvailable = errors.New("this feature is not available in your current Hugo version, see https://goo.gl/YMrWcn for more information")
+var ErrFeatureNotAvailable = &FeatureNotAvailableError{Cause: 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.
 func Must(err error) {
@@ -69,3 +101,18 @@ func Must(err error) {
 		panic(err)
 	}
 }
+
+// IsNotExist returns true if the error is a file not found error.
+// Unlike os.IsNotExist, this also considers wrapped errors.
+func IsNotExist(err error) bool {
+	if os.IsNotExist(err) {
+		return true
+	}
+
+	// os.IsNotExist does not consider wrapped errors.
+	if os.IsNotExist(errors.Unwrap(err)) {
+		return true
+	}
+
+	return false
+}

common/herrors/errors_test.go

@@ -0,0 +1,45 @@
+// 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 herrors
+
+import (
+	"errors"
+	"fmt"
+	"testing"
+
+	qt "github.com/frankban/quicktest"
+	"github.com/spf13/afero"
+)
+
+func TestIsNotExist(t *testing.T) {
+	c := qt.New(t)
+
+	c.Assert(IsNotExist(afero.ErrFileNotFound), qt.Equals, true)
+	c.Assert(IsNotExist(afero.ErrFileExists), qt.Equals, false)
+	c.Assert(IsNotExist(afero.ErrDestinationExists), qt.Equals, false)
+	c.Assert(IsNotExist(nil), qt.Equals, false)
+
+	c.Assert(IsNotExist(fmt.Errorf("foo")), qt.Equals, false)
+
+	// os.IsNotExist returns false for wrapped errors.
+	c.Assert(IsNotExist(fmt.Errorf("foo: %w", afero.ErrFileNotFound)), qt.Equals, true)
+}
+
+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)
+}

common/herrors/file_error.go

@@ -1,4 +1,4 @@
-// Copyright 2022 The Hugo Authors. All rights reserved.
+// 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.
@@ -15,19 +15,20 @@ package herrors
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
 	"path/filepath"
 
-	"github.com/bep/godartsass"
+	godartsassv1 "github.com/bep/godartsass"
+
+	"github.com/bep/godartsass/v2"
 	"github.com/bep/golibsass/libsass/libsasserrors"
 	"github.com/gohugoio/hugo/common/paths"
 	"github.com/gohugoio/hugo/common/text"
 	"github.com/pelletier/go-toml/v2"
 	"github.com/spf13/afero"
 	"github.com/tdewolff/parse/v2"
-
-	"errors"
 )
 
 // FileError represents an error when handling a file: Parsing a config file,
@@ -35,7 +36,7 @@ import (
 type FileError interface {
 	error
 
-	// ErroContext holds some context information about the error.
+	// ErrorContext holds some context information about the error.
 	ErrorContext() *ErrorContext
 
 	text.Positioner
@@ -45,6 +46,9 @@ type FileError interface {
 
 	// UpdateContent updates the error with a new ErrorContext from the content of the file.
 	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.
@@ -57,6 +61,11 @@ var (
 	_ Unwrapper = (*fileError)(nil)
 )
 
+func (fe *fileError) SetFilename(filename string) FileError {
+	fe.position.Filename = filename
+	return fe
+}
+
 func (fe *fileError) UpdatePosition(pos text.Position) FileError {
 	oldFilename := fe.Position().Filename
 	if pos.Filename != "" && fe.fileType == "" {
@@ -112,7 +121,6 @@ func (fe *fileError) UpdateContent(r io.Reader, linematcher LineMatcherFn) FileE
 	}
 
 	return fe
-
 }
 
 type fileError struct {
@@ -145,6 +153,8 @@ func (e *fileError) causeString() string {
 	// Avoid repeating the file info in the error message.
 	case godartsass.SassError:
 		return v.Message
+	case godartsassv1.SassError:
+		return v.Message
 	case libsasserrors.Error:
 		return v.Message
 	default:
@@ -176,7 +186,6 @@ func NewFileErrorFromName(err error, name string) FileError {
 	}
 
 	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.
@@ -187,7 +196,6 @@ func NewFileErrorFromPos(err error, pos text.Position) FileError {
 		_, fileType = paths.FileAndExtNoDelimiter(filepath.Clean(pos.Filename))
 	}
 	return &fileError{cause: err, fileType: fileType, position: pos}
-
 }
 
 func NewFileErrorFromFileInErr(err error, fs afero.Fs, linematcher LineMatcherFn) FileError {
@@ -244,7 +252,6 @@ func openFile(filename string, fs afero.Fs) (afero.File, string, error) {
 		}); ok {
 			realFilename = s.Filename()
 		}
-
 	}
 
 	f, err2 := fs.Open(filename)
@@ -292,7 +299,7 @@ func extractFileTypePos(err error) (string, text.Position) {
 	}
 
 	// The error type from the minifier contains line number and column number.
-	if line, col := exctractLineNumberAndColumnNumber(err); line >= 0 {
+	if line, col := extractLineNumberAndColumnNumber(err); line >= 0 {
 		pos.LineNumber = line
 		pos.ColumnNumber = col
 		return fileType, pos
@@ -364,7 +371,7 @@ func extractOffsetAndType(e error) (int, string) {
 	}
 }
 
-func exctractLineNumberAndColumnNumber(e error) (int, int) {
+func extractLineNumberAndColumnNumber(e error) (int, int) {
 	switch v := e.(type) {
 	case *parse.Error:
 		return v.Line, v.Column
@@ -385,6 +392,13 @@ func extractPosition(e error) (pos text.Position) {
 		pos.Filename = filename
 		pos.Offset = start.Offset
 		pos.ColumnNumber = start.Column
+	case godartsassv1.SassError:
+		span := v.Span
+		start := span.Start
+		filename, _ := paths.UrlToFilename(span.Url)
+		pos.Filename = filename
+		pos.Offset = start.Offset
+		pos.ColumnNumber = start.Column
 	case libsasserrors.Error:
 		pos.Filename = v.File
 		pos.LineNumber = v.Line
@@ -392,3 +406,17 @@ func extractPosition(e error) (pos text.Position) {
 	}
 	return
 }
+
+// TextSegmentError is an error with a text segment attached.
+type TextSegmentError struct {
+	Segment string
+	Err     error
+}
+
+func (e TextSegmentError) Unwrap() error {
+	return e.Err
+}
+
+func (e TextSegmentError) Error() string {
+	return e.Err.Error()
+}

common/herrors/file_error_test.go

@@ -1,4 +1,4 @@
-// Copyright 2022 The Hugo Authors. All rights reserved.
+// 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.
@@ -14,12 +14,11 @@
 package herrors
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 	"testing"
 
-	"errors"
-
 	"github.com/gohugoio/hugo/common/text"
 
 	qt "github.com/frankban/quicktest"
@@ -48,7 +47,6 @@ 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.LinesPos, qt.Equals, 2)
 	c.Assert(errorContext.ChromaLexer, qt.Equals, "go-html-template")
-
 }
 
 func TestNewFileErrorExtractFromMessage(t *testing.T) {

common/hexec/exec.go

@@ -118,7 +118,7 @@ func SafeCommand(name string, arg ...string) (*exec.Cmd, error) {
 	return exec.Command(bin, arg...), nil
 }
 
-// Exec encorces a security policy for commands run via os/exec.
+// Exec enforces a security policy for commands run via os/exec.
 type Exec struct {
 	sc security.Config
 

common/hreflect/helpers.go

@@ -1,4 +1,4 @@
-// Copyright 2019 The Hugo Authors. All rights reserved.
+// 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.
 //
@@ -23,6 +23,7 @@ import (
 	"time"
 
 	"github.com/gohugoio/hugo/common/htime"
+	"github.com/gohugoio/hugo/common/maps"
 	"github.com/gohugoio/hugo/common/types"
 )
 
@@ -188,6 +189,20 @@ func IsTime(tp reflect.Type) bool {
 	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.
 // 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.
@@ -208,6 +223,23 @@ func AsTime(v reflect.Value, loc *time.Location) (time.Time, bool) {
 	return time.Time{}, false
 }
 
+func CallMethodByName(cxt context.Context, name string, v reflect.Value) []reflect.Value {
+	fn := v.MethodByName(name)
+	var args []reflect.Value
+	tp := fn.Type()
+	if tp.NumIn() > 0 {
+		if tp.NumIn() > 1 {
+			panic("not supported")
+		}
+		first := tp.In(0)
+		if IsContextType(first) {
+			args = append(args, reflect.ValueOf(cxt))
+		}
+	}
+
+	return fn.Call(args)
+}
+
 // Based on: https://github.com/golang/go/blob/178a2c42254166cffed1b25fb1d3c7a5727cada6/src/text/template/exec.go#L931
 func indirectInterface(v reflect.Value) reflect.Value {
 	if v.Kind() != reflect.Interface {
@@ -219,4 +251,24 @@ func indirectInterface(v reflect.Value) reflect.Value {
 	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
+	}
+
+	return isContextCache.GetOrCreate(tp, func() bool {
+		return tp.Implements(contextInterface)
+	})
+}

common/hreflect/helpers_test.go

@@ -14,6 +14,7 @@
 package hreflect
 
 import (
+	"context"
 	"reflect"
 	"testing"
 	"time"
@@ -40,6 +41,42 @@ func TestGetMethodByName(t *testing.T) {
 	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 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) {
 	v := reflect.ValueOf("Hugo")
 

common/hstrings/strings.go

@@ -0,0 +1,129 @@
+// 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 hstrings
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+	"sync"
+
+	"github.com/gohugoio/hugo/compare"
+)
+
+var _ compare.Eqer = StringEqualFold("")
+
+// StringEqualFold is a string that implements the compare.Eqer interface and considers
+// two strings equal if they are equal when folded to lower case.
+// The compare.Eqer interface is used in Hugo to compare values in templates (e.g. using the eq template function).
+type StringEqualFold string
+
+func (s StringEqualFold) EqualFold(s2 string) bool {
+	return strings.EqualFold(string(s), s2)
+}
+
+func (s StringEqualFold) String() string {
+	return string(s)
+}
+
+func (s StringEqualFold) Eq(s2 any) bool {
+	switch ss := s2.(type) {
+	case string:
+		return s.EqualFold(ss)
+	case fmt.Stringer:
+		return s.EqualFold(ss.String())
+	}
+
+	return false
+}
+
+// EqualAny returns whether a string is equal to any of the given strings.
+func EqualAny(a string, b ...string) bool {
+	for _, s := range b {
+		if a == s {
+			return true
+		}
+	}
+	return false
+}
+
+// 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 {
+	for _, v := range arr {
+		if v == el {
+			return true
+		}
+	}
+	return false
+}
+
+// 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 false
+}
+
+type Tuple struct {
+	First  string
+	Second string
+}

common/hstrings/strings_test.go

@@ -0,0 +1,56 @@
+// 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 hstrings
+
+import (
+	"regexp"
+	"testing"
+
+	qt "github.com/frankban/quicktest"
+)
+
+func TestStringEqualFold(t *testing.T) {
+	c := qt.New(t)
+
+	s1 := "A"
+	s2 := "a"
+
+	c.Assert(StringEqualFold(s1).EqualFold(s2), qt.Equals, true)
+	c.Assert(StringEqualFold(s1).EqualFold(s1), qt.Equals, true)
+	c.Assert(StringEqualFold(s2).EqualFold(s1), qt.Equals, true)
+	c.Assert(StringEqualFold(s2).EqualFold(s2), qt.Equals, true)
+	c.Assert(StringEqualFold(s1).EqualFold("b"), qt.Equals, false)
+	c.Assert(StringEqualFold(s1).Eq(s2), qt.Equals, true)
+	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+`)
+	}
+}

common/htime/integration_test.go

@@ -0,0 +1,83 @@
+// 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.NewIntegrationTestBuilder(
+		hugolib.IntegrationTestConfig{
+			T:           t,
+			TxtarString: files,
+		},
+	).Build()
+
+	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_
+`)
+}

common/htime/time.go

@@ -14,10 +14,11 @@
 package htime
 
 import (
+	"log"
 	"strings"
 	"time"
 
-	"github.com/bep/clock"
+	"github.com/bep/clocks"
 	"github.com/spf13/cast"
 
 	"github.com/gohugoio/locales"
@@ -74,7 +75,7 @@ var (
 		"December",
 	}
 
-	Clock = clock.System()
+	Clock = clocks.System()
 )
 
 func NewTimeFormatter(ltr locales.Translator) TimeFormatter {
@@ -123,12 +124,15 @@ func (f TimeFormatter) Format(t time.Time, layout string) string {
 	monthIdx := t.Month() - 1 // Month() starts at 1.
 	dayIdx := t.Weekday()
 
-	s = strings.ReplaceAll(s, longMonthNames[monthIdx], f.ltr.MonthWide(t.Month()))
-	if !strings.Contains(s, f.ltr.MonthWide(t.Month())) {
+	if strings.Contains(layout, "January") {
+		s = strings.ReplaceAll(s, longMonthNames[monthIdx], f.ltr.MonthWide(t.Month()))
+	} else if strings.Contains(layout, "Jan") {
 		s = strings.ReplaceAll(s, shortMonthNames[monthIdx], f.ltr.MonthAbbreviated(t.Month()))
 	}
-	s = strings.ReplaceAll(s, longDayNames[dayIdx], f.ltr.WeekdayWide(t.Weekday()))
-	if !strings.Contains(s, f.ltr.WeekdayWide(t.Weekday())) {
+
+	if strings.Contains(layout, "Monday") {
+		s = strings.ReplaceAll(s, longDayNames[dayIdx], f.ltr.WeekdayWide(t.Weekday()))
+	} else if strings.Contains(layout, "Mon") {
 		s = strings.ReplaceAll(s, shortDayNames[dayIdx], f.ltr.WeekdayAbbreviated(t.Weekday()))
 	}
 
@@ -163,3 +167,11 @@ func Since(t time.Time) time.Duration {
 type AsTimeProvider interface {
 	AsTime(zone *time.Location) time.Time
 }
+
+// StopWatch is a simple helper to measure time during development.
+func StopWatch(name string) func() {
+	start := time.Now()
+	return func() {
+		log.Printf("StopWatch %q took %s", name, time.Since(start))
+	}
+}

common/hugio/copy.go

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

common/hugio/hasBytesWriter.go

@@ -1,4 +1,4 @@
-// Copyright 2022 The Hugo Authors. All rights reserved.
+// 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.

common/hugio/hasBytesWriter_test.go

@@ -1,4 +1,4 @@
-// Copyright 2022 The Hugo Authors. All rights reserved.
+// 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.

common/hugio/readers.go

@@ -14,6 +14,7 @@
 package hugio
 
 import (
+	"bytes"
 	"io"
 	"strings"
 )
@@ -57,3 +58,22 @@ func NewReadSeekerNoOpCloser(r ReadSeeker) ReadSeekerNoOpCloser {
 func NewReadSeekerNoOpCloserFromString(content string) ReadSeekerNoOpCloser {
 	return ReadSeekerNoOpCloser{strings.NewReader(content)}
 }
+
+// NewReadSeekerNoOpCloserFromString uses strings.NewReader to create a new ReadSeekerNoOpCloser
+// from the given bytes slice.
+func NewReadSeekerNoOpCloserFromBytes(content []byte) ReadSeekerNoOpCloser {
+	return ReadSeekerNoOpCloser{bytes.NewReader(content)}
+}
+
+// NewReadSeekCloser 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)

common/hugio/writers.go

@@ -15,7 +15,6 @@ package hugio
 
 import (
 	"io"
-	"io/ioutil"
 )
 
 // As implemented by strings.Builder.
@@ -34,7 +33,7 @@ type multiWriteCloser struct {
 func (m multiWriteCloser) Close() error {
 	var err error
 	for _, c := range m.closers {
-		if closeErr := c.Close(); err != nil {
+		if closeErr := c.Close(); closeErr != nil {
 			err = closeErr
 		}
 	}
@@ -63,7 +62,7 @@ func ToWriteCloser(w io.Writer) io.WriteCloser {
 		io.Closer
 	}{
 		w,
-		ioutil.NopCloser(nil),
+		io.NopCloser(nil),
 	}
 }
 
@@ -79,6 +78,6 @@ func ToReadCloser(r io.Reader) io.ReadCloser {
 		io.Closer
 	}{
 		r,
-		ioutil.NopCloser(nil),
+		io.NopCloser(nil),
 	}
 }

common/hugo/hugo.go

@@ -24,10 +24,19 @@ import (
 	"sync"
 	"time"
 
+	godartsassv1 "github.com/bep/godartsass"
+	"github.com/bep/logg"
+	"github.com/mitchellh/mapstructure"
+
+	"github.com/bep/godartsass/v2"
+	"github.com/gohugoio/hugo/common/hexec"
+	"github.com/gohugoio/hugo/common/loggers"
 	"github.com/gohugoio/hugo/hugofs/files"
 
 	"github.com/spf13/afero"
 
+	iofs "io/fs"
+
 	"github.com/gohugoio/hugo/config"
 	"github.com/gohugoio/hugo/hugofs"
 )
@@ -44,8 +53,8 @@ var (
 	vendorInfo string
 )
 
-// Info contains information about the current Hugo environment
-type Info struct {
+// HugoInfo contains information about the current Hugo environment
+type HugoInfo struct {
 	CommitHash string
 	BuildDate  string
 
@@ -58,36 +67,61 @@ type Info struct {
 	// version of go that the Hugo binary was built with
 	GoVersion string
 
+	conf ConfigProvider
 	deps []*Dependency
 }
 
 // Version returns the current version as a comparable version string.
-func (i Info) Version() VersionString {
+func (i HugoInfo) Version() VersionString {
 	return CurrentVersion.Version()
 }
 
 // Generator a Hugo meta generator HTML tag.
-func (i Info) Generator() template.HTML {
-	return template.HTML(fmt.Sprintf(`<meta name="generator" content="Hugo %s" />`, CurrentVersion.String()))
+func (i HugoInfo) Generator() template.HTML {
+	return template.HTML(fmt.Sprintf(`<meta name="generator" content="Hugo %s">`, CurrentVersion.String()))
 }
 
-func (i Info) IsProduction() bool {
+// 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 {
 	return i.Environment == EnvironmentProduction
 }
 
-func (i Info) IsExtended() bool {
+// 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 {
 	return IsExtended
 }
 
+// WorkingDir returns the project working directory.
+func (i HugoInfo) WorkingDir() string {
+	return i.conf.WorkingDir()
+}
+
 // Deps gets a list of dependencies for this Hugo build.
-func (i Info) Deps() []*Dependency {
+func (i HugoInfo) Deps() []*Dependency {
 	return i.deps
 }
 
+// ConfigProvider represents the config options that are relevant for HugoInfo.
+type ConfigProvider interface {
+	Environment() string
+	Running() bool
+	WorkingDir() string
+}
+
 // NewInfo creates a new Hugo Info object.
-func NewInfo(environment string, deps []*Dependency) Info {
-	if environment == "" {
-		environment = EnvironmentProduction
+func NewInfo(conf ConfigProvider, deps []*Dependency) HugoInfo {
+	if conf.Environment() == "" {
+		panic("environment not set")
 	}
 	var (
 		commitHash string
@@ -102,10 +136,11 @@ func NewInfo(environment string, deps []*Dependency) Info {
 		goVersion = bi.GoVersion
 	}
 
-	return Info{
+	return HugoInfo{
 		CommitHash:  commitHash,
 		BuildDate:   buildDate,
-		Environment: environment,
+		Environment: conf.Environment(),
+		conf:        conf,
 		deps:        deps,
 		GoVersion:   goVersion,
 	}
@@ -113,7 +148,7 @@ func NewInfo(environment string, deps []*Dependency) Info {
 
 // GetExecEnviron creates and gets the common os/exec environment used in the
 // external programs we interact with via os/exec, e.g. postcss.
-func GetExecEnviron(workDir string, cfg config.Provider, fs afero.Fs) []string {
+func GetExecEnviron(workDir string, cfg config.AllProvider, fs afero.Fs) []string {
 	var env []string
 	nodepath := filepath.Join(workDir, "node_modules")
 	if np := os.Getenv("NODE_PATH"); np != "" {
@@ -121,11 +156,17 @@ func GetExecEnviron(workDir string, cfg config.Provider, fs afero.Fs) []string {
 	}
 	config.SetEnvVars(&env, "NODE_PATH", nodepath)
 	config.SetEnvVars(&env, "PWD", workDir)
-	config.SetEnvVars(&env, "HUGO_ENVIRONMENT", cfg.GetString("environment"))
-	config.SetEnvVars(&env, "HUGO_ENV", cfg.GetString("environment"))
+	config.SetEnvVars(&env, "HUGO_ENVIRONMENT", cfg.Environment())
+	config.SetEnvVars(&env, "HUGO_ENV", cfg.Environment())
+	config.SetEnvVars(&env, "HUGO_PUBLISHDIR", filepath.Join(workDir, cfg.BaseConfig().PublishDir))
 
 	if fs != nil {
-		fis, err := afero.ReadDir(fs, files.FolderJSConfig)
+		var fis []iofs.DirEntry
+		d, err := fs.Open(files.FolderJSConfig)
+		if err == nil {
+			fis, err = d.(iofs.ReadDirFile).ReadDir(-1)
+		}
+
 		if err == nil {
 			for _, fi := range fis {
 				key := fmt.Sprintf("HUGO_FILE_%s", strings.ReplaceAll(strings.ToUpper(fi.Name()), ".", "_"))
@@ -150,8 +191,10 @@ type buildInfo struct {
 	*debug.BuildInfo
 }
 
-var bInfo *buildInfo
-var bInfoInit sync.Once
+var (
+	bInfo     *buildInfo
+	bInfoInit sync.Once
+)
 
 func getBuildInfo() *buildInfo {
 	bInfoInit.Do(func() {
@@ -178,30 +221,20 @@ func getBuildInfo() *buildInfo {
 				bInfo.GoArch = s.Value
 			}
 		}
-
 	})
 
 	return bInfo
 }
 
+func formatDep(path, version string) string {
+	return fmt.Sprintf("%s=%q", path, version)
+}
+
 // GetDependencyList returns a sorted dependency list on the format package="version".
 // It includes both Go dependencies and (a manually maintained) list of C(++) dependencies.
 func GetDependencyList() []string {
 	var deps []string
 
-	formatDep := func(path, version string) string {
-		return fmt.Sprintf("%s=%q", path, version)
-	}
-
-	if IsExtended {
-		deps = append(
-			deps,
-			// TODO(bep) consider adding a DepsNonGo() method to these upstream projects.
-			formatDep("github.com/sass/libsass", "3.6.5"),
-			formatDep("github.com/webmproject/libwebp", "v1.2.0"),
-		)
-	}
-
 	bi := getBuildInfo()
 	if bi == nil {
 		return deps
@@ -211,11 +244,39 @@ func GetDependencyList() []string {
 		deps = append(deps, formatDep(dep.Path, dep.Version))
 	}
 
+	deps = append(deps, GetDependencyListNonGo()...)
+
 	sort.Strings(deps)
 
 	return deps
 }
 
+// GetDependencyListNonGo returns a list of non-Go dependencies.
+func GetDependencyListNonGo() []string {
+	var deps []string
+
+	if IsExtended {
+		deps = append(
+			deps,
+			formatDep("github.com/sass/libsass", "3.6.5"),
+			formatDep("github.com/webmproject/libwebp", "v1.3.2"),
+		)
+	}
+
+	if dartSass := dartSassVersion(); dartSass.ProtocolVersion != "" {
+		dartSassPath := "github.com/sass/dart-sass-embedded"
+		if IsDartSassV2() {
+			dartSassPath = "github.com/sass/dart-sass"
+		}
+		deps = append(deps,
+			formatDep(dartSassPath+"/protocol", dartSass.ProtocolVersion),
+			formatDep(dartSassPath+"/compiler", dartSass.CompilerVersion),
+			formatDep(dartSassPath+"/implementation", dartSass.ImplementationVersion),
+		)
+	}
+	return deps
+}
+
 // IsRunningAsTest reports whether we are running as a test.
 func IsRunningAsTest() bool {
 	for _, arg := range os.Args {
@@ -249,3 +310,90 @@ type Dependency struct {
 	// Replaced by this dependency.
 	Replace *Dependency
 }
+
+func dartSassVersion() godartsass.DartSassVersion {
+	if DartSassBinaryName == "" {
+		return godartsass.DartSassVersion{}
+	}
+	if IsDartSassV2() {
+		v, _ := godartsass.Version(DartSassBinaryName)
+		return v
+	}
+
+	v, _ := godartsassv1.Version(DartSassBinaryName)
+	var vv godartsass.DartSassVersion
+	mapstructure.WeakDecode(v, &vv)
+	return vv
+}
+
+// DartSassBinaryName is the name of the Dart Sass binary to use.
+// TODO(beop) 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"}
+)
+
+func IsDartSassV2() bool {
+	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)
+}
+
+// DeprecateLevel informs about a deprecation logging at the given level.
+func DeprecateLevel(item, alternative, version string, level logg.Level) {
+	var msg string
+	if level == logg.LevelError {
+		msg = fmt.Sprintf("%s was deprecated in Hugo %s and will be removed in Hugo %s. %s", item, version, CurrentVersion.Next().ReleaseVersion(), alternative)
+	} else {
+		msg = fmt.Sprintf("%s was deprecated in Hugo %s and will be removed in a future release. %s", item, version, alternative)
+	}
+
+	loggers.Log().Logger().WithLevel(level).WithField(loggers.FieldNameCmd, "deprecated").Logf(msg)
+}
+
+// We ususally 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 >= 12:
+		// Start failing the build after about a year.
+		return logg.LevelError
+	case minorDiff >= 6:
+		// Start printing warnings after about six months.
+		return logg.LevelWarn
+	default:
+		return logg.LevelInfo
+	}
+}

common/hugo/hugo_test.go

@@ -17,16 +17,19 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/bep/logg"
 	qt "github.com/frankban/quicktest"
 )
 
 func TestHugoInfo(t *testing.T) {
 	c := qt.New(t)
 
-	hugoInfo := NewInfo("", nil)
+	conf := testConfig{environment: "production", workingDir: "/mywork", running: false}
+	hugoInfo := NewInfo(conf, nil)
 
 	c.Assert(hugoInfo.Version(), qt.Equals, CurrentVersion.Version())
 	c.Assert(fmt.Sprintf("%T", VersionString("")), qt.Equals, fmt.Sprintf("%T", hugoInfo.Version()))
+	c.Assert(hugoInfo.WorkingDir(), qt.Equals, "/mywork")
 
 	bi := getBuildInfo()
 	if bi != nil {
@@ -36,9 +39,45 @@ func TestHugoInfo(t *testing.T) {
 	}
 	c.Assert(hugoInfo.Environment, qt.Equals, "production")
 	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.IsExtended(), qt.Equals, IsExtended)
+	c.Assert(hugoInfo.IsServer(), qt.Equals, false)
 
-	devHugoInfo := NewInfo("development", nil)
+	devHugoInfo := NewInfo(testConfig{environment: "development", running: true}, nil)
+	c.Assert(devHugoInfo.IsDevelopment(), qt.Equals, true)
 	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 -= 1
+	c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelInfo)
+	ver.Minor -= 6
+	c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelWarn)
+	ver.Minor -= 6
+	c.Assert(deprecationLogLevelFromVersion(ver.String()), qt.Equals, logg.LevelError)
+}
+
+type testConfig struct {
+	environment string
+	running     bool
+	workingDir  string
+}
+
+func (c testConfig) Environment() string {
+	return c.environment
+}
+
+func (c testConfig) Running() bool {
+	return c.running
+}
+
+func (c testConfig) WorkingDir() string {
+	return c.workingDir
 }

common/hugo/version.go

@@ -67,8 +67,11 @@ func (h VersionString) String() string {
 
 // Compare implements the compare.Comparer interface.
 func (h VersionString) Compare(other any) int {
-	v := MustParseVersion(h.String())
-	return compareVersions(v, other)
+	return compareVersions(h.Version(), other)
+}
+
+func (h VersionString) Version() Version {
+	return MustParseVersion(h.String())
 }
 
 // Eq implements the compare.Eqer interface.
@@ -264,7 +267,6 @@ func compareFloatWithVersion(v1 float64, v2 Version) int {
 
 	if v1maj > v2.Major {
 		return 1
-
 	}
 
 	if v1maj < v2.Major {
@@ -276,7 +278,6 @@ func compareFloatWithVersion(v1 float64, v2 Version) int {
 	}
 
 	return -1
-
 }
 
 func GoMinorVersion() int {

common/hugo/version_current.go

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

common/loggers/handlerdefault.go

@@ -0,0 +1,106 @@
+// 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
+}

common/loggers/handlersmisc.go

@@ -0,0 +1,145 @@
+// 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/identity"
+)
+
+// 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 := identity.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
+	})
+}

common/loggers/handlerterminal.go

@@ -0,0 +1,90 @@
+// 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"
+	"strings"
+	"sync"
+
+	"github.com/bep/logg"
+)
+
+// newNoColoursHandler creates a new NoColoursHandler
+func newNoColoursHandler(outWriter, errWriter io.Writer, noLevelPrefix bool, predicate func(*logg.Entry) bool) *noColoursHandler {
+	if predicate == nil {
+		predicate = func(e *logg.Entry) bool { return true }
+	}
+	return &noColoursHandler{
+		noLevelPrefix: noLevelPrefix,
+		outWriter:     outWriter,
+		errWriter:     errWriter,
+		predicate:     predicate,
+	}
+}
+
+type noColoursHandler struct {
+	mu            sync.Mutex
+	outWriter     io.Writer // Defaults to os.Stdout.
+	errWriter     io.Writer // Defaults to os.Stderr.
+	predicate     func(*logg.Entry) bool
+	noLevelPrefix bool
+}
+
+func (h *noColoursHandler) 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 + ": "
+	}
+
+	if h.noLevelPrefix {
+		fmt.Fprintf(w, "%s%s", prefix, e.Message)
+	} else {
+		fmt.Fprintf(w, "%s %s%s", levelString[e.Level], prefix, e.Message)
+	}
+
+	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
+}

common/loggers/ignorableLogger.go

@@ -1,65 +0,0 @@
-// 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"
-	"strings"
-)
-
-// 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 ...string) IgnorableLogger {
-	statementsSet := make(map[string]bool)
-	for _, s := range statements {
-		statementsSet[strings.ToLower(s)] = true
-	}
-	return ignorableLogger{
-		Logger:     logger,
-		statements: statementsSet,
-	}
-}
-
-// 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,
-	}
-}

common/loggers/logger.go

@@ -0,0 +1,368 @@
+// 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.Stdout
+	}
+	if opts.Level == 0 {
+		opts.Level = logg.LevelWarn
+	}
+
+	var logHandler logg.Handler
+	if terminal.PrintANSIColors(os.Stdout) {
+		logHandler = newDefaultHandler(opts.Stdout, opts.Stderr)
+	} else {
+		logHandler = newNoColoursHandler(opts.Stdout, 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 := newNoColoursHandler(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 opts.SuppressStatements != nil && 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,
+		out:         opts.Stdout,
+		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,
+		Stdout:        os.Stdout,
+		Stderr:        os.Stdout,
+	}
+	return New(opts)
+}
+
+func NewTrace() Logger {
+	opts := Options{
+		DistinctLevel: logg.LevelWarn,
+		Level:         logg.LevelTrace,
+		Stdout:        os.Stdout,
+		Stderr:        os.Stdout,
+	}
+	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)
+	Errorln(v ...any)
+	Errors() string
+	Errorsf(id, format string, v ...any)
+	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
+	Out() 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)
+	Warnln(v ...any)
+	Deprecatef(fail bool, format string, v ...any)
+	Trace(s logg.StringFunc)
+}
+
+type logAdapter struct {
+	logCounters *logLevelCounter
+	errors      *strings.Builder
+	reset       func()
+	out         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) Out() io.Writer {
+	return l.out
+}
+
+// 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
+	}
+	l.Printf("%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.out, format, v...)
+}
+
+func (l *logAdapter) Println(v ...any) {
+	fmt.Fprintln(l.out, 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) Errorsf(id, format string, v ...any) {
+	l.errorl.WithField(FieldNameStatementID, id).Logf(format, v...)
+}
+
+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
+}

common/loggers/logger_test.go

@@ -0,0 +1,154 @@
+// 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 i := 0; i < 10; i++ {
+		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 i := 0; i < 3; i++ {
+		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)
+
+	}
+}

common/loggers/loggerglobal.go

@@ -0,0 +1,54 @@
+// 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"
+)
+
+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)
+}

common/loggers/loggers.go

@@ -1,355 +0,0 @@
-// 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"
-	"io/ioutil"
-	"log"
-	"os"
-	"regexp"
-	"runtime"
-	"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     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 ioutil.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 {
-		panic(panicOnWarningMessage)
-	}
-}
-
-func (l *logger) Warnln(v ...any) {
-	l.WARN.Println(v...)
-	if PanicOnWarning {
-		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, ioutil.Discard, false)
-}
-
-// NewBasicLoggerForWriter creates a new basic logger writing to w.
-func NewBasicLoggerForWriter(t jww.Threshold, w io.Writer) Logger {
-	return newLogger(t, jww.LevelError, w, ioutil.Discard, false)
-}
-
-// 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 != ioutil.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,
-	}
-}

common/loggers/loggers_test.go

@@ -1,60 +0,0 @@
-// 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 |")
-}

common/maps/cache.go

@@ -0,0 +1,90 @@
+// 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 maps
+
+import "sync"
+
+// Cache is a simple thread safe cache backed by a map.
+type Cache[K comparable, T any] struct {
+	m map[K]T
+	sync.RWMutex
+}
+
+// NewCache creates a new Cache.
+func NewCache[K comparable, T any]() *Cache[K, T] {
+	return &Cache[K, T]{m: make(map[K]T)}
+}
+
+// Delete deletes the given key from the cache.
+func (c *Cache[K, T]) Get(key K) (T, bool) {
+	c.RLock()
+	v, found := c.m[key]
+	c.RUnlock()
+	return v, found
+}
+
+// GetOrCreate gets the value for the given key if it exists, or creates it if not.
+func (c *Cache[K, T]) GetOrCreate(key K, create func() T) T {
+	c.RLock()
+	v, found := c.m[key]
+	c.RUnlock()
+	if found {
+		return v
+	}
+	c.Lock()
+	defer c.Unlock()
+	v, found = c.m[key]
+	if found {
+		return v
+	}
+	v = create()
+	c.m[key] = v
+	return v
+}
+
+// Set sets the given key to the given value.
+func (c *Cache[K, T]) Set(key K, value T) {
+	c.Lock()
+	c.m[key] = value
+	c.Unlock()
+}
+
+// SliceCache is a simple thread safe cache backed by a map.
+type SliceCache[T any] struct {
+	m map[string][]T
+	sync.RWMutex
+}
+
+func NewSliceCache[T any]() *SliceCache[T] {
+	return &SliceCache[T]{m: make(map[string][]T)}
+}
+
+func (c *SliceCache[T]) Get(key string) ([]T, bool) {
+	c.RLock()
+	v, found := c.m[key]
+	c.RUnlock()
+	return v, found
+}
+
+func (c *SliceCache[T]) Append(key string, values ...T) {
+	c.Lock()
+	c.m[key] = append(c.m[key], values...)
+	c.Unlock()
+}
+
+func (c *SliceCache[T]) Reset() {
+	c.Lock()
+	c.m = make(map[string][]T)
+	c.Unlock()
+}

common/maps/maps.go

@@ -29,7 +29,7 @@ func ToStringMapE(in any) (map[string]any, error) {
 	case Params:
 		return vv, nil
 	case map[string]string:
-		var m = map[string]any{}
+		m := map[string]any{}
 		for k, v := range vv {
 			m[k] = v
 		}
@@ -43,25 +43,25 @@ func ToStringMapE(in any) (map[string]any, error) {
 // ToParamsAndPrepare converts in to Params and prepares it for use.
 // If in is nil, an empty map is returned.
 // See PrepareParams.
-func ToParamsAndPrepare(in any) (Params, bool) {
+func ToParamsAndPrepare(in any) (Params, error) {
 	if types.IsNil(in) {
-		return Params{}, true
+		return Params{}, nil
 	}
 	m, err := ToStringMapE(in)
 	if err != nil {
-		return nil, false
+		return nil, err
 	}
 	PrepareParams(m)
-	return m, true
+	return m, nil
 }
 
 // MustToParamsAndPrepare calls ToParamsAndPrepare and panics if it fails.
 func MustToParamsAndPrepare(in any) Params {
-	if p, ok := ToParamsAndPrepare(in); ok {
-		return p
-	} else {
-		panic(fmt.Sprintf("cannot convert %T to maps.Params", in))
+	p, err := ToParamsAndPrepare(in)
+	if err != nil {
+		panic(fmt.Sprintf("cannot convert %T to maps.Params: %s", in, err))
 	}
+	return p
 }
 
 // ToStringMap converts in to map[string]interface{}.
@@ -96,6 +96,8 @@ func ToSliceStringMap(in any) ([]map[string]any, error) {
 	switch v := in.(type) {
 	case []map[string]any:
 		return v, nil
+	case Params:
+		return []map[string]any{v}, nil
 	case []any:
 		var s []map[string]any
 		for _, entry := range v {
@@ -123,6 +125,23 @@ func LookupEqualFold[T any | string](m map[string]T, key string) (T, bool) {
 	return s, false
 }
 
+// MergeShallow merges src into dst, but only if the key does not already exist in dst.
+// The keys are compared case insensitively.
+func MergeShallow(dst, src map[string]any) {
+	for k, v := range src {
+		found := false
+		for dk := range dst {
+			if strings.EqualFold(dk, k) {
+				found = true
+				break
+			}
+		}
+		if !found {
+			dst[k] = v
+		}
+	}
+}
+
 type keyRename struct {
 	pattern glob.Glob
 	newKey  string
@@ -173,21 +192,45 @@ func (KeyRenamer) keyPath(k1, k2 string) string {
 }
 
 func (r KeyRenamer) renamePath(parentKeyPath string, m map[string]any) {
-	for key, val := range m {
-		keyPath := r.keyPath(parentKeyPath, key)
-		switch val.(type) {
+	for k, v := range m {
+		keyPath := r.keyPath(parentKeyPath, k)
+		switch vv := v.(type) {
 		case map[any]any:
-			val = cast.ToStringMap(val)
-			r.renamePath(keyPath, val.(map[string]any))
+			r.renamePath(keyPath, cast.ToStringMap(vv))
 		case map[string]any:
-			r.renamePath(keyPath, val.(map[string]any))
+			r.renamePath(keyPath, vv)
 		}
 
 		newKey := r.getNewKey(keyPath)
 
 		if newKey != "" {
-			delete(m, key)
-			m[newKey] = val
+			delete(m, k)
+			m[newKey] = v
+		}
+	}
+}
+
+// ConvertFloat64WithNoDecimalsToInt converts float64 values with no decimals to int recursively.
+func ConvertFloat64WithNoDecimalsToInt(m map[string]any) {
+	for k, v := range m {
+		switch vv := v.(type) {
+		case float64:
+			if v == float64(int64(vv)) {
+				m[k] = int64(vv)
+			}
+		case map[string]any:
+			ConvertFloat64WithNoDecimalsToInt(vv)
+		case []any:
+			for i, vvv := range vv {
+				switch vvvv := vvv.(type) {
+				case float64:
+					if vvv == float64(int64(vvvv)) {
+						vv[i] = int64(vvvv)
+					}
+				case map[string]any:
+					ConvertFloat64WithNoDecimalsToInt(vvvv)
+				}
+			}
 		}
 	}
 }

common/maps/maps_test.go

@@ -116,11 +116,11 @@ func TestToSliceStringMap(t *testing.T) {
 
 func TestToParamsAndPrepare(t *testing.T) {
 	c := qt.New(t)
-	_, ok := ToParamsAndPrepare(map[string]any{"A": "av"})
-	c.Assert(ok, qt.IsTrue)
+	_, err := ToParamsAndPrepare(map[string]any{"A": "av"})
+	c.Assert(err, qt.IsNil)
 
-	params, ok := ToParamsAndPrepare(nil)
-	c.Assert(ok, qt.IsTrue)
+	params, err := ToParamsAndPrepare(nil)
+	c.Assert(err, qt.IsNil)
 	c.Assert(params, qt.DeepEquals, Params{})
 }
 

common/maps/params.go

@@ -23,30 +23,37 @@ import (
 // Params is a map where all keys are lower case.
 type Params map[string]any
 
-// Get does a lower case and nested search in this map.
+// KeyParams is an utility struct for the WalkParams method.
+type KeyParams struct {
+	Key    string
+	Params Params
+}
+
+// GetNested does a lower case and nested search in this map.
 // It will return nil if none found.
-func (p Params) Get(indices ...string) any {
+// Make all of these methods internal somehow.
+func (p Params) GetNested(indices ...string) any {
 	v, _, _ := getNested(p, indices)
 	return v
 }
 
-// Set overwrites values in p with values in pp for common or new keys.
+// SetParams overwrites values in dst with values in src for common or new keys.
 // This is done recursively.
-func (p Params) Set(pp Params) {
-	for k, v := range pp {
-		vv, found := p[k]
+func SetParams(dst, src Params) {
+	for k, v := range src {
+		vv, found := dst[k]
 		if !found {
-			p[k] = v
+			dst[k] = v
 		} else {
 			switch vvv := vv.(type) {
 			case Params:
 				if pv, ok := v.(Params); ok {
-					vvv.Set(pv)
+					SetParams(vvv, pv)
 				} else {
-					p[k] = v
+					dst[k] = v
 				}
 			default:
-				p[k] = v
+				dst[k] = v
 			}
 		}
 	}
@@ -54,7 +61,7 @@ func (p Params) Set(pp Params) {
 
 // IsZero returns true if p is considered empty.
 func (p Params) IsZero() bool {
-	if p == nil || len(p) == 0 {
+	if len(p) == 0 {
 		return true
 	}
 
@@ -62,32 +69,30 @@ func (p Params) IsZero() bool {
 		return false
 	}
 
-	for k, _ := range p {
-		return k == mergeStrategyKey
+	for k := range p {
+		return k == MergeStrategyKey
 	}
 
 	return false
-
 }
 
-// Merge transfers values from pp to p for new keys.
+// MergeParamsWithStrategy transfers values from src to dst for new keys using the merge strategy given.
 // This is done recursively.
-func (p Params) Merge(pp Params) {
-	p.merge("", pp)
+func MergeParamsWithStrategy(strategy string, dst, src Params) {
+	dst.merge(ParamsMergeStrategy(strategy), src)
 }
 
-// MergeRoot transfers values from pp to p for new keys where p is the
-// root of the tree.
+// MergeParams transfers values from src to dst for new keys using the merge encoded in dst.
 // This is done recursively.
-func (p Params) MergeRoot(pp Params) {
-	ms, _ := p.GetMergeStrategy()
-	p.merge(ms, pp)
+func MergeParams(dst, src Params) {
+	ms, _ := dst.GetMergeStrategy()
+	dst.merge(ms, src)
 }
 
 func (p Params) merge(ps ParamsMergeStrategy, pp Params) {
 	ns, found := p.GetMergeStrategy()
 
-	var ms = ns
+	ms := ns
 	if !found && ps != "" {
 		ms = ps
 	}
@@ -97,7 +102,7 @@ func (p Params) merge(ps ParamsMergeStrategy, pp Params) {
 
 	for k, v := range pp {
 
-		if k == mergeStrategyKey {
+		if k == MergeStrategyKey {
 			continue
 		}
 		vv, found := p[k]
@@ -116,8 +121,9 @@ func (p Params) merge(ps ParamsMergeStrategy, pp Params) {
 	}
 }
 
+// For internal use.
 func (p Params) GetMergeStrategy() (ParamsMergeStrategy, bool) {
-	if v, found := p[mergeStrategyKey]; found {
+	if v, found := p[MergeStrategyKey]; found {
 		if s, ok := v.(ParamsMergeStrategy); ok {
 			return s, true
 		}
@@ -125,21 +131,23 @@ func (p Params) GetMergeStrategy() (ParamsMergeStrategy, bool) {
 	return ParamsMergeStrategyShallow, false
 }
 
+// For internal use.
 func (p Params) DeleteMergeStrategy() bool {
-	if _, found := p[mergeStrategyKey]; found {
-		delete(p, mergeStrategyKey)
+	if _, found := p[MergeStrategyKey]; found {
+		delete(p, MergeStrategyKey)
 		return true
 	}
 	return false
 }
 
-func (p Params) SetDefaultMergeStrategy(s ParamsMergeStrategy) {
+// For internal use.
+func (p Params) SetMergeStrategy(s ParamsMergeStrategy) {
 	switch s {
 	case ParamsMergeStrategyDeep, ParamsMergeStrategyNone, ParamsMergeStrategyShallow:
 	default:
 		panic(fmt.Sprintf("invalid merge strategy %q", s))
 	}
-	p[mergeStrategyKey] = s
+	p[MergeStrategyKey] = s
 }
 
 func getNested(m map[string]any, indices []string) (any, string, map[string]any) {
@@ -187,7 +195,7 @@ func GetNestedParam(keyStr, separator string, candidates ...Params) (any, error)
 
 	keySegments := strings.Split(keyStr, separator)
 	for _, m := range candidates {
-		if v := m.Get(keySegments...); v != nil {
+		if v := m.GetNested(keySegments...); v != nil {
 			return v, nil
 		}
 	}
@@ -233,9 +241,57 @@ const (
 	// Add new keys, merge existing.
 	ParamsMergeStrategyDeep ParamsMergeStrategy = "deep"
 
-	mergeStrategyKey = "_merge"
+	MergeStrategyKey = "_merge"
 )
 
+// CleanConfigStringMapString removes any processing instructions from m,
+// m will never be modified.
+func CleanConfigStringMapString(m map[string]string) map[string]string {
+	if len(m) == 0 {
+		return m
+	}
+	if _, found := m[MergeStrategyKey]; !found {
+		return m
+	}
+	// Create a new map and copy all the keys except the merge strategy key.
+	m2 := make(map[string]string, len(m)-1)
+	for k, v := range m {
+		if k != MergeStrategyKey {
+			m2[k] = v
+		}
+	}
+	return m2
+}
+
+// CleanConfigStringMap is the same as CleanConfigStringMapString but for
+// map[string]any.
+func CleanConfigStringMap(m map[string]any) map[string]any {
+	if len(m) == 0 {
+		return m
+	}
+	if _, found := m[MergeStrategyKey]; !found {
+		return m
+	}
+	// Create a new map and copy all the keys except the merge strategy key.
+	m2 := make(map[string]any, len(m)-1)
+	for k, v := range m {
+		if k != MergeStrategyKey {
+			m2[k] = v
+		}
+		switch v2 := v.(type) {
+		case map[string]any:
+			m2[k] = CleanConfigStringMap(v2)
+		case Params:
+			var p Params = CleanConfigStringMap(v2)
+			m2[k] = p
+		case map[string]string:
+			m2[k] = CleanConfigStringMapString(v2)
+		}
+
+	}
+	return m2
+}
+
 func toMergeStrategy(v any) ParamsMergeStrategy {
 	s := ParamsMergeStrategy(cast.ToString(v))
 	switch s {
@@ -255,7 +311,7 @@ func PrepareParams(m Params) {
 	for k, v := range m {
 		var retyped bool
 		lKey := strings.ToLower(k)
-		if lKey == mergeStrategyKey {
+		if lKey == MergeStrategyKey {
 			v = toMergeStrategy(v)
 			retyped = true
 		} else {

common/maps/params_test.go

@@ -75,13 +75,13 @@ func TestParamsSetAndMerge(t *testing.T) {
 
 	createParamsPair := func() (Params, Params) {
 		p1 := Params{"a": "av", "c": "cv", "nested": Params{"al2": "al2v", "cl2": "cl2v"}}
-		p2 := Params{"b": "bv", "a": "abv", "nested": Params{"bl2": "bl2v", "al2": "al2bv"}, mergeStrategyKey: ParamsMergeStrategyDeep}
+		p2 := Params{"b": "bv", "a": "abv", "nested": Params{"bl2": "bl2v", "al2": "al2bv"}, MergeStrategyKey: ParamsMergeStrategyDeep}
 		return p1, p2
 	}
 
 	p1, p2 := createParamsPair()
 
-	p1.Set(p2)
+	SetParams(p1, p2)
 
 	c.Assert(p1, qt.DeepEquals, Params{
 		"a": "abv",
@@ -92,12 +92,12 @@ func TestParamsSetAndMerge(t *testing.T) {
 			"bl2": "bl2v",
 		},
 		"b":              "bv",
-		mergeStrategyKey: ParamsMergeStrategyDeep,
+		MergeStrategyKey: ParamsMergeStrategyDeep,
 	})
 
 	p1, p2 = createParamsPair()
 
-	p1.Merge(p2)
+	MergeParamsWithStrategy("", p1, p2)
 
 	// Default is to do a shallow merge.
 	c.Assert(p1, qt.DeepEquals, Params{
@@ -111,8 +111,8 @@ func TestParamsSetAndMerge(t *testing.T) {
 	})
 
 	p1, p2 = createParamsPair()
-	p1.SetDefaultMergeStrategy(ParamsMergeStrategyNone)
-	p1.Merge(p2)
+	p1.SetMergeStrategy(ParamsMergeStrategyNone)
+	MergeParamsWithStrategy("", p1, p2)
 	p1.DeleteMergeStrategy()
 
 	c.Assert(p1, qt.DeepEquals, Params{
@@ -125,8 +125,8 @@ func TestParamsSetAndMerge(t *testing.T) {
 	})
 
 	p1, p2 = createParamsPair()
-	p1.SetDefaultMergeStrategy(ParamsMergeStrategyShallow)
-	p1.Merge(p2)
+	p1.SetMergeStrategy(ParamsMergeStrategyShallow)
+	MergeParamsWithStrategy("", p1, p2)
 	p1.DeleteMergeStrategy()
 
 	c.Assert(p1, qt.DeepEquals, Params{
@@ -140,8 +140,8 @@ func TestParamsSetAndMerge(t *testing.T) {
 	})
 
 	p1, p2 = createParamsPair()
-	p1.SetDefaultMergeStrategy(ParamsMergeStrategyDeep)
-	p1.Merge(p2)
+	p1.SetMergeStrategy(ParamsMergeStrategyDeep)
+	MergeParamsWithStrategy("", p1, p2)
 	p1.DeleteMergeStrategy()
 
 	c.Assert(p1, qt.DeepEquals, Params{

common/maps/scratch.go

@@ -30,6 +30,7 @@ type Scratch struct {
 
 // Scratcher provides a scratching service.
 type Scratcher interface {
+	// Scratch returns a "scratch pad" that can be used to store state.
 	Scratch() *Scratch
 }
 

common/para/para.go

@@ -27,7 +27,7 @@ type Workers struct {
 
 // Runner wraps the lifecycle methods of a new task set.
 //
-// Run wil block until a worker is available or the context is cancelled,
+// Run will block until a worker is available or the context is cancelled,
 // and then run the given func in a new goroutine.
 // Wait will wait for all the running goroutines to finish.
 type Runner interface {