Skip to content

Add ptrequality linter #5870

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

eikemeier
Copy link

@eikemeier eikemeier commented Jun 8, 2025

ptrequality detects comparisons against the address of newly created values, such as ptr == &MyStruct{} or ptr == new(MyStruct).

https://github.com/fillmore-labs/ptrequality

@ldez
Copy link
Member

ldez commented Jun 8, 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.0
  • The linter repository must have a CI and tests.
  • It must use go/analysis.
  • It must have a valid semver tag, ex: v1.0.0, v0.1.0 (0.0.x are not valid).
  • 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 for diagnosing 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 the linter: new Support new linter label Jun 8, 2025
@ldez ldez self-requested a review June 8, 2025 12:41
@ldez ldez added the feedback required Requires additional feedback label Jun 8, 2025
@ldez
Copy link
Member

ldez commented Jun 8, 2025

The same problem exists as in your previous PR: the linter's name is inaccurate.
I recommend changing the name.

@eikemeier
Copy link
Author

The same problem exists as in your previous PR: the linter's name is inaccurate. I recommend changing the name.

Suggest a good name, then. Two hard things, you know…

@ldez
Copy link
Member

ldez commented Jun 8, 2025

cmp is a standard package and also a module, but your linter is not related to those elements.

Your linter is detecting pointers used within equality, so I suggest something like: ptrequality,eqpointer, etc.

@ldez
Copy link
Member

ldez commented Jun 8, 2025

You must rename your module, your analyzer, and your repository.

@eikemeier eikemeier force-pushed the fillmore-labs/cmplint branch from 4291cde to d6be453 Compare June 8, 2025 18:25
ptrequality is a Go linter (static analysis tool) that detects comparisons against
the address of newly created values, such as ptr == &MyStruct{} or ptr == new(MyStruct).

https://github.com/fillmore-labs/ptrequality

Signed-off-by: Oliver Eikemeier <eikemeier@fillmore-labs.com>
@eikemeier eikemeier force-pushed the fillmore-labs/cmplint branch from d6be453 to 1430f05 Compare June 8, 2025 19:12
@eikemeier eikemeier changed the title Add cmplint linter Add ptrequality linter Jun 8, 2025
@ldez
Copy link
Member

ldez commented Jun 8, 2025

This is not what I asked for:

I don't know why you are doing that, but I will not allow this type of wrapper.

If you don't want to rename, say it, but don't try to fool me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feedback required Requires additional feedback linter: new Support new linter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy