Documentation
¶
Overview ¶
Package format implements the output formats decolint can write lint issues in: one-line-per-issue text, a JSON array, and GitHub Actions workflow command annotations.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GitHubFormat ¶
type GitHubFormat struct{}
GitHubFormat prints one GitHub Actions workflow command (::error/::warning) per issue.
func (GitHubFormat) WriteIssues ¶
WriteIssues writes issues to w as GitHub Actions workflow commands.
type JSONFormat ¶
type JSONFormat struct{}
JSONFormat prints a JSON array of issues.
func (JSONFormat) WriteIssues ¶
WriteIssues writes issues to w as a JSON array. It marshals into an in-memory buffer first so that a failure never leaves partial JSON on w.
type TextFormat ¶
type TextFormat struct{}
TextFormat prints one line per issue, matching linter.Issue.String.
func (TextFormat) WriteIssues ¶
WriteIssues writes issues to w, one line per issue.
Source Files
Click to show internal directories.
Click to hide internal directories.