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). The general flow is as follows:

Lint (files and directories)     LintString (stdin)
            \                   /
             lintFiles         /
                     \        /
                      +      +
+-------------------+ lintFile ------+|lintMarkdown|lintADoc|lintRST
|                    /    |    \       |            |       /
|                   /     |     \      |           /       /
|                  /      |      \     |          +--------
|                 /       |       \    |         /
|                +        +        +   +        +
|               lintCode  lintLines  lintHTML
|               |         |              |
|               |         |              +
|                \        |         lintProse
|                 \       |        /
|                  +      +       +
|                      lintText
|   <= add Alerts{}       |
+-------------------------+

Index

• type Block
  • func NewBlock(ctx, txt, raw, sel string) Block
• type Linter
  • func (l Linter) Lint(input []string, pat string) ([]*core.File, error)
  • func (l Linter) LintString(src string) ([]*core.File, error)

Types

type Block

type Block struct {
	Context string        // parent content - e.g., sentence -> paragraph
	Text    string        // text content
	Raw     string        // text content without any processing
	Scope   core.Selector // section selector
}

A Block represents a section of text.

func NewBlock

func NewBlock(ctx, txt, raw, sel string) Block

NewBlock makes a new Block with prepared text and a Selector.

type Linter

type Linter struct {
	Config       *core.Config   // command-line and config file settings
	CheckManager *check.Manager // loaded checks
}

A Linter lints a File.

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.