nolint: drop allow-leading-space option and add "nolint:all" (#3002)

.golangci.yml

@@ -61,7 +61,7 @@ linters-settings:
   misspell:
     locale: US
   nolintlint:
-    allow-leading-space: true # don't require machine-readable nolint directives (i.e. with no leading space)
+    allow-leading-space: false
     allow-unused: false # report any unused nolint directives
     require-explanation: false # don't require an explanation for nolint directives
     require-specific: false # don't require nolint directives to be specific about which linter is being skipped

docs/src/docs/usage/false-positives.mdx

@@ -95,11 +95,11 @@ run:
 
 ## Nolint Directive
 
-To exclude issues from all linters use `//nolint`.
+To exclude issues from all linters use `//nolint:all`.
 For example, if it's used inline (not from the beginning of the line) it excludes issues only for this line.
 
 ```go
-var bad_name int //nolint
+var bad_name int //nolint:all
 ```
 
 To exclude issues from specific linters only:
@@ -111,7 +111,7 @@ var bad_name int //nolint:golint,unused
 To exclude issues for the block of code use this directive on the beginning of a line:
 
 ```go
-//nolint
+//nolint:all
 func allIssuesInThisFunctionAreExcluded() *string {
   // ...
 }

pkg/config/linters_settings.go

@@ -77,7 +77,6 @@ var defaultLintersSettings = LintersSettings{
 	},
 	NoLintLint: NoLintLintSettings{
 		RequireExplanation: false,
-		AllowLeadingSpace:  true,
 		RequireSpecific:    false,
 		AllowUnused:        false,
 	},
@@ -488,7 +487,6 @@ type NlreturnSettings struct {
 
 type NoLintLintSettings struct {
 	RequireExplanation bool     `mapstructure:"require-explanation"`
-	AllowLeadingSpace  bool     `mapstructure:"allow-leading-space"`
 	RequireSpecific    bool     `mapstructure:"require-specific"`
 	AllowNoExplanation []string `mapstructure:"allow-no-explanation"`
 	AllowUnused        bool     `mapstructure:"allow-unused"`

pkg/golinters/nolintlint.go

@@ -57,9 +57,6 @@ func runNoLintLint(pass *analysis.Pass, settings *config.NoLintLintSettings) ([]
 	if settings.RequireExplanation {
 		needs |= nolintlint.NeedsExplanation
 	}
-	if !settings.AllowLeadingSpace {
-		needs |= nolintlint.NeedsMachineOnly
-	}
 	if settings.RequireSpecific {
 		needs |= nolintlint.NeedsSpecific
 	}

pkg/golinters/nolintlint/README.md

@@ -8,10 +8,10 @@ nolintlint is a Go static analysis tool to find ill-formed or insufficiently exp
 To ensure that lint exceptions have explanations.  Consider the case below:
 
 ```Go
-import "crypto/md5" //nolint
+import "crypto/md5" //nolint:all
 
 func hash(data []byte) []byte {
-	return md5.New().Sum(data) //nolint
+	return md5.New().Sum(data) //nolint:all
 }
 ```
 
@@ -27,5 +27,5 @@ func hash(data []byte) []byte {
 ```
 
 `nolintlint` can also identify cases where you may have written `//  nolint`.  Finally `nolintlint`, can also enforce that you
-use the machine-readable nolint directive format `//nolint` and that you mention what linter is being suppressed, as shown above when we write `//nolint:gosec`.
+use the machine-readable nolint directive format `//nolint:all` and that you mention what linter is being suppressed, as shown above when we write `//nolint:gosec`.
 

pkg/golinters/nolintlint/nolintlint.go

@@ -152,7 +152,7 @@ func NewLinter(needs Needs, excludes []string) (*Linter, error) {
 	}
 
 	return &Linter{
-		needs:           needs,
+		needs:           needs | NeedsMachineOnly,
 		excludeByLinter: excludeByName,
 	}, nil
 }
@@ -184,12 +184,14 @@ func (l Linter) Run(fset *token.FileSet, nodes ...ast.Node) ([]Issue, error) {
 					leadingSpace = leadingSpaceMatches[1]
 				}
 
-				directiveWithOptionalLeadingSpace := comment.Text
+				directiveWithOptionalLeadingSpace := "//"
 				if len(leadingSpace) > 0 {
-					split := strings.Split(strings.SplitN(comment.Text, ":", 2)[0], "//")
+					directiveWithOptionalLeadingSpace += " "
-					directiveWithOptionalLeadingSpace = "// " + strings.TrimSpace(split[1])
 				}
 
+				split := strings.Split(strings.SplitN(comment.Text, ":", 2)[0], "//")
+				directiveWithOptionalLeadingSpace += strings.TrimSpace(split[1])
+
 				pos := fset.Position(comment.Pos())
 				end := fset.Position(comment.End())
 
@@ -227,8 +229,9 @@ func (l Linter) Run(fset *token.FileSet, nodes ...ast.Node) ([]Issue, error) {
 				}
 
 				lintersText, explanation := fullMatches[1], fullMatches[2]
+
 				var linters []string
-				if len(lintersText) > 0 {
+				if len(lintersText) > 0 && !strings.HasPrefix(lintersText, "all") {
 					lls := strings.Split(lintersText, ",")
 					linters = make([]string, 0, len(lls))
 					rangeStart := (pos.Column - 1) + len("//") + len(leadingSpace) + len("nolint:")

pkg/golinters/nolintlint/nolintlint_test.go

@@ -12,7 +12,7 @@ import (
 )
 
 //nolint:funlen
-func TestNoLintLint(t *testing.T) {
+func TestLinter_Run(t *testing.T) {
 	type issueWithReplacement struct {
 		issue       string
 		replacement *result.Replacement
@@ -89,11 +89,11 @@ func foo() {
 		},
 		{
 			desc: "when machine-readable style isn't used",
-			needs: NeedsMachineOnly,
 			contents: `
 package bar
 
 func foo() {
+  bad() // nolint
   bad() //   nolint
   good() //nolint
 }`,
@@ -108,24 +108,12 @@ func foo() {
 						},
 					},
 				},
-			},
-		},
 				{
-			desc: "extra spaces in front of directive are reported",
+					issue: "directive `//   nolint` should be written without leading space as `//nolint` at testing.go:6:9",
-			contents: `
-package bar
-
-func foo() {
-  bad() //  nolint
-  good() // nolint
-}`,
-			expected: []issueWithReplacement{
-				{
-					issue: "directive `//  nolint` should not have more than one leading space at testing.go:5:9",
 					replacement: &result.Replacement{
 						Inline: &result.InlineFix{
 							StartCol:  10,
-							Length:    2,
+							Length:    3,
 							NewString: "",
 						},
 					},

pkg/golinters/staticcheck_common.go

@@ -98,7 +98,7 @@ func staticCheckConfig(settings *config.StaticCheckSettings) *scconfig.Config {
 }
 
 // https://github.com/dominikh/go-tools/blob/9bf17c0388a65710524ba04c2d821469e639fdc2/lintcmd/lint.go#L437-L477
-// nolint // Keep the original source code.
+//nolint:gocritic // Keep the original source code.
 func filterAnalyzerNames(analyzers []string, checks []string) map[string]bool {
 	allowedChecks := map[string]bool{}
 

pkg/result/processors/nolint.go

@@ -252,7 +252,7 @@ func (p *Nolint) extractInlineRangeFromComment(text string, g ast.Node, fset *to
 		}
 	}
 
-	if !strings.HasPrefix(text, "nolint:") {
+	if strings.HasPrefix(text, "nolint:all") || !strings.HasPrefix(text, "nolint:") {
 		return buildRange(nil) // ignore all linters
 	}
 
@@ -260,8 +260,12 @@ func (p *Nolint) extractInlineRangeFromComment(text string, g ast.Node, fset *to
 	var linters []string
 	text = strings.Split(text, "//")[0] // allow another comment after this comment
 	linterItems := strings.Split(strings.TrimPrefix(text, "nolint:"), ",")
-	for _, linter := range linterItems {
+	for _, item := range linterItems {
-		linterName := strings.ToLower(strings.TrimSpace(linter))
+		linterName := strings.ToLower(strings.TrimSpace(item))
+		if linterName == "all" {
+			p.unknownLintersSet = map[string]bool{}
+			return buildRange(nil)
+		}
 
 		lcs := p.dbManager.GetLinterConfigs(linterName)
 		if lcs == nil {

pkg/result/processors/testdata/autogen_exclude_doc.go

@@ -4,7 +4,7 @@ package testdata
 
 import "fmt"
 
-// nolint
+//nolint:all
 func PrintString(s string) {
 	fmt.Printf("%s", s)
 }

pkg/result/processors/testdata/nolint.go

@@ -3,26 +3,26 @@ package testdata
 var nolintSpecific int    //nolint:gofmt
 var nolintSpace int       // nolint: gofmt
 var nolintSpaces int      //nolint:gofmt, govet
-var nolintAll int         // nolint
+var nolintAll int         // nolint:all
-var nolintAndAppendix int // nolint // another comment
+var nolintAndAppendix int // nolint:all // another comment
 
-//nolint
+//nolint:all
 var nolintVarByPrecedingComment int
 
-//nolint
+//nolint:all
 
 var dontNolintVarByPrecedingCommentBecauseOfNewLine int
 
-var nolintPrecedingVar string //nolint
+var nolintPrecedingVar string //nolint:all
 var dontNolintVarByPrecedingCommentBecauseOfDifferentColumn int
 
-//nolint
+//nolint:all
 func nolintFuncByPrecedingComment() *string {
 	xv := "v"
 	return &xv
 }
 
-//nolint
+//nolint:all
 // second line
 func nolintFuncByPrecedingMultilineComment1() *string {
 	xv := "v"
@@ -30,14 +30,14 @@ func nolintFuncByPrecedingMultilineComment1() *string {
 }
 
 // first line
-//nolint
+//nolint:all
 func nolintFuncByPrecedingMultilineComment2() *string {
 	xv := "v"
 	return &xv
 }
 
 // first line
-//nolint
+//nolint:all
 // third line
 func nolintFuncByPrecedingMultilineComment3() *string {
 	xv := "v"

test/testdata/default_exclude.go

@@ -11,6 +11,7 @@ func ExportedFunc1() {
 }
 
 // InvalidFuncComment // ERROR stylecheck `ST1020: comment on exported function ExportedFunc2 should be of the form "ExportedFunc2 ..."`
+//
 //nolint:golint
 func ExportedFunc2() {
 }

test/testdata/fix/in/nolintlint.go

@@ -10,7 +10,7 @@ func nolintlint() {
 	fmt.Println() //  nolint:bob // leading spaces should be dropped
 
 	// note that the next lines will retain trailing whitespace when fixed
-	fmt.Println() //nolint // nolint should be dropped
+	fmt.Println() //nolint:all // nolint should be dropped
 	fmt.Println() //nolint:lll // nolint should be dropped
 
 	fmt.Println() //nolint:alice,lll // we don't drop individual linters from lists

test/testdata/nolintlint_unused.go

@@ -6,7 +6,7 @@ package testdata
 import "fmt"
 
 func Foo() {
-	fmt.Println("unused")          // nolint // ERROR "directive `//nolint .*` is unused"
+	fmt.Println("unused")          //nolint:all // ERROR "directive `//nolint .*` is unused"
 	fmt.Println("unused,specific") //nolint:varcheck // ERROR "directive `//nolint:varcheck .*` is unused for linter varcheck"
 	fmt.Println("not run")         //nolint:unparam // unparam is not run so this is ok
 }

tools/tools.go

@@ -1,3 +1,4 @@
+//go:build tools
 // +build tools
 
 package tools
@@ -7,7 +8,7 @@ package tools
 // https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module
 // https://github.com/golang/go/issues/25922
 //
-// nolint
+//nolint:all
 import (
 	_ "github.com/goreleaser/goreleaser"
 )