jcchavezs/porto

Tool for adding vanity import to Go code

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

Inclusion/exclusion rules

porto skips autogenerated, internal, third party and vendored files by default. You can customize what files get included using some flags:

• 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 ignore directories (e.g. tooling directories), pass the --skip-dirs flag:

porto --skip-dirs "^tools$" path/to/library

• If you want to include internal folders and directories skipped by default:

porto --include-internal --skip-dirs-use-default=false path/to/library

• If you want to restrict to certain files e.g. doc.go you can use:

porto --restrict-to-files "doc.go$" path/to/library