generator

package

Go to main page

Versions in this module

v0

v0.42.0

Sep 15, 2026

Changes in this version

+ var ErrChatProvidersRequired = errors.NewSentinel("gtb.generator.chat_providers_required", ...)

+ var ErrUnknownChatProvider = errors.NewSentinel("gtb.generator.unknown_chat_provider", ...)

+ func DefaultChatProviders() []string

+ func KnownChatProviders() []string

+ func ValidateChatProviders(providers []string, features []ManifestFeature) error

+ type ManifestChat struct

+ Providers []string

type ManifestProperties

+ Chat ManifestChat

type SkeletonConfig

+ Chat ManifestChat

v0.41.2

Sep 15, 2026

v0.41.1

Sep 15, 2026

v0.41.0

Sep 14, 2026

Changes in this version

+ const CICDComponentVersion

+ const DefaultCICDComponentSource

+ const DefaultDirMode

+ const DefaultFileMode

+ const DocsLayoutDiataxis

+ const DocsLayoutFlat

+ const KeychainFeature

+ const SkipLintEnv

+ var BreakingChanges = map[string]string

+ var DefaultSelectedFeatures = defaultSelectedFromCatalogue()

+ var ErrCommandProtected = errors.NewSentinel("gtb.generator.command_protected", "command is protected")

+ var ErrFuncNotFound = errors.NewSentinel("gtb.generator.func_not_found", "target function not found")

+ var ErrInvalidInput = errors.NewSentinel("gtb.generator.invalid_input", "invalid generator input")

+ var ErrInvalidPackageName = errors.NewSentinel("gtb.generator.invalid_package_name", "invalid package name")

+ var ErrModuleNotFound = errors.NewSentinel("gtb.generator.module_not_found", "could not find module name in go.mod")

+ var ErrNoFrontmatter = errors.NewSentinel("gtb.generator.no_frontmatter", ...)

+ var ErrNotGoToolBaseProject = errors.NewSentinel("gtb.generator.not_go_tool_base_project", ...)

+ var ErrParentCommandFileNotFound = errors.NewSentinel("gtb.generator.parent_command_file_not_found", "parent command file not found")

+ var ErrParentPathNotFound = errors.NewSentinel("gtb.generator.parent_path_not_found", "parent path not found in manifest")

+ var SelectableFeatures = append(slices.Clone(ToggleableFeatures), KeychainFeature)

+ var ToggleableFeatures = featureNamesFromCatalogue()

+ func AppendIgnorePattern(fs afero.Fs, projectPath, pattern string) (changed bool, err error)

+ func EncodeManifestFile(fs afero.Fs, manifestPath string, m *Manifest) error

+ func ManifestPathFor(projectPath string) string

+ func PascalCase(s string) string

+ func PreviewAppendIgnorePatterns(fs afero.Fs, projectPath string, patterns []string) (content string, err error)

+ func PreviewRemoveIgnorePattern(fs afero.Fs, projectPath, pattern string) (content string, changed bool, err error)

+ func RemoveIgnorePattern(fs afero.Fs, projectPath, pattern string) (changed bool, err error)

+ func ScaffoldIgnoreFile(fs afero.Fs, projectPath string) error

+ func SealIgnorePattern(fs afero.Fs, projectPath, pattern string) (changed bool, err error)

+ func UnsealIgnorePattern(fs afero.Fs, projectPath, pattern string) (changed bool, err error)

+ func ValidateCIComponentSource(source string) error

+ func ValidateCommandName(name string) error

+ func ValidateConfigLayers(layers []string) error

+ func ValidateDescription(desc string) error

+ func ValidateEnvPrefix(prefix string) error

+ func ValidateExternalCommand(ec *ManifestExternalCommand) error

+ func ValidateFeatureName(name string) error

+ func ValidateFlagDefaultCode(def string) error

+ func ValidateFlagName(name string) error

+ func ValidateFlagShorthand(shorthand string) error

+ func ValidateFlagType(flagType string) error

+ func ValidateHost(host string) error

+ func ValidateLongDescription(desc string) error

+ func ValidateManifest(m *Manifest) error

+ func ValidateName(name string) error

+ func ValidateOrg(org, releaseProvider string) error

+ func ValidatePackagePath(pkgPath string) error

+ func ValidateParentPath(parent string) error

+ func ValidateReleaseSourceType(sourceType string) error

+ func ValidateRepo(repo string) error

+ func ValidateRepoName(name string) error

+ func ValidateSelectableFeatureName(name string) error

+ func ValidateSigningBackend(backend string) error

+ func ValidateSigningExternalKeyEmail(email string) error

+ func ValidateSigningKMSRegion(region string) error

+ func ValidateSigningKeyID(keyID string) error

+ func ValidateSigningKeySource(source string) error

+ func ValidateSigningPublicKey(publicKey string) error

+ func ValidateSlackChannel(channel string) error

+ func ValidateSlackTeam(team string) error

+ func ValidateTeamsChannel(channel string) error

+ func ValidateTeamsTeam(team string) error

+ func ValidateTelemetryEndpoint(endpoint string) error

+ func ValidateTemplateSource(ts *TemplateSource) error

+ func ValidateUpdateCheckInterval(interval string) error

+ func ValidateUpdatePolicy(policy string) error

+ type CommandContext struct

+ Aliases []string

+ Args string

+ DryRun bool

+ Force bool

+ Hidden bool

+ Long string

+ MCPEnabled *bool

+ Name string

+ Overwrite string

+ ParentPath []string

+ PersistentPreRun bool

+ PreRun bool

+ ProjectPath string

+ Protected *bool

+ Short string

+ UpdateDocs bool

+ WithAssets bool

+ WithConfigValidation bool

+ WithInitializer bool

+ func (c CommandContext) ToConfig() *Config

+ type CommandFlag struct

+ Default string

+ DefaultIsCode bool

+ Description string

+ Hidden bool

+ Name string

+ Persistent bool

+ Required bool

+ Shorthand string

+ Type string

+ type CommandPipeline struct

+ func (p *CommandPipeline) Run(ctx context.Context, data templates.CommandData, cmdDir string) (PipelineResult, error)

+ type Config struct

+ AIModel string

+ AIProvider string

+ Agentless bool

+ Aliases []string

+ Args string

+ DryRun bool

+ Flags []string

+ Force bool

+ GitBranch string

+ GitInit bool

+ GitPush bool

+ Hidden bool

+ Long string

+ MCPEnabled *bool

+ MaxSteps int

+ Name string

+ NoAIAttribution bool

+ NonInteractive bool

+ Overwrite string

+ Parent string

+ Path string

+ PersistentPreRun bool

+ PreRun bool

+ Prompt string

+ Protected *bool

+ PublicAPI bool

+ ScriptPath string

+ Short string

+ UpdateDocs bool

+ WithAssets bool

+ WithConfigValidation bool

+ WithInitializer bool

+ type DryRunResult struct

+ Actions []string

+ Created []FilePreview

+ Modified []FilePreview

+ func (r *DryRunResult) Print(w io.Writer)

+ type ExternalCommandSpec = ManifestExternalCommand

+ type FilePreview struct

+ Content []byte

+ Diff string

+ Path string

+ type Generator struct

+ func New(p *props.Props, cfg *Config) *Generator

+ func (g *Generator) AddTemplateSource(ctx context.Context, ts TemplateSource) error

+ func (g *Generator) ApplyFeatures(ctx context.Context, desired map[string]bool) ([]string, error)

+ func (g *Generator) AttachExternalAdapter(ctx context.Context) error

+ func (g *Generator) AttachExternalCommand(ctx context.Context, spec ExternalCommandSpec) error

+ func (g *Generator) CheckIgnorePaths(paths []string) []IgnoreCheckResult

+ func (g *Generator) CurrentFeatures() ([]ManifestFeature, error)

+ func (g *Generator) CurrentSigning() (ManifestSigning, error)

+ func (g *Generator) DetachExternalCommand(ctx context.Context, module string) error

+ func (g *Generator) DisableSigning(ctx context.Context) error

+ func (g *Generator) DivergedUnignoredFiles() ([]string, error)

+ func (g *Generator) EnableRealTemplateClone() *Generator

+ func (g *Generator) EnableSigning(ctx context.Context, signing ManifestSigning) error

+ func (g *Generator) FeatureEnabled(name string) (bool, error)

+ func (g *Generator) FindCommandParentPath(name string) ([]string, error)

+ func (g *Generator) Generate(ctx context.Context) error

+ func (g *Generator) GenerateCommandFile(ctx context.Context, cmdDir string, data *templates.CommandData) error

+ func (g *Generator) GenerateDocs(ctx context.Context, target string, isPackage bool) error

+ func (g *Generator) GenerateDryRun(ctx context.Context) (*DryRunResult, error)

+ func (g *Generator) GenerateSkeleton(ctx context.Context, config SkeletonConfig) error

+ func (g *Generator) GenerateSkeletonDryRun(ctx context.Context, config SkeletonConfig) (*DryRunResult, error)

+ func (g *Generator) ListExternalCommands() ([]ManifestExternalCommand, bool, error)

+ func (g *Generator) ListIgnoreRules() (*IgnoreListing, error)

+ func (g *Generator) ListTemplateSources() ([]TemplateSource, error)

+ func (g *Generator) RegenerateCommand(ctx context.Context, cmd ManifestCommand, parentPath []string) error

+ func (g *Generator) RegenerateManifest(ctx context.Context) error

+ func (g *Generator) RegenerateProject(ctx context.Context) error

+ func (g *Generator) RegenerateProjectDryRun(ctx context.Context) (*DryRunResult, error)

+ func (g *Generator) Remove(ctx context.Context) error

+ func (g *Generator) RemoveTemplateSource(ctx context.Context, name string) error

+ func (g *Generator) SealedTrackedFiles() ([]string, error)

+ func (g *Generator) SetMCPEnabled(ctx context.Context, commandPath string, enabled bool) error

+ func (g *Generator) SetProtection(ctx context.Context, commandName string, protected bool) error

+ func (g *Generator) UpdateTemplateSource(ctx context.Context, name string) error

+ func (g *Generator) WithTemplateClone(fn templateCloneFunc) *Generator

+ type IgnoreCheckResult struct

+ Ignored bool

+ Matched bool

+ Negated bool

+ Path string

+ Rule string

+ State RuleState

+ type IgnoreListEntry struct

+ Ignored bool

+ Path string

+ Rule string

+ State RuleState

+ type IgnoreListing struct

+ Entries []IgnoreListEntry

+ Rules []string

+ StaleRules []string

+ type IgnoreRules struct

+ func LoadIgnoreRules(fs afero.Fs, projectPath string) *IgnoreRules

+ func (r *IgnoreRules) Explain(relPath string) (rule string, negated, matched bool)

+ func (r *IgnoreRules) IsIgnored(relPath string) bool

+ func (r *IgnoreRules) IsSealed(relPath string) bool

+ func (r *IgnoreRules) Rules() []string

+ func (r *IgnoreRules) State(relPath string) RuleState

+ type Manifest struct

+ Commands []ManifestCommand

+ Hashes map[string]string

+ Properties ManifestProperties

+ ReleaseSource ManifestReleaseSource

+ Version ManifestVersion

+ func DecodeManifestFile(fs afero.Fs, manifestPath string) (*Manifest, error)

+ func (m *Manifest) GetReleaseSource() (sourceType, owner, repo string)

+ func (m *Manifest) TrackedFiles() map[string]string

+ type ManifestBootstrap struct

+ AutoInitialise bool

+ SkipConfigCheck []string

+ type ManifestCI struct

+ ComponentSource string

+ type ManifestCommand struct

+ Aliases []string

+ Args string

+ Commands []ManifestCommand

+ Description MultilineString

+ Flags []ManifestFlag

+ Hash string

+ Hashes map[string]string

+ Hidden bool

+ LongDescription MultilineString

+ MCPEnabled *bool

+ MutuallyExclusive [][]string

+ Name string

+ PersistentPreRun bool

+ PreRun bool

+ Protected *bool

+ RequiredTogether [][]string

+ Warning string

+ WithAssets bool

+ WithConfigValidation bool

+ WithInitializer bool

+ func (c ManifestCommand) MarshalYAML() (any, error)

+ type ManifestCommandUpdate struct

+ Aliases []string

+ Args string

+ Description string

+ Flags []ManifestFlag

+ Hashes map[string]string

+ Hidden bool

+ LongDescription string

+ MCPEnabled *bool

+ Name string

+ PersistentPreRun bool

+ PreRun bool

+ Protected *bool

+ WithAssets bool

+ WithConfigValidation bool

+ WithInitializer bool

+ type ManifestExternalAttach struct

+ Args []string

+ Constructor string

+ Name string

+ Wrap bool

+ type ManifestExternalCommand struct

+ Alias string

+ Attach []ManifestExternalAttach

+ ImportPath string

+ Module string

+ Version string

+ type ManifestFeature struct

+ Enabled bool

+ Name string

+ type ManifestFlag struct

+ Default string

+ DefaultIsCode bool

+ Description MultilineString

+ Hidden bool

+ Name string

+ Persistent bool

+ Required bool

+ Shorthand string

+ Type string

+ Warning string

+ func (f ManifestFlag) MarshalYAML() (any, error)

+ type ManifestHelp struct

+ SlackChannel string

+ SlackTeam string

+ TeamsChannel string

+ TeamsTeam string

+ Type string

+ type ManifestProperties struct

+ Bootstrap ManifestBootstrap

+ CI ManifestCI

+ ConfigLayers []string

+ Description MultilineString

+ DocsLayout string

+ EnvPrefix string

+ ExternalCommands []ManifestExternalCommand

+ ExternalCommandsAdapter bool

+ Features []ManifestFeature

+ Help ManifestHelp

+ ModulePublished bool

+ Name string

+ Signing ManifestSigning

+ Telemetry ManifestTelemetry

+ Templates []TemplateSource

+ UpdateCheckInterval string

+ UpdatePolicy string

+ func (p ManifestProperties) ResolvedDocsLayout() string

+ type ManifestReleaseSource struct

+ Host string

+ Owner string

+ Private bool

+ Repo string

+ Type string

+ type ManifestSigning struct

+ Backend string

+ Enabled bool

+ ExternalKeyEmail string

+ KMSRegion string

+ KeyID string

+ KeySource string

+ PublicKey string

+ RequireExternalCrosscheck bool

+ RequireSignature bool

+ func ApplySigningDefaults(s ManifestSigning) ManifestSigning

+ type ManifestTelemetry struct

+ Endpoint string

+ OTelEndpoint string

+ type ManifestVersion struct

+ GoToolBase string

+ type MultilineString string

+ func (s MultilineString) MarshalYAML() (any, error)

+ type PipelineOptions struct

+ SkipAssets bool

+ SkipDocumentation bool

+ SkipRegistration bool

+ type PipelineResult struct

+ Warnings []StepWarning

+ type RuleState int

+ const StateIgnored

+ const StateManaged

+ const StateSealed

+ func (s RuleState) String() string

+ type SkeletonConfig struct

+ Bootstrap ManifestBootstrap

+ CIComponentSource string

+ ConfigLayers []string

+ Description string

+ EnvPrefix string

+ Features []ManifestFeature

+ GoVersion string

+ HelpType string

+ Host string

+ Name string

+ Path string

+ Private bool

+ Repo string

+ Signing ManifestSigning

+ SlackChannel string

+ SlackTeam string

+ TeamsChannel string

+ TeamsTeam string

+ TelemetryEndpoint string

+ TelemetryOTelEndpoint string

+ Templates []TemplateSource

+ UpdateCheckInterval string

+ UpdatePolicy string

+ type StepWarning struct

+ Err error

+ Step string

+ type TemplateContractData struct

+ Description string

+ DisabledFeatures []string

+ EnabledFeatures []string

+ EnvPrefix string

+ GoToolBaseVersion string

+ GoVersion string

+ HelpType string

+ Host string

+ ModulePath string

+ Name string

+ Org string

+ Private bool

+ ReleaseProvider string

+ Repo string

+ RepoName string

+ SigningEnabled bool

+ func (d TemplateContractData) GetReleaseProvider() string

+ type TemplateDescriptor struct

+ Contract int

+ Description string

+ Replaces []string

+ type TemplateSource struct

+ Fingerprint string

+ Hashes map[string]string

+ Location string

+ Name string

+ Ref string

+ Resolved string

+ Type TemplateSourceType

+ func ParseTemplateSpec(fs afero.Fs, spec, name string) (TemplateSource, error)

+ type TemplateSourceType string

+ const TemplateSourceGit

+ const TemplateSourceLocal

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