linter

Documentation

Overview

Package linter provides functions to check and fix files for trailing whitespaces and blank lines. It offers three main components:

• Manager, which wraps a file and provides a simple interface for opening, closing and reading lines.
• Replacer, which wraps two Manager instances and provides a simple interface for safely replacing a file with another. The intention is that the replacer is used by in-place formatters.
• Linter, which wraps a Manager and a list of checkers and provides a simple interface for linting and fixing

Index

• Variables
• type Checker
• type Linter
  • func NewLinter(name string) *Linter
  • func (l *Linter) Fix(file Writeable) (err error)
  • func (l *Linter) GetIssues() (rows [][]int, errs []error)
  • func (l *Linter) HasCheckers() bool
  • func (l *Linter) HasIssues() bool
  • func (l *Linter) InsertChecker(c Checker)
  • func (l *Linter) Lint(file Readable) (err error)
  • func (l *Linter) Summary() (ok bool)
• type Main
• type ReadStringer
• type ReadWriteSeekerCloser
• type Readable
• type Reader
  • func CreateShadow(name string) (shadow *Reader, err error)
  • func NewReader(name string) (*Reader, error)
  • func (f *Reader) Close() error
  • func (f *Reader) HasLines() bool
  • func (f *Reader) Load(filename ...string) error
  • func (f *Reader) Next() (line string, err error)
  • func (f *Reader) Open() (err error)
  • func (f *Reader) Rename(name string) error
  • func (f *Reader) ReplaceWith(replacement *Reader) (err error)
  • func (f *Reader) Reset() error
  • func (f *Reader) Save() error
  • func (f *Reader) Write(lines ...string) error
• type Writeable
• type Writer
  • func NewWriter(file *Reader) (formatter *Writer, err error)
  • func (f *Writer) Close() (err error)
  • func (f *Writer) Load(filename ...string) (err error)
  • func (f *Writer) Open() (err error)
  • func (f *Writer) Save() error
  • func (f *Writer) Write(line ...string) error

Variables

var ErrNoCheckers = errors.New("no checkers configured")

ErrNoCheckers is returned when no checkers have been configured.

Types

type Checker

type Checker interface {
	Analyze(string, int)
	Finalize()
	Results() ([]int, error)
	Fix(string) string
	Stop() int
}

Checker represents a line analyser.

type Linter

type Linter struct {
	// Name contains the name of file to lint.
	Name string
	// Checkers contains the checkers to be used.
	Checkers []Checker
	// Error contains the error, if any.
	Error error
	// Touched is a flag whether the file has been touched.
	Touched bool
}

Linter represents a file linter.

func NewLinter

func NewLinter(name string) *Linter

NewLinter creates a new linter, with the default checkers.

func (*Linter) Fix

func (l *Linter) Fix(file Writeable) (err error)

Fix fixes the file by removing trailing whitespaces and blank lines.

func (*Linter) GetIssues

func (l *Linter) GetIssues() (rows [][]int, errs []error)

GetIssues returns a list of rows with issues and a list of errors.

func (*Linter) HasCheckers

func (l *Linter) HasCheckers() bool

HasCheckers returns true if the linter has checkers configured.

func (*Linter) HasIssues

func (l *Linter) HasIssues() bool

HasIssues takes a list of errors and returns false if all errors are nil.

func (*Linter) InsertChecker

func (l *Linter) InsertChecker(c Checker)

InsertChecker adds a checker to the list of checkers in use.

func (*Linter) Lint

func (l *Linter) Lint(file Readable) (err error)

Lint checks the file.

func (*Linter) Summary

func (l *Linter) Summary() (ok bool)

Summary prints a summary of the file.

type Main

type Main = *Reader

Main is an alias for Reader, to be used as a base for other types.

type ReadStringer

type ReadStringer interface {
	ReadString(delim byte) (string, error)
}

ReadStringer is a simplified version of bufio.Reader.

type ReadWriteSeekerCloser

type ReadWriteSeekerCloser interface {
	io.ReadWriteSeeker
	io.Closer
}

ReadWriteSeekerCloser is a combination of io.ReadWriteSeeker and io.Closer.

type Readable

type Readable interface {
	Open() error
	Close() error
	HasLines() bool
	Next() (string, error)
	Load(...string) error
}

Readable describes a file that can be read from.

type Reader

type Reader struct {
	// Name is the name of the file to open. Should be a full or relative path.
	Name string
	// contains filtered or unexported fields
}

Reader represents a wrapped management of file handling. Given a name, it can open, close and read lines from the file, until EOF.

func CreateShadow

func CreateShadow(name string) (shadow *Reader, err error)

CreateShadow creates a new shadow file for the given file.

func NewReader

func NewReader(name string) (*Reader, error)

NewReader opens a file for reading (and writing).

func (*Reader) Close

func (f *Reader) Close() error

Close closes the file. Returns nil if the file is already closed.

func (*Reader) HasLines

func (f *Reader) HasLines() bool

HasLines returns true if there are lines available to read.

func (*Reader) Load

func (f *Reader) Load(filename ...string) error

Load opens the file. It allows for reusing the same file manager for a new file. If no filename is provided, it equates to calling Open().

func (*Reader) Next

func (f *Reader) Next() (line string, err error)

Next reads the next line from the file.

func (*Reader) Open

func (f *Reader) Open() (err error)

Open the file for reading. Returns an error if the file doesn't exist.

func (*Reader) Rename

func (f *Reader) Rename(name string) error

Rename renames the file to the given string.

func (*Reader) ReplaceWith

func (f *Reader) ReplaceWith(replacement *Reader) (err error)

ReplaceWith replaces the current file with the given file.

func (*Reader) Reset

func (f *Reader) Reset() error

Reset resets the file to the beginning and assigns a fresh reader.

func (*Reader) Save

func (f *Reader) Save() error

Save simply closes the file, since all writes are done in place.

func (*Reader) Write

func (f *Reader) Write(lines ...string) error

Write writes a line to the file.

type Writeable

type Writeable interface {
	Readable
	Write(...string) error
	Save() error
}

Writeable describes a file that can be written to.

type Writer

type Writer struct {
	Main
	Shadow *Reader
}

Writer enables formatting of a file, by first writing to a temporary file. When the formatting is done, the original file is replaced with the temporary file.

func NewWriter

func NewWriter(file *Reader) (formatter *Writer, err error)

NewWriter creates a new formatter for the given file.

func (*Writer) Close

func (f *Writer) Close() (err error)

Close closes both files.

func (*Writer) Load

func (f *Writer) Load(filename ...string) (err error)

Load loads both files.

func (*Writer) Open

func (f *Writer) Open() (err error)

Open opens both files.

func (*Writer) Save

func (f *Writer) Save() error

Save applies the changes to the original file.

func (*Writer) Write

func (f *Writer) Write(line ...string) error

Write writes a line to the Shadow file.