Merge pull request #1899 from bartekpacia/ci/gofumpt

Format whole codebase with gofumpt and enforce it in CI

.github/workflows/lint.yml

@@ -14,6 +14,26 @@ permissions:
   contents: read
 
 jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.20"
+
+      - name: Clone repository
+        uses: actions/checkout@v4
+
+      - name: Set up gofumpt
+        run: go install mvdan.cc/gofumpt@latest
+
+      - name: Run gofumpt
+        run: |
+          non_formatted_files="$(gofumpt -l .)"
+          echo "$non_formatted_files"
+          test -z "$non_formatted_files"
+
   staticcheck:
     runs-on: ubuntu-latest
     steps:

.github/workflows/test.yml

@@ -31,19 +31,26 @@ jobs:
 
       - name: Set PATH
         run: echo "${GITHUB_WORKSPACE}/.local/bin" >>"${GITHUB_PATH}"
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
       - if: matrix.go == '1.20.x' && matrix.os == 'ubuntu-latest'
         run: make ensure-goimports
+
       - if: matrix.go == '1.20.x' && matrix.os == 'ubuntu-latest'
         run: make lint
+
       - run: make vet
       - run: make test
       - run: make check-binary-size
+
       - if: matrix.go == '1.20.x' && matrix.os == 'ubuntu-latest'
         run: make generate
+
       - run: make diffcheck
+
       - if: matrix.go == '1.20.x' && matrix.os == 'ubuntu-latest'
         run: make v3diff
+
       - if: success() && matrix.go == '1.20.x' && matrix.os == 'ubuntu-latest'
         uses: codecov/codecov-action@v4
         with:

args.go

@@ -143,9 +143,11 @@ func (a *ArgumentBase[T, C, VC]) Parse(s []string) ([]string, error) {
 	return s[count:], nil
 }
 
-type FloatArg = ArgumentBase[float64, NoConfig, floatValue]
-type IntArg = ArgumentBase[int64, IntegerConfig, intValue]
-type StringArg = ArgumentBase[string, StringConfig, stringValue]
-type StringMapArg = ArgumentBase[map[string]string, StringConfig, StringMap]
-type TimestampArg = ArgumentBase[time.Time, TimestampConfig, timestampValue]
-type UintArg = ArgumentBase[uint64, IntegerConfig, uintValue]
+type (
+	FloatArg     = ArgumentBase[float64, NoConfig, floatValue]
+	IntArg       = ArgumentBase[int64, IntegerConfig, intValue]
+	StringArg    = ArgumentBase[string, StringConfig, stringValue]
+	StringMapArg = ArgumentBase[map[string]string, StringConfig, StringMap]
+	TimestampArg = ArgumentBase[time.Time, TimestampConfig, timestampValue]
+	UintArg      = ArgumentBase[uint64, IntegerConfig, uintValue]
+)

args_test.go

@@ -10,7 +10,6 @@ import (
 )
 
 func TestArgumentsRootCommand(t *testing.T) {
-
 	cmd := buildMinimalTestCommand()
 	var ival int64
 	var fval float64
@@ -48,7 +47,6 @@ func TestArgumentsRootCommand(t *testing.T) {
 }
 
 func TestArgumentsSubcommand(t *testing.T) {
-
 	cmd := buildMinimalTestCommand()
 	var ifval int64
 	var svals []string

cli.go

@@ -29,9 +29,7 @@ import (
 	"strings"
 )
 
-var (
-	isTracingOn = os.Getenv("URFAVE_CLI_TRACING") == "on"
-)
+var isTracingOn = os.Getenv("URFAVE_CLI_TRACING") == "on"
 
 func tracef(format string, a ...any) {
 	if !isTracingOn {

command_test.go

@@ -2867,7 +2867,8 @@ func TestPersistentFlag(t *testing.T) {
 		},
 	}
 
-	err := cmd.Run(buildTestContext(t), []string{"app",
+	err := cmd.Run(buildTestContext(t), []string{
+		"app",
 		"--persistentCommandFlag", "hello",
 		"--persistentCommandSliceFlag", "100",
 		"--persistentCommandOverrideFlag", "102",
@@ -2903,7 +2904,6 @@ func TestPersistentFlag(t *testing.T) {
 }
 
 func TestPersistentFlagIsSet(t *testing.T) {
-
 	result := ""
 	resultIsSet := false
 
@@ -2939,7 +2939,6 @@ func TestPersistentFlagIsSet(t *testing.T) {
 }
 
 func TestRequiredPersistentFlag(t *testing.T) {
-
 	app := &Command{
 		Name: "root",
 		Flags: []Flag{
@@ -3701,7 +3700,6 @@ func TestCommand_ParentCommand_Set(t *testing.T) {
 }
 
 func TestCommandReadArgsFromStdIn(t *testing.T) {
-
 	tests := []struct {
 		name          string
 		input         string
@@ -3860,7 +3858,6 @@ func TestCommandReadArgsFromStdIn(t *testing.T) {
 			} else {
 				r.Error(err)
 			}
-
 		})
 	}
 }

errors.go

@@ -80,7 +80,6 @@ type mutuallyExclusiveGroupRequiredFlag struct {
 }
 
 func (e *mutuallyExclusiveGroupRequiredFlag) Error() string {
-
 	var missingFlags []string
 	for _, grpf := range e.flags.Flags {
 		var grpString []string

fish.go

@@ -133,7 +133,6 @@ func (cmd *Command) prepareFishFlags(flags []Flag, previousCommands []string) []
 				completion.WriteString(fmt.Sprintf(
 					" -s %s", strings.TrimSpace(opt),
 				))
-
 			}
 		}
 

flag_bool_with_inverse_test.go

@@ -9,9 +9,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-var (
-	errBothEnvFlagsAreSet = fmt.Errorf("cannot set both flags `--env` and `--no-env`")
-)
+var errBothEnvFlagsAreSet = fmt.Errorf("cannot set both flags `--env` and `--no-env`")
 
 type boolWithInverseTestCase struct {
 	args    []string
@@ -361,7 +359,6 @@ func TestBoolWithInverseDestination(t *testing.T) {
 	checkAndReset := func(expectedCount int, expectedValue bool) error {
 		if *count != expectedCount {
 			return fmt.Errorf("expected count to be %d, got %d", expectedCount, *count)
-
 		}
 
 		if *destination != expectedValue {

flag_float_slice.go

@@ -4,8 +4,10 @@ import (
 	"flag"
 )
 
-type FloatSlice = SliceBase[float64, NoConfig, floatValue]
-type FloatSliceFlag = FlagBase[[]float64, NoConfig, FloatSlice]
+type (
+	FloatSlice     = SliceBase[float64, NoConfig, floatValue]
+	FloatSliceFlag = FlagBase[[]float64, NoConfig, FloatSlice]
+)
 
 var NewFloatSlice = NewSliceBase[float64, NoConfig, floatValue]
 

flag_int_slice.go

@@ -1,7 +1,9 @@
 package cli
 
-type IntSlice = SliceBase[int64, IntegerConfig, intValue]
-type IntSliceFlag = FlagBase[[]int64, IntegerConfig, IntSlice]
+type (
+	IntSlice     = SliceBase[int64, IntegerConfig, intValue]
+	IntSliceFlag = FlagBase[[]int64, IntegerConfig, IntSlice]
+)
 
 var NewIntSlice = NewSliceBase[int64, IntegerConfig, intValue]
 

flag_string_map.go

@@ -1,7 +1,9 @@
 package cli
 
-type StringMap = MapBase[string, StringConfig, stringValue]
-type StringMapFlag = FlagBase[map[string]string, StringConfig, StringMap]
+type (
+	StringMap     = MapBase[string, StringConfig, stringValue]
+	StringMapFlag = FlagBase[map[string]string, StringConfig, StringMap]
+)
 
 var NewStringMap = NewMapBase[string, StringConfig, stringValue]
 

flag_string_slice.go

@@ -1,7 +1,9 @@
 package cli
 
-type StringSlice = SliceBase[string, StringConfig, stringValue]
-type StringSliceFlag = FlagBase[[]string, StringConfig, StringSlice]
+type (
+	StringSlice     = SliceBase[string, StringConfig, stringValue]
+	StringSliceFlag = FlagBase[[]string, StringConfig, StringSlice]
+)
 
 var NewStringSlice = NewSliceBase[string, StringConfig, stringValue]
 

flag_uint_slice.go

@@ -1,7 +1,9 @@
 package cli
 
-type UintSlice = SliceBase[uint64, IntegerConfig, uintValue]
-type UintSliceFlag = FlagBase[[]uint64, IntegerConfig, UintSlice]
+type (
+	UintSlice     = SliceBase[uint64, IntegerConfig, uintValue]
+	UintSliceFlag = FlagBase[[]uint64, IntegerConfig, UintSlice]
+)
 
 var NewUintSlice = NewSliceBase[uint64, IntegerConfig, uintValue]
 

flag_validation_test.go

@@ -8,7 +8,6 @@ import (
 )
 
 func TestFlagDefaultValidation(t *testing.T) {
-
 	cmd := &Command{
 		Name: "foo",
 		Flags: []Flag{
@@ -33,7 +32,6 @@ func TestFlagDefaultValidation(t *testing.T) {
 }
 
 func TestFlagValidation(t *testing.T) {
-
 	r := require.New(t)
 
 	testCases := []struct {

help_test.go

@@ -1189,7 +1189,8 @@ func TestMutuallyExclusiveFlags(t *testing.T) {
 							Name: "s1",
 						},
 					},
-				}},
+				},
+			},
 		},
 	}
 

internal/build/build.go

@@ -289,7 +289,7 @@ func testCleanup(packages []string) error {
 		}
 	}
 
-	return os.WriteFile("coverage.txt", out.Bytes(), 0644)
+	return os.WriteFile("coverage.txt", out.Bytes(), 0o644)
 }
 
 func GfmrunActionFunc(ctx context.Context, cmd *cli.Command) error {
@@ -499,7 +499,7 @@ func GenerateActionFunc(ctx context.Context, cmd *cli.Command) error {
 	return os.WriteFile(
 		filepath.Join(top, "godoc-current.txt"),
 		[]byte(cliDocs),
-		0644,
+		0o644,
 	)
 }
 
@@ -557,7 +557,7 @@ func EnsureGfmrunActionFunc(ctx context.Context, cmd *cli.Command) error {
 		return err
 	}
 
-	return downloadFile(gfmrunURL.String(), gfmrunExe, 0755, 0755)
+	return downloadFile(gfmrunURL.String(), gfmrunExe, 0o755, 0o755)
 }
 
 func EnsureMkdocsActionFunc(ctx context.Context, cmd *cli.Command) error {
@@ -642,7 +642,6 @@ func V3Diff(ctx context.Context, cmd *cli.Command) error {
 		"--label=b/godoc",
 		"godoc-current.txt",
 	)
-
 	if err != nil {
 		fmt.Printf("# %v ---> Hey! <---\n", badNewsEmoji)
 		fmt.Println(strings.TrimSpace(v3diffWarning))

template.go

@@ -1,18 +1,23 @@
 package cli
 
-var helpNameTemplate = `{{$v := offset .FullName 6}}{{wrap .FullName 3}}{{if .Usage}} - {{wrap .Usage $v}}{{end}}`
-var argsTemplate = `{{if .Arguments}}{{range .Arguments}}{{.Usage}}{{end}}{{end}}`
-var usageTemplate = `{{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.FullName}}{{if .VisibleFlags}} [command [command options]]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}{{template "argsTemplate" .}}{{end}}{{end}}`
-var descriptionTemplate = `{{wrap .Description 3}}`
-var authorsTemplate = `{{with $length := len .Authors}}{{if ne 1 $length}}S{{end}}{{end}}:
+var (
+	helpNameTemplate    = `{{$v := offset .FullName 6}}{{wrap .FullName 3}}{{if .Usage}} - {{wrap .Usage $v}}{{end}}`
+	argsTemplate        = `{{if .Arguments}}{{range .Arguments}}{{.Usage}}{{end}}{{end}}`
+	usageTemplate       = `{{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.FullName}}{{if .VisibleFlags}} [command [command options]]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}{{template "argsTemplate" .}}{{end}}{{end}}`
+	descriptionTemplate = `{{wrap .Description 3}}`
+	authorsTemplate     = `{{with $length := len .Authors}}{{if ne 1 $length}}S{{end}}{{end}}:
    {{range $index, $author := .Authors}}{{if $index}}
    {{end}}{{$author}}{{end}}`
+)
+
 var visibleCommandTemplate = `{{ $cv := offsetCommands .VisibleCommands 5}}{{range .VisibleCommands}}
    {{$s := join .Names ", "}}{{$s}}{{ $sp := subtract $cv (offset $s 3) }}{{ indent $sp ""}}{{wrap .Usage $cv}}{{end}}`
+
 var visibleCommandCategoryTemplate = `{{range .VisibleCategories}}{{if .Name}}
 
    {{.Name}}:{{range .VisibleCommands}}
      {{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{else}}{{template "visibleCommandTemplate" .}}{{end}}{{end}}`
+
 var visibleFlagCategoryTemplate = `{{range .VisibleFlagCategories}}
    {{if .Name}}{{.Name}}
 

value_source_test.go

@@ -33,7 +33,6 @@ func TestEnvVarValueSource(t *testing.T) {
 			r.True(ok)
 			r.Equal(str, "bar")
 		})
-
 	})
 
 	t.Run("implements fmt.Stringer", func(t *testing.T) {
@@ -80,7 +79,7 @@ func TestFileValueSource(t *testing.T) {
 		fileName := filepath.Join(os.TempDir(), fmt.Sprintf("urfave-cli-testing-existing_file-%[1]v", rand.Int()))
 		t.Cleanup(func() { _ = os.Remove(fileName) })
 
-		r.Nil(os.WriteFile(fileName, []byte("pita"), 0644))
+		r.Nil(os.WriteFile(fileName, []byte("pita"), 0o644))
 
 		t.Run("found", func(t *testing.T) {
 			src := &fileValueSource{Path: fileName}
@@ -113,7 +112,7 @@ func TestFilePaths(t *testing.T) {
 	fileName := filepath.Join(os.TempDir(), fmt.Sprintf("urfave-cli-tests-some_file_name_%[1]v", rand.Int()))
 	t.Cleanup(func() { _ = os.Remove(fileName) })
 
-	r.Nil(os.WriteFile(fileName, []byte("Hello"), 0644))
+	r.Nil(os.WriteFile(fileName, []byte("Hello"), 0o644))
 
 	sources := Files("junk_file_name", fileName)
 	str, src, ok := sources.LookupWithSource()