Skip to content

dev: format linter descriptions inside help command #5205

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

Merged

Conversation

alexandear
Copy link
Member

@alexandear alexandear commented Dec 8, 2024

This is for consistency with the documentation.

Before:

$ go run ./cmd/golangci-lint/ help linters
Enabled by default linters:
errcheck: errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases [fast: false, auto-fix: false]
gosimple: Linter for Go source code that specializes in simplifying code [fast: false, auto-fix: false]
govet: Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes. [fast: false, auto-fix: false]
ineffassign: Detects when assignments to existing variables are not used [fast: true, auto-fix: false]
staticcheck: It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint. [fast: false, auto-fix: false]
unused: Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false]

Disabled by default linters:
asasalint: check for pass []any as any in variadic func(...any) [fast: false, auto-fix: false]
asciicheck: checks that all code identifiers does not have non-ASCII symbols in the name [fast: true, auto-fix: false]
bidichk: Checks for dangerous unicode character sequences [fast: true, auto-fix: false]
...

After:

$ go run ./cmd/golangci-lint/ help linters
Enabled by default linters:
errcheck: Errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases. [fast: false, auto-fix: false]
gosimple: Linter for Go source code that specializes in simplifying code. [fast: false, auto-fix: false]
govet: Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes. [fast: false, auto-fix: false]
ineffassign: Detects when assignments to existing variables are not used. [fast: true, auto-fix: false]
staticcheck: It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint. [fast: false, auto-fix: false]
unused: Checks Go code for unused constants, variables, functions and types. [fast: false, auto-fix: false]

Disabled by default linters:
asasalint: Check for pass []any as any in variadic func(...any). [fast: false, auto-fix: false]
asciicheck: Checks that all code identifiers does not have non-ASCII symbols in the name. [fast: true, auto-fix: false]
bidichk: Checks for dangerous unicode character sequences. [fast: true, auto-fix: false]
...

@ldez ldez self-requested a review December 8, 2024 21:16
@ldez ldez added the topic: cosmetic changes contain cosmetic improvements label Dec 8, 2024
@alexandear alexandear force-pushed the dev-capitalize-linter-description branch from 3ebb1ce to 4b090e1 Compare December 8, 2024 21:31
@ldez ldez force-pushed the dev-capitalize-linter-description branch from cb55604 to f814f27 Compare December 8, 2024 21:34
@ldez ldez added this to the next milestone Dec 8, 2024
@ldez ldez force-pushed the dev-capitalize-linter-description branch from f814f27 to e56b966 Compare December 8, 2024 21:48
@ldez ldez changed the title dev: capitalize the first word of the linter description dev: format linter descriptions inside the help command Dec 8, 2024
@ldez ldez changed the title dev: format linter descriptions inside the help command dev: format linter descriptions inside help command Dec 8, 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 e955af1 into golangci:master Dec 8, 2024
15 checks passed
@ldez ldez modified the milestones: next, v1.63 Jan 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: cosmetic changes contain cosmetic improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants