KEMBAR78
lib package - github.com/yoheimuta/protolint/lib - Go Packages

lib

package
v0.56.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 25, 2025 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrLintFailure error is returned when there is a linting error
	ErrLintFailure = libinternal.ErrLintFailure
	// ErrInternalFailure error is returned when there is a parsing, internal, or runtime error.
	ErrInternalFailure = libinternal.ErrInternalFailure
)

Functions

func Lint

func Lint(args []string, stdout, stderr io.Writer) error

Lint is used to lint Protocol Buffer files with the protolint tool. It takes an array of strings (args) representing command line arguments, as well as two io.Writer instances (stdout and stderr) to which the output of the command should be written. It returns an error in the case of a linting error (ErrLintFailure) or a parsing, internal, or runtime error (ErrInternalFailure). Otherwise, it returns nil on success.

Note: This function automatically initializes the default lint runner if none is set, so you don't need to call cmd.Initialize() before using it.

func SetLintRunner added in v0.55.0

func SetLintRunner(runner LintRunner)

SetLintRunner sets the runner used by the Lint function

Types

type LintRunner added in v0.55.0

type LintRunner = libinternal.LintRunner

LintRunner is an interface for running lint commands

func GetLintRunner added in v0.55.3

func GetLintRunner() LintRunner

GetLintRunner returns the current lint runner

Jump to

Keyboard shortcuts

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