https://github.com/mariocarrion/nit

Opinionated code organization linter for Go projects.
https://github.com/mariocarrion/nit

go golang golang-tools lint linter linting nitpick styleguide

Last synced: over 1 year ago
JSON representation

Opinionated code organization linter for Go projects.

• Host: GitHub
• URL: https://github.com/mariocarrion/nit
• Owner: MarioCarrion
• License: mit
• Archived: true
• Created: 2018-11-30T02:21:40.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-03-27T07:01:02.000Z (about 3 years ago)
• Last Synced: 2025-02-10T16:48:38.903Z (over 1 year ago)
• Topics: go, golang, golang-tools, lint, linter, linting, nitpick, styleguide
• Language: Go
• Homepage:
• Size: 293 KB
• Stars: 21
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# nit

[![Go Report Card](https://goreportcard.com/badge/github.com/MarioCarrion/nit)](https://goreportcard.com/report/github.com/MarioCarrion/nit)

[![Circle CI](https://circleci.com/gh/MarioCarrion/nit.svg?style=svg)](https://circleci.com/gh/MarioCarrion/nit)

[![coverage](https://gocover.io/_badge/github.com/MarioCarrion/nit?0 "coverage")](http://gocover.io/github.com/MarioCarrion/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. [X] `imports` is the first section

   - [X] Requires parenthesized declaration,

   - [X] One maximum, and

   - [X] Separated in 3 blocks: standard, external and same package (local).

1. [X] `type` is the second section

   - [X] Requires parenthesized declaration,

   - [X] Section must be sorted: exported first, then unexported; and

   - [X] Supports `//-` comment for separating groups

1. [X] `const` is the third section

   - [X] Requires parenthesized declaration,

   - [X] Multiple allowed, and

   - [X] Section must be sorted: exported first, then unexported.

1. [X] `var` is the fourth section

   - [X] Requires parenthesized declaration, and

   - [X] Section must be sorted: exported first, then unexported.

1. [X] `func` is the fifth section

   - [X] Must be sorted, exported first, then unexported, and

   - [X] Supports `//-` comment for separating groups.

1. [X] `func` method, is the sixth section

   - [X] Must be sorted by type, exported first, then unexported; and

   - [X] Supports `//-` comment for separating groups.

Fancy State Machine explaining the rules above:

![code](code.png "code organization in file")

## Installing

* Using `go` (>= 1.13): `go get github.com/MarioCarrion/nit/cmd/nit@v0.6.0`, for installing v0.6.0 for example; see the releases for other versions.

* Using it as a dependency with the [`tools.go` paradigm](https://github.com/go-modules-by-example/index/blob/master/010_tools/README.md):

```go

// +build tools

package tools

import (

	_ "github.com/MarioCarrion/nit/cmd/nit"

)

```

## Using

After installing you can use:

```

nit -pkg  $(go list ./...)

```

Please use `nit -h` for other available arguments.

## Development requirements

Go >= 1.14.0