naming

Documentation

Overview

Copyright 2026 YLD Limited SPDX-License-Identifier: Apache-2.0 Package naming provides identifier sanitization and conversion utilities for translating between HCL and YAML naming conventions. It handles dash-to-underscore mapping, identifier deduplication, and safe identifier generation.

Index

• func SanitizeIdentifier(in string) string
• func ToHCLKey(name string) string
• func ToYAMLKey(name string) string
• func UniqueIdentifier(base string, existing []string) string
• func UniqueIdentifierInSet(base string, existing map[string]struct{}) string

Functions

func SanitizeIdentifier

func SanitizeIdentifier(in string) string

SanitizeIdentifier replaces non-alphanumeric characters with underscores and ensures a valid identifier.

func ToHCLKey

func ToHCLKey(name string) string

ToHCLKey converts a name to an HCL-compatible key by replacing hyphens with underscores.

func ToYAMLKey

func ToYAMLKey(name string) string

ToYAMLKey converts a name to a YAML-compatible key by replacing underscores with hyphens.

func UniqueIdentifier

func UniqueIdentifier(base string, existing []string) string

UniqueIdentifier returns base or a suffixed variant that does not collide with existing.

func UniqueIdentifierInSet

func UniqueIdentifierInSet(base string, existing map[string]struct{}) string

UniqueIdentifierInSet returns base or a suffixed variant not present in the existing set.