inspect

package
v0.2.4 Latest Latest
Warning

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

Go to latest
Published: May 24, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SchemaVersion     = "vango.inspect.v1.0"
	ArtifactKind      = "vango_inspect"
	DefaultOutputPath = ".vango/vango_inspect.json"
)

Variables

This section is empty.

Functions

func MarshalDeterministic

func MarshalDeterministic(r *Report) ([]byte, error)

func Write

func Write(path string, r *Report) error

Types

type ArtifactEntry

type ArtifactEntry struct {
	Name               string                        `json:"name"`
	Kind               string                        `json:"kind"`
	Path               string                        `json:"path"`
	SchemaVersion      string                        `json:"schema_version"`
	Status             artifact.ArtifactRefStatus    `json:"status"`
	Digest             string                        `json:"digest,omitempty"`
	Required           bool                          `json:"required"`
	ProofLevel         artifact.ProofLevel           `json:"proof_level"`
	DiagnosticCount    int                           `json:"diagnostic_count"`
	ErrorCount         int                           `json:"error_count"`
	WarningCount       int                           `json:"warning_count"`
	OperationReadiness []artifact.OperationReadiness `json:"operation_readiness"`
}

type ArtifactInput

type ArtifactInput struct {
	Name               string
	Kind               string
	Path               string
	SchemaVersion      string
	Status             artifact.ArtifactRefStatus
	Digest             string
	Required           bool
	ProofLevel         artifact.ProofLevel
	Diagnostics        []artifact.Diagnostic
	OperationReadiness []artifact.OperationReadiness
}

type BuildOptions

type BuildOptions struct {
	ProjectRoot  string
	ArtifactRoot string
	OutputPath   string
	Name         string
	Module       string
	AppVersion   string
	ToolVersion  string
	Commit       string
}

type Report

type Report struct {
	SchemaVersion      string                          `json:"schema_version"`
	ArtifactID         string                          `json:"artifact_id"`
	ArtifactKind       string                          `json:"artifact_kind"`
	Producer           artifact.Producer               `json:"producer"`
	App                artifact.App                    `json:"app"`
	Analysis           artifact.Analysis               `json:"analysis"`
	ArtifactRoot       string                          `json:"artifact_root"`
	Artifacts          []ArtifactEntry                 `json:"artifacts"`
	Summary            Summary                         `json:"summary"`
	OperationReadiness []artifact.OperationReadiness   `json:"operation_readiness"`
	Inputs             []artifact.ArtifactRef          `json:"inputs"`
	Outputs            []artifact.ArtifactRef          `json:"outputs"`
	References         map[string]artifact.ArtifactRef `json:"references"`
	Diagnostics        []artifact.Diagnostic           `json:"diagnostics"`
}

func Build

func Build(opts BuildOptions, inputs []ArtifactInput) (*Report, error)

type Summary

type Summary struct {
	ArtifactCount         int `json:"artifact_count"`
	CurrentArtifacts      int `json:"current_artifacts"`
	NotGeneratedArtifacts int `json:"not_generated_artifacts"`
	MissingArtifacts      int `json:"missing_artifacts"`
	StaleArtifacts        int `json:"stale_artifacts"`
	InvalidArtifacts      int `json:"invalid_artifacts"`
	DiagnosticCount       int `json:"diagnostic_count"`
	ErrorCount            int `json:"error_count"`
	WarningCount          int `json:"warning_count"`
	ManualRequiredCount   int `json:"manual_required_count"`
	BlockedCount          int `json:"blocked_count"`
}

type ValidationOptions

type ValidationOptions struct {
	ProjectRoot      string
	RequireArtifacts bool
}

type ValidationResult

type ValidationResult struct {
	Valid       bool                  `json:"valid"`
	Diagnostics []artifact.Diagnostic `json:"diagnostics"`
}

func Validate

func Validate(r *Report, opts ValidationOptions) ValidationResult

Jump to

Keyboard shortcuts

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