feat: improve name handling to avoid duplicates

Author: lopi-py

src/naming.ts

@@ -1,3 +1,51 @@
-export function formatName(name: string) {
-    return name.toLowerCase().replace(" ", "_")
+import { Instance } from "./roblox";
+
+// TODO: allow other cases instead of lower case
+export enum Casing {
+    LowerCase,
+}
+
+function formatName(name: string, casing: Casing = Casing.LowerCase) {
+    switch (casing) {
+        case Casing.LowerCase:
+            return name.toLowerCase().replace(" ", "_")
+    }
+}
+
+interface FixNamesOptions {
+    includeSelf?: boolean;
+    descendants?: boolean;
+    casing?: Casing;
+}
+
+export function fixNames(instance: Instance, options?: FixNamesOptions) {
+    let namesCount: Record<string, number> = {}
+
+    instance.name = formatName(instance.name, options?.casing)
+
+    if (options?.includeSelf)
+        namesCount[instance.name] = 1
+
+    function processChild(child: Instance) {
+        const name = formatName(child.name, options?.casing)
+
+        if (namesCount[name])
+            namesCount[name]++
+        else
+            namesCount[name] = 1
+
+        const suffix = namesCount[name] > 1 ? `_${namesCount[name]}` : ""
+        child.name = name + suffix
+    }
+
+    function processChildren(_instance: Instance) {
+        _instance.children.forEach(processChild)
+
+        if (!options?.descendants)
+            namesCount = {}
+
+        _instance.children.forEach(processChildren)
+    }
+
+    processChildren(instance)
 }

src/roblox.ts

@@ -7,8 +7,8 @@ export interface Properties {
 }
 
 export interface Instance {
+    name: string;
     readonly className: string;
-    readonly name: string;
     readonly properties: Properties;
     readonly children: Instance[];
 }

src/translators/jsx.ts

@@ -1,4 +1,4 @@
-import { formatName } from "../naming";
+import { fixNames } from "../naming";
 import { Instance } from "../roblox";
 import { TypeScriptSerializer } from "../seralizers/typescript";
 import { Snippet } from "../snippet";
@@ -9,7 +9,7 @@ function translate(instance: Instance, indent: number = 0): string {
 
     snippet.writeLine(`<${instance.className.toLowerCase()}`)
     snippet.indent++
-    snippet.writeLine(`Key="${formatName(instance.name)}"`)
+    snippet.writeLine(`Key="${instance.name}"`)
 
     Object.entries(instance.properties).forEach(([property, value]) => {
         const serialized = serializer.ser(value)
@@ -37,5 +37,7 @@ function translate(instance: Instance, indent: number = 0): string {
 }
 
 export function TranslateJsx(instance: Instance): CodegenResult {
+    fixNames(instance)
+
     return { title: "TypeScript", code: translate(instance), language: "TYPESCRIPT" }
 }

src/translators/react.ts

@@ -1,4 +1,4 @@
-import { formatName } from "../naming";
+import { fixNames } from "../naming";
 import { Instance } from "../roblox";
 import { LuauSerializer } from "../seralizers/luau";
 import { Snippet } from "../snippet";
@@ -22,7 +22,7 @@ function translate(instance: Instance, indent: number = 0): string {
         snippet.indent++
 
         instance.children.forEach((child) => {
-            snippet.writeLine(`${formatName(child.name)} = ${translate(child, snippet.indent)},`)
+            snippet.writeLine(`${child.name} = ${translate(child, snippet.indent)},`)
         })
 
         snippet.indent--
@@ -35,5 +35,7 @@ function translate(instance: Instance, indent: number = 0): string {
 }
 
 export function TranslateReact(instance: Instance): CodegenResult {
+    fixNames(instance)
+
     return { title: "Luau", code: translate(instance), language: "PYTHON" }
 }

src/translators/vanilla.ts

@@ -1,4 +1,4 @@
-import { formatName } from "../naming";
+import { fixNames } from "../naming";
 import { Instance } from "../roblox";
 import { LuauSerializer } from "../seralizers/luau";
 import { Snippet } from "../snippet";
@@ -7,21 +7,19 @@ function translate(instance: Instance, indent: number = 0, parent?: Instance): s
     const serializer = new LuauSerializer();
     const snippet = new Snippet(indent);
 
-    const name = formatName(instance.name)
-    const properties = Object.entries(instance.properties)
-
-    snippet.writeLine(`local ${name} = Instance.new("${instance.className}")`)
+    snippet.writeLine(`local ${instance.name} = Instance.new("${instance.className}")`)
 
+    const properties = Object.entries(instance.properties)
     properties.forEach(([property, value], index) => {
-        snippet.write(`${name}.${property} = ${serializer.ser(value)}`)
+        snippet.write(`${instance.name}.${property} = ${serializer.ser(value)}`)
 
         if (index != properties.length - 1)
             snippet.newLine()
     })
 
     if (parent) {
         snippet.newLine()
-        snippet.write(`${name}.Parent = ${formatName(parent.name)}`)
+        snippet.write(`${instance.name}.Parent = ${parent.name}`)
     }
 
     if (instance.children.length > 0) {
@@ -42,5 +40,7 @@ function translate(instance: Instance, indent: number = 0, parent?: Instance): s
 }
 
 export function TranslateVanilla(instance: Instance): CodegenResult {
+    fixNames(instance, { includeSelf: true, descendants: true })
+
     return { title: "Luau", code: translate(instance), language: "PYTHON" }
 }