Skip to content

Commit

Permalink
Re-add --printUnusedTemplates and --printPathWarnings
Browse files Browse the repository at this point in the history
And now with tests.

Updates #10953
  • Loading branch information
bep committed May 19, 2023
1 parent e4e0313 commit d6197a4
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 7 deletions.
16 changes: 9 additions & 7 deletions commands/commandeer.go
Expand Up @@ -115,11 +115,13 @@ type rootCommand struct {
environment string

// Common build flags.
baseURL string
gc bool
poll string
panicOnWarning bool
forceSyncStatic bool
baseURL string
gc bool
poll string
panicOnWarning bool
forceSyncStatic bool
printPathWarnings bool
printUnusedTemplates bool

// Profile flags (for debugging of performance problems)
cpuprofile string
Expand Down Expand Up @@ -538,8 +540,8 @@ func applyLocalBuildFlags(cmd *cobra.Command, r *rootCommand) {
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().BoolVarP(&r.printPathWarnings, "printPathWarnings", "", false, "print warnings on duplicate target paths etc.")
cmd.Flags().BoolVarP(&r.printUnusedTemplates, "printUnusedTemplates", "", false, "print warnings on unused templates.")
cmd.Flags().StringVarP(&r.cpuprofile, "profile-cpu", "", "", "write cpu profile to `file`")
cmd.Flags().StringVarP(&r.memprofile, "profile-mem", "", "", "write memory profile to `file`")
cmd.Flags().BoolVarP(&r.printm, "printMemoryUsage", "", false, "print memory usage to screen at intervals")
Expand Down
22 changes: 22 additions & 0 deletions commands/hugobuilder.go
Expand Up @@ -41,7 +41,9 @@ import (
"github.com/gohugoio/hugo/hugolib/filesystems"
"github.com/gohugoio/hugo/livereload"
"github.com/gohugoio/hugo/resources/page"
"github.com/gohugoio/hugo/tpl"
"github.com/gohugoio/hugo/watcher"
"github.com/spf13/afero"
"github.com/spf13/fsync"
"golang.org/x/sync/errgroup"
"golang.org/x/sync/semaphore"
Expand Down Expand Up @@ -411,6 +413,26 @@ func (c *hugoBuilder) build() error {
if err != nil {
return err
}

if c.r.printPathWarnings {
hugofs.WalkFilesystems(h.Fs.PublishDir, func(fs afero.Fs) bool {
if dfs, ok := fs.(hugofs.DuplicatesReporter); ok {
dupes := dfs.ReportDuplicates()
if dupes != "" {
c.r.logger.Warnln("Duplicate target paths:", dupes)
}
}
return false
})
}

if c.r.printUnusedTemplates {
unusedTemplates := h.Tmpl().(tpl.UnusedTemplatesProvider).UnusedTemplates()
for _, unusedTemplate := range unusedTemplates {
c.r.logger.Warnf("Template %s is unused, source file %s", unusedTemplate.Name(), unusedTemplate.Filename())
}
}

h.PrintProcessingStats(os.Stdout)
c.r.Println()
}
Expand Down
17 changes: 17 additions & 0 deletions testscripts/commands/hugo_printpathwarnings.txt
@@ -0,0 +1,17 @@
hugo --printPathWarnings

stdout 'Duplicate target paths: .index.html \(2\)'

-- hugo.toml --
disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT", "404", "section"]
baseURL = "https://example.org/"
-- layouts/_default/single.html --
Single.
-- layouts/index.html --
Home.
-- content/p1.md --
---
title: "P1"
url: "/"
---

11 changes: 11 additions & 0 deletions testscripts/commands/hugo_printunusedtemplates.txt
@@ -0,0 +1,11 @@
hugo --printUnusedTemplates

stdout 'Template _default/list.html is unused'

-- hugo.toml --
disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT", "404", "section", "page"]
baseURL = "https://example.org/"
-- layouts/index.html --
Home.
-- layouts/_default/list.html --
{{ errorf "unused template: %s" .Kind }}

0 comments on commit d6197a4

Please sign in to comment.