golang自动格式化导入语句工具插件goimports-reviser的使用

goimports-reviser是一个用于对Golang导入语句进行排序和格式化的工具，它可以按照3-4个分组（标准库、通用库、公司库和项目依赖）来组织导入语句，同时还提供代码格式化功能（不需要单独使用gofmt或goimports）。

主要功能

• 自动排序导入语句到不同分组
• 提供代码格式化功能（通过-format选项）
• 移除未使用的导入（通过-rm-unused选项）
• 为版本化包设置别名（通过-set-alias选项）
• 自定义公司前缀（通过-company-prefixes选项）

安装方法

使用Go安装

go install -v github.com/incu6us/goimports-reviser/v3@latest

使用Brew安装

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

使用Snap安装

snap install goimports-reviser

使用示例

基本用法

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

递归处理目录

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

处理多个目标

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

代码示例

使用前

package testdata

import (
	"log"

	"github.com/incu6us/goimports-reviser/testdata/innderpkg"

	"bytes"

	"golang.org/x/exp/slices"
)

使用后

package testdata

import (
	"bytes"
	"log"

	"golang.org/x/exp/slices"

	"github.com/incu6us/goimports-reviser/testdata/innderpkg"
)

带有注释的导入

package testdata

import (
    "fmt" // comments to the package here
)

格式化代码示例

使用前：

package main
func test(){
}
func additionalTest(){
}

使用后：

package main

func test(){
}

func additionalTest(){
}

配置选项

Usage of goimports-reviser:
  -apply-to-generated-files
    	Apply imports sorting and formatting(if the option is set) to generated files. Generated file is a file with first comment which starts with comment '// Code generated'. Optional parameter.
  -company-prefixes string
    	Company package prefixes which will be placed after 3rd-party group by default(if defined). Values should be comma-separated. Optional parameters.
  -excludes string
    	Exclude files or dirs, example: '.git/,proto/*.go'.
  -file-path string
    	Deprecated. Put file name as an argument(last item) of command line.
  -format
    	Option will perform additional formatting. Optional parameter.
  -imports-order string
    	Your imports groups can be sorted in your way.
    	std - std import group;
    	general - libs for general purpose;
    	company - inter-org or your company libs(if you set '-company-prefixes'-option, then 4th group will be split separately. In other case, it will be the part of general purpose libs);
    	project - your local project dependencies;
    	blanked - imports with "_" alias;
    	dotted - imports with "." alias.
    	Optional parameter. (default "std,general,company,project")
  -list-diff
    	Option will list files whose formatting differs from goimports-reviser. Optional parameter.
  -local string
    	Deprecated
  -output string
    	Can be "file", "write" or "stdout". Whether to write the formatted content back to the file or to stdout. When "write" together with "-list-diff" will list the file name and write back to the file. Optional parameter. (default "file")
  -project-name string
    	Your project name(ex.: github.com/incu6us/goimports-reviser). Optional parameter.
  -recursive
    	Apply rules recursively if target is a directory. In case of ./... execution will be recursively applied by default. Optional parameter.
  -rm-unused
    	Remove unused imports. Optional parameter.
  -separate-named
        Separate named imports from their group with a new line. Optional parameter.
  -set-alias
    	Set alias for versioned package names, like 'github.com/go-pg/pg/v9'. In this case import will be set as 'pg "github.com/go-pg/pg/v9"'. Optional parameter.
  -set-exit-status
    	set the exit status to 1 if a change is needed/made. Optional parameter.
  -use-cache
    	Use cache to improve performance. Optional parameter.
  -version
    	Show version.

在JetBrains IDE中配置