Skip to content

feat: add clickhouselint#6485

Merged
ldez merged 4 commits into
golangci:mainfrom
cyrilou242:main
Apr 18, 2026
Merged

feat: add clickhouselint#6485
ldez merged 4 commits into
golangci:mainfrom
cyrilou242:main

Conversation

@cyrilou242

@cyrilou242 cyrilou242 commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

Hey, we'd like to add the clickhouse-go-linter:
https://github.com/ClickHouse/clickhouse-go-linter

This linter is used internally at ClickHouse Inc and we decided to make it public recently.

The linter detects 2 common implementation mistakes:

  • forgetting to call rows.Err() after calling rows.Next()
  • forgetting to call defer batch.Close() when using Batch

These implementation mistakes are often observed in codebases using the clickhouse-go driver. They result in incomplete data and hard-to-troubleshoot bugs.

Notes:

  1. seen in recommendations:

The linter should be published as a binary (useful to diagnose bug origins).

--> it's not done as of today but will be done eventually.

@CLAassistant

CLAassistant commented Apr 3, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@boring-cyborg

boring-cyborg Bot commented Apr 3, 2026

Copy link
Copy Markdown

Hey, thank you for opening your first Pull Request !

@ldez ldez added the linter: new Support new linter label Apr 3, 2026
@ldez
ldez self-requested a review April 3, 2026 22:26
@ldez

ldez commented Apr 3, 2026

Copy link
Copy Markdown
Member

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.

Base Requirements

These requirements are not declarative; the team will verify them.

  • It must not be a duplicate of another linter or a rule of a linter.
  • It must not have false positives/negatives.

Linter

  • It must have a valid license:
    • AGPL is not allowed
    • The file must start with LICENSE (capitalized)
    • The file must contain the required information by the license, ex: author, year, etc.
  • It must use Go version <= 1.25.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()
    • panic()
    • log.Fatal(), os.Exit(), or similar.
  • It must not modify the AST.
  • 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.

Other 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 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)
  • Use main as the default branch name.

Workflow

  • A tag should never be recreated.
  • The reviews or changes should be addressed as commits (no squash).

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.

@cyrilou242

Copy link
Copy Markdown
Contributor Author

bumped to the new version of the linter that fixes:

  • It must not contain: init()
  • The linter repository should have a readme and linting.

@cyrilou242

Copy link
Copy Markdown
Contributor Author

bumped to the new version of the linter that fixes:

go.sum not matching go.mod

see change, thanks @alexandear

@ldez ldez added this to the unreleased milestone Apr 18, 2026
@ldez ldez changed the title feat: add clickhouse client linter feat: add clickhouselint Apr 18, 2026
@ldez
ldez merged commit 6d1ebeb into golangci:main Apr 18, 2026
18 of 19 checks passed
@ldez ldez modified the milestones: unreleased, v2.12 May 1, 2026
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.

3 participants