package imports

import "golang.org/x/tools/internal/imports"

Package imports implements a Go pretty-printer (like package "go/format") that also adds or removes import statements as necessary.

Index ¶

• func ApplyFixes(fixes []*ImportFix, filename string, src []byte, opt *Options) (formatted []byte, err error)
• func Process(filename string, src []byte, opt *Options) (formatted []byte, err error)
• func VendorlessPath(ipath string) string
• type ImportFix
• func FixImports(filename string, src []byte, opt *Options) (fixes []*ImportFix, err error)
• func GetAllCandidates(filename string, opt *Options) (pkgs []ImportFix, err error)
• type ImportFixType
• type ImportInfo
• type ModuleJSON
• type ModuleResolver
• func (r *ModuleResolver) ClearForNewMod()
• func (r *ModuleResolver) ClearForNewScan()
• type Options
• type PackageExport
• func GetPackageExports(pkg, filename string, opt *Options) (exports []PackageExport, err error)
• type ProcessEnv
• func (e *ProcessEnv) GetResolver() Resolver
• type Resolver

Package Files ¶

fix.go imports.go mod.go mod_cache.go sortimports.go zstdlib.go

func ApplyFixes ¶ Uses

func ApplyFixes(fixes []*ImportFix, filename string, src []byte, opt *Options) (formatted []byte, err error)

ApplyFix will apply all of the fixes to the file and format it.

func Process ¶ Uses

func Process(filename string, src []byte, opt *Options) (formatted []byte, err error)

Process implements golang.org/x/tools/imports.Process with explicit context in env.

func VendorlessPath ¶ Uses

func VendorlessPath(ipath string) string

VendorlessPath returns the devendorized version of the import path ipath. For example, VendorlessPath("foo/bar/vendor/a/b") returns "a/b".

type ImportFix ¶ Uses

type ImportFix struct {
    // StmtInfo represents the import statement this fix will add, remove, or change.
    StmtInfo ImportInfo
    // IdentName is the identifier that this fix will add or remove.
    IdentName string
    // FixType is the type of fix this is (AddImport, DeleteImport, SetImportName).
    FixType ImportFixType
}

func FixImports ¶ Uses

func FixImports(filename string, src []byte, opt *Options) (fixes []*ImportFix, err error)

FixImports returns a list of fixes to the imports that, when applied, will leave the imports in the same state as Process.

Note that filename's directory influences which imports can be chosen, so it is important that filename be accurate.

func GetAllCandidates ¶ Uses

func GetAllCandidates(filename string, opt *Options) (pkgs []ImportFix, err error)

GetAllCandidates gets all of the standard library candidate packages to import in sorted order on import path.

type ImportFixType ¶ Uses

type ImportFixType int

const (
    AddImport ImportFixType = iota
    DeleteImport
    SetImportName
)

type ImportInfo ¶ Uses

type ImportInfo struct {
    ImportPath string // import path, e.g. "crypto/rand".
    Name       string // import name, e.g. "crand", or "" if none.
}

An ImportInfo represents a single import statement.

type ModuleJSON ¶ Uses

type ModuleJSON struct {
    Path      string      // module path
    Replace   *ModuleJSON // replaced by this module
    Main      bool        // is this the main module?
    Dir       string      // directory holding files for this module, if any
    GoMod     string      // path to go.mod file for this module, if any
    GoVersion string      // go version used in module
}

type ModuleResolver ¶ Uses

type ModuleResolver struct {
    Initialized   bool
    Main          *ModuleJSON
    ModsByModPath []*ModuleJSON // All modules, ordered by # of path components in module Path...
    ModsByDir     []*ModuleJSON // ...or Dir.
    // contains filtered or unexported fields
}

ModuleResolver implements resolver for modules using the go command as little as feasible.

func (*ModuleResolver) ClearForNewMod ¶ Uses

func (r *ModuleResolver) ClearForNewMod()

func (*ModuleResolver) ClearForNewScan ¶ Uses

func (r *ModuleResolver) ClearForNewScan()

type Options ¶ Uses

type Options struct {
    Env *ProcessEnv // The environment to use. Note: this contains the cached module and filesystem state.

    Fragment  bool // Accept fragment of a source file (no package statement)
    AllErrors bool // Report all errors (not just the first 10 on different lines)

    Comments  bool // Print comments (true if nil *Options provided)
    TabIndent bool // Use tabs for indent (true if nil *Options provided)
    TabWidth  int  // Tab width (8 if nil *Options provided)

    FormatOnly bool // Disable the insertion and deletion of imports
}

Options is golang.org/x/tools/imports.Options with extra internal-only options.

type PackageExport ¶ Uses

type PackageExport struct {
    Fix     *ImportFix
    Exports []string
}

A PackageExport is a package and its exports.

func GetPackageExports ¶ Uses

func GetPackageExports(pkg, filename string, opt *Options) (exports []PackageExport, err error)

GetPackageExports returns all known packages with name pkg and their exports.

type ProcessEnv ¶ Uses

type ProcessEnv struct {
    LocalPrefix string
    Debug       bool

    // If non-empty, these will be used instead of the
    // process-wide values.
    GOPATH, GOROOT, GO111MODULE, GOPROXY, GOFLAGS, GOSUMDB string
    WorkingDir                                             string

    // If true, use go/packages regardless of the environment.
    ForceGoPackages bool

    // Logf is the default logger for the ProcessEnv.
    Logf func(format string, args ...interface{})
    // contains filtered or unexported fields
}

ProcessEnv contains environment variables and settings that affect the use of the go command, the go/build package, etc.

func (*ProcessEnv) GetResolver ¶ Uses

func (e *ProcessEnv) GetResolver() Resolver

type Resolver ¶ Uses

type Resolver interface {
    ClearForNewScan()
    // contains filtered or unexported methods
}

A Resolver does the build-system-specific parts of goimports.