chore: add support for gofumpt (#4055)

.golangci.yml

@@ -18,6 +18,7 @@ linters:
     - errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases [fast: false, auto-fix: false]
     - goconst # Finds repeated strings that could be replaced by a constant [fast: true, auto-fix: false]
     - gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true, auto-fix: true]
+    - gofumpt # Gofumpt checks whether code was gofumpt-ed. [fast: true, auto-fix: true]
     - goimports # In addition to fixing imports, goimports also formats your code in the same style as gofmt. [fast: true, auto-fix: true]
     - gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations. [fast: true, auto-fix: false]
     - goprintffuncname # Checks that printf-like functions are named with `f` at the end [fast: true, auto-fix: false]
@@ -73,6 +74,9 @@ linters:
 linters-settings:
   goconst:
     min-len: 5
+  gosec:
+    excludes:
+      - G115
 
 issues:
   exclude-dirs:

internal/args/args.go

@@ -24,24 +24,22 @@ func (a RawArgs) ExistsArgByName(name string) bool {
 	return ok
 }
 
-var (
-	scalarKinds = map[reflect.Kind]bool{
-		reflect.Int:     true,
-		reflect.Int8:    true,
-		reflect.Int16:   true,
-		reflect.Int32:   true,
-		reflect.Int64:   true,
-		reflect.Uint:    true,
-		reflect.Uint8:   true,
-		reflect.Uint16:  true,
-		reflect.Uint32:  true,
-		reflect.Uint64:  true,
-		reflect.Float32: true,
-		reflect.Float64: true,
-		reflect.Bool:    true,
-		reflect.String:  true,
-	}
-)
+var scalarKinds = map[reflect.Kind]bool{
+	reflect.Int:     true,
+	reflect.Int8:    true,
+	reflect.Int16:   true,
+	reflect.Int32:   true,
+	reflect.Int64:   true,
+	reflect.Uint:    true,
+	reflect.Uint8:   true,
+	reflect.Uint16:  true,
+	reflect.Uint32:  true,
+	reflect.Uint64:  true,
+	reflect.Float32: true,
+	reflect.Float64: true,
+	reflect.Bool:    true,
+	reflect.String:  true,
+}
 
 // SplitRaw creates a map that maps arg names to their values.
 // ["arg1=1", "arg2=2", "arg3"] => {"arg1": "1", "arg2": "2", "arg3":"" }

internal/args/errors.go

@@ -10,8 +10,7 @@ import (
 // Marshal & Unmarshal Errors
 //
 
-type DataMustBeAPointerError struct {
-}
+type DataMustBeAPointerError struct{}
 
 func (e *DataMustBeAPointerError) Error() string {
 	return "data must be a pointer to a struct"
@@ -21,8 +20,7 @@ func (e *DataMustBeAPointerError) Error() string {
 // Marshal Errors
 //
 
-type DataMustBeAMarshalableValueError struct {
-}
+type DataMustBeAMarshalableValueError struct{}
 
 func (e *DataMustBeAMarshalableValueError) Error() string {
 	return "data must be a marshalable value (a scalar type or a Marshaler)"
@@ -71,22 +69,19 @@ func (e *UnmarshalArgError) Unwrap() error {
 	return e.Err
 }
 
-type InvalidArgNameError struct {
-}
+type InvalidArgNameError struct{}
 
 func (e *InvalidArgNameError) Error() string {
 	return "arg name must only contain lowercase letters, numbers or dashes"
 }
 
-type UnknownArgError struct {
-}
+type UnknownArgError struct{}
 
 func (e *UnknownArgError) Error() string {
 	return "unknown argument"
 }
 
-type DuplicateArgError struct {
-}
+type DuplicateArgError struct{}
 
 func (e *DuplicateArgError) Error() string {
 	return "duplicate argument"
@@ -100,8 +95,7 @@ func (e *CannotSetNestedFieldError) Error() string {
 	return fmt.Sprintf("cannot set nested field for unmarshalable type %T", e.Dest)
 }
 
-type MissingIndexOnArrayError struct {
-}
+type MissingIndexOnArrayError struct{}
 
 func (e *MissingIndexOnArrayError) Error() string {
 	return "missing index on the array"
@@ -129,8 +123,7 @@ func (e *MissingIndicesInArrayError) Error() string {
 	}
 }
 
-type MissingMapKeyError struct {
-}
+type MissingMapKeyError struct{}
 
 func (e *MissingMapKeyError) Error() string {
 	return "missing map key"

internal/args/marshal_test.go

@@ -125,7 +125,7 @@ func TestMarshal(t *testing.T) {
 	t.Run("well-known-types", run(TestCase{
 		data: &WellKnownTypes{
 			Size: 20 * scw.GB,
-			Time: time.Date(2006, 01, 02, 15, 04, 05, 0, time.UTC),
+			Time: time.Date(2006, 1, 2, 15, 4, 5, 0, time.UTC),
 		},
 		expected: []string{
 			"size=20GB",

internal/args/unmarshal_test.go

@@ -251,7 +251,7 @@ func TestUnmarshalStruct(t *testing.T) {
 			"time=2006-01-02T15:04:05Z",
 		},
 		expected: &WellKnownTypes{
-			Time: time.Date(2006, 01, 02, 15, 04, 05, 0, time.UTC),
+			Time: time.Date(2006, 1, 2, 15, 4, 5, 0, time.UTC),
 		},
 	}))
 
@@ -260,7 +260,7 @@ func TestUnmarshalStruct(t *testing.T) {
 			"time=+1m1s",
 		},
 		expected: &WellKnownTypes{
-			Time: time.Date(1970, 01, 01, 0, 1, 1, 0, time.UTC),
+			Time: time.Date(1970, 1, 1, 0, 1, 1, 0, time.UTC),
 		},
 	}))
 
@@ -533,6 +533,7 @@ func TestUnmarshalStruct(t *testing.T) {
 		error: "cannot unmarshal arg 'strings': missing index on the array",
 	}))
 }
+
 func TestIsUmarshalableValue(t *testing.T) {
 	type TestCase struct {
 		expected bool

internal/config/config.go

@@ -18,7 +18,7 @@ const (
 	ScwConfigPathEnv = "SCW_CLI_CONFIG_PATH"
 
 	DefaultConfigFileName   = "cli.yaml"
-	defaultConfigPermission = 0644
+	defaultConfigPermission = 0o644
 
 	DefaultOutput      = "human"
 	configFileTemplate = `# Scaleway CLI config file
@@ -101,7 +101,7 @@ func (c *Config) Save() error {
 		return err
 	}
 
-	err = os.MkdirAll(filepath.Dir(c.path), 0700)
+	err = os.MkdirAll(filepath.Dir(c.path), 0o700)
 	if err != nil {
 		return err
 	}

internal/config/editor.go

@@ -5,11 +5,9 @@ import (
 	"runtime"
 )
 
-var (
-	// List of env variables where to find the editor to use
-	// Order in slice is override order, the latest will override the first ones
-	editorEnvVariables = []string{"EDITOR", "VISUAL"}
-)
+// List of env variables where to find the editor to use
+// Order in slice is override order, the latest will override the first ones
+var editorEnvVariables = []string{"EDITOR", "VISUAL"}
 
 func GetSystemDefaultEditor() string {
 	switch runtime.GOOS {

internal/core/autocomplete_test.go

@@ -219,9 +219,8 @@ func TestAutocompleteArgs(t *testing.T) {
 		Namespace: "test",
 		Resource:  "flower",
 		Verb:      "list",
-		ArgsType: reflect.TypeOf(struct {
-		}{}),
-		ArgSpecs: core.ArgSpecs{},
+		ArgsType:  reflect.TypeOf(struct{}{}),
+		ArgSpecs:  core.ArgSpecs{},
 		Run: func(_ context.Context, _ interface{}) (interface{}, error) {
 			return []*struct {
 				Name string
@@ -239,9 +238,8 @@ func TestAutocompleteArgs(t *testing.T) {
 		Namespace: "test",
 		Resource:  "material",
 		Verb:      "list",
-		ArgsType: reflect.TypeOf(struct {
-		}{}),
-		ArgSpecs: core.ArgSpecs{},
+		ArgsType:  reflect.TypeOf(struct{}{}),
+		ArgSpecs:  core.ArgSpecs{},
 		Run: func(_ context.Context, _ interface{}) (interface{}, error) {
 			return []*struct {
 				Name string

internal/core/bootstrap.go

@@ -261,7 +261,6 @@ func Bootstrap(config *BootstrapConfig) (exitCode int, result interface{}, err e
 	rootCmd.SetArgs(args)
 	rootCmd.SetHelpCommand(&cobra.Command{Hidden: true})
 	err = rootCmd.Execute()
-
 	if err != nil {
 		if _, ok := err.(*interactive.InterruptError); ok {
 			return 130, nil, err

internal/core/checks.go

@@ -35,11 +35,11 @@ func GetLatestVersionUpdateFilePath(cacheDir string) string {
 
 // CreateAndCloseFile creates a file and closes it. It returns true on succeed, false on failure.
 func CreateAndCloseFile(path string) error {
-	err := os.MkdirAll(filepath.Dir(path), 0700)
+	err := os.MkdirAll(filepath.Dir(path), 0o700)
 	if err != nil {
 		return fmt.Errorf("failed creating path %s: %s", path, err)
 	}
-	newFile, err := os.OpenFile(path, os.O_CREATE|os.O_TRUNC|os.O_RDWR, 0600)
+	newFile, err := os.OpenFile(path, os.O_CREATE|os.O_TRUNC|os.O_RDWR, 0o600)
 	if err != nil {
 		return fmt.Errorf("failed creating file %s: %s", path, err)
 	}

internal/core/cobra_builder.go

@@ -26,7 +26,7 @@ type cobraBuilder struct {
 
 // build creates the cobra root command.
 func (b *cobraBuilder) build() *cobra.Command {
-	var groups = map[string]*cobra.Group{
+	groups := map[string]*cobra.Group{
 		"available": {ID: "available", Title: "AVAILABLE"},
 		"labs":      {ID: "labs", Title: "AVAILABLE LABS"},
 		"config":    {ID: "config", Title: "CONFIGURATION"},

internal/core/command.go

@@ -13,7 +13,6 @@ import (
 
 // Command represent a CLI command. From this higher level type we create Cobra command objects.
 type Command struct {
-
 	// Namespace is the top level entry point of a command. (e.g scw instance)
 	Namespace string
 
@@ -271,6 +270,7 @@ func (c *Commands) RemoveResource(namespace, resource string) {
 		}
 	}
 }
+
 func (c *Commands) Add(cmd *Command) {
 	c.commands = append(c.commands, cmd)
 	c.commandIndex[cmd.getPath()] = cmd

internal/core/error.go

@@ -11,7 +11,6 @@ import (
 // CliError is an all-in-one error structure that can be used in commands to return useful errors to the user.
 // CliError implements JSON and human marshaler for a smooth experience.
 type CliError struct {
-
 	// The original error that triggers this CLI error.
 	// The Err.String() will be print in red to the user.
 	Err error

internal/core/errors.go

@@ -23,6 +23,7 @@ func InvalidSecretKeyError(value string) *CliError {
 		Hint: "secret_key should be a valid UUID, formatted as: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.",
 	}
 }
+
 func InvalidAccessKeyError(value string) *CliError {
 	return &CliError{
 		Err:  fmt.Errorf("invalid access_key '%v'", value),

internal/core/example.go

@@ -11,7 +11,6 @@ import (
 
 // Example represents an example for the usage of a CLI command.
 type Example struct {
-
 	// Short is the title given to the example.
 	Short string
 
@@ -32,11 +31,11 @@ func (e *Example) GetCommandLine(binaryName string, cmd *Command) string {
 	case e.ArgsJSON != "":
 		//  Query and path parameters don't have json tag,
 		//  so we need to enforce a JSON tag on every field to make this work.
-		var cmdArgs = newObjectWithForcedJSONTags(cmd.ArgsType)
+		cmdArgs := newObjectWithForcedJSONTags(cmd.ArgsType)
 		if err := json.Unmarshal([]byte(e.ArgsJSON), cmdArgs); err != nil {
 			panic(fmt.Errorf("in command '%s', example '%s': %w", cmd.getPath(), cmd.Short, err))
 		}
-		var cmdArgsAsStrings, err = args.MarshalStruct(cmdArgs)
+		cmdArgsAsStrings, err := args.MarshalStruct(cmdArgs)
 		positionalArg := cmd.ArgSpecs.GetPositionalArg()
 		if positionalArg != nil {
 			for i, cmdArg := range cmdArgsAsStrings {

internal/core/reflect_test.go

@@ -128,7 +128,6 @@ func Test_getValuesForFieldByName(t *testing.T) {
 			},
 		},
 		{
-
 			name: "Special test",
 			testCase: TestCase{
 				cmdArgs: &SpecialRequest{

internal/core/testing.go

@@ -132,7 +132,6 @@ type AfterFuncCtx struct {
 
 // TestConfig contain configuration that can be used with the Test function
 type TestConfig struct {
-
 	// Array of command to load (see main.go)
 	Commands *Commands
 
@@ -619,7 +618,7 @@ type GoldenReplacement struct {
 // GoldenReplacePatterns replace the list of patterns with their given replacement
 func GoldenReplacePatterns(golden string, replacements ...GoldenReplacement) (string, error) {
 	var matchFailed []string
-	var changedGolden = golden
+	changedGolden := golden
 
 	for _, replacement := range replacements {
 		if !replacement.Pattern.MatchString(changedGolden) {
@@ -647,8 +646,8 @@ func TestCheckGoldenAndReplacePatterns(replacements ...GoldenReplacement) TestCh
 		goldenPath := getTestFilePath(t, ".golden")
 		// In order to avoid diff in goldens we set all timestamp to the same date
 		if *UpdateGoldens {
-			require.NoError(t, os.MkdirAll(path.Dir(goldenPath), 0755))
-			require.NoError(t, os.WriteFile(goldenPath, []byte(actual), 0644)) //nolint:gosec
+			require.NoError(t, os.MkdirAll(path.Dir(goldenPath), 0o755))
+			require.NoError(t, os.WriteFile(goldenPath, []byte(actual), 0o644)) //nolint:gosec
 		}
 
 		expected, err := os.ReadFile(goldenPath)
@@ -666,8 +665,8 @@ func TestCheckGolden() TestCheck {
 		goldenPath := getTestFilePath(t, ".golden")
 		// In order to avoid diff in goldens we set all timestamp to the same date
 		if *UpdateGoldens {
-			require.NoError(t, os.MkdirAll(path.Dir(goldenPath), 0755))
-			require.NoError(t, os.WriteFile(goldenPath, []byte(actual), 0644)) //nolint:gosec
+			require.NoError(t, os.MkdirAll(path.Dir(goldenPath), 0o755))
+			require.NoError(t, os.WriteFile(goldenPath, []byte(actual), 0o644)) //nolint:gosec
 		}
 
 		expected, err := os.ReadFile(goldenPath)
@@ -685,8 +684,8 @@ func TestCheckS3Golden() TestCheck {
 		goldenPath := getTestFilePath(t, ".golden")
 		// In order to avoid diff in goldens we set all timestamp to the same date
 		if *UpdateGoldens {
-			require.NoError(t, os.MkdirAll(path.Dir(goldenPath), 0755))
-			require.NoError(t, os.WriteFile(goldenPath, []byte(normalizedActual), 0644)) //nolint:gosec
+			require.NoError(t, os.MkdirAll(path.Dir(goldenPath), 0o755))
+			require.NoError(t, os.WriteFile(goldenPath, []byte(normalizedActual), 0o644)) //nolint:gosec
 		}
 
 		expected, err := os.ReadFile(goldenPath)

internal/core/validate_test.go

@@ -23,8 +23,7 @@ type FirstNestedElement struct {
 	SecondNestedElement *SecondNestedElement
 }
 
-type SecondNestedElement struct {
-}
+type SecondNestedElement struct{}
 
 type elementCustom struct {
 	*Element

internal/core/view.go

@@ -12,7 +12,6 @@ type View struct {
 }
 
 type ViewField struct {
-
 	// Label is the string displayed as header or key for a field.
 	Label string
 

internal/docgen/docgen.go

@@ -77,7 +77,7 @@ func GenerateDocs(commands *core.Commands, outDir string) error {
 		if err != nil {
 			return err
 		}
-		err = os.WriteFile(path.Join(outDir, name+".md"), []byte(namespaceDoc), 0600)
+		err = os.WriteFile(path.Join(outDir, name+".md"), []byte(namespaceDoc), 0o600)
 		if err != nil {
 			return err
 		}