provisional

package

v1.6.8 Latest Latest Go to latest Published: Jan 4, 2026 License: Apache-2.0 Imports: 18 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][]spec.Violation, err error)
func ProcessSpecs(cxt context.Context, specs *spec.SpecPullRequest, ...) (violations map[string][]spec.Violation, err error)
type ComparableEntity
type EntityState
- func (es EntityState[T]) Presence() (p Presence)
type Novelty
type Policy
type Presence
type State
- func Check(spec *spec.Specification, entity types.Entity, originalEntity types.Entity) State
- func (s State) String() string

Constants ¶

View Source

const (
	PresenceUnknown        Presence = iota
	PresenceBase                    = 1 << (iota - 1)
	PresenceBaseInProgress          = 1 << (iota - 1)
	PresenceHead                    = 1 << (iota - 1)
	PresenceHeadInProgress          = 1 << (iota - 1)
)

View Source

const (
	NoveltyNone   Novelty = iota
	NoveltyNew            = 1 << (iota - 1)
	NoveltyIfDefd         = 1 << (iota - 1)
)

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, writer files.Writer[string]) (violations map[string][]spec.Violation, err error)

func ProcessSpecs ¶ added in v1.5.56

func ProcessSpecs(cxt context.Context, specs *spec.SpecPullRequest, pipelineOptions pipeline.ProcessingOptions, writer files.Writer[string]) (violations map[string][]spec.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
}

func (EntityState[T]) Presence ¶ added in v1.6.0

func (es EntityState[T]) Presence() (p Presence)

type Novelty ¶ added in v1.6.0

type Novelty uint8

func (Novelty) Has ¶ added in v1.6.0

func (n Novelty) Has(op Novelty) bool

func (Novelty) IsIfDefd ¶ added in v1.6.0

func (n Novelty) IsIfDefd() bool

func (Novelty) IsNew ¶ added in v1.6.0

func (n Novelty) IsNew() bool

type Policy ¶

type Policy string

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

type Presence ¶ added in v1.6.0

type Presence uint8

func (Presence) Has ¶ added in v1.6.0

func (p Presence) Has(op Presence) bool

func (Presence) Novelty ¶ added in v1.6.0

func (p Presence) Novelty() (Novelty, error)

func (Presence) String ¶ added in v1.6.0

func (p Presence) String() 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

Source Files ¶

View all Source files

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