mariocarrion/nit repository overview

⁠nit

nit is an opinionated Code Organization linter for Go.

It defines a collection of rules to determine how each Go file should be organized internally.

⁠Rules

1. imports is the first section
   • Requires parenthesized declaration,
   • One maximum, and
   • Separated in 3 blocks: standard, external and same package (local).
2. type is the second section
   • Requires parenthesized declaration,
   • Section must be sorted: exported first, then unexported; and
   • Supports //- comment for separating groups
3. const is the third section
   • Requires parenthesized declaration,
   • Multiple allowed, and
   • Section must be sorted: exported first, then unexported.
4. var is the fourth section
   • Requires parenthesized declaration, and
   • Section must be sorted: exported first, then unexported.
5. func is the fifth section
   • Must be sorted, exported first, then unexported, and
   • Supports //- comment for separating groups.
6. func method, is the sixth section
   • Must be sorted by type, exported first, then unexported; and
   • Supports //- comment for separating groups.

Fancy State Machine explaining the rules above:

⁠Installing

• Using go (< 11.1): go install github.com/MarioCarrion/nit/cmd/nit or download a precompiled release.
• Using go (>= 1.11): GO111MODULE=on go get github.com/MarioCarrion/nit/cmd/[email protected], for installing v0.6.0 for example; see the releases for other versions.
• Using it as a depency with the tools.go paradigm⁠:

// +build tools

// tools.go content

package tools

import (
	_ "github.com/go-swagger/go-swagger/cmd/swagger"
)

⁠Using

After installing you can use:

nit -pkg <base local package> $(go list ./...)

Please use nit -h for other available arguments.

⁠Development requirements

Go >= 1.13.1