Handle newlines in blocks caused by conflict with goimports

[avorima]

Multi-line comments separated with newlines cause conflicts with goimports.

Given:

package proc

import (
	"github.com/a/b"
	"github.com/local/foo"

	// A multi-line comment explaining what this dependency
	// is used for or what it initializes.
	_ "github.com/client/auth"
)

sections:
  - Standard
  - Default
  - Prefix(github.com/local)

The result is:

package proc

import (
	"github.com/a/b"
	// A multi-line comment explaining what this dependency
	// is used for or what it initializes.
	_ "github.com/client/auth"

	"github.com/local/foo"
)

But goimports will format it as:

package proc

import (
	"github.com/a/b"

	// A multi-line comment explaining what this dependency
	// is used for or what it initializes.
	_ "github.com/client/auth"

	"github.com/local/foo"
)

This means that the two cannot be used together, e.g. with golangci-lint.

[daixiang0]

If you want gci work with goimports, you should add Prefix(github.com/a) and Prefix(github.com/client), since they are belonged to the same type but a different way to group.

[avorima]

This only affects 1 file though. Right now I have a few workarounds for this, but having to force this for every file in the project to fix it for 1 is not practical I think.

[daixiang0]

Although there is a conflict, golangci-lint would return a definite result. Also, you can skip use GCI for some files with golangci-lint config.

[avorima]

Yes, that is one workaround. Still, the actual gci invocation has to be adapted to ignore that one file.
It would be great if golangci-lint could apply the fixes from gci like with goimports for example

[daixiang0]

Actually goimports would add an empty line before comments(not only for multi-lines) which break the sections from gci:

"fmt"
// test1
"go/test1"
// test2
"go/test2"

to

"fmt"

// test1
"go/test1"
// test2
"go/test2"

I really do not like this behavior of goimports.

[daixiang0]

A workaround is that put comments after import.

I do not know why goimports does it.

[daixiang0]

Close now since no plan to fix, unless more users require it.

[howardjohn]

This currently is still pretty broken for us. While we can get it working by moving the comment inline ("foo.bar" // my comment), this is not auto-fixed so we end up with much developer pain.

[daixiang0]

@howardjohn I think you can try without goimports, since its import completion is useless in most cases(IDE will do it, checking it in CI is unnecessary, and any import missing will break UT).

[howardjohn]

goimports is a requirement for our use cases

[daixiang0]

@howardjohn I am working on compatible with goimports, also I want to know how you use GCI, single or within golangci-lint？