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 fparams linter#4853

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
artemk1337 wants to merge2 commits intogolangci:master
base:master
Choose a base branch
Loading
fromartemk1337:fparams
Open

Conversation

@artemk1337
Copy link

Description

fparams is a linter tool for Go that checks the formatting of function parameters and return values. The linter ensures that function parameters and return values are either all on one line or each on a new line. This helps maintain consistent and readable code formatting in Go projects.

Link:https://github.com/artemk1337/fparams

Example

Given a function declaration like this:

funcexample(aint,bint,c,dstring) (int,error) {return0,nil}

fparams will suggest changing it to:

funcexample(aint,bint,cstring,dstring,) (int,error,) {return0,nil}

@boring-cyborg
Copy link

Hey, thank you for opening your first Pull Request !

@bombsimon
Copy link
Member

bombsimon commentedJul 1, 2024
edited by ldez
Loading

Same concept aspairedbrackets in#3225

ldez reacted with thumbs up emoji

@ldez
Copy link
Member

ldez commentedJul 1, 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.
  • 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 must use Go <= 1.21

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.

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 labelsJul 1, 2024
@CLAassistant
Copy link

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.

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

Reviewers

No reviews

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.

4 participants

@artemk1337@bombsimon@ldez@CLAassistant

[8]ページ先頭

©2009-2025 Movatter.jp