goimport

Documentation

Overview

go-import Performs auto import of non go files. Given the directory to be imported go-import will create gokeep.go Go source files and a new self-contained goimport.go Go source file. The gokeep.go file is created in the same package and directory as the cwd package. The goimport.go file is created in the package and directory under directories to be imported, It has helpful defaults designed for use with go generate.

For example, given this snippet,

package painkiller

running this command

go-import /dirs_to_be_force_imported

in the same directory will create the file goimport.go, and in /dirs_to_be_force_imported will create the file gokeep.go

Typically, this process would be run using go generate, like this:

//go:generate go-import

With no arguments, it processes the package in the current directory. Otherwise, the arguments must name a single directory holding a Go package or a set of Go source files that represent a single Go package.

The -tag flag accepts a build tag string.

Code generated for package main by go-bindata DO NOT EDIT. (@generated) sources: tmpl/import.tmpl

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func Main()
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func Usage()
• type Generator
  • func NewGenerator(importPrefix string, globImport string, tag string) *Generator
• type Import
• type ImportTemplateInfo
• type Package
  • func (pkg Package) Package() string

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func Main

func Main()

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

func Usage

func Usage()

Usage is a replacement usage function for the flags package.

Types

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator holds the state of the analysis. Primarily used to buffer the goimportName for format.Source.

func NewGenerator

func NewGenerator(importPrefix string, globImport string, tag string) *Generator

type Import

type Import struct {
	GoImportToolName string
	GoImportToolArgs string
	ModuleName       string
	ImportPaths      []string
	BuildTags        []string
}

type ImportTemplateInfo

type ImportTemplateInfo struct {
	GoImportToolName string
	GoImportToolArgs []string
	ModuleName       string
	ImportPaths      []string
	BuildTag         string
}

type Package

type Package struct {
	// contains filtered or unexported fields
}

Package holds a single parsed package and associated files and ast files.

func (Package) Package

func (pkg Package) Package() string