Normalize acronyms option

Author: engthiago

README.md

@@ -82,6 +82,9 @@ Controls generated string quotes. Options: `double`, `single`. Default: `double`
 `--semicolons`, `--no-semicolons` optional  
 Controls semicolons on generated TypeScript statements. Options: `true`, `false`. Default: `true`.
 
+`--normalize-acronyms`, `--no-normalize-acronyms` optional  
+Normalizes leading acronyms in generated property names, such as `ULS` to `uls`. Default: `false`.
+
 ## Configuration File
 
 Create `typesharp.json`:
@@ -98,7 +101,8 @@ Create `typesharp.json`:
   "dictionaryStyle": "record",
   "readonlyProperties": false,
   "quoteStyle": "double",
-  "semicolons": true
+  "semicolons": true,
+  "normalizeAcronyms": false
 }
 ```
 

src/typesharp-ts/dist/main.mjs

@@ -122,6 +122,33 @@ namespace Demo {
   assert.match(generated.get("Demo.Module.ts")!, /export \* from '\.\/Person'/);
 });
 
+test("supports default and acronym-normalized property naming", () => {
+  const files = [
+    parseSourceFile(
+      "report.cs",
+      `
+public class ULSReport {}
+public class Report {
+  public string SubCategory { get; set; }
+  public ULSReport ULS { get; set; }
+  public string URLValue { get; set; }
+}`,
+    ),
+  ];
+
+  const defaultReport = new Map(generate(files).map((file) => [file.name, file.text])).get("Report.ts")!;
+  assert.match(defaultReport, /subCategory: string;/);
+  assert.match(defaultReport, /uLS: ULSReport;/);
+  assert.match(defaultReport, /uRLValue: string;/);
+
+  const normalizedReport = new Map(
+    generate(files, { normalizeAcronyms: true }).map((file) => [file.name, file.text]),
+  ).get("Report.ts")!;
+  assert.match(normalizedReport, /subCategory: string;/);
+  assert.match(normalizedReport, /uls: ULSReport;/);
+  assert.match(normalizedReport, /urlValue: string;/);
+});
+
 test("supports property readonly attributes without global readonly", () => {
   const person = generate([
     parseSourceFile(
@@ -225,6 +252,7 @@ test("supports current CLI arguments", () => {
       "--readonly-properties",
       "--quote-style=single",
       "--no-semicolons",
+      "--normalize-acronyms",
     ]),
     {
       configPath: "./config/tssharp.json",
@@ -239,6 +267,7 @@ test("supports current CLI arguments", () => {
       readonlyProperties: true,
       quoteStyle: "single",
       semicolons: false,
+      normalizeAcronyms: true,
     },
   );
 });
@@ -256,6 +285,7 @@ test("loads typesharp.json and lets CLI override file values", async () => {
         exportModule: true,
         dictionaryStyle: "index-signature",
         readonlyProperties: true,
+        normalizeAcronyms: true,
       }),
     );
 
@@ -272,6 +302,7 @@ test("loads typesharp.json and lets CLI override file values", async () => {
       readonlyProperties: true,
       quoteStyle: undefined,
       semicolons: undefined,
+      normalizeAcronyms: true,
     });
   } finally {
     await rm(temp, { recursive: true, force: true });
@@ -302,6 +333,7 @@ test("defaults fileFilter to C# source files", async () => {
       readonlyProperties: undefined,
       quoteStyle: undefined,
       semicolons: undefined,
+      normalizeAcronyms: undefined,
     });
   } finally {
     await rm(temp, { recursive: true, force: true });

src/typesharp-ts/spec/node_test.ts

@@ -7,6 +7,7 @@ export interface GenerateOptions {
   readonlyProperties?: boolean;
   quoteStyle?: "double" | "single";
   semicolons?: boolean;
+  normalizeAcronyms?: boolean;
 }
 
 export interface GeneratedFile {
@@ -91,7 +92,7 @@ function generateClass(node: ClassNode, typeMap: TypeMap, options: Required<Gene
       hasAttribute(prop.attributes, "ReadOnly");
     const prefix = readonly ? "readonly " : "";
     if (union) {
-      lines.push(`   ${prefix}${camelCase(prop.name)}: ${union}${statementEnd(options)}`);
+      lines.push(`   ${prefix}${propertyName(prop.name, options)}: ${union}${statementEnd(options)}`);
       continue;
     }
 
@@ -102,7 +103,9 @@ function generateClass(node: ClassNode, typeMap: TypeMap, options: Required<Gene
       : toTypeScriptType(prop.type, node, typeMap, options);
     if (hasAttribute(prop.attributes, "Partial")) typeName = `Partial<${typeName}>`;
     lines.push(
-      `   ${prefix}${camelCase(prop.name)}${optional ? "?" : ""}: ${typeName}${nullable}${statementEnd(options)}`,
+      `   ${prefix}${propertyName(prop.name, options)}${optional ? "?" : ""}: ${typeName}${nullable}${
+        statementEnd(options)
+      }`,
     );
   }
   lines.push("}", "");
@@ -192,11 +195,22 @@ function simpleName(name: string): string {
   return name.split(".").at(-1) ?? name;
 }
 
+function propertyName(value: string, options: Required<GenerateOptions>): string {
+  return options.normalizeAcronyms ? acronymCamelCase(value) : camelCase(value);
+}
+
 function camelCase(value: string): string {
   if (value.length === 0) return value;
   return value[0].toLowerCase() + value.slice(1);
 }
 
+function acronymCamelCase(value: string): string {
+  if (value.length === 0) return value;
+  const leadingAcronym = value.match(/^[A-Z]+(?=$|[A-Z][a-z])/);
+  if (!leadingAcronym) return camelCase(value);
+  return leadingAcronym[0].toLowerCase() + value.slice(leadingAcronym[0].length);
+}
+
 function normalizeOptions(options: GenerateOptions): Required<GenerateOptions> {
   return {
     exportModule: options.exportModule ?? false,
@@ -205,6 +219,7 @@ function normalizeOptions(options: GenerateOptions): Required<GenerateOptions> {
     readonlyProperties: options.readonlyProperties ?? false,
     quoteStyle: options.quoteStyle ?? "double",
     semicolons: options.semicolons ?? true,
+    normalizeAcronyms: options.normalizeAcronyms ?? false,
   };
 }
 

src/typesharp-ts/src/generator.ts

@@ -50,6 +50,7 @@ export async function convert(options: CliOptions): Promise<void> {
     readonlyProperties: options.readonlyProperties,
     quoteStyle: options.quoteStyle,
     semicolons: options.semicolons,
+    normalizeAcronyms: options.normalizeAcronyms,
   });
   await mkdir(options.destination, { recursive: true });
   for (const file of files) {
@@ -82,7 +83,13 @@ export function parseArgs(args: string[]): ParsedCliOptions {
     w: "watch",
     m: "export-module",
   };
-  const booleanFlags = new Set(["watch", "export-module", "readonly-properties", "semicolons"]);
+  const booleanFlags = new Set([
+    "watch",
+    "export-module",
+    "readonly-properties",
+    "semicolons",
+    "normalize-acronyms",
+  ]);
   const arrayFlags = new Set(["exclude-pattern", "exclude-patterns"]);
 
   for (let i = 0; i < args.length; i++) {
@@ -157,6 +164,7 @@ function finalizeOptions(options: ConfigFileOptions): CliOptions {
     readonlyProperties: options.readonlyProperties,
     quoteStyle: options.quoteStyle,
     semicolons: options.semicolons,
+    normalizeAcronyms: options.normalizeAcronyms,
   };
 }
 
@@ -174,6 +182,7 @@ function mapRawOptions(values: Map<string, string | boolean>): ParsedCliOptions
   setBoolean(options, "readonlyProperties", values.get("readonly-properties"));
   setString(options, "quoteStyle", values.get("quote-style"));
   setBoolean(options, "semicolons", values.get("semicolons"));
+  setBoolean(options, "normalizeAcronyms", values.get("normalize-acronyms"));
   return options;
 }
 

src/typesharp-ts/src/main.ts

@@ -9,5 +9,6 @@
   "dictionaryStyle": "record",
   "readonlyProperties": false,
   "quoteStyle": "double",
-  "semicolons": true
+  "semicolons": true,
+  "normalizeAcronyms": false
 }