stackpreset

Documentation

Overview

Code generated by internal/tools/commandcontractgen; DO NOT EDIT.

Index

• func Build(presetID string) (report.Record, error)
• func BuildWithRenderer(presetID string, renderer cliexec.Renderer) (report.Record, error)
• func IDs() []string
• func IsPresetID(value string) bool
• type PlanningHint
  • func AdmitPlanningHint(raw any) (PlanningHint, error)
  • func PlanningHintFor(presetID string) (PlanningHint, bool)
  • func (hint PlanningHint) JSONValue() map[string]any
• type Profile
  • func ProfileFor(presetID string) (Profile, bool)
  • func ProfileForWithRenderer(presetID string, renderer cliexec.Renderer) (Profile, bool)

Functions

func Build

func Build(presetID string) (report.Record, error)

func BuildWithRenderer

func BuildWithRenderer(presetID string, renderer cliexec.Renderer) (report.Record, error)

func IDs

func IDs() []string

func IsPresetID

func IsPresetID(value string) bool

Types

type PlanningHint

type PlanningHint struct {
	PresetID                  string
	PrimaryLanguages          []string
	StarterEnvironmentClasses []string
	StarterWitnessKinds       []string
}

PlanningHint is the compact, child-owned stack projection used by repository-neutral planners. It intentionally omits path suggestions and rendered commands; callers can request the complete preset report when needed.

func AdmitPlanningHint

func AdmitPlanningHint(raw any) (PlanningHint, error)

AdmitPlanningHint validates a serialized planning hint against the preset owner instead of asking a parent command to duplicate its fields.

func PlanningHintFor

func PlanningHintFor(presetID string) (PlanningHint, bool)

PlanningHintFor returns the bounded stack facts that are useful during adoption planning without duplicating the complete preset contract.

func (PlanningHint) JSONValue

func (hint PlanningHint) JSONValue() map[string]any

type Profile

type Profile struct {
	ExpectedFiles             []string
	PrimaryLanguages          []string
	Purpose                   string
	StarterEnvironmentClasses []string
	StarterProofLikePaths     []string
	StarterWitnessKinds       []string
	SuggestedCommands         []string
}

func ProfileFor

func ProfileFor(presetID string) (Profile, bool)

func ProfileForWithRenderer

func ProfileForWithRenderer(presetID string, renderer cliexec.Renderer) (Profile, bool)