adhere to the widespread comment directive format

[mvdan]

In Go, //go:* is reserved for the Go toolchain. See https://golang.org/cmd/compile/.

It is encouraged that other Go tools use a similar "namespace" prefix for their comment directives. For example, //gccgo:*, //lint:* for staticcheck, //go-sumtype:*, and so on. See https://groups.google.com/g/golang-dev/c/r4rdPdsH1Fg/m/tNZazPenX5cJ.

golangci-lint kind of does this, but not really. https://golangci-lint.run/usage/false-positives/#nolint gives this example:

var bad_name int //nolint

That's no good, because it clearly does not adhere to the widespread format. It is not formally defined, but in practice it follows something like ^[a-z]+:[a-z]+.

A possible fix would be //nolint:all, which is also clearer. Another option would be to follow staticcheck's https://staticcheck.io/docs/configuration/#line-based-linter-directives, which already follows the format with //lint:ignore ....

[boring-cyborg]

Hey, thank you for opening your first Issue ! 🙂 If you would like to contribute we have a guide for contributors.

[mvdan]

For the sake of documenting this better upstream, I've raised golang/go#43776.

[kortschak]

Moving to the approach used by staticcheck would also have the advantage that file-wide directives will work properly; currently the way to do a file-wide directed is to attach the comment to the package decl, which in turn results in a line in the godoc.

See https://staticcheck.io/docs/#file-based-linter-directives for how staticcheck does it.

[kortschak]

Also, @ldez given that this is a deviation from the Go standard, I think this is a bug and not an enhancement.

[ldez]

Today, nolint can have two syntax:

• just a simple comment: // nolint
• a directive syntax //nolint

In the code base of golangci-lint, it's used as a simple comment syntax. So from my point of view, there is no deviation.

But my main concern, it's the resulting breaking change of the syntax change.

currently the way to do a file-wide directed is to attach the comment to the package decl, which in turn results in a line in the godoc.

currently the nolint directives are ignored in the godoc #1566 (comment)

[mvdan]

just a simple comment: // nolint

To be honest, I don't think this is a good solution. All golangci-lint directives should clearly look like directives, not plain English comments.

there is no deviation.

I don't follow - the docs clearly point towards //nolint, which does not use a space and does not adhere to the format.

the resulting breaking change

The fix could be rolled out over time, or come with an automated way to fix up older comments like https://github.com/ipld/specs/pull/353/files#diff-ed097ee1bca871446cf885a8fabf9722c54921cf7bae59f780cd14a6f305c3d5.

[AlekSi]

I would propose for golangci-lint to complain about all forms with spaces: // nolint, //nolint: name, etc.

[ldez]

@AlekSi you can already do that:

linters-settings:
  nolintlint:
    # Disable to ensure that nolint directives don't have a leading space. Default is true.
    allow-leading-space: false

[AlekSi]

And I think the default should be changed to false in some future version with some warnings in between.

Edit: also, the current code doesn't handle //nolint: name (with space) case.