goimports-reviser

The tool sorts imports into groups. By default, the order is std,general,company,project. You can customize this using the -imports-order and -company-prefixes flags.

Import Groups

• std: Standard library imports.
• general: General purpose third-party libraries.
• company: Inter-org or company-specific libraries (requires -company-prefixes).
• project: Your local project dependencies.
• blanked: Imports using the _ alias.
• dotted: Imports using the . alias.

Customizing Groups

Use -company-prefixes with comma-separated values to define which packages belong to the company group. Use -imports-order to define a custom sequence of the groups listed above.

goimports-reviser -imports-order std,general,company,project,blanked,dotted -company-prefixes github.com/my-org,gitlab.com/my-org

You can install goimports-reviser using Go, Homebrew, or Snap.

### With Go
```bash
go install -v github.com/incu6us/goimports-reviser/v3@latest

With Brew

brew tap incu6us/homebrew-tap
brew install incu6us/homebrew-tap/goimports-reviser

With Snap

snap install goimports-reviser

You can use goimports-reviser as a linter by running it through go vet. This allows you to integrate the import reviser into your standard Go verification workflow. You must point to the specific binary built for your OS and architecture using the -vettool flag.

go vet -vettool=bin/macos-amd64/goimportsreviserlint ./...

You can run the tool on a specific file, a directory, or recursively using the ./... pattern. Common flags include -rm-unused to remove unused imports and -set-alias to handle versioned package aliases.

Basic usage on a single file

goimports-reviser -rm-unused -set-alias -format ./reviser/reviser.go

Recursive usage on a directory

goimports-reviser -rm-unused -set-alias -format -recursive reviser

Recursive usage on the current project

goimports-reviser -rm-unused -set-alias -format ./...

Multiple targets

goimports-reviser -rm-unused -set-alias -format ./reviser/reviser.go ./pkg/...

The -output flag determines how the tool handles the processed content:

• stdout: Prints the formatted content to standard output.
• file: Writes the formatted content back to the original file.
• write: Similar to file, but when used with -list-diff, it will also list the filename in addition to writing the changes back to the file.

The goimports-reviser CLI tool is used to sort and format Go imports according to specific rules. You can provide file paths or directories as arguments. If you provide - as an argument, it reads from stdin.

Basic Usage:

goimports-reviser [options] <file_or_directory>

Common patterns:

• Format a directory recursively: Use -recursive.
• Check for changes without applying them: Use -list-diff to list files that need formatting and -set-exit-status to return exit code 1 if changes are needed.
• Write changes back to files: Use -output write (or -output file) in combination with -list-diff to both list the files and apply the fixes.

goimports-reviser -rm-unused -set-alias -format goimports-reviser/main.go

The -set-alias flag automatically rewrites import aliases for versioned packages (e.g., github.com/go-pg/pg/v9 becomes pg "github.com/go-pg/pg/v9").

// Before
import "github.com/go-pg/pg/v9"

// After using -set-alias
import pg "github.com/go-pg/pg/v9"

The -separate-named flag separates named imports from their group with a new line.

// Before
import (
    "fmt"
    "github.com/incu6us/goimports-reviser/pkg"
    extpkg "google.com/golang/pkg"
    extslice "github.com/PeterRK/slices"
    "golang.org/x/exp/slices"
)

// After using -separate-named
import (
    "fmt"

    "github.com/incu6us/goimports-reviser/pkg"
    "golang.org/x/exp/slices"

    extpkg "google.com/golang/pkg"
    extslice "github.com/PeterRK/slices"
)

You can customize how import groups are sorted using the -imports-order flag. The available groups are:

• std: Standard library imports.
• general: General purpose libraries.
• company: Inter-org or company-specific libraries. If you define -company-prefixes, a 4th group (project) will be split separately. Otherwise, company libs are part of general.
• project: Your local project dependencies.
• blanked: Imports using the _ alias.
• dotted: Imports using the . alias.

To define what constitutes a 'company' package, use the -company-prefixes flag with a comma-separated list of prefixes.

goimports-reviser -company-prefixes github.com/mycompany -imports-order std,general,company,project