imports

Documentation

Overview

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

Index

• Variables
• func Process(filename string, src []byte, opt *Options) ([]byte, error)
• type Options

Variables

var Debug = false

Debug controls verbose logging.

var LocalPrefix string

LocalPrefix, if set, instructs Process to sort import paths with the given prefix into another group after 3rd-party packages.

Functions

func Process

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

Process formats and adjusts imports for the provided file. If opt is nil the defaults are used.

Note that filename's directory influences which imports can be chosen, so it is important that filename be accurate. To process data “as if” it were in filename, pass the data as a non-nil src.

Types

type Options

type Options struct {
	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)

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

Options specifies options for processing files.