lint

package

v1.4.3 Latest Latest Go to latest Published: Jun 21, 2019 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ValeLint/vale

Links

Open Source Insights

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)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 ¶ added in v0.4.0

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

LintString src according to its format.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL