Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/incu6us/goimports-reviser
Right imports sorting & code formatting tool (goimports alternative)
https://github.com/incu6us/goimports-reviser
go gofmt goimports goimports-reviser golang sort-goimports
Last synced: 3 months ago
JSON representation
Right imports sorting & code formatting tool (goimports alternative)
- Host: GitHub
- URL: https://github.com/incu6us/goimports-reviser
- Owner: incu6us
- License: mit
- Created: 2020-04-08T14:49:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-08T14:01:31.000Z (8 months ago)
- Last Synced: 2024-04-16T20:21:57.620Z (7 months ago)
- Topics: go, gofmt, goimports, goimports-reviser, golang, sort-goimports
- Language: Go
- Homepage:
- Size: 2.52 MB
- Stars: 535
- Watchers: 8
- Forks: 69
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go-extra - goimports-reviser - 04-08T14:49:07Z|2022-08-25T07:23:14Z| (Editor Plugins / Routers)
README
---
# goimports-reviser [](https://twitter.com/intent/tweet?text=Right%20golang%20imports%20sorting%20and%20code%20formatting%20tool%20(goimports%20alternative)&url=https://github.com/incu6us/goimports-reviser&hashtags=golang,code,goimports-reviser,goimports,gofmt,developers)
[](https://vshymanskyy.github.io/StandWithUkraine)
[](https://codecov.io/gh/incu6us/goimports-reviser)
[](https://snapcraft.io/goimports-reviser)
[](https://github.com/avelino/awesome-go)
Tool for Golang to sort goimports by 3-4 groups(with own [linter](linter/README.md)): std, general, company(which is optional) and project dependencies.
Also, formatting for your code will be prepared(so, you don't need to use `gofmt` or `goimports` separately).
Use additional options `-rm-unused` to remove unused imports and `-set-alias` to rewrite import aliases for versioned packages or for packages with additional prefix/suffix(example: `opentracing "github.com/opentracing/opentracing-go"`).
`-company-prefixes` - will create group for company imports(libs inside your organization). Values should be comma-separated.
## Configuration:
### Cmd
```bash
goimports-reviser -rm-unused -set-alias -format ./reviser/reviser.go
```
You can also apply rules to a dir or recursively apply using ./... as a target:
```bash
goimports-reviser -rm-unused -set-alias -format -recursive reviser
```
```bash
goimports-reviser -rm-unused -set-alias -format ./...
```
### Example, to configure it with JetBrains IDEs (via file watcher plugin):
### Options:
```text
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.
-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.
```
## Install
### With Go
```bash
go install -v github.com/incu6us/goimports-reviser/v3@latest
```
### With Brew
```bash
brew tap incu6us/homebrew-tap
brew install incu6us/homebrew-tap/goimports-reviser
```
### With Snap
```bash
snap install goimports-reviser
```
## Examples
Before usage:
```go
package testdata
import (
"log"
"github.com/incu6us/goimports-reviser/testdata/innderpkg"
"bytes"
"golang.org/x/exp/slices"
)
```
After usage:
```go
package testdata
import (
"bytes"
"log"
"golang.org/x/exp/slices"
"github.com/incu6us/goimports-reviser/testdata/innderpkg"
)
```
Comments(not Docs) for imports is acceptable. Example:
```go
package testdata
import (
"fmt" // comments to the package here
)
```
### Example with `-company-prefixes`-option
Before usage:
```go
package testdata // goimports-reviser/testdata
import (
"fmt" //fmt package
"golang.org/x/exp/slices" //custom package
"github.com/incu6us/goimports-reviser/pkg" // this is a company package which is not a part of the project, but is a part of your organization
"goimports-reviser/pkg"
)
```
After usage:
```go
package testdata // goimports-reviser/testdata
import (
"fmt" // fmt package
"golang.org/x/exp/slices" // custom package
"github.com/incu6us/goimports-reviser/pkg" // this is a company package which is not a part of the project, but is a part of your organization
"goimports-reviser/pkg"
)
```
### Example with `-imports-order std,general,company,project,blanked,dotted`-option
Before usage:
```go
package testdata // goimports-reviser/testdata
import (
_ "github.com/pkg1"
. "github.com/pkg2"
"fmt" //fmt package
"golang.org/x/exp/slices" //custom package
"github.com/incu6us/goimports-reviser/pkg" // this is a company package which is not a part of the project, but is a part of your organization
"goimports-reviser/pkg"
)
```
After usage:
```go
package testdata // goimports-reviser/testdata
import (
"fmt" // fmt package
"golang.org/x/exp/slices" // custom package
"github.com/incu6us/goimports-reviser/pkg" // this is a company package which is not a part of the project, but is a part of your organization
"goimports-reviser/pkg"
_ "github.com/pkg1"
. "github.com/pkg2"
)
```
### Example with `-format`-option
Before usage:
```go
package main
func test(){
}
func additionalTest(){
}
```
After usage:
```go
package main
func test(){
}
func additionalTest(){
}
```
---
## Give a Star! ⭐
If you like or are using this project, please give it a **star**.
### Stargazers
[](https://starchart.cc/incu6us/goimports-reviser)
