Merge pull request #42 from innocenzi/feat/enums-in-default-transformer

feat: add `EnumCollector`

src/Collectors/DefaultCollector.php

@@ -40,7 +40,7 @@ protected function resolveAlreadyTransformedType(ClassTypeReflector $reflector):
 
         $transpiler = new TranspileTypeToTypeScriptAction(
             $missingSymbols,
-            $name,
+            $name
         );
 
         return TransformedType::create(

src/Collectors/EnumCollector.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Spatie\TypeScriptTransformer\Collectors;
+
+use BackedEnum;
+use ReflectionClass;
+use Spatie\TypeScriptTransformer\Structures\TransformedType;
+use Spatie\TypeScriptTransformer\Transformers\EnumTransformer;
+use Spatie\TypeScriptTransformer\TypeReflectors\ClassTypeReflector;
+
+class EnumCollector extends DefaultCollector
+{
+    public function getTransformedType(ReflectionClass $class): ?TransformedType
+    {
+        $transformers = array_map('get_class', $this->config->getTransformers());
+
+        if (! \in_array(EnumTransformer::class, $transformers, true)) {
+            return null;
+        }
+
+        $reflector = ClassTypeReflector::create($class);
+
+        if (! $reflector->getReflectionClass()->implementsInterface(BackedEnum::class)) {
+            return null;
+        }
+
+        $transformedType = $reflector->getType()
+            ? $this->resolveAlreadyTransformedType($reflector)
+            : $this->resolveTypeViaTransformer($reflector);
+
+        if ($reflector->isInline()) {
+            $transformedType->name = null;
+            $transformedType->isInline = true;
+        }
+
+        return $transformedType;
+    }
+}

tests/Collectors/EnumCollectorTest.php

@@ -0,0 +1,26 @@
+<?php
+
+use function PHPUnit\Framework\assertEquals;
+use function PHPUnit\Framework\assertNotNull;
+use Spatie\TypeScriptTransformer\Collectors\EnumCollector;
+use Spatie\TypeScriptTransformer\Tests\FakeClasses\BackedEnumWithoutAnnotation;
+
+use Spatie\TypeScriptTransformer\Transformers\EnumTransformer;
+use Spatie\TypeScriptTransformer\TypeScriptTransformerConfig;
+
+it('collects backed enums', function () {
+    $collector = new EnumCollector(
+        TypeScriptTransformerConfig::create()->transformers([
+            EnumTransformer::class,
+        ])
+    );
+
+    $reflection = new ReflectionClass(BackedEnumWithoutAnnotation::class);
+    $transformedType = $collector->getTransformedType($reflection);
+
+    assertNotNull($transformedType);
+    assertEquals(
+        "'foo' | 'bar'",
+        $transformedType->transformed,
+    );
+})->skip(version_compare(PHP_VERSION, '8.1', '<'), 'Enums are a PHP 8.1+ feature.');

tests/FakeClasses/BackedEnumWithoutAnnotation.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Spatie\TypeScriptTransformer\Tests\FakeClasses;
+
+enum BackedEnumWithoutAnnotation: string
+{
+    case FOO = 'foo';
+    case BAR = 'bar';
+}