qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-18 16:54:43 -07:00
Code Releases Activity

imports: support repairing import grouping/ordering

Browse Source 
The existing implementation detects import groups and tryies to
sort/regroup only the last one. Ignore existing grouping and
applying the sort function to all imports fix this.

Fixes golang/go#20818

Change-Id: I5db46c6dc8fabd9299b79349880994be5c1b8195
Reviewed-on: https://go-review.googlesource.com/c/116795
Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
This commit is contained in:
Serhii Aheienko 2018-06-06 23:43:48 +03:00 committed by Brad Fitzpatrick
parent 87312bc3ed
commit 12a7c317e8
2 changed files with 174 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

193
imports/fix_test.go
View File

@ -253,7 +253,6 @@ import (
)
`,
},
// Don't remove dot imports.
{
name: "dont_remove_dot_imports",
@ -481,6 +480,7 @@ func main() {
},
// golang.org/issue/7132
// Updated by 20818: repair import grouping
{
name: "issue 7132",
in: `package main
@ -502,7 +502,6 @@ c = fmt.Printf
import (
"fmt"
"gu"
"github.com/foo/bar"
@ -586,6 +585,7 @@ func main() {
// Blank line can be added before all types of import declarations.
// golang.org/issue/7866
// Updated by 20818: repair import grouping
{
name: "issue 7866",
in: `package main
@ -609,15 +609,11 @@ func main() {
import (
"fmt"
renamed_bar "github.com/foo/bar"
"io"
. "github.com/foo/baz"
"strings"
renamed_bar "github.com/foo/bar"
. "github.com/foo/baz"
_ "github.com/foo/qux"
)
@ -1052,6 +1048,157 @@ var _ = fmt.Printf
import "fmt"
var _ = fmt.Printf
`,
},
// Support repairing import grouping/ordering
// golang.org/issue/20818
{
name: "issue 20818",
in: `import (
"testing"
"github.com/Sirupsen/logrus"
"context"
)
func main() {
_, _, _ = testing.T, logrus.Entry, context.Context
}
`,
out: `package main
import (
"context"
"testing"
"github.com/Sirupsen/logrus"
)
func main() {
_, _, _ = testing.T, logrus.Entry, context.Context
}
`,
},
{
name: "issue 20818 more groups",
in: `import (
"testing"
"k8s.io/apimachinery/pkg/api/meta"
"fmt"
"github.com/pkg/errors"
"golang.org/x/tools/cover"
"github.com/sirupsen/logrus"
"context"
)
func main() {
_, _, _, _, _, _ = testing.T, logrus.Entry, context.Context, meta.AnyGroup, fmt.Printf, errors.Frame
}
`,
out: `package main
import (
"context"
"fmt"
"testing"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"k8s.io/apimachinery/pkg/api/meta"
)
func main() {
_, _, _, _, _, _ = testing.T, logrus.Entry, context.Context, meta.AnyGroup, fmt.Printf, errors.Frame
}
`,
},
{
name: "issue 20818 blank lines and single-line comments",
in: `import (
"testing"
"k8s.io/apimachinery/pkg/api/meta"
// a comment for the "fmt" package (#26921: they are broken, should be fixed)
"fmt"
"github.com/pkg/errors" // some comment
"golang.org/x/tools/cover"
"github.com/sirupsen/logrus"
"context"
)
func main() {
_, _, _, _, _, _ = testing.T, logrus.Entry, context.Context, meta.AnyGroup, fmt.Printf, errors.Frame
}
`,
out: `package main
import (
"context"
"fmt"
"testing"
"github.com/pkg/errors" // some comment
"github.com/sirupsen/logrus"
"k8s.io/apimachinery/pkg/api/meta" // a comment for the "fmt" package (#26921: they are broken, should be fixed)
)
func main() {
_, _, _, _, _, _ = testing.T, logrus.Entry, context.Context, meta.AnyGroup, fmt.Printf, errors.Frame
}
`,
},
{
name: "issue 20818 local packages",
in: `import (
"local/foo"
"testing"
"k8s.io/apimachinery/pkg/api/meta"
"fmt"
"github.com/pkg/errors"
"github.com/local/bar"
"golang.org/x/tools/cover"
"github.com/sirupsen/logrus"
"context"
)
func main() {
_, _, _, _, _, _ = testing.T, logrus.Entry, context.Context, meta.AnyGroup, fmt.Printf, errors.Frame
_, _ = foo.Foo, bar.Bar
}
`,
out: `package main
import (
"context"
"fmt"
"testing"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"k8s.io/apimachinery/pkg/api/meta"
"github.com/local/bar"
"local/foo"
)
func main() {
_, _, _, _, _, _ = testing.T, logrus.Entry, context.Context, meta.AnyGroup, fmt.Printf, errors.Frame
_, _ = foo.Foo, bar.Bar
}
`,
},
}
@ -1073,9 +1220,11 @@ func TestFixImports(t *testing.T) {
}
oldFindImport := findImport
oldDirPackageInfo := dirPackageInfo
oldLocalPrefix := LocalPrefix
defer func() {
findImport = oldFindImport
dirPackageInfo = oldDirPackageInfo
LocalPrefix = oldLocalPrefix
}()
findImport = func(_ context.Context, pkgName string, symbols map[string]bool, filename string) (string, bool, error) {
return simplePkgs[pkgName], pkgName == "str", nil
@ -1083,6 +1232,7 @@ func TestFixImports(t *testing.T) {
dirPackageInfo = func(_, _, _ string) (*packageInfo, error) {
return nil, fmt.Errorf("no directory package info in tests")
}
LocalPrefix = "local,github.com/local"
options := &Options{
TabWidth: 8,
@ -1092,18 +1242,19 @@ func TestFixImports(t *testing.T) {
}
for _, tt := range tests {
options.FormatOnly = tt.formatOnly
if *only != "" && tt.name != *only {
continue
}
buf, err := Process(tt.name+".go", []byte(tt.in), options)
if err != nil {
t.Errorf("error on %q: %v", tt.name, err)
continue
}
if got := string(buf); got != tt.out {
t.Errorf("results diff on %q\nGOT:\n%s\nWANT:\n%s\n", tt.name, got, tt.out)
}
t.Run(tt.name, func(t *testing.T) {
options.FormatOnly = tt.formatOnly
if *only != "" && tt.name != *only {
return
}
buf, err := Process(tt.name+".go", []byte(tt.in), options)
if err != nil {
t.Fatalf("error on %q: %v", tt.name, err)
}
if got := string(buf); got != tt.out {
t.Fatalf("results diff on %q\nGOT:\n%s\nWANT:\n%s\n", tt.name, got, tt.out)
}
})
}
}
@ -1291,7 +1442,7 @@ func TestFixModuleVersion(t *testing.T) {
import (
"fmt"
"foo/v2"
"github.com/foo/v2"
)
var (

14
imports/sortimports.go
View File

@ -34,18 +34,8 @@ func sortImports(fset *token.FileSet, f *ast.File) {
continue
}
// Identify and sort runs of specs on successive lines.
i := 0
specs := d.Specs[:0]
for j, s := range d.Specs {
if j > i && fset.Position(s.Pos()).Line > 1+fset.Position(d.Specs[j-1].End()).Line {
// j begins a new run. End this one.
specs = append(specs, sortSpecs(fset, f, d.Specs[i:j])...)
i = j
}
}
specs = append(specs, sortSpecs(fset, f, d.Specs[i:])...)
d.Specs = specs
// Sort and regroup all imports.
sortSpecs(fset, f, d.Specs)
// Deduping can leave a blank line before the rparen; clean that up.
if len(d.Specs) > 0 {