Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Add errgroupcheck linter#4891

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
alexbagnolini wants to merge1 commit intogolangci:master
base:master
Choose a base branch
Loading
fromalexbagnolini:master

Conversation

@alexbagnolini
Copy link

errgroupcheck analyzes code and reports any usage ofgolang.org/x/sync/errgroup that is missing any call to theWait() func.

All the examples reported in theerrgroup documentation showcase the correct usage of theWait() func to wait for all the coroutines to complete before proceeding.

Missing theWait() call allows the code to compile just fine, but yields unexpected results due to the coroutines running without any wait for termination.

@boring-cyborg
Copy link

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commentedAug 2, 2024
edited
Loading

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign ourContributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let usrecheck it.

@ldez
Copy link
Member

ldez commentedAug 2, 2024
edited
Loading

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.
  • It must use Go version <= 1.21
  • The linter repository must have a CI and tests.
  • It must usego/analysis.
  • It must have a valid tag, ex:v1.0.0,v0.1.0.
  • It must not containinit().
  • It must not containpanic().
  • It must not containlog.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 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 anddisable 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 thelintersdb/builder_linter.go and.golangci.next.reference.yml.
  • The load mode (WithLoadMode(...)):
    • if the linter usesgoanalysis.LoadModeSyntax -> noWithLoadForGoAnalysis() inlintersdb/builder_linter.go
    • if the linter usesgoanalysis.LoadModeTypesInfo, it requiresWithLoadForGoAnalysis() inlintersdb/builder_linter.go
  • The version inWithSince(...) must be the next minor version (v1.X.0) of golangci-lint.
  • WithURL() must contain the URL of the repository.

Recommendations

  • The filejsonschema/golangci.next.jsonschema.json should be updated.
  • The filejsonschema/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 to diagnose bug origins).
  • The linter repository should have a.gitignore (IDE files, binaries, OS files, etc. should not be committed)
  • A tag should never be recreated.
  • usemain as the default branch name.

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).

The reviews should be addressed as commits (no squash).

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.

@ldezldez added linter: newSupport new linter waiting for: contributor feedbackRequires additional feedback labelsAug 2, 2024
@ldezldez self-requested a reviewAugust 2, 2024 19:04
@Antonboom
Copy link
Contributor

Another yet case foruncalled

#3348

@alexbagnolini

This comment was marked as outdated.

@ldez

This comment was marked as outdated.

@alexbagnolini

This comment was marked as outdated.

@alexbagnolini
Copy link
Author

Can you help me understand this?

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.

The only config available is to enable / disable the sole rule currently implemented.

Should I change the Default to befalse and leave the value totrue, or the opposite?

errgroupcheck:# Check if any sync.errgroup.Group instance is missing a call to the Wait() func.# Default: truerequire-wait:true

@ldez
Copy link
Member

ldez commentedAug 8, 2024

The "# Default:" should be the default value.
The value of the option should not be the default value.

# Default: truerequire-wait:false

@ldezldez changed the titleAdd new lintererrgroupcheckAdd errgroupcheck linterAug 21, 2024
@Crocmagnon
Copy link
Contributor

Does the longer work for errgroups stored as struct attribute?
I have a use case where I’m creating a struct containing an errgroup in a "constructor", starting goroutines in a method of the struct and waiting in a third. What would that look like?

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@ldezldezAwaiting requested review from ldez

Assignees

No one assigned

Labels

linter: newSupport new linterwaiting for: contributor feedbackRequires additional feedback

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@alexbagnolini@CLAassistant@ldez@Antonboom@Crocmagnon

[8]ページ先頭

©2009-2025 Movatter.jp