Helper messages for documenting build process

.gitignore

@@ -4,6 +4,7 @@
 .*envrc
 .envrc
 .idea
+# goimports is installed here if not available
 /.local/
 /site/
 coverage.txt

cmd/urfave-cli-genflags/generated.gotmpl

@@ -1,70 +1,71 @@
-// WARNING: this file is generated. DO NOT EDIT
+{{.HeaderWarning}}
 
 package {{.PackageName}}
 
-{{range .SortedFlagTypes}}
+{{range .SortedFlagTypes -}}
 // {{.TypeName}} is a flag with type {{if .ValuePointer}}*{{end}}{{.GoType}}
 type {{.TypeName}} struct {
- Name string
+ Name string
 
- Category string
- DefaultText string
- FilePath string
- Usage string
+ Category  string
+ DefaultText string
+ FilePath  string
+ Usage  string
 
- Required bool
- Hidden bool
- HasBeenSet bool
+ Required  bool
+ Hidden  bool
+ HasBeenSet bool
 
- Value {{if .ValuePointer}}*{{end}}{{.GoType}}
- Destination {{if .NoDestinationPointer}}{{else}}*{{end}}{{.GoType}}
+ Value  {{if .ValuePointer}}*{{end}}{{.GoType}}
+ Destination {{if .NoDestinationPointer}}{{else}}*{{end}}{{.GoType}}
 
- Aliases []string
- EnvVars []string
+ Aliases []string
+ EnvVars []string
 
- defaultValue {{if .ValuePointer}}*{{end}}{{.GoType}}
-
- {{range .StructFields}}
- {{.Name}} {{if .Pointer}}*{{end}}{{.Type}}
- {{end}}
+ defaultValue {{if .ValuePointer}}*{{end}}{{.GoType}}
+{{ range .StructFields}}
+ {{.Name}} {{if .Pointer}}*{{end}}{{.Type}}
+{{end -}}
 }
 
-{{if .GenerateFmtStringerInterface}}
+{{if .GenerateFmtStringerInterface -}}
 // String returns a readable representation of this value (for usage defaults)
 func (f *{{.TypeName}}) String() string {
- return {{$.UrfaveCLINamespace}}FlagStringer(f)
+ return {{$.UrfaveCLINamespace}}FlagStringer(f)
 }
+
 {{end}}{{/* /if .GenerateFmtStringerInterface */}}
 
-{{if .GenerateFlagInterface}}
+{{- if .GenerateFlagInterface -}}
 // IsSet returns whether or not the flag has been set through env or file
 func (f *{{.TypeName}}) IsSet() bool {
- return f.HasBeenSet
+ return f.HasBeenSet
 }
 
 // Names returns the names of the flag
 func (f *{{.TypeName}}) Names() []string {
- return {{$.UrfaveCLINamespace}}FlagNames(f.Name, f.Aliases)
+ return {{$.UrfaveCLINamespace}}FlagNames(f.Name, f.Aliases)
 }
 
 {{end}}{{/* /if .GenerateFlagInterface */}}
 
-{{if .GenerateRequiredFlagInterface}}
+{{- if .GenerateRequiredFlagInterface -}}
 // IsRequired returns whether or not the flag is required
 func (f *{{.TypeName}}) IsRequired() bool {
- return f.Required
+ return f.Required
 }
+
 {{end}}{{/* /if .GenerateRequiredFlagInterface */}}
 
-{{if .GenerateVisibleFlagInterface}}
+{{- if .GenerateVisibleFlagInterface -}}
 // IsVisible returns true if the flag is not hidden, otherwise false
 func (f *{{.TypeName}}) IsVisible() bool {
  return !f.Hidden
 }
 {{end}}{{/* /if .GenerateVisibleFlagInterface */}}
 {{end}}{{/* /range .SortedFlagTypes */}}
 
-// vim{{/* 👻 */}}:ro
-{{/*
+{{- "// vim"}}:ro
+{{- /* 👻
 vim:filetype=gotexttmpl
 */}}

cmd/urfave-cli-genflags/main.go

@@ -225,6 +225,10 @@ type Spec struct {
  UrfaveCLITestNamespace string `yaml:"urfave_cli_test_namespace"`
 }
 
+func (Spec) HeaderWarning() string {
+ return "// WARNING: this file is generated. DO NOT EDIT"
+}
+
 func (gfs *Spec) SortedFlagTypes() []*FlagType {
  typeNames := []string{}
 

internal/build/build.go

@@ -82,6 +82,7 @@ func main() {
  {
  Name: "generate",
  Action: GenerateActionFunc,
+ Usage: "generate API docs",
  },
  {
  Name: "yamlfmt",
@@ -496,6 +497,7 @@ func checkBinarySizeActionFunc(c *cli.Context) (err error) {
 func GenerateActionFunc(cCtx *cli.Context) error {
  top := cCtx.Path("top")
 
+ log.Println("--- generating godoc-current.txt API reference ---")
  cliDocs, err := sh("go", "doc", "-all", top)
  if err != nil {
  return err
@@ -514,6 +516,7 @@ func GenerateActionFunc(cCtx *cli.Context) error {
  return err
  }
 
+ log.Println("--- generating Go source files ---")
  return runCmd("go", "generate", cCtx.Path("top")+"/...")
 }