component

package

Go to main page

Versions in this module

v0

v0.16.3

Mar 25, 2026

v0.16.2

Mar 25, 2026

v0.16.1

Mar 24, 2026

v0.16.0

Mar 24, 2026

v0.15.0

Mar 24, 2026

v0.14.0

Mar 24, 2026

v0.13.4

Mar 24, 2026

v0.13.3

Mar 24, 2026

v0.13.2

Mar 23, 2026

v0.13.1

Mar 23, 2026

v0.13.0

Mar 22, 2026

v0.12.0

Mar 21, 2026

v0.11.0

Mar 21, 2026

v0.10.3

Mar 20, 2026

v0.10.2

Mar 20, 2026

v0.10.1

Mar 19, 2026

v0.10.0

Mar 18, 2026

Changes in this version

type ComposeDefinitions

+ func (d *ComposeDefinitions) Definition(section, name string) (any, bool)

type ComposeFile

+ func (c *ComposeFile) AddSectionEntryBlock(section, key, block string) error

+ func (c *ComposeFile) SectionEntryBlock(section, key string) (string, bool)

type ComposeProject

+ func (c *ComposeProject) DeleteDefinition(section, name string) bool

+ func (c *ComposeProject) SetDefinition(section, name string, value any)

v0.9.3

Mar 17, 2026

Changes in this version

type ComposeFile

+ func (c *ComposeFile) AddVolumeBlock(name, block string) error

+ func (c *ComposeFile) HasVolume(name string) bool

+ func (c *ComposeFile) VolumeBlock(name string) (string, bool)

v0.9.2

Mar 17, 2026

Changes in this version

type ComposeFile

+ func LoadComposeFileOptional(path string) (*ComposeFile, error)

+ func (c *ComposeFile) AddServiceBlock(name, block string) error

+ func (c *ComposeFile) DeleteServiceKey(service, key string) error

+ func (c *ComposeFile) HasService(name string) bool

+ func (c *ComposeFile) ServiceBlock(name string) (string, bool)

+ func (c *ComposeFile) SetServiceStringList(service, key string, values []string) error

v0.9.1

Mar 17, 2026

v0.9.0

Mar 17, 2026

Changes in this version

type CreateOption

+ AllowedDispositions []Disposition

+ DefaultDisposition Disposition

type Definition

+ AllowedDispositions []Disposition

+ DefaultDisposition Disposition

+ func (d Definition) FollowUpsForDisposition(disposition Disposition) []FollowUpSpec

+ type Disposition string

+ const DispositionDisabled

+ const DispositionDistributed

+ const DispositionEnabled

+ const DispositionSuperseded

+ func LegacyDispositionForState(allowed []Disposition, state State) Disposition

+ func ParseDisposition(value string) (Disposition, error)

+ func PromptDisposition(name string, guidance StateGuidance, allowed []Disposition, ...) (Disposition, error)

+ func ResolveAllowedDisposition(allowed []Disposition, disposition Disposition) (Disposition, error)

+ func ReviewDefaultDisposition(view ReviewView) Disposition

+ func StateToDisposition(state State) Disposition

type FollowUpSpec

+ AppliesToDisposition Disposition

+ type PromptDispositionFunc func(name string, guidance StateGuidance, allowed []Disposition, ...) (Disposition, error)

type ReviewDecision

+ Disposition Disposition

type ReviewOptions

+ PromptDisposition PromptDispositionFunc

type ReviewView

+ Disposition Disposition

type State

+ func DispositionToState(disposition Disposition) State

type StateGuidance

+ DisabledHelp string

+ DistributedHelp string

+ EnabledHelp string

+ SupersededHelp string

v0.8.0

Mar 16, 2026

Changes in this version

+ func PromptCreateFollowUps(cmd *cobra.Command, option CreateOption, decision *ReviewDecision, ...) error

+ func PromptDeclaredReviewFollowUps(view ReviewView, decision *ReviewDecision, input InputFunc, ...) error

+ func PromptFollowUp(componentName string, spec FollowUpSpec, defaultValue string, input InputFunc, ...) (string, error)

+ func RenderConfiguredFollowUps(view ReviewView) []string

+ func RenderDecisionFollowUps(def Definition, decision ReviewDecision) string

+ func RenderFollowUpSection(componentName string, spec FollowUpSpec) string

+ func ResolveCreateDecisions(cmd *cobra.Command, input InputFunc, options ...CreateOption) (map[string]ReviewDecision, error)

type CreateOption

+ FollowUps []FollowUpSpec

type Definition

+ FollowUps []FollowUpSpec

+ func (d Definition) FollowUpsForState(state State) []FollowUpSpec

+ type FollowUpSpec struct

+ AppliesTo State

+ Choices []Choice

+ CustomPrompt string

+ DefaultValue string

+ FlagName string

+ FlagUsage string

+ Label string

+ Name string

+ PromptOnCreate bool

+ Question string

+ type FollowUpValue struct

+ Value string

+ type PromptChoiceFunc func(name string, choices []Choice, defaultValue string, input InputFunc, ...) (string, error)

type ReportRow

+ FollowUps map[string]string

type ReviewOptions

+ PromptChoice PromptChoiceFunc

type ReviewView

+ FollowUpValues map[string]string

v0.7.0

Mar 15, 2026

Changes in this version

+ const ReportFormatJSON

+ const ReportFormatSection

+ const ReportFormatTable

+ const ReportFormatYAML

+ func AddReportFlags(cmd *cobra.Command, verboseTarget *bool, formatTarget *string)

+ func AddReviewFlags(cmd *cobra.Command, reportTarget, verboseTarget *bool, formatTarget *string)

+ func BuildReviewQuestion(view ReviewView) string

+ func DriftCheckLines(view ReviewView) []string

+ func RenderComponentStatus(view ReviewView) string

+ func RenderCurrentGuidance(view ReviewView) string

+ func RenderMigrationImpact(migration DataMigrationRequirement) string

+ func RenderReviewSummary(views []ReviewView, decisions map[string]ReviewDecision, ...) (string, error)

+ func RenderTransitionSummary(behavior TransitionBehavior) string

+ func RunReview(views []ReviewView, opts ReviewOptions) (map[string]ReviewDecision, error)

+ func WriteComponentStatusReport(out io.Writer, views []ReviewView, verbose bool) error

+ func WriteComponentStatusReportWithFormat(out io.Writer, views []ReviewView, verbose bool, format string) error

+ func WriteDriftDetails(out io.Writer, status ComponentStatus)

+ type PromptStateFunc func(name string, guidance StateGuidance, input InputFunc) (State, error)

+ type ReportRow struct

+ CurrentGuidance string

+ DetectedMode string

+ DriftChecks []string

+ DriftDetail string

+ IfDisabled string

+ IfEnabled string

+ Name string

+ State string

+ func BuildComponentStatusRows(views []ReviewView, verbose bool) []ReportRow

+ type ReviewConfirmFunc func(prompt string) (bool, error)

+ type ReviewDecision struct

+ Options map[string]string

+ State State

+ type ReviewMode struct

+ Report bool

+ Verbose bool

+ type ReviewOptions struct

+ Confirm ReviewConfirmFunc

+ Input InputFunc

+ PromptExtra ReviewPromptExtraFunc

+ PromptState PromptStateFunc

+ SummaryLine SummaryLineFunc

+ type ReviewPromptExtraFunc func(view ReviewView, decision *ReviewDecision) error

+ type ReviewView struct

+ Definition Definition

+ Detail string

+ DriftDetail string

+ Extra any

+ Name string

+ SDKStatus *ComponentStatus

+ State DetectedState

type State

+ func ReviewDefaultState(view ReviewView) State

+ type SummaryLineFunc func(view ReviewView, decision ReviewDecision) (string, error)

v0.6.1

Mar 15, 2026

Changes in this version

+ func PromptChoice(name string, choices []Choice, defaultValue string, input InputFunc, ...) (string, error)

+ type Choice struct

+ Aliases []string

+ AllowCustomInput bool

+ Help string

+ Label string

+ Value string

v0.6.0

Mar 14, 2026

Changes in this version

+ func RenderChecklistItem(label, state, detail string) string

+ func RenderCommandBlock(text string) string

v0.5.6

Mar 14, 2026

v0.5.5

Mar 13, 2026

v0.5.4

Mar 13, 2026

Changes in this version

+ func RenderIntroSection(title, body string) string

+ func RenderPromptLine(text string) string

+ func RenderSection(title, body string) string

v0.5.3

Mar 13, 2026

v0.5.2

Mar 13, 2026

Changes in this version

type CreateOption

+ PromptOnCreate bool

type Definition

+ Guidance StateGuidance

+ PromptOnCreate bool

+ func (d Definition) CreateOption() CreateOption

v0.5.1

Mar 13, 2026

Changes in this version

type ComposeFile

+ func (c *ComposeFile) DeleteSectionEntry(section, key string) error

+ func (c *ComposeFile) DeleteService(name string) error

+ func (c *ComposeFile) DeleteServiceEnv(service, key string) error

+ func (c *ComposeFile) DeleteVolume(name string) error

+ func (c *ComposeFile) Save() error

+ func (c *ComposeFile) SetServiceEnv(service, key, value string) error

+ type ComposeProject struct

+ func ParseComposeProject(data []byte) (*ComposeProject, error)

+ func (c *ComposeProject) AddDefinitions(defs *ComposeDefinitions)

+ func (c *ComposeProject) Bytes() ([]byte, error)

+ func (c *ComposeProject) PruneUnusedResources()

+ func (c *ComposeProject) RemoveService(name string) bool

v0.5.0

Mar 13, 2026

Changes in this version

+ const DefaultDrupalRootfs

+ var ErrActionCancelled = errors.New("component action cancelled")

+ func AddCreateFlags(cmd *cobra.Command, options ...CreateOption)

+ func AddDrupalRootfsFlag(cmd *cobra.Command, target *string, defaultValue string)

+ func ParseStateOverrides(values map[string]string) (map[string]State, error)

+ func ResolveCreateStates(cmd *cobra.Command, input InputFunc, options ...CreateOption) (map[string]State, error)

+ type ApplyOptions struct

+ AutoApprove bool

+ Confirm func(prompt string) (bool, error)

+ Yolo bool

+ type Behavior struct

+ Disable TransitionBehavior

+ Enable TransitionBehavior

+ Idempotent bool

+ type Component interface

+ DefaultState func() State

+ Name func() string

+ SpecFor func(state State) ComponentSpec

+ type ComponentSpec struct

+ AfterDisable []Hook

+ AfterEnable []Hook

+ BeforeDisable []Hook

+ BeforeEnable []Hook

+ Compose ComposeSpec

+ Drupal DrupalSpec

+ Gates GateSpec

+ Name string

+ type ComponentStatus struct

+ Name string

+ Off StateCheck

+ On StateCheck

+ State DetectedState

+ func DetectComponentStatus(ctx *config.Context, projectRoot string, def Definition, opts DetectOptions) (ComponentStatus, error)

+ func DetectComponentStatuses(ctx *config.Context, projectRoot string, opts DetectOptions, ...) ([]ComponentStatus, error)

+ type ComposeDefinitions struct

+ Configs map[string]any

+ Networks map[string]any

+ Secrets map[string]any

+ Services map[string]any

+ Volumes map[string]any

+ func ParseComposeDefinitions(data []byte) (*ComposeDefinitions, error)

+ type ComposeFile struct

+ func LoadComposeFile(data []byte) (*ComposeFile, error)

+ func (c *ComposeFile) AddDefinitions(defs *ComposeDefinitions)

+ func (c *ComposeFile) Bytes() ([]byte, error)

+ func (c *ComposeFile) PruneUnusedResources()

+ func (c *ComposeFile) RemoveService(name string) bool

+ type ComposeSpec struct

+ Definitions *ComposeDefinitions

+ PruneUnusedResource bool

+ RemoveServices []string

+ type CreateOption struct

+ Default State

+ Guidance StateGuidance

+ Name string

+ Shorthand string

+ type DataMigrationRequirement string

+ const DataMigrationBackfill

+ const DataMigrationHard

+ const DataMigrationNone

+ type Definition struct

+ Behavior Behavior

+ DefaultState State

+ Dependencies Dependencies

+ Gates GateSpec

+ Name string

+ Off DomainSpec

+ On DomainSpec

+ func (d Definition) ComposerPackagesForEnable() []string

+ func (d Definition) DrupalModulesForEnable() []DrupalModuleDependency

+ func (d Definition) StrictComposerPackages() []string

+ func (d Definition) StrictDrupalModules() []DrupalModuleDependency

+ type DeleteMapEntriesTransform struct

+ Matches []MapEntryMatch

+ func (t DeleteMapEntriesTransform) Apply(set *DrupalConfigSet) error

+ type Dependencies struct

+ DrupalModules []DrupalModuleDependency

+ func (d Dependencies) ComposerPackagesForEnable() []string

+ func (d Dependencies) DrupalModulesForEnable() []DrupalModuleDependency

+ func (d Dependencies) StrictComposerPackages() []string

+ func (d Dependencies) StrictDrupalModules() []DrupalModuleDependency

+ type DetectOptions struct

+ ComposeRoot string

+ DrupalRoot string

+ DrupalRootfs string

+ type DetectedState string

+ const StateDrifted

+ type DomainSpec struct

+ Compose YAMLStateSpec

+ Drupal YAMLStateSpec

+ type DrupalConfigSet struct

+ func LoadDrupalConfigSet(ctx *config.Context, root string) (*DrupalConfigSet, error)

+ func NewDrupalConfigSet(root string, files map[string][]byte) *DrupalConfigSet

+ func (d *DrupalConfigSet) DeleteFiles(names ...string)

+ func (d *DrupalConfigSet) DeleteMapEntries(match MapEntryMatch) error

+ func (d *DrupalConfigSet) ReplaceString(old, new string)

+ func (d *DrupalConfigSet) Save(ctx *config.Context) error

+ func (d *DrupalConfigSet) UpsertFile(name string, data []byte)

+ type DrupalLayout struct

+ Root string

+ func ResolveDrupalLayout(projectRoot, drupalRoot string) DrupalLayout

+ func (l DrupalLayout) ComposerJSONPath() string

+ func (l DrupalLayout) ConfigSyncDir() string

+ type DrupalModuleDependency struct

+ ComposerPackage string

+ Mode DrupalModuleDependencyMode

+ Module string

+ type DrupalModuleDependencyMode string

+ const DrupalModuleDependencyEnableOnly

+ const DrupalModuleDependencyStrict

+ type DrupalSpec struct

+ ConfigSyncDir string

+ DeleteFiles []string

+ DisableTransforms []DrupalTransform

+ EnableTransforms []DrupalTransform

+ Files map[string][]byte

+ type DrupalTransform interface

+ Apply func(*DrupalConfigSet) error

+ type GateSpec struct

+ DisableConfirmation string

+ EnableConfirmation string

+ LocalOnly bool

+ type Hook func(context.Context, *Runtime) error

+ type InputFunc func(question ...string) (string, error)

+ type Manager struct

+ func NewManager(ctx *config.Context) *Manager

+ func (m *Manager) DisableComponent(ctx context.Context, spec ComponentSpec) error

+ func (m *Manager) DisableComponentWithOptions(ctx context.Context, spec ComponentSpec, opts ApplyOptions) error

+ func (m *Manager) EnableComponent(ctx context.Context, spec ComponentSpec) error

+ func (m *Manager) EnableComponentWithOptions(ctx context.Context, spec ComponentSpec, opts ApplyOptions) error

+ func (m *Manager) ReconcileAll(ctx context.Context, states map[string]State, opts ApplyOptions, ...) error

+ func (m *Manager) ReconcileComponent(ctx context.Context, feature Component, state State, opts ApplyOptions) error

+ type MapEntryMatch struct

+ Key string

+ Value string

+ type Registry struct

+ func NewRegistry(features ...Component) *Registry

+ func (r *Registry) Component(name string) (Component, bool)

+ func (r *Registry) Components() []Component

+ func (r *Registry) MustRegister(feature Component)

+ func (r *Registry) Register(feature Component) error

+ type ReplaceStringsTransform struct

+ Replacements []StringReplacement

+ func (t ReplaceStringsTransform) Apply(set *DrupalConfigSet) error

+ type RepoSource struct

+ Path string

+ Ref string

+ Repo string

+ type RuleCheckResult struct

+ Detail string

+ Domain string

+ File string

+ Match bool

+ Op RuleOp

+ Path string

+ type RuleOp string

+ const OpDelete

+ const OpReplace

+ const OpRestore

+ const OpSet

+ type Runtime struct

+ Context *config.Context

+ Docker *docker.DockerClient

+ type State string

+ const StateOff

+ const StateOn

+ func ParseState(value string) (State, error)

+ func PromptState(name string, guidance StateGuidance, input InputFunc) (State, error)

+ type StateCheck struct

+ Failed int

+ Passed int

+ Results []RuleCheckResult

+ State State

+ type StateGuidance struct

+ DefaultState State

+ OffHelp string

+ OnHelp string

+ Question string

+ type StaticComponent struct

+ func NewStaticComponent(name string, defaultState State, on ComponentSpec, off ComponentSpec) StaticComponent

+ func (f StaticComponent) DefaultState() State

+ func (f StaticComponent) Name() string

+ func (f StaticComponent) SpecFor(state State) ComponentSpec

+ type StringReplacement struct

+ New string

+ Old string

+ type TransitionBehavior struct

+ DataMigration DataMigrationRequirement

+ Summary string

+ type YAMLDocument struct

+ func LoadYAMLDocument(data []byte) (*YAMLDocument, error)

+ func (d *YAMLDocument) Bytes() ([]byte, error)

+ func (d *YAMLDocument) DeletePath(path string) error

+ func (d *YAMLDocument) SetString(path, value string) error

+ type YAMLRule struct

+ Exclude []string

+ Files []string

+ Old any

+ Op RuleOp

+ Path string

+ SourceFiles []string

+ Value any

+ type YAMLStateSpec struct

+ Canonical []RepoSource

+ Rules []YAMLRule

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