Merge pull request #367 from morphsteve/quote-typescript-property-names

Quote non-standard object keys when transforming to Typescript
spatie · Mar 2, 2023 · ef671d7 · ef671d7
2 parents 2c7fe45 + 3419ca9
commit ef671d7
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/src/Support/TypeScriptTransformer/DataTypeScriptTransformer.php b/src/Support/TypeScriptTransformer/DataTypeScriptTransformer.php
@@ -81,6 +81,10 @@ function (string $carry, ReflectionProperty $property) use ($isOptional, $dataCl
 
                 $propertyName = $dataProperty->outputMappedName ?? $dataProperty->name;
 
+                if (! preg_match('/^[$_a-zA-Z][$_a-zA-Z0-9]*$/', $propertyName)) {
+                    $propertyName = "'{$propertyName}'";
+                }
+
                 return $isOptional
                     ? "{$carry}{$propertyName}?: {$transformed};" . PHP_EOL
                     : "{$carry}{$propertyName}: {$transformed};" . PHP_EOL;

diff --git a/tests/Support/TypeScriptTransformer/DataTypeScriptTransformerTest.php b/tests/Support/TypeScriptTransformer/DataTypeScriptTransformerTest.php
@@ -160,10 +160,12 @@ public function __construct(
 it('outputs types with properties using their mapped name', function () {
     $config = TypeScriptTransformerConfig::create();
 
-    $data = new class ('Good job Ruben') extends Data {
+    $data = new class ('Good job Ruben', 'Hi Ruben') extends Data {
         public function __construct(
             #[MapOutputName(SnakeCaseMapper::class)]
             public string $someCamelCaseProperty,
+            #[MapOutputName('some:non:standard:property')]
+            public string $someNonStandardProperty,
         ) {
         }
     };

diff --git a/...ypeScriptTransformerTest__it_outputs_types_with_properties_using_their_mapped_name__1.txt b/...ypeScriptTransformerTest__it_outputs_types_with_properties_using_their_mapped_name__1.txt
@@ -1,3 +1,4 @@
 {
 some_camel_case_property: string;
+'some:non:standard:property': string;
 }