lint

package

v3.4.1 Latest Latest Go to latest Published: Apr 8, 2024 License: MIT Imports: 31 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

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).

This section is empty.

This section is empty.

This section is empty.

type Comment struct {
	Text   string
	Line   int
	Offset int
	Scope  string
}

Comment represents an in-code comment (line or block).

type ExtendedHTMLWriter struct {
	*org.HTMLWriter
}

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

type Linter struct {
	Manager *check.Manager

	HasDir bool
	// contains filtered or unexported fields
}

A Linter lints a File.

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

NewLinter initializes a Linter.

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

Lint src according to its format.

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

LintString src according to its format.

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.

type Solution struct {
	Suggestions []string `json:"suggestions"`
	Error       string   `json:"error"`
}

Solution is a potential solution to an alert.

func ParseAlert(s string, cfg *core.Config) (Solution, error)

ParseAlert returns a slice of suggestions for the given Vale alert.