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 new linter canonicalheader #4672

Merged
merged 1 commit into from Apr 25, 2024
Merged

Conversation

lasiar
Copy link
Contributor

@lasiar lasiar commented Apr 22, 2024

canonicalheader analyzes code and reports or fixes non-canonical header key in net/http.Header, doc.

The linter suggest canonical header:

http.Header{}.Get("Test-Header")

instead of non-canonical header:

http.Header{}.Get("TeSt-HeAdEr")

This change also speeds up the code a little, benchmark from repo:

name             time/op
Canonical-10     29.7ns ± 4%
NonCanonical-10  69.0ns ± 1%

name             alloc/op
Canonical-10      0.00B     
NonCanonical-10   16.0B ± 0%

name             allocs/op
Canonical-10       0.00     
NonCanonical-10    1.00 ± 0%

Now, the linter works only with value net/http.Header (not pointer) and with string literal.


The reason I created this PR:

I tried to add this linter at #4241. But the PR was closed, because duplicate linter (#4241 (comment)).

So this not fully duplicate, SA1008 checks direct write to map.
staticcheck doesn't want to add checks for methods calls dominikh/go-tools#1519 (comment).

@ldez
Copy link
Member

ldez commented Apr 22, 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.

.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 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 lintersdb/builder_linter.go and .golangci.next.reference.yml.
  • The load mode (WithLoadMode(...)):
    • if the linter doesn't use types: goanalysis.LoadModeSyntax
    • goanalysis.LoadModeTypesInfo required WithLoadForGoAnalysis() in the lintersdb/builder_linter.go
  • 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 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 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 ldez added the linter: new Support new linter label Apr 22, 2024
@ldez ldez self-requested a review April 22, 2024 18:45
@ldez ldez added the feedback required Requires additional feedback label Apr 22, 2024
Canonicalheader checks http header via http.CanonicalHeaderKey().
@ldez ldez added enhancement New feature or improvement and removed feedback required Requires additional feedback labels Apr 22, 2024
@lasiar lasiar requested a review from ldez April 22, 2024 19:12
@ldez ldez added this to the next milestone Apr 25, 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 merged commit b2df2f4 into golangci:master Apr 25, 2024
13 checks passed
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

2 participants