gofimports/README.md

1.0 KiB

gofimports

Group Go imports with my opinionated preferences.

First is standard. Then third party, then company if exist. The last is local.

Also main selling point of this is group imports not sort imports. So please run gofumpt or gofmt after this.

Install

With Go version >= 1.16:

go install github.com/haunt98/gofimports/cmd/gofimports@latest

Usage

# Format ./internal
# with print impacted file (-l),
# write to file (-w),
# print diff (-d)
# company is github.com/make-go-great
gofimports -l -company github.com/make-go-great -w -d ./internal

Example result:

import (
	"fmt"

	"github.com/urfave/cli/v2"
	"github.com/pkg/diff"

	"github.com/make-go-great/color-go"

	"github.com/haunt98/gofimports/internal/imports"
)

Roadmap

  • Diff with color
  • Add profiling
  • Improve performance

Thanks