provisional

package

v1.5.49 Latest Latest Go to latest Published: Sep 24, 2025 License: Apache-2.0 Imports: 17 Imported by: 0

Details

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

Repository

github.com/project-chip/alchemy

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func IsProvisional(spec *spec.Specification, entity types.Entity) bool
func Pipeline(cxt context.Context, baseRoot string, headRoot string, docPaths []string, ...) (violations map[string][]Violation, err error)
type ComparableEntity
type EntityState
type Policy
type State
- func Check(spec *spec.Specification, entity types.Entity, originalEntity types.Entity) State
- func (s State) String() string
type Violation
type ViolationType
- func (vt ViolationType) Has(o ViolationType) bool
- func (vt ViolationType) String() string

Constants ¶

View Source

const (
	PolicyNone   Policy = "none"
	PolicyLoose         = "loose"
	PolicyStrict        = "strict"
)

Variables ¶

This section is empty.

Functions ¶

func IsProvisional ¶

func IsProvisional(spec *spec.Specification, entity types.Entity) bool

func Pipeline ¶

func Pipeline(cxt context.Context, baseRoot string, headRoot string, docPaths []string, pipelineOptions pipeline.ProcessingOptions, renderOptions []render.Option, writer files.Writer[string]) (violations map[string][]Violation, err error)

Types ¶

type ComparableEntity ¶

type ComparableEntity interface {
	types.Entity
	Equals(types.Entity) bool
}

type EntityState ¶

type EntityState[T types.Entity] struct {
	HeadInProgress T
	Head           T
	BaseInProgress T
	Base           T
}

type Policy ¶

type Policy string

type State ¶

type State uint8

const (
	StateUnknown State = iota
	StateExplicitlyProvisional
	StateAllDataTypeReferencesProvisional
	StateAllDataTypeReferencesNonProvisional
	StateSomeDataTypeReferencesProvisional
	StateAllClustersProvisional
	StateAllClustersNonProvisional
	StateSomeClustersProvisional
	StateUnreferenced
)

func Check ¶

func Check(spec *spec.Specification, entity types.Entity, originalEntity types.Entity) State

func (State) String ¶

func (s State) String() string

type Violation ¶

type Violation struct {
	Type   ViolationType
	Entity types.Entity
	Path   string
	Line   int
}

type ViolationType ¶

type ViolationType uint8

const (
	ViolationTypeNone ViolationType = 0

	ViolationTypeNonProvisional ViolationType = 1 << (iota - 1)
	ViolationTypeNotIfDefd
)

func (ViolationType) Has ¶

func (vt ViolationType) Has(o ViolationType) bool

func (ViolationType) String ¶

func (vt ViolationType) String() string

Source Files ¶

View all Source files

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