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 intrange linter #4378

Merged
merged 6 commits into from
Feb 15, 2024
Merged

Conversation

ckaznocha
Copy link
Contributor

@ckaznocha ckaznocha commented Feb 12, 2024

Hi,

I'd like to add a new linter: intrange

It looks for loops which iterate over integers and suggests that the new go1.22 support for ranging over integers can be used. See: https://go.dev/ref/spec#Go_1.22

It does not suggest updating loops which:

  • increment more than 1 in each iteration
  • mutate the value of the integer in the body of the loop
  • use anything other than an integer type
  • start with anything other than zero

It works for integer literals, const/vars, and expressions that evaluate to an integer

Copy link

boring-cyborg bot commented Feb 12, 2024

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commented Feb 12, 2024

CLA assistant check
All committers have signed the CLA.

@ldez
Copy link
Member

ldez commented Feb 12, 2024

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.

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().
  • It must not contain log.fatal(), os.exit(), or similar.
  • It must not modify the AST.
  • 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.
  • WithURL() must contain the URL of the repository.

Recommendations

  • The linter should not use SSA. (SSA can be a problem with 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.

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.

@ldez
Copy link
Member

ldez commented Feb 12, 2024

FYI 0.0.x are not semver complaint because a bug fix cannot happen before a minor release or an impossible initial version v0.0.0.

PATCH version when you make backward compatible bug fixes

https://semver.org/

How should I deal with revisions in the 0.y.z initial development phase?

The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.

https://semver.org/#how-should-i-deal-with-revisions-in-the-0yz-initial-development-phase


The version in WithSince(...) must be the next minor version (v1.X.0) of golangci-lint.

@ldez ldez added linter: new Support new linter feedback required Requires additional feedback labels Feb 12, 2024
@ldez ldez removed the feedback required Requires additional feedback label Feb 12, 2024
@ckaznocha
Copy link
Contributor Author

Thanks for taking a first pass @ldez! I believe both of your comments have been addressed.

pkg/golinters/intrange.go Outdated Show resolved Hide resolved
pkg/lint/lintersdb/manager.go Outdated Show resolved Hide resolved
@ldez ldez added the feedback required Requires additional feedback label Feb 15, 2024
ckaznocha and others added 2 commits February 15, 2024 11:41
Co-authored-by: Ludovic Fernandez <ldez@users.noreply.github.com>
Co-authored-by: Ludovic Fernandez <ldez@users.noreply.github.com>
@ckaznocha ckaznocha requested a review from ldez February 15, 2024 19:41
@ldez ldez removed the feedback required Requires additional feedback label Feb 15, 2024
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 changed the title feat: add intrange linter feat: add intrange linter Feb 15, 2024
@ldez ldez merged commit b96ff83 into golangci:master Feb 15, 2024
12 checks passed
@ckaznocha ckaznocha deleted the ckaznocha/intrange branch February 15, 2024 23:04
Antonboom pushed a commit to Antonboom/golangci-lint that referenced this pull request Mar 3, 2024
@ldez ldez added this to the next milestone Mar 4, 2024
@ldez ldez added the enhancement New feature or improvement label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improvement linter: new Support new linter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants