speca

Documentation

Index

• func NewEmptyReference() models.Reference
• func NewReference(file string, line int, offset int) models.Reference
• type Allow
• type Component
• type Integrity
• type Notice
• type Referable
  • func NewEmptyReferable[T any](value T) Referable[T]
  • func NewReferable[T any](value T, ref models.Reference) Referable[T]
  • func (s Referable[T]) Reference() models.Reference
  • func (s Referable[T]) Value() T
• type Spec
• type SpecialFlags

Functions

func NewEmptyReference

func NewEmptyReference() models.Reference

func NewReference

func NewReference(file string, line int, offset int) models.Reference

Types

type Allow

type Allow struct {
	DepOnAnyVendor Referable[bool]
	DeepScan       Referable[bool]
}

type Component

type Component struct {
	Name                  Referable[string]
	DeepScan              Referable[bool]
	ResolvedPaths         []Referable[models.ResolvedPath]
	AllowedProjectImports []Referable[models.ResolvedPath]
	AllowedVendorGlobs    []Referable[models.Glob]
	MayDependOn           []Referable[string]
	CanUse                []Referable[string]
	SpecialFlags          SpecialFlags
}

type Integrity

type Integrity struct {
	DocumentNotices []Notice
	Suggestions     []Notice
}

type Notice

type Notice struct {
	Notice error
	Ref    models.Reference
}

type Referable

type Referable[T any] struct {
	// contains filtered or unexported fields
}

func NewEmptyReferable

func NewEmptyReferable[T any](value T) Referable[T]

func NewReferable

func NewReferable[T any](value T, ref models.Reference) Referable[T]

func (Referable[T]) Reference

func (s Referable[T]) Reference() models.Reference

func (Referable[T]) Value

func (s Referable[T]) Value() T

type Spec

type Spec struct {
	RootDirectory       Referable[string]
	WorkingDirectory    Referable[string]
	ModuleName          Referable[string]
	Allow               Allow
	Components          []Component
	Exclude             []Referable[models.ResolvedPath]
	ExcludeFilesMatcher []Referable[*regexp.Regexp]
	Integrity           Integrity
}

type SpecialFlags

type SpecialFlags struct {
	AllowAllProjectDeps Referable[bool]
	AllowAllVendorDeps  Referable[bool]
}