porto

README

Porto

Tool for adding vanity imports URI to Go files.

e.g. package zipkin -> package zipkin // import "github.com/openzipkin/zipkin-go"

Install

go install github.com/jcchavezs/porto/cmd/porto

Getting started

Run the tool and display the changes without applying them

porto path/to/library

If you want the changes to be applied to the files directly, run:

porto -w path/to/library

If you just want to list the files that porto would change vanity import, run:

porto -l path/to/library

If you want to ignore files (e.g. proto generated files), pass the --skip-files flag:

porto --skip-files ".*\\.pb\\.go$" path/to/library

If you want to include internal folders too

porto --include-internal path/to/library

Documentation

Index

• func FindAndAddVanityImportForDir(workingDir, absDir string, opts Options) (int, error)
• type Options

Functions

func FindAndAddVanityImportForDir

func FindAndAddVanityImportForDir(workingDir, absDir string, opts Options) (int, error)

FindAndAddVanityImportForDir scans all files in a folder and based on go.mod files encountered decides wether add a vanity import or not.

Types

type Options

type Options struct {
	// writes result to file directly
	WriteResultToFile bool
	// List files to be changed
	ListDiffFiles bool
	// Set of regex for matching files to be skipped
	SkipFilesRegexes []*regexp.Regexp
	// Include internal packages
	IncludeInternal bool
}

Options represents the options for adding vanity import.