models

Documentation

Index

• type Config
• type ConfigComponent
• type ConfigComponentDependencies
• type ConfigComponents
• type ConfigDependencies
• type ConfigExclude
• type ConfigOptional
• type ConfigSettings
• type ConfigSettingsImports
• type ConfigSettingsTags
• type ConfigVendor
• type ConfigVendors
• type LintOptions
• type SDKError
  • func NewSDKError(internal error, projectDirectory arch.PathAbsolute) SDKError
  • func (e SDKError) Error() string

Types

type Config

type Config struct {
	SyntaxProblems arch.RefSlice[string]

	Version          arch.Ref[arch.ConfigVersion]
	WorkingDirectory arch.Ref[arch.PathRelative]
	Settings         ConfigSettings
	Exclude          ConfigExclude
	Components       ConfigComponents
	Vendors          ConfigVendors
	CommonComponents arch.RefSlice[arch.ComponentName]
	CommonVendors    arch.RefSlice[arch.VendorName]
	Dependencies     ConfigDependencies
}

type ConfigComponent

type ConfigComponent struct {
	In arch.RefSlice[arch.PathRelativeGlob]
}

type ConfigComponentDependencies

type ConfigComponentDependencies struct {
	MayDependOn    arch.RefSlice[arch.ComponentName]
	CanUse         arch.RefSlice[arch.VendorName]
	AnyVendorDeps  arch.Ref[bool]
	AnyProjectDeps arch.Ref[bool]
	CanContainTags arch.RefSlice[arch.StructTag]
	DeepScan       ConfigOptional[arch.Ref[bool]]
}

type ConfigComponents

type ConfigComponents struct {
	Map arch.RefMap[arch.ComponentName, ConfigComponent]
}

type ConfigDependencies

type ConfigDependencies struct {
	Map arch.RefMap[arch.ComponentName, ConfigComponentDependencies]
}

type ConfigExclude

type ConfigExclude struct {
	RelativeDirectories arch.RefSlice[arch.PathRelative]
	RelativeFiles       arch.RefSlice[arch.PathRelativeRegExp]
}

type ConfigOptional

type ConfigOptional[T any] struct {
	Value   T
	Defined bool
}

type ConfigSettings

type ConfigSettings struct {
	DeepScan arch.Ref[bool]
	Imports  ConfigSettingsImports
	Tags     ConfigSettingsTags
}

type ConfigSettingsImports

type ConfigSettingsImports struct {
	StrictMode            arch.Ref[bool]
	AllowAnyVendorImports arch.Ref[bool]
}

type ConfigSettingsTags

type ConfigSettingsTags struct {
	Allowed     arch.Ref[arch.ConfigSettingsTagsEnum]
	AllowedList arch.RefSlice[arch.StructTag]
}

type ConfigVendor

type ConfigVendor struct {
	In arch.RefSlice[arch.PathImportGlob]
}

type ConfigVendors

type ConfigVendors struct {
	Map arch.RefMap[arch.VendorName, ConfigVendor]
}

type LintOptions

type LintOptions struct {
	// Check go AST syntax? (default: true)
	CheckSyntax bool
}

type SDKError

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

SDKError used for user-friendly error formatting this error will recursive parse wrapped errors for better display

func NewSDKError

func NewSDKError(internal error, projectDirectory arch.PathAbsolute) SDKError

func (SDKError) Error

func (e SDKError) Error() string