inikit

package

v0.1.2 Latest Latest Go to latest Published: Feb 18, 2026 License: MIT Imports: 9 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/confighub/sdk

Links

Open Source Insights

Documentation ¶

Overview ¶

Package inikit is used to interpret AppConfig/INI configuration units.

Constants ¶

View Source

const (
	ResourceTypeNoSchema = api.ResourceType("NoSchema")
	ResourceNameNoName   = api.ResourceName("NoName")
	ConfigSchemaPath     = api.ResolvedPath("configHub.configSchema")
	ConfigNamePath       = api.ResolvedPath("configHub.configName")
)

Variables ¶

View Source

var INIResourceProvider = &INIResourceProviderType{}

INIResourceProvider implements the ResourceProvider interface for AppConfig/INI.

Functions ¶

This section is empty.

Types ¶

type INIResourceProviderType ¶

type INIResourceProviderType struct{}

func (*INIResourceProviderType) ContextPath ¶

func (*INIResourceProviderType) ContextPath(contextField string) string

func (*INIResourceProviderType) DataType ¶

func (*INIResourceProviderType) DataType() api.DataType

func (*INIResourceProviderType) DefaultResourceCategory ¶

func (*INIResourceProviderType) DefaultResourceCategory() api.ResourceCategory

DefaultResourceCategory returns the default resource category to assume, which is AppConfig in this case.

func (*INIResourceProviderType) GetPathRegistry ¶

func (*INIResourceProviderType) GetPathRegistry() api.AttributeNameToResourceTypeToPathToVisitorInfoType

func (*INIResourceProviderType) NameSeparator ¶

func (*INIResourceProviderType) NameSeparator() string

func (*INIResourceProviderType) NativeToYAML ¶

func (*INIResourceProviderType) NativeToYAML(data []byte) ([]byte, error)

NativeToYAML converts INI data to YAML format using native libraries.

func (*INIResourceProviderType) NormalizeName ¶

func (*INIResourceProviderType) NormalizeName(name string) string

func (*INIResourceProviderType) RemoveScopeFromResourceName ¶

func (*INIResourceProviderType) RemoveScopeFromResourceName(resourceName api.ResourceName) api.ResourceName

func (*INIResourceProviderType) ResourceAndCategoryTypeMaps ¶

func (*INIResourceProviderType) ResourceAndCategoryTypeMaps(docs gaby.Container) (resourceMap yamlkit.ResourceNameToCategoryTypesMap, categoryTypeMap yamlkit.ResourceCategoryTypeToNamesMap, err error)

ResourceAndCategoryTypeMaps returns maps of all resources in the provided list of parsed YAML documents, from from names to categories+types and categories+types to names.

func (*INIResourceProviderType) ResourceCategoryGetter ¶

func (*INIResourceProviderType) ResourceCategoryGetter(doc *gaby.YamlDoc) (api.ResourceCategory, error)

ResourceCategoryGetter just returns ResourceCategoryAppConfig for INI documents.

func (*INIResourceProviderType) ResourceNameGetter ¶

func (*INIResourceProviderType) ResourceNameGetter(doc *gaby.YamlDoc) (api.ResourceName, error)

ResourceNameGetter extracts the property configHub.configName, and returns NoName if not present.

func (*INIResourceProviderType) ResourceTypeGetter ¶

func (*INIResourceProviderType) ResourceTypeGetter(doc *gaby.YamlDoc) (api.ResourceType, error)

ResourceTypeGetter extracts the property configHub.configSchema, and returns NoSchema if not present.

func (*INIResourceProviderType) ResourceTypesAreSimilar ¶

func (*INIResourceProviderType) ResourceTypesAreSimilar(resourceTypeA, resourceTypeB api.ResourceType) bool

func (*INIResourceProviderType) ScopelessResourceNamePath ¶

func (*INIResourceProviderType) ScopelessResourceNamePath() api.ResolvedPath

func (*INIResourceProviderType) SetResourceName ¶

func (*INIResourceProviderType) SetResourceName(doc *gaby.YamlDoc, name string) error

func (*INIResourceProviderType) TypeDescription ¶

func (*INIResourceProviderType) TypeDescription() string

func (*INIResourceProviderType) YAMLToNative ¶

func (*INIResourceProviderType) YAMLToNative(yamlData []byte) ([]byte, error)

YAMLToNative converts YAML data to INI format using native libraries.

Source Files ¶

View all Source files

inikit.go

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