lint

Documentation

Overview

Package lint implements Vale's syntax-aware linting functionality.

The package is split into core linting logic (this file), source code (code.go), and markup (markup.go).

Index

• type ExtendedHTMLWriter
  • func (w *ExtendedHTMLWriter) WriteComment(n org.Comment)
• type Linter
  • func NewLinter(cfg *core.Config) (*Linter, error)
  • func (l *Linter) Lint(input []string, pat string) ([]*core.File, error)
  • func (l *Linter) LintString(src string) ([]*core.File, error)
  • func (l *Linter) SetMetaScope(scope string)
  • func (l *Linter) Transform(f *core.File) (string, error)

Types

type ExtendedHTMLWriter

type ExtendedHTMLWriter struct {
	*org.HTMLWriter
}

func (*ExtendedHTMLWriter) WriteComment

func (w *ExtendedHTMLWriter) WriteComment(n org.Comment)

type Linter

type Linter struct {
	Manager *check.Manager

	HasDir bool
	// contains filtered or unexported fields
}

A Linter lints a File.

func NewLinter

func NewLinter(cfg *core.Config) (*Linter, error)

NewLinter initializes a Linter.

func (*Linter) Lint

func (l *Linter) Lint(input []string, pat string) ([]*core.File, error)

Lint src according to its format.

func (*Linter) LintString

func (l *Linter) LintString(src string) ([]*core.File, error)

LintString src according to its format.

func (*Linter) SetMetaScope

func (l *Linter) SetMetaScope(scope string)

SetMetaScope sets an optional meta scope.

A meta scope is a string that is appended to the end of each check's scope providing extra context for the check.

func (*Linter) Transform

func (l *Linter) Transform(f *core.File) (string, error)

Transform applies the configured transformations to text and returns the result.

This is used by the `vale` command to apply transformations to text before linting it.

Transformations include block and token ignores, as well as some built-in replacements.