chore: rename forbidigo options

Author: ldez

.golangci.next.reference.yml

@@ -708,20 +708,20 @@ linters-settings:
     # Default: ["^(fmt\\.Print(|f|ln)|print|println)$"]
     forbid:
       # Built-in bootstrapping functions.
-      - ^print(ln)?$
+      - pattern: ^print(ln)?$
       # Optional message that gets included in error reports.
-      - p: ^fmt\.Print.*$
+      - pattern: ^fmt\.Print.*$
         msg: Do not commit print statements.
       # Alternatively, put messages at the end of the regex, surrounded by `(# )?`
       # Escape any special characters. Those messages get included in error reports.
-      - 'fmt\.Print.*(# Do not commit print statements\.)?'
+      - pattern: 'fmt\.Print.*(# Do not commit print statements\.)?'
       # Forbid spew Dump, whether it is called as function or method.
       # Depends on analyze-types below.
-      - ^spew\.(ConfigState\.)?Dump$
+      - pattern: ^spew\.(ConfigState\.)?Dump$
       # The package name might be ambiguous.
       # The full import path can be used as additional criteria.
       # Depends on analyze-types below.
-      - p: ^v1.Dump$
+      - pattern: ^v1.Dump$
         pkg: ^example.com/pkg/api/v1$
     # Exclude godoc examples from forbidigo checks.
     # Default: true

jsonschema/golangci.next.jsonschema.json

@@ -942,31 +942,23 @@
             "forbid": {
               "description": "List of identifiers to forbid (written using `regexp`)",
               "type": "array",
-              "examples": ["^print(ln)?$"],
               "items": {
-                "anyOf": [
-                  {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "pattern": {
+                    "description": "Pattern",
                     "type": "string"
                   },
-                  {
-                    "type": "object",
-                    "additionalProperties": false,
-                    "properties": {
-                      "p": {
-                        "description": "Pattern",
-                        "type": "string"
-                      },
-                      "pkg": {
-                        "description": "Package",
-                        "type": "string"
-                      },
-                      "msg": {
-                        "description": "Message",
-                        "type": "string"
-                      }
-                    }
+                  "pkg": {
+                    "description": "Package",
+                    "type": "string"
+                  },
+                  "msg": {
+                    "description": "Message",
+                    "type": "string"
                   }
-                ]
+                }
               }
             }
           }

pkg/config/linters_settings.go

@@ -1,12 +1,9 @@
 package config
 
 import (
-	"encoding"
 	"errors"
 	"fmt"
 	"runtime"
-
-	"gopkg.in/yaml.v3"
 )
 
 var defaultLintersSettings = LintersSettings{
@@ -425,8 +422,6 @@ type ForbidigoSettings struct {
 	AnalyzeTypes         bool               `mapstructure:"analyze-types"`
 }
 
-var _ encoding.TextUnmarshaler = &ForbidigoPattern{}
-
 // ForbidigoPattern corresponds to forbidigo.pattern and adds mapstructure support.
 // The YAML field names must match what forbidigo expects.
 type ForbidigoPattern struct {
@@ -437,30 +432,11 @@ type ForbidigoPattern struct {
 	// If the entry is a map, then the other fields are set as usual by mapstructure.
 	patternString string
 
-	Pattern string `yaml:"p" mapstructure:"p"`
+	Pattern string `yaml:"p" mapstructure:"pattern"`
 	Package string `yaml:"pkg,omitempty" mapstructure:"pkg,omitempty"`
 	Msg     string `yaml:"msg,omitempty" mapstructure:"msg,omitempty"`
 }
 
-func (p *ForbidigoPattern) UnmarshalText(text []byte) error {
-	// Validation happens when instantiating forbidigo.
-	p.patternString = string(text)
-	return nil
-}
-
-// MarshalString converts the pattern into a string as needed by forbidigo.NewLinter.
-//
-// MarshalString is intentionally not called MarshalText,
-// although it has the same signature
-// because implementing encoding.TextMarshaler led to infinite recursion when yaml.Marshal called MarshalText.
-func (p *ForbidigoPattern) MarshalString() ([]byte, error) {
-	if p.patternString != "" {
-		return []byte(p.patternString), nil
-	}
-
-	return yaml.Marshal(p)
-}
-
 type FunlenSettings struct {
 	Lines          int  `mapstructure:"lines"`
 	Statements     int  `mapstructure:"statements"`

pkg/golinters/forbidigo/forbidigo.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/ashanbrown/forbidigo/forbidigo"
 	"golang.org/x/tools/go/analysis"
+	"gopkg.in/yaml.v3"
 
 	"github.com/golangci/golangci-lint/pkg/config"
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
@@ -49,7 +50,7 @@ func runForbidigo(pass *analysis.Pass, settings *config.ForbidigoSettings) error
 	// Convert patterns back to strings because that is what NewLinter accepts.
 	var patterns []string
 	for _, pattern := range settings.Forbid {
-		buffer, err := pattern.MarshalString()
+		buffer, err := yaml.Marshal(pattern)
 		if err != nil {
 			return err
 		}

pkg/golinters/forbidigo/testdata/forbidigo.yml

@@ -3,5 +3,5 @@ version: "2"
 linters-settings:
   forbidigo:
     forbid:
-      - fmt\.Print.*
-      - time.Sleep(# no sleeping!)?
+      - pattern: fmt\.Print.*
+      - pattern: time.Sleep(# no sleeping!)?

pkg/golinters/forbidigo/testdata/forbidigo_struct.yml

@@ -4,7 +4,7 @@ linters-settings:
   forbidigo:
     analyze-types: true
     forbid:
-      - p: fmt\.Print.*
+      - pattern: fmt\.Print.*
         pkg: ^fmt$
-      - p: time.Sleep
+      - pattern: time.Sleep
         msg: no sleeping!

test/testdata/configs/path-except.yml

@@ -3,8 +3,8 @@ version: "2"
 linters-settings:
   forbidigo:
     forbid:
-      - fmt\.Print.*
-      - time.Sleep(# no sleeping!)?
+      - pattern: fmt\.Print.*
+      - pattern: time.Sleep(# no sleeping!)?
 
 linters:
   exclusions: