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 funcorder linter #5630

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Add funcorder linter #5630

wants to merge 22 commits into from

Conversation

manuelarte
Copy link

@manuelarte manuelarte commented Mar 25, 2025

This linter detects that the exported method for a struct are placed before the non-exported methods. It also detects that the NewXYZ functions are placed after the struct declaration and before the struct's methods.
Following the uber style guidelines about function-grouping-and-ordering.

Repository: https://github.com/manuelarte/funcorder

Copy link

boring-cyborg bot commented Mar 25, 2025

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commented Mar 25, 2025

CLA assistant check
All committers have signed the CLA.

@manuelarte
Copy link
Author

manuelarte commented Mar 25, 2025

For some reason, when I try to run:

go run ./cmd/golangci-lint/ run --no-config --default=none --enable=funcorder ./pkg/golinters/funcorder/testdata/funcorder.go

I get the errors that I am expecting, but the // want ... comment is not "working" (even that I have the same testdata in my repo and it's working)/

@ldez
Copy link
Member

ldez commented Mar 25, 2025

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.23
  • 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. (v0.0.x not valid tag)
  • 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 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 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 lintersdb/builder_linter.go and .golangci.next.reference.yml.
  • The load mode (WithLoadMode(...)):
    • if the linter uses goanalysis.LoadModeSyntax -> no WithLoadForGoAnalysis() in lintersdb/builder_linter.go
    • if the linter uses goanalysis.LoadModeTypesInfo, it requires WithLoadForGoAnalysis() in lintersdb/builder_linter.go
  • The version in WithSince(...) must be the next minor version (v2.X.0) of golangci-lint.
  • WithURL() must contain the URL of the repository.

Recommendations

  • The file jsonschema/golangci.next.jsonschema.json should be updated.
  • The file jsonschema/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.
  • use main 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.

@ldez ldez added linter: new Support new linter feedback required Requires additional feedback labels Mar 25, 2025
@ldez ldez self-requested a review March 25, 2025 20:04
@manuelarte

This comment was marked as outdated.

@ldez ldez added feedback required Requires additional feedback and removed feedback required Requires additional feedback labels Mar 26, 2025
@manuelarte

This comment was marked as outdated.

@ldez ldez removed the feedback required Requires additional feedback label Mar 26, 2025
@manuelarte

This comment was marked as off-topic.

@ldez

This comment was marked as outdated.

@manuelarte manuelarte changed the title Add gofuncor linter Add funcorder linter Mar 26, 2025
@manuelarte

This comment was marked as outdated.

@manuelarte

This comment was marked as outdated.

@ldez

This comment was marked as outdated.

@manuelarte

This comment was marked as outdated.

@ldez

This comment was marked as outdated.

@ccoVeille

This comment was marked as outdated.

@manuelarte

This comment was marked as outdated.

@ldez

This comment was marked as outdated.

@ldez ldez added the feedback required Requires additional feedback label Mar 28, 2025
@ldez ldez added feedback required Requires additional feedback and removed feedback required Requires additional feedback labels Mar 28, 2025
@ldez ldez added feedback required Requires additional feedback and removed feedback required Requires additional feedback labels Mar 28, 2025
@manuelarte

This comment has been minimized.

@ldez ldez removed the feedback required Requires additional feedback label Mar 28, 2025
@manuelarte
Copy link
Author

is there something else expected from me? or I just need to wait for this PR to be approved or rejected?

@ldez
Copy link
Member

ldez commented Mar 29, 2025

For now, you just have to wait.

@@ -529,6 +531,14 @@ linters:
# Default: false
analyze-types: true

funcorder:
# Enable/disable feature to check constructors are placed after struct declaration
Copy link
Member

Choose a reason for hiding this comment

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

Please add . at the end for consistency:

Suggested change
# Enable/disable feature to check constructors are placed after struct declaration
# Enable/disable feature to check constructors are placed after struct declaration.

# Enable/disable feature to check constructors are placed after struct declaration
# Default: true
constructor: false
# Enable/disable feature to check whether the exported struct's methods are placed before the non-exported
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# Enable/disable feature to check whether the exported struct's methods are placed before the non-exported
# Enable/disable feature to check whether the exported struct's methods are placed before the non-exported.

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.

5 participants