From d0b2463fd70fb603394053338d4eb33cd8b3788a Mon Sep 17 00:00:00 2001 From: Sebastien Rosset Date: Tue, 13 Dec 2022 02:20:39 -0800 Subject: [PATCH] doc: improve documentation for goimport local-prefixes (#3349) --- .golangci.reference.yml | 4 ++-- pkg/golinters/goimports.go | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.golangci.reference.yml b/.golangci.reference.yml index be183411..4e9128df 100644 --- a/.golangci.reference.yml +++ b/.golangci.reference.yml @@ -654,8 +654,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 diff --git a/pkg/golinters/goimports.go b/pkg/golinters/goimports.go index 355fa8aa..97ad6d46 100644 --- a/pkg/golinters/goimports.go +++ b/pkg/golinters/goimports.go @@ -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 imports in autofix mode.", []*analysis.Analyzer{analyzer}, nil, ).WithContextSetter(func(lintCtx *linter.Context) {