cqlinters.go

package api

import "fmt"

type CQLinterType string

type CQLinter interface {
	// String should return the human-text-friendly name of this linter
	fmt.Stringer

	Type() CQLinterType

	// DependencyName returns the name of the PyPI package that implements this linter
	DependencyName() string

	// IsConfigured returns true if there is a configuration for this linter in the given project,
	// regardless of whether this is a proper and clean configuration.
	IsConfigured(project Project) bool

	// IsProperlyConfigured returns true if the project is properly configured.
	IsProperlyConfigured(project Project) bool

	// IsInstalled returns true if the linter is installed (e.g. its executable is on PATH),
	// such that Run() can be called without errorring.
	IsInstalled() bool

	// Run runs the linter on the project, collects the issues that it reports and returns them,
	// or an error if that failed.
	Run(project Project) ([]CQLinterResult, error)
}

type CQLinterResult interface {
	fmt.Stringer
}