Skip to content

doc: improve documentation for goimport local-prefixes #3349

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.

Sign up for GitHub

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
merged 15 commits into from
Dec 13, 2022
Merged

doc: improve documentation for goimport local-prefixes #3349

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
d61f629
Add better documentation for goimport local-prefixes
sebastien-rosset Nov 7, 2022
349d563
Merge branch 'master' into importdocimprovement
sebastien-rosset Nov 7, 2022
b13722b
Add better documentation for goimport local-prefixes
sebastien-rosset Nov 7, 2022
4ce3c0e
Merge branch 'importdocimprovement' of github.com:CiscoM31/golangci-l…
sebastien-rosset Nov 7, 2022
e4a50f5
Improve documentation of 'goimports' linter
sebastien-rosset Nov 7, 2022
b6a52e2
Improve documentation of 'goimports' linter
sebastien-rosset Nov 7, 2022
507450d
Improve documentation
sebastien-rosset Nov 7, 2022
7e14c3a
Improve documentation
sebastien-rosset Nov 7, 2022
e0bb080
Merge branch 'master' into importdocimprovement
sebastien-rosset Nov 7, 2022
19204f9
improve documentation
sebastien-rosset Nov 9, 2022
560e0b0
Merge branch 'importdocimprovement' of github.com:CiscoM31/golangci-l…
sebastien-rosset Nov 9, 2022
aa9161d
Merge branch 'master' into importdocimprovement
sebastien-rosset Nov 10, 2022
a5f7046
Merge branch 'master' into importdocimprovement
sebastien-rosset Nov 15, 2022
58e9fcd
Merge branch 'master' into importdocimprovement
sebastien-rosset Dec 1, 2022
eb5f5db
Merge branch 'master' into importdocimprovement
sebastien-rosset Dec 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .golangci.reference.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,8 +650,8 @@ linters-settings:
template-path: /path/to/my/template.tmpl

goimports:
# Put imports beginning with prefix after 3rd-party packages.
# It's a comma-separated list of prefixes.
# A comma-separated list of prefixes, which, if set, checks import paths
# with the given prefixes are grouped after 3rd-party packages.
# Default: ""
local-prefixes: github.com/org/project

Expand Down
3 changes: 2 additions & 1 deletion pkg/golinters/goimports.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ func NewGoimports(settings *config.GoImportsSettings) *goanalysis.Linter {

return goanalysis.NewLinter(
goimportsName,
"In addition to fixing imports, goimports also formats your code in the same style as gofmt.",
"Check import statements are formatted according to the 'goimport' command. "+
"Reformat code when the '--fix' option is specified.",
Copy link
Member

Choose a reason for hiding this comment

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

Did you see there's a column at https://golangci-lint.run/usage/linters/ that tells if the linter has autofix or not (that it will format your code with --fix which is the same)? I'm not sure it's needed twice? Also worth mentioning the flag is not the only way apply fixes.

[]*analysis.Analyzer{analyzer},
nil,
).WithContextSetter(func(lintCtx *linter.Context) {
Expand Down