Skip to content

Commit

Permalink
allow non-URL local package names (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
kwo committed Nov 19, 2020
1 parent c177722 commit 4ad3233
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 14 deletions.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ module github.com/daixiang0/gci

go 1.14

require golang.org/x/tools v0.0.0-20200724022722-7017fd6b1305
require golang.org/x/tools v0.0.0-20201118003311-bd56c0adb394
18 changes: 11 additions & 7 deletions go.sum
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/mod v0.3.0 h1:RM4zey1++hCTbCVQfnWeKs9/IEsaBLA8vTkd0WVtmH4=
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20200724022722-7017fd6b1305 h1:yaM5S0KcY0lIoZo7Fl+oi91b/DdlU2zuWpfHrpWbCS0=
golang.org/x/tools v0.0.0-20200724022722-7017fd6b1305/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
golang.org/x/tools v0.0.0-20201118003311-bd56c0adb394 h1:O3VD5Fds21mB1WVRTbkiz/HTXESx6Jql5ucPZi69oiM=
golang.org/x/tools v0.0.0-20201118003311-bd56c0adb394/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
30 changes: 24 additions & 6 deletions pkg/gci/gci.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import (
"path/filepath"
"sort"
"strings"

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

const (
Expand All @@ -30,8 +32,25 @@ import (
importEndFlag = []byte(`
)
`)
standardPackages = make(map[string]struct{})
)

func init() {
pkgs, err := packages.Load(nil, "std")
if err != nil {
panic(err)
}

for _, p := range pkgs {
standardPackages[p.PkgPath] = struct{}{}
}
}

func isStandardPackage(pkg string) bool {
_, ok := standardPackages[pkg]
return ok
}

type FlagSet struct {
LocalFlag string
DoWrite, DoDiff *bool
Expand Down Expand Up @@ -158,17 +177,16 @@ func getPkgInfo(line string, comment bool) (string, string, string) {
}

func getPkgType(line, localFlag string) int {
if !strings.Contains(line, dot) {
return standard
} else if strings.Contains(line, localFlag) {
pkgName := strings.Trim(line, "\"\\`")
if strings.HasPrefix(pkgName, localFlag) {
return local
} else {
return remote
} else if isStandardPackage(pkgName) {
return standard
}
return remote
}

const (
dot = "."
blank = " "
indent = "\t"
linebreak = "\n"
Expand Down
38 changes: 38 additions & 0 deletions pkg/gci/gci_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package gci

import (
"fmt"
"testing"
)

func TestGetPkgType(b *testing.T) {
testCases := []struct {
Line string
LocalFlag string
ExpectedResult int
}{
{Line: `"foo/pkg/bar"`, LocalFlag: "foo", ExpectedResult: local},
{Line: `"github.com/foo/bar"`, LocalFlag: "foo", ExpectedResult: remote},
{Line: `"context"`, LocalFlag: "foo", ExpectedResult: standard},
{Line: `"os/signal"`, LocalFlag: "foo", ExpectedResult: standard},
{Line: `"foo/pkg/bar"`, LocalFlag: "bar", ExpectedResult: remote},
{Line: `"github.com/foo/bar"`, LocalFlag: "bar", ExpectedResult: remote},
{Line: `"context"`, LocalFlag: "bar", ExpectedResult: standard},
{Line: `"os/signal"`, LocalFlag: "bar", ExpectedResult: standard},
{Line: `"foo/pkg/bar"`, LocalFlag: "github.com/foo/bar", ExpectedResult: remote},
{Line: `"github.com/foo/bar"`, LocalFlag: "github.com/foo/bar", ExpectedResult: local},
{Line: `"context"`, LocalFlag: "github.com/foo/bar", ExpectedResult: standard},
{Line: `"os/signal"`, LocalFlag: "github.com/foo/bar", ExpectedResult: standard},
}

for _, _tCase := range testCases {
tCase := _tCase
testFn := func(t *testing.T) {
result := getPkgType(tCase.Line, tCase.LocalFlag)
if got, want := result, tCase.ExpectedResult; got != want {
t.Errorf("bad result: %d, expected: %d", got, want)
}
}
b.Run(fmt.Sprintf("%s:%s", tCase.LocalFlag, tCase.Line), testFn)
}
}

0 comments on commit 4ad3233

Please sign in to comment.