Merge pull request #137 from RightCapitalHQ/feature/modify-generic-ty…

…pe-parsing fix: modify generic type transpiling
RightCapitalHQ · Apr 1, 2024 · 814d010 · 814d010
2 parents 1c9aca4 + 59c143c
commit 814d010
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/change/@rightcapital-phpdoc-parser-c3a9dd19-9660-47d4-81f7-cf7e3c9def0d.json b/change/@rightcapital-phpdoc-parser-c3a9dd19-9660-47d4-81f7-cf7e3c9def0d.json
@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "fix: modify generic type parsing",
+  "packageName": "@rightcapital/phpdoc-parser",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/src/phpdoc-parser/transpiler/php-doc-to-typescript-type-transpiler.ts b/src/phpdoc-parser/transpiler/php-doc-to-typescript-type-transpiler.ts
@@ -95,8 +95,22 @@ export class PhpDocTypeNodeToTypescriptTypeNodeTranspiler {
             this.transpile(sourceTypeNode.genericTypes[0]),
           );
         }
+
         if (sourceTypeNode.genericTypes.length === 2) {
           // Record<KeyType, ValueType>
+
+          if (
+            sourceTypeNode.genericTypes[0].isIdentifierTypeNode() &&
+            ['int', 'integer', 'float', 'double'].includes(
+              sourceTypeNode.genericTypes[0].name,
+            )
+          ) {
+            // turn into regular Array like Type[]
+            return factory.createArrayTypeNode(
+              this.transpile(sourceTypeNode.genericTypes[1]),
+            );
+          }
+
           return factory.createTypeReferenceNode(
             factory.createIdentifier('Record'),
             [

diff --git a/tests/transpiler/transpiler.test.ts b/tests/transpiler/transpiler.test.ts
@@ -62,6 +62,7 @@ describe('TranspilerTest', () => {
   const commentText = `/**
     * @property-read  array|null  $person
     * @property       int         $id
+    * @property-read  \\Illuminate\\Database\\Eloquent\\Collection<int, int>  $ids
     */`;
 
   // Parse the PHPDoc comment text to get node structures.
@@ -71,6 +72,7 @@ describe('TranspilerTest', () => {
   const transpiledTypeDefinitionTestCases = [
     'person: any | null;',
     'id: number;',
+    'ids: number[];',
   ];
 
   transpiledCommentNodes.forEach((transpiledCommentNode, index) => {