1 // Package imports implements a Go pretty-printer (like package "go/format")
2 // that also adds or removes import statements as necessary.
3 package imports // import "golang.org/x/tools/imports"
9 "golang.org/x/tools/internal/gocommand"
10 intimp "golang.org/x/tools/internal/imports"
13 // Options specifies options for processing files.
15 Fragment bool // Accept fragment of a source file (no package statement)
16 AllErrors bool // Report all errors (not just the first 10 on different lines)
18 Comments bool // Print comments (true if nil *Options provided)
19 TabIndent bool // Use tabs for indent (true if nil *Options provided)
20 TabWidth int // Tab width (8 if nil *Options provided)
22 FormatOnly bool // Disable the insertion and deletion of imports
25 // Debug controls verbose logging.
28 // LocalPrefix is a comma-separated string of import path prefixes, which, if
29 // set, instructs Process to sort the import paths with the given prefixes
30 // into another group after 3rd-party packages.
31 var LocalPrefix string
33 // Process formats and adjusts imports for the provided file.
34 // If opt is nil the defaults are used, and if src is nil the source
35 // is read from the filesystem.
37 // Note that filename's directory influences which imports can be chosen,
38 // so it is important that filename be accurate.
39 // To process data ``as if'' it were in filename, pass the data as a non-nil src.
40 func Process(filename string, src []byte, opt *Options) ([]byte, error) {
43 src, err = ioutil.ReadFile(filename)
49 opt = &Options{Comments: true, TabIndent: true, TabWidth: 8}
51 intopt := &intimp.Options{
52 Env: &intimp.ProcessEnv{
53 GocmdRunner: &gocommand.Runner{},
55 LocalPrefix: LocalPrefix,
56 AllErrors: opt.AllErrors,
57 Comments: opt.Comments,
58 FormatOnly: opt.FormatOnly,
59 Fragment: opt.Fragment,
60 TabIndent: opt.TabIndent,
61 TabWidth: opt.TabWidth,
64 intopt.Env.Logf = log.Printf
66 return intimp.Process(filename, src, intopt)
69 // VendorlessPath returns the devendorized version of the import path ipath.
70 // For example, VendorlessPath("foo/bar/vendor/a/b") returns "a/b".
71 func VendorlessPath(ipath string) string {
72 return intimp.VendorlessPath(ipath)