bug: v0.4.0 changes default ordering

[twmb]

https://github.com/daixiang0/gci/pull/70/files#r917027845

The already-good code changed from standard, default, prefix(github.com/daixiang0/gci) to standard, prefix(github.com/daixiang0/gci), default even though the sections configuration did not change: https://github.com/daixiang0/gci/blob/9349c88f1609b0e71ec5cac5576b1a413ac25869/pkg/gci/internal/testdata/common.cfg.yaml

[daixiang0]

Yes, v0.4.0 introduces breaking changes.

[twmb]

If I'm understanding it correctly, you're saying that it's no longer an option to organize custom imports after default?

My organization previously was:

• stdlib
• default
• org, non-repo
• org, repo

That's my only use case, and the one use case I see consistently across other repos and orgs, and have used for years.

[daixiang0]

Now the imports like:

• standard
• custom
• default

The custom section is for your own org, the reason is based on how far the imports are from your repo. The "standard" is built-in, which should be first. The default section means all 3rd-party imports, should be last.

[Dreamacro]

@daixiang0 I have installed the latest golangci-lint (ed4befe), but the auto-fix result is wrong.

linters-settings:
  gci:
    sections:
      - standard
      - default
      - prefix(myorg)

the order of sections has no effect on the result. it makes the code become

• standard
• prefix(myorg)
• default

I confirmed that the prefix is working because when I commented it out, it was merged into default.

[daixiang0]

The order is not related to your config :(

Please check doc

[ImSingee]

Is there any necessary reason for this breaking change?

[Dreamacro]

It looks like sections is just sorting without an order relationship. So sad, I had to look for some other sort of linter 😢

UPDATE

When I install the pre-master golangci-lint go install github.com/golangci/golangci-lint/cmd/golangci-lint@1d8a15a

The order of sections will be sorted according to the expected results

[daixiang0]

It looks like sections is just sorting without an order relationship. So sad, I had to look for some other sort of linter 😢

UPDATE

When I install the pre-master golangci-lint go install github.com/golangci/golangci-lint/cmd/golangci-lint@1d8a15a

The order of sections will be sorted according to the expected results

There would be a misunderstanding that I never say the section order can be configured, I will update the document to make it clear.

[daixiang0]

The default ordering will be revert as #72 @twmb @ImSingee

Thanks for your input.

[daixiang0]

@Dreamacro please try golangci/golangci-lint@5e18365

[Dreamacro]

@daixiang0 It seems that if the prefix contains uppercase letters, the packets are not aggregated properly.

BTW, It would be nice to be able to sort in the order of sections. Anyway, thanks for your work.

[daixiang0]

@Dreamacro let me confirm it.

[StephenBrown2]

It would be nice to be able to sort in the order of sections.

I would like to second this. This is the main reason I started using gci, as it states in the README:

The desired output format is highly configurable and allows for more custom formatting than goimport does.

I had been using gci under the assumption that I could also control the order of the import blocks with the order of section flags, and had been configuring it as such, exactly how twmb said.

[daixiang0]

For order config support, tracked as #74.

Close it by #72

[twmb]

Thank you @daixiang0,
I didn't realize the order wasn't controllable before because I had always ordered custom last.

[daixiang0]

@Dreamacro not reproduce it, could you provide config and codes?

It seems that if the prefix contains uppercase letters, the packets are not aggregated properly.

[Dreamacro]

@daixiang0 It can be reproduced on my repo: https://github.com/Dreamacro/clash

run go install github.com/golangci/golangci-lint/cmd/golangci-lint@master and add this on .golangci.yaml

issues:
  fix: true

then run make lint and all not standard packages will group into one.

[daixiang0]

@daixiang0 It can be reproduced on my repo: https://github.com/Dreamacro/clash

run go install github.com/golangci/golangci-lint/cmd/golangci-lint@master and add this on .golangci.yaml

issues:
  fix: true

then run make lint and all not standard packages will group into one.

The default section means:

default: All rest import blocks

So it works as your config.

From https://github.com/daixiang0/gci#gci

[Dreamacro]

@daixiang0 Still a bit confused, is this any different from the example in https://github.com/daixiang0/gci#examples?

[Dreamacro]

I tried the example.

• When the package has no uppercase characters

gci write -s standard -s default -s "prefix(github.com/daixiang0/gci)" main.go

package main

import (
	"golang.org/x/tools"

	"fmt"

	"github.com/daixiang0/gci"
)

to

package main

import (
	"fmt"

	"golang.org/x/tools"

	"github.com/daixiang0/gci"
)

• When the package has uppercase characters

gci write -s standard -s default -s "prefix(github.com/Daixiang0/gci)" main.go

package main

import (
	"golang.org/x/tools"

	"fmt"

	"github.com/Daixiang0/gci"
)

to

package main

import (
	"fmt"

	"github.com/Daixiang0/gci"
	"golang.org/x/tools"
)