-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
- Loading branch information
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
// Wrapper around x/tools/imports that only removes imports, never adds new ones. | ||
|
||
package imports | ||
|
||
import ( | ||
"bytes" | ||
"go/ast" | ||
"go/build" | ||
"go/parser" | ||
"go/printer" | ||
"go/token" | ||
"path/filepath" | ||
"strings" | ||
|
||
"golang.org/x/tools/imports" | ||
|
||
"golang.org/x/tools/go/ast/astutil" | ||
) | ||
|
||
type visitFn func(node ast.Node) | ||
|
||
func (fn visitFn) Visit(node ast.Node) ast.Visitor { | ||
fn(node) | ||
return fn | ||
} | ||
|
||
// Prune removes any unused imports | ||
func Prune(filename string, src []byte) ([]byte, error) { | ||
fset := token.NewFileSet() | ||
|
||
file, err := parser.ParseFile(fset, filename, src, parser.ParseComments|parser.AllErrors) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
unused, err := getUnusedImports(file, filename) | ||
if err != nil { | ||
return nil, err | ||
} | ||
for ipath, name := range unused { | ||
astutil.DeleteNamedImport(fset, file, name, ipath) | ||
} | ||
printConfig := &printer.Config{Mode: printer.TabIndent, Tabwidth: 8} | ||
|
||
var buf bytes.Buffer | ||
if err := printConfig.Fprint(&buf, fset, file); err != nil { | ||
return nil, err | ||
} | ||
|
||
return imports.Process(filename, buf.Bytes(), &imports.Options{FormatOnly: true, Comments: true, TabIndent: true, TabWidth: 8}) | ||
} | ||
|
||
func getUnusedImports(file *ast.File, filename string) (map[string]string, error) { | ||
imported := map[string]*ast.ImportSpec{} | ||
used := map[string]bool{} | ||
|
||
abs, err := filepath.Abs(filename) | ||
if err != nil { | ||
return nil, err | ||
} | ||
srcDir := filepath.Dir(abs) | ||
|
||
ast.Walk(visitFn(func(node ast.Node) { | ||
if node == nil { | ||
return | ||
} | ||
switch v := node.(type) { | ||
case *ast.ImportSpec: | ||
if v.Name != nil { | ||
imported[v.Name.Name] = v | ||
break | ||
} | ||
ipath := strings.Trim(v.Path.Value, `"`) | ||
if ipath == "C" { | ||
break | ||
} | ||
|
||
local := importPathToName(ipath, srcDir) | ||
|
||
imported[local] = v | ||
case *ast.SelectorExpr: | ||
xident, ok := v.X.(*ast.Ident) | ||
if !ok { | ||
break | ||
} | ||
if xident.Obj != nil { | ||
// if the parser can resolve it, it's not a package ref | ||
break | ||
} | ||
used[xident.Name] = true | ||
} | ||
}), file) | ||
|
||
for pkg := range used { | ||
delete(imported, pkg) | ||
} | ||
|
||
unusedImport := map[string]string{} | ||
for pkg, is := range imported { | ||
if !used[pkg] && pkg != "_" && pkg != "." { | ||
name := "" | ||
if is.Name != nil { | ||
name = is.Name.Name | ||
} | ||
unusedImport[strings.Trim(is.Path.Value, `"`)] = name | ||
} | ||
} | ||
|
||
return unusedImport, nil | ||
} | ||
|
||
func importPathToName(importPath, srcDir string) (packageName string) { | ||
pkg, err := build.Default.Import(importPath, srcDir, 0) | ||
if err != nil { | ||
return "" | ||
} | ||
|
||
return pkg.Name | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
package imports | ||
|
||
import ( | ||
"io/ioutil" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestPrune(t *testing.T) { | ||
b, err := Prune("testdata/unused.go", mustReadFile("testdata/unused.go")) | ||
require.NoError(t, err) | ||
require.Equal(t, string(mustReadFile("testdata/unused.expected.go")), string(b)) | ||
} | ||
|
||
func mustReadFile(filename string) []byte { | ||
b, err := ioutil.ReadFile(filename) | ||
if err != nil { | ||
panic(err) | ||
} | ||
return b | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
package testdata | ||
|
||
import _ "underscore" | ||
import a "fmt" | ||
import "time" | ||
|
||
type foo struct { | ||
Time time.Time `json:"text"` | ||
} | ||
|
||
func fn() { | ||
a.Println("hello") | ||
} | ||
|
||
type Message struct { | ||
ID string `json:"id"` | ||
Text string `json:"text"` | ||
CreatedBy string `json:"createdBy"` | ||
CreatedAt time.Time `json:"createdAt"` | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
package testdata | ||
|
||
import "unused" | ||
import _ "underscore" | ||
import a "fmt" | ||
import "time" | ||
|
||
type foo struct { | ||
Time time.Time `json:"text"` | ||
} | ||
|
||
func fn() { | ||
a.Println("hello") | ||
} | ||
|
||
type Message struct { | ||
ID string `json:"id"` | ||
Text string `json:"text"` | ||
CreatedBy string `json:"createdBy"` | ||
CreatedAt time.Time `json:"createdAt"` | ||
} |