config

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 9, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package config provides configuration structures for code generators.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DartFetchConfig added in v0.2.0

type DartFetchConfig struct {
	// PubName is the package name used in pubspec.yaml.
	PubName string `json:"pubName,omitempty"`
	// PubVersion is the package version.
	PubVersion string `json:"pubVersion,omitempty"`
	// PubDescription is the package description.
	PubDescription string `json:"pubDescription,omitempty"`
	// PubAuthor is the author name.
	PubAuthor string `json:"pubAuthor,omitempty"`
	// PubHomepage is the homepage URL.
	PubHomepage string `json:"pubHomepage,omitempty"`
	// PubRepository is the repository URL.
	PubRepository string `json:"pubRepository,omitempty"`

	// SdkConstraint sets the Dart SDK constraint (default: ">=3.13.0 <4.0.0").
	SdkConstraint string `json:"sdkConstraint,omitempty"`

	// UseDartIoSender controls whether the generated runtime includes the
	// default dart:io HttpClient sender. When false the user must inject
	// their own HttpSender (useful for browser targets).
	UseDartIoSender bool `json:"useDartIoSender"`

	// ModelPropertyNaming controls property naming (default: camelCase).
	ModelPropertyNaming string `json:"modelPropertyNaming,omitempty"`

	// SortParamsByRequiredFlag puts required params before optional ones.
	SortParamsByRequiredFlag bool `json:"sortParamsByRequiredFlag,omitempty"`

	// License
	LicenseName string `json:"licenseName,omitempty"`
	LicenseUrl  string `json:"licenseUrl,omitempty"`
}

DartFetchConfig holds configuration specific to the dart-fetch generator.

The dart-fetch generator produces a Dart client with no third-party runtime dependencies. HTTP requests are dispatched through a pluggable HttpSender; a dart:io-based default is provided for VM/Flutter targets.

func NewDartFetchConfig added in v0.2.0

func NewDartFetchConfig() *DartFetchConfig

NewDartFetchConfig creates a new DartFetchConfig with default values.

type FileNamingType

type FileNamingType string

FileNamingType represents the file naming convention.

const (
	FileNamingPascalCase FileNamingType = "PascalCase"
	FileNamingCamelCase  FileNamingType = "camelCase"
	FileNamingKebabCase  FileNamingType = "kebab-case"
)

The file naming conventions a generator accepts.

type GeneratorConfig

type GeneratorConfig struct {
	// Input/Output
	InputSpec   string `json:"inputSpec"`
	OutputDir   string `json:"outputDir"`
	TemplateDir string `json:"templateDir,omitempty"`

	// Generator identification
	GeneratorName string `json:"generatorName"`

	// Package configuration
	PackageName    string `json:"packageName,omitempty"`
	ApiPackage     string `json:"apiPackage,omitempty"`
	ModelPackage   string `json:"modelPackage,omitempty"`
	InvokerPackage string `json:"invokerPackage,omitempty"`

	// Naming
	ModelNamePrefix string `json:"modelNamePrefix,omitempty"`
	ModelNameSuffix string `json:"modelNameSuffix,omitempty"`
	ApiNamePrefix   string `json:"apiNamePrefix,omitempty"`
	ApiNameSuffix   string `json:"apiNameSuffix,omitempty"`

	// Global flags
	SkipOverwrite       bool `json:"skipOverwrite,omitempty"`
	SkipValidateSpec    bool `json:"skipValidateSpec,omitempty"`
	StrictSpec          bool `json:"strictSpec,omitempty"`
	EnableMinimalUpdate bool `json:"enableMinimalUpdate,omitempty"`

	// Additional properties (generator-specific)
	AdditionalProperties map[string]any `json:"additionalProperties,omitempty"`

	// Global properties
	GlobalProperties map[string]any `json:"globalProperties,omitempty"`
}

GeneratorConfig holds configuration for code generation.

type ModelPropertyNamingType

type ModelPropertyNamingType string

ModelPropertyNamingType represents the property naming convention.

const (
	PropertyNamingOriginal   ModelPropertyNamingType = "original"
	PropertyNamingCamelCase  ModelPropertyNamingType = "camelCase"
	PropertyNamingPascalCase ModelPropertyNamingType = "PascalCase"
	PropertyNamingSnakeCase  ModelPropertyNamingType = "snake_case"
)

The property naming conventions a generator accepts.

type TypeScriptFetchConfig

type TypeScriptFetchConfig struct {
	// Package generation
	WithPackageJson bool `json:"withPackageJson,omitempty"`

	// Generation options
	WithInterfaces            bool   `json:"withInterfaces,omitempty"`
	UseSingleRequestParameter bool   `json:"useSingleRequestParameter"`
	PrefixParameterInterfaces bool   `json:"prefixParameterInterfaces,omitempty"`
	WithoutRuntimeChecks      bool   `json:"withoutRuntimeChecks,omitempty"`
	StringEnums               bool   `json:"stringEnums,omitempty"`
	ImportFileExtension       string `json:"importFileExtension,omitempty"`
	FileNaming                string `json:"fileNaming,omitempty"` // PascalCase, camelCase, kebab-case

	// Validation
	GenerateValidationAttributes bool `json:"validationAttributes,omitempty"`

	// Square brackets in array names
	UseSquareBracketsInArrayNames bool `json:"useSquareBracketsInArrayNames,omitempty"`

	// Model property naming
	ModelPropertyNaming string `json:"modelPropertyNaming,omitempty"` // original, camelCase, PascalCase, snake_case

	// Enum property naming
	EnumPropertyNaming string `json:"enumPropertyNaming,omitempty"`

	// Null-safe additional props
	NullSafeAdditionalProps bool `json:"nullSafeAdditionalProps,omitempty"`

	// Allow unicode identifiers
	AllowUnicodeIdentifiers bool `json:"allowUnicodeIdentifiers,omitempty"`

	// Prepend form or body parameters to the list
	PrependFormOrBodyParameters bool `json:"prependFormOrBodyParameters,omitempty"`

	// Sort params by required flag
	SortParamsByRequiredFlag bool `json:"sortParamsByRequiredFlag,omitempty"`

	// Sort model properties by required flag
	SortModelPropertiesByRequiredFlag bool `json:"sortModelPropertiesByRequiredFlag,omitempty"`

	// Ensure unique params
	EnsureUniqueParams bool `json:"ensureUniqueParams,omitempty"`

	// Legacy discriminator behavior
	LegacyDiscriminatorBehavior bool `json:"legacyDiscriminatorBehavior,omitempty"`

	// Disallow additional properties if not present
	DisallowAdditionalPropertiesIfNotPresent bool `json:"disallowAdditionalPropertiesIfNotPresent,omitempty"`

	// License
	LicenseName string `json:"licenseName,omitempty"`
	LicenseUrl  string `json:"licenseUrl,omitempty"`
}

TypeScriptFetchConfig holds configuration specific to typescript-fetch generator.

func NewTypeScriptFetchConfig

func NewTypeScriptFetchConfig() *TypeScriptFetchConfig

NewTypeScriptFetchConfig creates a new TypeScriptFetchConfig with default values.

Jump to

Keyboard shortcuts

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