nit

README

nit

I'm nitpicking your code.

What is this?

A really, really nitpicking linter that complains when the code is not organized according to the following very opinionated rules:

1. imports is the first section
   • Requires parenthesized declaration,
   • One maximum,
   • 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.
3. const is the third section
   • Requires parenthesized declaration,
   • Multiple allowed,
   • Section must be sorted: exported first, then unexported.
4. var is the fourth section
   • Requires parenthesized declaration,
   • Section must be sorted: exported first, then unexported.
5. func is the fifth section
   • Must be sorted, exported first, then unexported.
6. func method, is the sixth section
   • Must be sorted by type, exported first, then unexported.

Development

• Requires dep, you can use retool for installing that dependency.
• goenv is used for versioning Go.

Documentation

Index

• type BreakComments
  • func NewBreakComments(fset *token.FileSet, comments []*ast.CommentGroup) *BreakComments
  • func (c *BreakComments) HasGeneratedCode() bool
  • func (c *BreakComments) MoveTo(line int)
  • func (c *BreakComments) Next() int
• type ConstsValidator
  • func (c *ConstsValidator) Validate(v *ast.GenDecl, fset *token.FileSet) error
• type FileSection
  • func NewFuncDeclFileSection(decl *ast.FuncDecl) (FileSection, error)
  • func NewGenDeclFileSection(decl *ast.GenDecl) (FileSection, error)
• type FileSectionMachine
  • func NewFileSectionMachine(start FileSection) (*FileSectionMachine, error)
  • func (v *FileSectionMachine) Transition(next FileSection) error
• type FileSectionTransition
  • func NewFileSectionTransition(s FileSection) (FileSectionTransition, error)
• type FuncsValidator
  • func NewFuncsValidator(c *BreakComments) *FuncsValidator
  • func (f *FuncsValidator) Validate(v *ast.FuncDecl, fset *token.FileSet) error
• type ImportsSection
  • func NewImportsSection(path, localPathPrefix string) ImportsSection
• type ImportsSectionMachine
  • func NewImportsSectionMachine(start ImportsSection) (*ImportsSectionMachine, error)
  • func (s *ImportsSectionMachine) Current() ImportsTransition
  • func (s *ImportsSectionMachine) Previous() ImportsTransition
  • func (s *ImportsSectionMachine) Transition(next ImportsSection) error
• type ImportsTransition
  • func NewImportsTransition(s ImportsSection) (ImportsTransition, error)
• type ImportsValidator
  • func NewImportsValidator(localPath string) ImportsValidator
  • func (i *ImportsValidator) Validate(v *ast.GenDecl, fset *token.FileSet) error
• type MethodsValidator
  • func NewMethodsValidator(c *BreakComments, t TypesFound) (*MethodsValidator, error)
  • func (m *MethodsValidator) Validate(v *ast.FuncDecl, fset *token.FileSet) error
• type Nitpicker
  • func (v *Nitpicker) Validate(filename string) error
• type TypesFound
• type TypesValidator
  • func NewTypesValidator(c *BreakComments) *TypesValidator
  • func (tv *TypesValidator) Types() []string
  • func (tv *TypesValidator) Validate(v *ast.GenDecl, fset *token.FileSet) error
• type VarsValidator
  • func (c *VarsValidator) Validate(v *ast.GenDecl, fset *token.FileSet) error

Types

type BreakComments

type BreakComments struct {
	// contains filtered or unexported fields
}

BreakComments defines all the found break-like comments in the file.

func NewBreakComments

func NewBreakComments(fset *token.FileSet, comments []*ast.CommentGroup) *BreakComments

NewBreakComments returns all the valid break-like comments.

func (*BreakComments) HasGeneratedCode

func (c *BreakComments) HasGeneratedCode() bool

HasGeneratedCode indicates whether the current file contains a "code generated expression".

func (*BreakComments) MoveTo

func (c *BreakComments) MoveTo(line int)

Moves current line cursor to the received line.

func (*BreakComments) Next

func (c *BreakComments) Next() int

Returns the next break line if any, when no more left it returns -1.

type ConstsValidator

type ConstsValidator struct {
	// contains filtered or unexported fields
}

ConstsValidator defines the type including the rules used for validating the `const` sections.

func (*ConstsValidator) Validate

func (c *ConstsValidator) Validate(v *ast.GenDecl, fset *token.FileSet) error

Validate makes sure the implemented `const` declaration satisfies the following rules: * Group declaration is parenthesized * Declarations are sorted

type FileSection

type FileSection uint8

FileSection represents a code section.

const (
	// FileSectionImports defines the `imports` state.
	FileSectionImports FileSection = iota // FIXME kill

	// FileSectionTypes defines the `type` state.
	FileSectionTypes

	// FileSectionConsts defines the `const` state.
	FileSectionConsts

	// FileSectionVars defines the `var` state.
	FileSectionVars

	// FileSectionFuncs defines the `func` state.
	FileSectionFuncs

	// SectionMethods defines the `method` state.
	FileSectionMethods
)

func NewFuncDeclFileSection

func NewFuncDeclFileSection(decl *ast.FuncDecl) (FileSection, error)

NewFuncDeclFileSection returns a new State that matches the decl type.

func NewGenDeclFileSection

func NewGenDeclFileSection(decl *ast.GenDecl) (FileSection, error)

NewGenDeclFileSection returns a new State that matches the decl type.

type FileSectionMachine

type FileSectionMachine struct {
	// contains filtered or unexported fields
}

FileSectionMachine represents the state machine determining the right order for the sections in file.

func NewFileSectionMachine

func NewFileSectionMachine(start FileSection) (*FileSectionMachine, error)

NewFileSectionTransition returns a new transition corresponding to the received value.

func (*FileSectionMachine) Transition

func (v *FileSectionMachine) Transition(next FileSection) error

Transition updates the internal state.

type FileSectionTransition

type FileSectionTransition interface {
	Imports() (FileSectionTransition, error)
	Types() (FileSectionTransition, error)
	Consts() (FileSectionTransition, error)
	Vars() (FileSectionTransition, error)
	Funcs() (FileSectionTransition, error)
	Methods() (FileSectionTransition, error)
}

FileSectionTransition represents one of the 6 valid sections in the current file, it defines the State Machine transition rules for that concrete section, the order to be expected is:

"Imports" -> "Types" -> "Consts" -> "Vars" -> "Funcs" -> "Methods"

func NewFileSectionTransition

func NewFileSectionTransition(s FileSection) (FileSectionTransition, error)

NewFileSectionTransition returns a new transition corresponding to the received value.

type FuncsValidator

type FuncsValidator struct {
	// contains filtered or unexported fields
}

FuncsValidator defines the type including the rules used for validating functions.

func NewFuncsValidator

func NewFuncsValidator(c *BreakComments) *FuncsValidator

NewFuncsValidator returns a correctly initialized FuncsValidator.

func (*FuncsValidator) Validate

func (f *FuncsValidator) Validate(v *ast.FuncDecl, fset *token.FileSet) error

Validate makes sure the implemented function satisfies the following rules considering all previous declared functions: * Sorted exported functions are declared first, * Sorted unexported functions are declared next, and * Both groups can declare their own sorted subgroups,

type ImportsSection

type ImportsSection uint8

ImportsSection represents one of the 3 valid `imports` sections.

const (
	// ImportsSectionStd represents the Standard Library Packages `imports` section.
	ImportsSectionStd ImportsSection = iota

	// ImportsSectionExternal represents the External Packages `imports` section.
	ImportsSectionExternal

	// ImportsSectionLocal represents the local Packages `imports` section.
	ImportsSectionLocal
)

func NewImportsSection

func NewImportsSection(path, localPathPrefix string) ImportsSection

NewImportsSection returns the value representing the corresponding Imports section.

type ImportsSectionMachine

type ImportsSectionMachine struct {
	// contains filtered or unexported fields
}

ImportsSectionMachine represents the `imports` code organization state machine.

func NewImportsSectionMachine

func NewImportsSectionMachine(start ImportsSection) (*ImportsSectionMachine, error)

NewImportsSectionMachine returns a new ImportsSectionMachine with the initial state as `start`.

func (*ImportsSectionMachine) Current

func (s *ImportsSectionMachine) Current() ImportsTransition

Current returns the current state.

func (*ImportsSectionMachine) Previous

func (s *ImportsSectionMachine) Previous() ImportsTransition

Previous returns the previous state.

func (*ImportsSectionMachine) Transition

func (s *ImportsSectionMachine) Transition(next ImportsSection) error

Transition updates the internal state.

type ImportsTransition

type ImportsTransition interface {
	External() (ImportsTransition, error)
	Local() (ImportsTransition, error)
	Standard() (ImportsTransition, error)
}

ImportsTransition represents one of the 3 valid `imports` sections, it defines the State Machine transition rules for that concrete section, the order to be expected is: "Standard" -> "External" -> "Local".

func NewImportsTransition

func NewImportsTransition(s ImportsSection) (ImportsTransition, error)

NewImportsTransition returns a new transition corresponding to the received value.

type ImportsValidator

type ImportsValidator struct {
	// contains filtered or unexported fields
}

ImportsValidator defines the type including the rules used for validating the `imports` section as a whole.

func NewImportsValidator

func NewImportsValidator(localPath string) ImportsValidator

NewImportsValidator returns a new instalce of ImporstValidator with the local path prefix set.

func (*ImportsValidator) Validate

func (i *ImportsValidator) Validate(v *ast.GenDecl, fset *token.FileSet) error

Validate makes sure the implemented `imports` declaration satisfies the following rules: * Group declaration is parenthesized * Packages are separated by a breaking line like this:

• First standard packages,
• Next external packages, and
• Finally local packages

type MethodsValidator

type MethodsValidator struct {
	// contains filtered or unexported fields
}

MethodsValidator defines the type including the rules used for validating methods.

func NewMethodsValidator

func NewMethodsValidator(c *BreakComments, t TypesFound) (*MethodsValidator, error)

NewMethodsValidator returns a correctly initialized MethodsValidator.

func (*MethodsValidator) Validate

func (m *MethodsValidator) Validate(v *ast.FuncDecl, fset *token.FileSet) error

Validate makes sure the implemented methods satisfies the following rules considering all previous declared methods: * Methods for exported types are declared first, then unexported ones, * Sorted exported methods are declared first, * Sorted unexported methods are declared next, and * Both groups can declare their own sorted subgroups.

type Nitpicker

type Nitpicker struct {
	LocalPath         string
	SkipGeneratedFile bool
	// contains filtered or unexported fields
}

Nitpicker defines the linter.

func (*Nitpicker) Validate

func (v *Nitpicker) Validate(filename string) error

Validate nitpicks the filename.

type TypesFound

type TypesFound interface {
	Types() []string
}

TypesFound defines the type returning the types found in the file.

type TypesValidator

type TypesValidator struct {
	// contains filtered or unexported fields
}

TypesValidator defines the type including the rules used for validating the `type` sections.

func NewTypesValidator

func NewTypesValidator(c *BreakComments) *TypesValidator

NewTypesValidator returns a correctly initialized TypesValidator.

func (*TypesValidator) Types

func (tv *TypesValidator) Types() []string

Types returns the names of all found types.

func (*TypesValidator) Validate

func (tv *TypesValidator) Validate(v *ast.GenDecl, fset *token.FileSet) error

Validate makes sure the implemented `type` declaration satisfies the following rules: * Group declaration is parenthesized * Sorted exported types are declared first, and * Sorted unexported types are declared next

type VarsValidator

type VarsValidator struct {
	// contains filtered or unexported fields
}

VarsValidator defines the type including the rules used for validating the `var` sections.

func (*VarsValidator) Validate

func (c *VarsValidator) Validate(v *ast.GenDecl, fset *token.FileSet) error

Validate makes sure the implemented `var` declaration satisfies the following rules: * Group declaration is parenthesized * Sorted exported vars are declared first, and * Sorted unexported vars are declared next