Complex Union Types with Special Characters Need Better Sanitization

[houstonhaynes]

When TypeScript enums or union types contain special characters (like @, /, -), Glutinum generates F# identifiers that either need backticks or fail compilation. Better sanitization with [<CompiledName>] would improve ergonomics.

Example (from CloudflareFS Management API generation)

// TypeScript enum with special characters
type VectorizePreset =
    | "@cf/baai/bge-small-en-v1.5"
    | "openai/text-embedding-ada-002"

Current Behavior (Hawaii, similar pattern)

type VectorizePreset =
    | [<CompiledName "@cf/baai/bge-small-en-v1.5">] @cfBaaiBgeSmallEnV1Numeric_5
    // ^ Invalid F# identifier starting with @

Proposed Improvement

type VectorizePreset =
    | [<CompiledName "@cf/baai/bge-small-en-v1.5">] CfBaaiBgeSmallEnV15
    | [<CompiledName "openai/text-embedding-ada-002">] OpenAiTextEmbeddingAda002

Sanitization Rules

1. Remove leading special characters
2. Convert /, -, . to word boundaries for PascalCase
3. Remove numeric suffixes that can't be in identifiers
4. Always use [<CompiledName>] to preserve original value

CloudflareFS Workaround

Manual post-processing scripts that:

1. Detect problematic identifiers
2. Add backticks where needed
3. Fix pattern matching to use consistent escaping

[MangelMaxime]

Issue created from Glutinum Tool

Glutinum version - 0.13.0-preview

TypeScript

// TypeScript enum with special characters
type VectorizePreset =
    | "@cf/baai/bge-small-en-v1.5"
    | "openai/text-embedding-ada-002"

FSharp

module rec Glutinum

open Fable.Core
open Fable.Core.JsInterop
open System

[<RequireQualifiedAccess>]
[<StringEnum(CaseRules.None)>]
type VectorizePreset =
    | [<CompiledName("@cf/baai/bge-small-en-v1.5")>] ``_AT_cf/baai/bge-small-en-v1_5``
    | ``openai/text-embedding-ada-002``

Even if the you are providing is not from Glutinum, I confirm that there is a bug here. Seems like I forgot to escape / character with _

We probably need to fix both these places:

cli/src/Glutinum.Converter/Utils/Naming.fs

Lines 11 to 24 in 63d5b05

	let private escapeName (name: string) : string =
	if
	name.Contains("-")
	|| name.Contains("$")
	|| name.Contains("#")
	|| name.Contains("<")
	|| name.Contains(">")
	|| name.Contains(" ")
	|| startWithDigit name
	|| Keywords.fsharp.Contains name
	then
	$"``%s{name}``"
	else
	name

cli/src/Glutinum.Converter/Utils/Naming.fs

Lines 40 to 58 in 63d5b05

	let replaceDot (text: string) : string = text.Replace(".", "_")
	let replaceAt (text: string) : string = text.Replace("@", "_AT_")
	type SanitizeNameResult = { Name: string; IsDifferent: bool }
	let sanitizeNameWithResult (name: string) : SanitizeNameResult =
	let sanitizedName = name |> replaceDot |> replaceAt |> removeSurroundingQuotes
	// Check if the name is different after sanitization
	// This is used to check if the value is different from the default Fable computed value
	// Especially useful for StringEnum values where we sometimes need to use [<CompiledValue(...)>]
	// to provide a different value than the default Fable computed value from the name
	let isDifferent = name <> sanitizedName
	{
	Name = sanitizedName |> escapeName
	IsDifferent = isDifferent
	}