Adds Golistics

[ufukty]

This PR adds Golistics to golangci-lint. Golistics is a linter to warn developer when a "holistic" method miss a field. Holistic methods are those methods that need to access all fields of the receiver to stay valid such as validators, comparators and serializers.

https://github.com/ufukty/golistics

Control list

• have checked the linter settings page for the keyword fields and could not find something similar.
• I have checked the linter for false positives by both automated and manual tests. It is also opt-in per method which makes even less likely to produce false positives.
• Repository has CI and CodeQL. CI is based on the go test tool which is performing analysistest based test.
• The PR also adds a test; which use the same example file with golistics: directives in method doc-comments.
• MIT license

I am currently working on the integration tests. If it is not too much of an inconvenience I would be grateful for getting directions.

Thanks,

[boring-cyborg]

Hey, thank you for opening your first Pull Request !

[ldez]

In order for a pull request adding a linter to be reviewed, the linter and the PR must follow some requirements.

• The CLA must be signed

Pull Request Description

• It must have a link to the linter repository.
• It must provide a short description of the linter.

Base Requirements

These requirements are not declarative; the team will verify them.

• It must not be a duplicate of another linter or a rule of a linter.
• It must not have false positives/negatives.

Linter

• It must have a valid license:
  • AGPL is not allowed
  • The file must start with LICENSE (capitalized)
  • The file must contain the required information by the license, ex: author, year, etc.
• It must use Go version <= 1.24.0
• The linter repository must have a CI and tests.
• It must use go/analysis.
• It must have a valid semver tag, ex: v1.0.0, v0.1.0 (0.0.x are not valid).
• It must not contain:
  • init()
  • panic()
  • log.Fatal(), os.Exit(), or similar.
• It must not modify the AST.
• It must have tests inside golangci-lint.

The Linter Tests Inside Golangci-lint

• They must have at least one std lib import.
• They must have integration tests without configuration (default).
• They must have integration tests with configuration (if the linter has a configuration).

.golangci.next.reference.yml

• The file .golangci.next.reference.yml must be updated.
• The file .golangci.reference.yml must NOT be edited.
• The linter must be added to the lists of available linters (alphabetical case-insensitive order).
  • enable and disable options
• If the linter has a configuration, the exhaustive configuration of the linter must be added (alphabetical case-insensitive order)
  • The values must be different from the default ones.
  • The default values must be defined in a comment.
  • The option must have a short description.

Other Requirements

• The files (tests and linter) inside golangci-lint must have the same name as the linter.
• The .golangci.yml of golangci-lint itself must not be edited, and the linter must not be added to this file.
• The linters must be sorted in alphabetical order (case-insensitive) in the lintersdb/builder_linter.go and .golangci.next.reference.yml.
• The load mode (WithLoadMode(...)):
  • if the linter uses goanalysis.LoadModeSyntax -> no WithLoadForGoAnalysis() in lintersdb/builder_linter.go
  • if the linter uses goanalysis.LoadModeTypesInfo, it requires WithLoadForGoAnalysis() in lintersdb/builder_linter.go
• The version in WithSince(...) must be the next minor version (v2.X.0) of golangci-lint.
• WithURL() must contain the URL of the repository.

Recommendations

• The file jsonschema/golangci.next.jsonschema.json should be updated.
• The file jsonschema/golangci.jsonschema.json must NOT be edited.
• The linter repository should have a readme and linting.
• The linter should be published as a binary (useful for diagnosing bug origins).
• The linter repository should have a .gitignore (IDE files, binaries, OS files, etc. should not be committed)
• Use main as the default branch name.

Workflow

• A tag should never be recreated.
• The reviews or changes should be addressed as commits (no squash).

---

The golangci-lint team will edit this comment to check the boxes before and during the review.

The code review will start after the completion of those checkboxes (except for the specific items that the team will help to verify).

If the author of the PR is a member of the golangci-lint team, he should not edit this message.

This checklist does not imply that we will accept the linter.

[ufukty]

Maybe screenshot would be helpful to understand easier what it does.

[ldez]

I didn't check you linter for now, but please remove go.mod, go.sum inside the tests, and remove any changes not related directly to your analyzer.

[ldez]

I repeat remove any changes not related directly to your analyzer (ex: the unrelated changes inside the config reference).

For the integration tests, add this on top of the Go test file:

//golangcitest:args -Egolistics

and remove pkg/golinters/golistics/testdata/golistics.yml

Also, each push produces a notification, so please limit the number of push.

[ufukty]

I'm pushing commits at once for all changes this time, hoping to resolve all.

Addressed those as you pointed:

• unnecessary formatter edits on yaml config file,
• unnecessary config file in test,
• lack of integration test file directive,

Also did:

• add a stdlib import in test file
• add WithLoadForGoAnalysis() for fixing the integration test error unexpected diagnostic: could not import image/color (Config.Importer.Import(image/color) returned nil but no error) ()
• drop dependency on inspect.Analyzer at the linter's itself (published patch)
• add .WithLoadMode(goanalysis.LoadModeTypesInfo)
• validate the next version is v2.9.0

Checked the branch diff to make sure the same mistake won't repeat again :)

[ufukty]

Hi, I came back to check if there is anything I missed and I should do before the review. Please let me know if there is any.