whitespace

README

Whitespace linter

Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc.

Example code:

package main

import "fmt"

func main() {

	fmt.Println("Hello world")
}

Reults in:

$ whitespace .
main.go:6:unnecessary newline

Installation guide

go get git.ultraware.nl/NiseVoid/whitespace

Gometalinter

You can add whitespace to gometalinter and enable it.

.gometalinter.json:

{
	"Linters": {
		"whitespace": "whitespace:PATH:LINE:MESSAGE"
	},

	"Enable": [
		"whitespace"
	]
}

commandline:

gometalinter --linter "whitespace:whitespace:PATH:LINE:MESSAGE" --enable "whitespace"

Documentation

Index

• type Message
  • func Run(file *ast.File, fset *token.FileSet, settings Settings) []Message
• type MessageType
• type Settings

Types

type Message

type Message struct {
	Pos     token.Position
	Type    MessageType
	Message string
}

Message contains a message

func Run

func Run(file *ast.File, fset *token.FileSet, settings Settings) []Message

Run runs this linter on the provided code

type MessageType

type MessageType uint8

MessageType describes what should happen to fix the warning

const (
	MessageTypeLeading MessageType = iota + 1
	MessageTypeTrailing
	MessageTypeAddAfter
)

List of MessageTypes

type Settings

type Settings struct {
	MultiIf bool
}

Settings contains settings for edge-cases