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

feat: add interfacebloat #3024

Merged
merged 4 commits into from Aug 21, 2022
Merged

Conversation

sashamelentyev
Copy link
Member

@sashamelentyev sashamelentyev commented Jul 30, 2022

A linter that checks the number of methods on an interface.
https://github.com/sashamelentyev/interfacebloat

@ldez
Copy link
Member

ldez commented Jul 30, 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 about 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 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.example.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
Copy link
Member

ldez commented Jul 30, 2022

What do you call the length of an interface? 🤔

Can you improve your readme?

  • add detailed explanation
  • add exemples

@ldez ldez added linter: new Support new linter blocked Need's direct action from maintainer labels Jul 30, 2022
@sashamelentyev
Copy link
Member Author

I mean count of methods in interface

@ldez
Copy link
Member

ldez commented Jul 30, 2022

What is the rule that you want to apply? is it limit the number of methods in an interface?
Can you explain why (please provide links to documentation)?

@sashamelentyev
Copy link
Member Author

Yes, limit the number of methods in an interface
interface bloat (fat interface) - it's anti-pattern

https://en.wikipedia.org/wiki/Interface_bloat
https://stackoverflow.com/questions/1894021/what-is-interface-bloat

@ldez
Copy link
Member

ldez commented Jul 30, 2022

So now, you have to improve your readme with the links and examples.

@sashamelentyev
Copy link
Member Author

@ldez I add short description and links

@ldez ldez added feedback required Requires additional feedback and removed blocked Need's direct action from maintainer labels Aug 19, 2022
@ldez
Copy link
Member

ldez commented Aug 20, 2022

sashamelentyev/interfacebloat#1

@ldez ldez removed the feedback required Requires additional feedback label Aug 20, 2022
@ldez
Copy link
Member

ldez commented Aug 21, 2022

The test failure is related to 6e756cb and fixed by #3118

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 63b2fe0 into golangci:master Aug 21, 2022
SeigeC pushed a commit to SeigeC/golangci-lint that referenced this pull request Apr 4, 2023
Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>
@ldez ldez added this to the v1.49 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

2 participants