[Code Health] Standardize & enforce golang import linting - Githubissues

pokt-network / poktroll

The official Shannon upgrade implementation of the Pocket Network Protocol implemented using the Cosmos SDK

MIT License

16 stars 10 forks source link

[Code Health] Standardize & enforce golang import linting #270

Closed Olshansk closed 4 months ago

Olshansk commented 11 months ago

Objective

Standardize & enforce imports across the codebase

Origin Document

This is the result of several discussions from #253:

Screenshot 2023-12-13 at 12 59 38 PM

Goals

Standardize & enforce imports across the codebase
Enforce the same import rules across local development & CI for all users
Make it easy/trivial for any developer to adopt the same import linting rules & practices

Deliverables

[ ] Select the type golang import rules / tool / server we'll be using (e.g. gofmt, goimport, etc...)
[ ] Update the CI to block/enforce the selected styling
[ ] Update make go_imports to use the select tool
[ ] Document (or link to) how developers can configure their development environments to enable the selected tool on their machines (e.g. JetBrains, neovim, vscode, etc...)

Non-goals / Non-deliverables

Document all possible IDE configurations (just the ones you're using)

Creator: @Olshansk Co-Owners: @bryanchriswhite @h5law

h5law commented 11 months ago

Tools that I use that seem to be what we are looking for:

https://pkg.go.dev/github.com/incu6us/goimports-reviser#section-readme

This sorts imports the way we want them to be

https://github.com/yoheimuta/protolint

For protobufs - imports and lints very nicely (considers import order too)

Olshansk commented 11 months ago

@h5law After we merge in #252, let's add a page / section called devtools so all contributors can have the same configs.

bryanchriswhite commented 11 months ago

See https://github.com/pokt-network/poktroll/pull/283#issuecomment-1865796092 (@Olshansk @h5law)