diagnostic

package

v0.1.19 Latest Latest Go to latest Published: Jun 8, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sholdee/drydock

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func StableCode(diag Diagnostic) string
type Diagnostic
- func FilterProjectDiagnostics(diags []Diagnostic, mode ProjectDiagnosticsMode) []Diagnostic
- func WithStableCodes(diags []Diagnostic) []Diagnostic
type ProjectDiagnosticClass
- func ClassifyProjectDiagnostic(diag Diagnostic) ProjectDiagnosticClass
type ProjectDiagnosticsMode
- func ParseProjectDiagnosticsMode(value string) (ProjectDiagnosticsMode, error)
- func (mode ProjectDiagnosticsMode) Normalize() ProjectDiagnosticsMode
- func (mode ProjectDiagnosticsMode) Validate() error
type Provenance
type Reporter
- func NewReporter(strict bool) *Reporter
type Severity

Constants ¶

View Source

const (
	CodePluginUnsupported   = "plugin.unsupported"
	CodePluginFailed        = "plugin.failed"
	CodePluginUnspecified   = "plugin.unspecified"
	CodePluginPolicyInvalid = "plugin.policy.invalid"
	CodePluginAutoDiscovery = "plugin.auto-discovery-deferred"
)

View Source

const (
	CodeProjectMissing                   = "project.missing"
	CodeProjectSourceRepositoryDenied    = "project.source-repository-denied"
	CodeProjectDestinationDenied         = "project.destination-denied"
	CodeProjectSourceNamespaceDenied     = "project.source-namespace-denied"
	CodeProjectResourceDenied            = "project.resource-denied"
	CodeProjectResourceDestinationDenied = "project.resource-destination-denied"
	CodeProjectResourceScopeDeferred     = "project.resource-scope-deferred"
	CodeProjectScopedClustersDeferred    = "project.project-scoped-clusters-deferred"
	CodeProjectRBACMetadataOnly          = "project.rbac-metadata-only"
	CodeProjectUnspecified               = "project.unspecified"
	CodeRepositoryMetadataMissing        = "repository.metadata-missing"
	CodeRepositoryProjectMismatch        = "repository.project-mismatch"
	CodeClusterMetadataMissing           = "cluster.metadata-missing"
	CodeClusterProjectMismatch           = "cluster.project-mismatch"
)

Variables ¶

This section is empty.

Functions ¶

func StableCode ¶

func StableCode(diag Diagnostic) string

Types ¶

type Diagnostic ¶

type Diagnostic struct {
	Code       string     `json:"code,omitempty" yaml:"code,omitempty"`
	Severity   Severity   `json:"severity" yaml:"severity"`
	Category   string     `json:"category" yaml:"category"`
	Message    string     `json:"message" yaml:"message"`
	Provenance Provenance `json:"provenance,omitempty" yaml:"provenance,omitempty"`
}

func FilterProjectDiagnostics ¶ added in v0.1.18

func FilterProjectDiagnostics(diags []Diagnostic, mode ProjectDiagnosticsMode) []Diagnostic

func WithStableCodes ¶

func WithStableCodes(diags []Diagnostic) []Diagnostic

type ProjectDiagnosticClass ¶ added in v0.1.18

type ProjectDiagnosticClass string

const (
	ProjectDiagnosticClassNonProject   ProjectDiagnosticClass = "non-project"
	ProjectDiagnosticClassActionable   ProjectDiagnosticClass = "actionable"
	ProjectDiagnosticClassDeferred     ProjectDiagnosticClass = "deferred"
	ProjectDiagnosticClassMetadataOnly ProjectDiagnosticClass = "metadata-only"
	ProjectDiagnosticClassOther        ProjectDiagnosticClass = "other"
)

func ClassifyProjectDiagnostic ¶ added in v0.1.18

func ClassifyProjectDiagnostic(diag Diagnostic) ProjectDiagnosticClass

type ProjectDiagnosticsMode ¶ added in v0.1.18

type ProjectDiagnosticsMode string

const (
	ProjectDiagnosticsModeActionable ProjectDiagnosticsMode = "actionable"
	ProjectDiagnosticsModeAll        ProjectDiagnosticsMode = "all"
	ProjectDiagnosticsModeOff        ProjectDiagnosticsMode = "off"
)

func ParseProjectDiagnosticsMode ¶ added in v0.1.18

func ParseProjectDiagnosticsMode(value string) (ProjectDiagnosticsMode, error)

func (ProjectDiagnosticsMode) Normalize ¶ added in v0.1.18

func (mode ProjectDiagnosticsMode) Normalize() ProjectDiagnosticsMode

func (ProjectDiagnosticsMode) Validate ¶ added in v0.1.18

func (mode ProjectDiagnosticsMode) Validate() error

type Provenance ¶

type Provenance struct {
	Path    string `json:"path,omitempty" yaml:"path,omitempty"`
	Pointer string `json:"pointer,omitempty" yaml:"pointer,omitempty"`
}

type Reporter ¶

type Reporter struct {
	// contains filtered or unexported fields
}

func NewReporter ¶

func NewReporter(strict bool) *Reporter

func (*Reporter) All ¶

func (r *Reporter) All() []Diagnostic

func (*Reporter) Error ¶

func (r *Reporter) Error(category, message string, provenance Provenance)

func (*Reporter) HasErrors ¶

func (r *Reporter) HasErrors() bool

func (*Reporter) Warn ¶

func (r *Reporter) Warn(category, message string, provenance Provenance)

type Severity ¶

type Severity string

const (
	SeverityWarning Severity = "warning"
	SeverityError   Severity = "error"
)

Source Files ¶

View all Source files

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