Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the ginkgolinter linter #3369

Merged
merged 1 commit into from
Dec 26, 2022
Merged

Add the ginkgolinter linter #3369

merged 1 commit into from
Dec 26, 2022

Conversation

nunnatsa
Copy link
Contributor

The ginkgolinter checks the ginkgo and gomega assertions in go tests. See here for
additional details: https://github.com/nunnatsa/ginkgolinter

@boring-cyborg
Copy link

boring-cyborg bot commented Nov 21, 2022

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commented Nov 21, 2022

CLA assistant check
All committers have signed the CLA.

@ldez
Copy link
Member

ldez commented Nov 21, 2022

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

Pull Request Description

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

Linter

  • It must not be a duplicate of another linter or a rule of a linter. (the team will help to verify that)
  • It must have a valid license (AGPL is not allowed) and the file must contain the required information by the license, ex: author, year, etc.
  • The linter repository must have a CI and tests.
  • It must use go/analysis.
  • It must have a valid tag, ex: v1.0.0, v0.1.0.
  • It must not contain init().
  • It must not contain panic(), log.fatal(), os.exit(), or similar.
  • It must not have false positives/negatives. (the team will help to verify that)
  • It must have tests inside golangci-lint.

The Linter Tests Inside Golangci-lint

  • They must have at least one std lib import.
  • They must work with T=<name of the linter test file>.go make test_linters. (the team will help to verify that)

.golangci.reference.yml

  • The linter must be added to the list 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.

Others 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 the alphabetical order (case-insensitive) in the Manager.GetAllSupportedLinterConfigs(...) and .golangci.reference.yml.
  • The load mode (WithLoadMode(...)):
    • if the linter doesn't use types: goanalysis.LoadModeSyntax
    • goanalysis.LoadModeTypesInfo required WithLoadForGoAnalysis() in the Manager.GetAllSupportedLinterConfigs(...)
  • The version in WithSince(...) must be the next minor version (v1.X.0) of golangci-lint.

Recommendations

  • The linter should not use SSA. (currently, SSA does not support generics)
  • The linter repository should have a readme and linting.
  • The linter should be published as a binary. (useful to diagnose bug origins)

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

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

@ldez ldez added the linter: new Support new linter label Nov 21, 2022
@nunnatsa nunnatsa force-pushed the ginkgolinter branch 5 times, most recently from 6552ace to 6e0f9b3 Compare November 28, 2022 12:21
@nunnatsa nunnatsa force-pushed the ginkgolinter branch 2 times, most recently from b3d352e to 9c978e8 Compare December 6, 2022 13:32
@nunnatsa nunnatsa mentioned this pull request Dec 6, 2022
@nunnatsa
Copy link
Contributor Author

nunnatsa commented Dec 7, 2022

/cc @ldez

@nunnatsa
Copy link
Contributor Author

Pushed: rebase + squash commits

@nunnatsa
Copy link
Contributor Author

@ldez - thanks for your fixes.

What is the next step? I noticed that It must not have false positives/negatives. (the team will help to verify that) item is not checked. Could you please add some more details about it?

@ldez ldez self-requested a review December 19, 2022 09:41
The ginkgolinter checks the ginkgo assersions in go tests. See here for
additional details: https://github.com/nunnatsa/ginkgolinter
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ldez ldez merged commit 26dde52 into golangci:master Dec 26, 2022
@nunnatsa nunnatsa deleted the ginkgolinter branch December 27, 2022 08:05
SeigeC pushed a commit to SeigeC/golangci-lint that referenced this pull request Apr 4, 2023
@ldez ldez added this to the v1.51 milestone Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
linter: new Support new linter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants