Skip to content

gci: improve error message #3777

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 2 commits into from
Apr 21, 2023
Merged

gci: improve error message #3777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bb6834
fix(gci): Custom section ordering, new section flags
deathbots Apr 13, 2023
8a34ffa
Merge branch 'master' into fix/gci-custom-section-order-and-new-flag-…
deathbots Apr 14, 2023
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
9 changes: 7 additions & 2 deletions pkg/golinters/gci.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package golinters

import (
"fmt"
"strings"
"sync"

gcicfg "github.com/daixiang0/gci/pkg/config"
Expand Down Expand Up @@ -145,7 +144,13 @@ func getErrorTextForGci(settings config.GciSettings) string {
}

if len(settings.Sections) > 0 {
text += " -s " + strings.Join(settings.Sections, ",")
for _, section := range settings.Sections {
text += " -s " + section
}
}

if settings.CustomOrder {
text += " --custom-order"
}

return text
Expand Down
3 changes: 2 additions & 1 deletion test/testdata/configs/gci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ linters-settings:
gci:
sections:
- standard
- prefix(github.com/golangci/golangci-lint)
- prefix(github.com/golangci/golangci-lint,github.com/daixiang0/gci)
- default
custom-order: true
4 changes: 4 additions & 0 deletions test/testdata/fix/in/gci.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,15 @@ package gci
import (
"github.com/golangci/golangci-lint/pkg/config"
"golang.org/x/tools/go/analysis"

"fmt"

gcicfg "github.com/daixiang0/gci/pkg/config"
)

func GoimportsLocalTest() {
fmt.Print("x")
_ = config.Config{}
_ = analysis.Analyzer{}
_ = gcicfg.BoolConfig{}
}
6 changes: 4 additions & 2 deletions test/testdata/fix/out/gci.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ package gci
import (
"fmt"

"golang.org/x/tools/go/analysis"

gcicfg "github.com/daixiang0/gci/pkg/config"
"github.com/golangci/golangci-lint/pkg/config"

"golang.org/x/tools/go/analysis"
)

func GoimportsLocalTest() {
fmt.Print("x")
_ = config.Config{}
_ = analysis.Analyzer{}
_ = gcicfg.BoolConfig{}
}
11 changes: 6 additions & 5 deletions test/testdata/gci.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
package testdata

import (
"golang.org/x/tools/go/analysis" // want "File is not \\`gci\\`-ed with --skip-generated -s standard -s prefix\\(github.com/golangci/golangci-lint,github.com/daixiang0/gci\\) -s default --custom-order"
"github.com/golangci/golangci-lint/pkg/config"
"fmt"

"github.com/golangci/golangci-lint/pkg/config" // want "File is not \\`gci\\`-ed with --skip-generated -s standard,prefix\\(github.com/golangci/golangci-lint\\),default"

"golang.org/x/tools/go/analysis" // want "File is not \\`gci\\`-ed with --skip-generated -s standard,prefix\\(github.com/golangci/golangci-lint\\),default"
"errors"
gcicfg "github.com/daixiang0/gci/pkg/config" // want "File is not \\`gci\\`-ed with --skip-generated -s standard -s prefix\\(github.com/golangci/golangci-lint,github.com/daixiang0/gci\\) -s default --custom-order"
)

func GoimportsLocalTest() {
fmt.Print("x")
fmt.Print(errors.New("x"))
_ = config.Config{}
_ = analysis.Analyzer{}
_ = gcicfg.BoolConfig{}
}