Expose more config options for forbidigo (#1677)

Author: ashanbrown

.golangci.example.yml

@@ -414,6 +414,8 @@ linters-settings:
       - fmt.Errorf # consider errors.Errorf in github.com/pkg/errors
       - fmt.Print.* # too much log noise
       - ginkgo\\.F.* # these are used just for local development
+    # Exclude godoc examples from forbidigo checks.  Default is true.
+    exclude_godoc_examples: false
 
   # The custom section can be used to define linter plugins to be loaded at runtime. See README doc
   #  for more info.

go.sum

@@ -416,7 +416,8 @@ type IfshortSettings struct {
 }
 
 type ForbidigoSettings struct {
-	Forbid []string `mapstructure:"forbid"`
+	Forbid               []string `mapstructure:"forbid"`
+	ExcludeGodocExamples bool     `mapstructure:"exclude-godoc-examples"`
 }
 
 type PredeclaredSettings struct {
@@ -488,6 +489,9 @@ var defaultLintersSettings = LintersSettings{
 		Ignore:    "",
 		Qualified: false,
 	},
+	Forbidigo: ForbidigoSettings{
+		ExcludeGodocExamples: true,
+	},
 }
 
 type CustomLinterSettings struct {

pkg/config/config.go

@@ -31,7 +31,12 @@ func NewForbidigo() *goanalysis.Linter {
 
 		analyzer.Run = func(pass *analysis.Pass) (interface{}, error) {
 			var res []goanalysis.Issue
-			forbid, err := forbidigo.NewLinter(s.Forbid)
+			options := []forbidigo.Option{
+				forbidigo.OptionExcludeGodocExamples(s.ExcludeGodocExamples),
+				// disable "//permit" directives so only "//nolint" directives matters within golangci lint
+				forbidigo.OptionIgnorePermitDirectives(true),
+			}
+			forbid, err := forbidigo.NewLinter(s.Forbid, options...)
 			if err != nil {
 				return nil, errors.Wrapf(err, "failed to create linter %q", linterName)
 			}

pkg/golinters/forbidigo.go

@@ -0,0 +1,9 @@
+//args: -Eforbidigo
+//config_path: testdata/configs/forbidigo.yml
+package testdata
+
+import "fmt"
+
+func ExampleForbidigo() {
+	fmt.Printf("too noisy!!!") // godoc examples are ignored (in *_test.go files only)
+}

test/testdata/forbidigo.go renamed to test/testdata/forbidigo_example.go

@@ -0,0 +1,9 @@
+//args: -Eforbidigo
+//config: linters-settings.forbidigo.exclude-godoc-examples=false
+package testdata
+
+import "fmt"
+
+func ExampleForbidigoNoGodoc() {
+	fmt.Printf("too noisy!!!") // ERROR "use of `fmt.Printf` forbidden by pattern.*"
+}