Function SanitizeName

pkg/stringutil/sanitize.go:76–103

SanitizeName sanitizes a string for use as an identifier, file name, or similar context. It provides configurable behavior through the SanitizeOptions parameter.

(name string, opts *SanitizeOptions)

// SanitizeName sanitizes a string for use as an identifier, file name, or similar context.
// It provides configurable behavior through the SanitizeOptions parameter.
func SanitizeName(name string, opts *SanitizeOptions) string {
	logSanitizeInput(name, opts)

	// Handle nil options
	if opts == nil {
		opts = &SanitizeOptions{}
	}

	result := normalizeSanitizeSeparators(strings.ToLower(name), opts)
	result = applySanitizePattern(result, buildSanitizePreservePattern(opts), len(opts.PreserveSpecialChars) > 0)

	// Consolidate multiple consecutive hyphens into a single hyphen
	result = multipleHyphens.ReplaceAllString(result, "-")

	// Optionally trim leading/trailing hyphens
	if opts.TrimHyphens {
		result = strings.Trim(result, "-")
	}

	// Return default value if result is empty
	if result == "" && opts.DefaultValue != "" {
		sanitizeLog.Printf("Sanitized name is empty, using default: %q", opts.DefaultValue)
		return opts.DefaultValue
	}

	sanitizeLog.Printf("Sanitized name result: %q", result)
	return result
}

// logSanitizeInput logs input parameters when debug logging is enabled.
func logSanitizeInput(name string, opts *SanitizeOptions) {