feat: allow to override configuration by package (#21)

Author: ldez

.golangci.yml

@@ -30,7 +30,7 @@ linters-settings:
     disable:
       - fieldalignment
   gocyclo:
-    min-complexity: 15
+    min-complexity: 20
   goconst:
     min-len: 5
     min-occurrences: 3

cmd/tagliatelle/tagliatelle.go

@@ -7,17 +7,19 @@ import (
 
 func main() {
 	cfg := tagliatelle.Config{
-		Rules: map[string]string{
-			"json":      "camel",
-			"yaml":      "camel",
-			"xml":       "camel",
-			"bson":      "camel",
-			"avro":      "snake",
-			"header":    "header",
-			"envconfig": "upperSnake",
-			"env":       "upperSnake",
+		Base: tagliatelle.Base{
+			Rules: map[string]string{
+				"json":      "camel",
+				"yaml":      "camel",
+				"xml":       "camel",
+				"bson":      "camel",
+				"avro":      "snake",
+				"header":    "header",
+				"envconfig": "upperSnake",
+				"env":       "upperSnake",
+			},
+			UseFieldName: true,
 		},
-		UseFieldName: true,
 	}
 
 	singlechecker.Main(tagliatelle.New(cfg))

copygo122_test.go

@@ -0,0 +1,62 @@
+//go:build go1.22 && !go1.23
+
+// Copyright 2016 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package tagliatelle_test
+
+import (
+	"io"
+	"io/fs"
+	"os"
+	"path/filepath"
+)
+
+// CopyFS IMPORTANT:
+// This is a modified copy of os.CopyFS.
+// os.CopyFS is available in go1.23.
+// TODO(ldez) remove this file when bump to go1.23.
+//
+//nolint:all // code from Go.
+func CopyFS(dir string, fsys fs.FS) error {
+	return fs.WalkDir(fsys, ".", func(path string, d fs.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+
+		fpath := path
+
+		newPath := filepath.Join(dir, fpath)
+		if d.IsDir() {
+			return os.MkdirAll(newPath, 0777)
+		}
+
+		// TODO(panjf2000): handle symlinks with the help of fs.ReadLinkFS
+		// 		once https://go.dev/issue/49580 is done.
+		//		we also need filepathlite.IsLocal from https://go.dev/cl/564295.
+		if !d.Type().IsRegular() {
+			return &os.PathError{Op: "CopyFS", Path: path, Err: os.ErrInvalid}
+		}
+
+		r, err := fsys.Open(path)
+		if err != nil {
+			return err
+		}
+		defer r.Close()
+		info, err := r.Stat()
+		if err != nil {
+			return err
+		}
+		w, err := os.OpenFile(newPath, os.O_CREATE|os.O_EXCL|os.O_WRONLY, 0666|info.Mode()&0777)
+		if err != nil {
+			return err
+		}
+
+		if _, err := io.Copy(w, r); err != nil {
+			w.Close()
+			return &os.PathError{Op: "Copy", Path: newPath, Err: err}
+		}
+		return w.Close()
+	})
+}

copygo123_test.go

@@ -0,0 +1,14 @@
+//go:build go1.23
+
+package tagliatelle_test
+
+import (
+	"io/fs"
+	"os"
+)
+
+// CopyFS temporary workaround.
+// TODO(ldez) remove this file when bump to go1.23.
+func CopyFS(dir string, fsys fs.FS) error {
+	return os.CopyFS(dir, fsys)
+}

go.mod

@@ -4,10 +4,12 @@ go 1.22.0
 
 require (
 	github.com/ettle/strcase v0.2.0
+	github.com/hashicorp/go-immutable-radix/v2 v2.1.0
 	golang.org/x/tools v0.27.0
 )
 
 require (
+	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
 	golang.org/x/mod v0.22.0 // indirect
 	golang.org/x/sync v0.9.0 // indirect
 )

go.sum

@@ -2,6 +2,14 @@ github.com/ettle/strcase v0.2.0 h1:fGNiVF21fHXpX1niBgk0aROov1LagYsOwV/xqKDKR/Q=
 github.com/ettle/strcase v0.2.0/go.mod h1:DajmHElDSaX76ITe3/VHVyMin4LWSJN5Z909Wp+ED1A=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/hashicorp/go-immutable-radix/v2 v2.1.0 h1:CUW5RYIcysz+D3B+l1mDeXrQ7fUvGGCwJfdASSzbrfo=
+github.com/hashicorp/go-immutable-radix/v2 v2.1.0/go.mod h1:hgdqLXA4f6NIjRVisM1TJ9aOJVNRqKZj+xDGF6m7PBw=
+github.com/hashicorp/go-uuid v1.0.3 h1:2gKiV6YVmrJ1i2CKKa9obLvRieoRGviZFL26PcT/Co8=
+github.com/hashicorp/go-uuid v1.0.3/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
+github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=
+github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=
+golang.org/x/exp v0.0.0-20221215174704-0915cd710c24 h1:6w3iSY8IIkp5OQtbYj8NeuKG1jS9d+kYaubXqsoOiQ8=
+golang.org/x/exp v0.0.0-20221215174704-0915cd710c24/go.mod h1:CxIveKay+FTh1D0yPZemJVgC/95VzuuOLq5Qi4xnoYc=
 golang.org/x/mod v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4=
 golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
 golang.org/x/sync v0.9.0 h1:fEo0HyrW1GIgZdpbhCRO0PkJajUS5H9IFUztCgEo2jQ=

readme.md

@@ -114,14 +114,24 @@ Define the rules, you want via your [golangci-lint](https://golangci-lint.run) c
 ```yaml
 linters-settings:
   tagliatelle:
-    # Check the struck tag name case.
+    # Check the struct tag name case.
     case:
-      # Use the struct field name to check the name of the struct tag.
-      # Default: false
-      use-field-name: true
+      # Define the association between tag name and case.
+      # Any struct tag name can be used.
+      # Support string cases:
+      # - `camel`
+      # - `pascal`
+      # - `kebab`
+      # - `snake`
+      # - `upperSnake`
+      # - `goCamel`
+      # - `goPascal`
+      # - `goKebab`
+      # - `goSnake`
+      # - `upper`
+      # - `lower`
+      # - `header`
       rules:
-        # Any struct tag type can be used.
-        # Support string case: `camel`, `pascal`, `kebab`, `snake`, `upperSnake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`, `header`.
         json: camel
         yaml: camel
         xml: camel
@@ -131,6 +141,87 @@ linters-settings:
         mapstructure: kebab
         env: upperSnake
         envconfig: upperSnake
+        whatever: snake
+      # Use the struct field name to check the name of the struct tag.
+      # Default: false
+      use-field-name: true
+      # The field names to ignore.
+      # Default: []
+      ignored-fields:
+        - Bar
+        - Foo
+      # Overrides the default/root configuration.
+      # Default: []
+      overrides:
+        -
+          # The package path. (uses `/` only as separator)
+          # Required
+          pkg: foo/bar
+          # Default: empty or the same as the default/root configuration.
+          rules:
+            json: snake
+            xml: pascal
+          # Default: false or the same as the default/root configuration.
+          use-field-name: true
+          # The field names to ignore.
+          # Default: [] or the same as the default/root configuration.
+          ignored-fields:
+            - Bar
+            - Foo
+          # Ignore the package (it takes the precedence over all other configuration).
+          # Default: false
+          ignore: true
+```
+
+#### Examples
+
+Overrides case rules for the package `foo/bar`:
+
+```yaml
+linters-settings:
+  tagliatelle:
+    case:
+      rules:
+        json: camel
+        yaml: camel
+        xml: camel
+      overrides:
+        - pkg: foo/bar
+          rules:
+            json: snake
+            xml: pascal
+```
+
+Ignore fields inside the package `foo/bar`:
+
+```yaml
+linters-settings:
+  tagliatelle:
+    case:
+      rules:
+        json: camel
+        yaml: camel
+        xml: camel
+      overrides:
+        - pkg: foo/bar
+          ignored-fields:
+            - Bar
+            - Foo
+```
+
+Ignore the package `foo/bar`:
+
+```yaml
+linters-settings:
+  tagliatelle:
+    case:
+      rules:
+        json: camel
+        yaml: camel
+        xml: camel
+      overrides:
+        - pkg: foo/bar
+          ignore: true
 ```
 
 More information here https://golangci-lint.run/usage/linters/#tagliatelle
@@ -171,9 +262,6 @@ linters-settings:
   tagliatelle:
     # Check the struck tag name case.
     case:
-      # Use the struct field name to check the name of the struct tag.
-      # Default: false
-      use-field-name: true
       rules:
         # Any struct tag type can be used.
         # Support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`
@@ -182,4 +270,7 @@ linters-settings:
         xml: camel
         toml: camel
         whatever: kebab
+      # Use the struct field name to check the name of the struct tag.
+      # Default: false
+      use-field-name: true
 ```