generator

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

type Config struct {
	// Lang is the language supported by this codegen infra.
	Lang SDKLang

	// OutputDir is the path to place generated code.
	OutputDir string

	// ModuleName is the module name to generate code for.
	ModuleName string

	// ModuleSourcePath is the subpath in OutputDir where a the module source subpath is located.
	ModuleSourcePath string

	// ModuleParentPath is the path from the module source subpath to the context directory
	ModuleParentPath string

	// IntrospectionJSON is an optional pre-computed introspection json string.
	IntrospectionJSON string

	// Merge indicates whether to merge the module deps with the existing project (i.e. a go.mod in a *parent* directory).
	Merge bool

	// Whether we are initializing a new module.
	// Currently, this is only used in go codegen to enforce backwards-compatible behavior
	// where a pre-existing go.mod file is checked during dagger init for whether its module
	// name is the expected value.
	IsInit bool

	// ClientOnly indicates that the codegen should only generate the client code.
	ClientOnly bool

	// Dev indicates that the codegen should use the local SDK instead of the published one.
	// This is only relevant when ClientOnly is true.
	Dev bool

	// The list of all dependencies used by the module.
	// This is used for client generator to automatically serves the dependencies
	// on connection.
	GitDependencies []modules.ModuleConfigDependency
}

type FormatTypeFuncs interface {
	WithScope(scope string) FormatTypeFuncs

	FormatKindList(representation string) string
	FormatKindScalarString(representation string) string
	FormatKindScalarInt(representation string) string
	FormatKindScalarFloat(representation string) string
	FormatKindScalarBoolean(representation string) string
	FormatKindScalarDefault(representation string, refName string, input bool) string
	FormatKindObject(representation string, refName string, input bool) string
	FormatKindInputObject(representation string, refName string, input bool) string
	FormatKindEnum(representation string, refName string) string
}

type GeneratedState struct {
	// Overlay is the overlay filesystem that contains generated code to write
	// over the output directory.
	Overlay fs.FS

	// PostCommands are commands that need to be run after the codegen has
	// finished. This is used for example to run `go mod tidy` after generating
	// Go code.
	PostCommands []*exec.Cmd

	// NeedRegenerate indicates that the code needs to be generated again. This
	// can happen if the codegen spat out templates that depend on generated
	// types. In that case the codegen needs to be run again with both the
	// templates and the initially generated types available.
	NeedRegenerate bool
}

type Generator interface {
	// GenerateModule runs codegen in a context of a module and returns a map of
	// default filename to content for that file.
	GenerateModule(ctx context.Context, schema *introspection.Schema, schemaVersion string) (*GeneratedState, error)

	// GenerateClient runs codegen in a context of a standalone client and returns
	// a map of default filename to content for that file.
	GenerateClient(ctx context.Context, schema *introspection.Schema, schemaVersion string) (*GeneratedState, error)
}

type SDKLang string