commands: Remove all dates from gendoc
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Sat, 1 May 2021 10:03:56 +0000 (12:03 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Sat, 1 May 2021 10:03:56 +0000 (12:03 +0200)
It creates lots of diffs even if there are no changes.

commands/gendoc.go

index 8312191f2f02d6e34c0d601b1e3cce52e5860c16..6d03aabcf09fb1ffd9dd92ecceb553c688830325 100644 (file)
@@ -18,7 +18,6 @@ import (
        "path"
        "path/filepath"
        "strings"
-       "time"
 
        "github.com/gohugoio/hugo/helpers"
        "github.com/gohugoio/hugo/hugofs"
@@ -36,7 +35,6 @@ type genDocCmd struct {
 
 func newGenDocCmd() *genDocCmd {
        const gendocFrontmatterTemplate = `---
-date: %s
 title: "%s"
 slug: %s
 url: %s
@@ -57,6 +55,12 @@ 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
                        }
@@ -66,19 +70,17 @@ for rendering in Hugo.`,
                                        return err
                                }
                        }
-                       now := time.Now().Format("2006-01-02")
                        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, now, strings.Replace(base, "_", " ", -1), base, url)
+                               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.")