Merge pull request #9 from worksome/feat-ignore-description-on-base-t…

…ypes

Add support for ignoring root type names

src/Inspections/DescriptionRequiredInspection.php

@@ -18,11 +18,13 @@
 use Worksome\Graphlint\InspectionDescription;
 use Worksome\Graphlint\ProblemsHolder;
 use Worksome\Graphlint\Utils\ApolloFederationChecker;
+use Worksome\Graphlint\Utils\RootTypeChecker;
 
 class DescriptionRequiredInspection extends Inspection
 {
     public function __construct(
         private readonly ApolloFederationChecker $apolloFederationChecker,
+        private readonly RootTypeChecker $baseTypeChecker,
     ) {
     }
 
@@ -100,6 +102,10 @@ private function visitDefinition(Node $node, ProblemsHolder $problemsHolder): vo
             return;
         }
 
+        if ($this->baseTypeChecker->isRootName($node->name)) {
+            return;
+        }
+
         if ($this->apolloFederationChecker->isApolloDefinitionName($node->name)) {
             return;
         }

src/Utils/RootTypeChecker.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Worksome\Graphlint\Utils;
+
+use GraphQL\Language\AST\NameNode;
+
+class RootTypeChecker
+{
+    public function __construct(
+        private readonly NodeNameResolver $nameResolver,
+    ) {
+    }
+
+    public function isRootName(NameNode $nameNode): bool
+    {
+        $name = $this->nameResolver->getName($nameNode);
+
+        if ($name === null) {
+            return false;
+        }
+
+        return RootTypeName::tryFrom($name) !== null;
+    }
+}

src/Utils/RootTypeName.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Worksome\Graphlint\Utils;
+
+enum RootTypeName: string
+{
+    case Query = 'Query';
+    case Mutation = "Mutation";
+}

test-resources/Inspections/DescriptionRequiredInspectionTest/mutation_query_type.skip.graphql.inc

@@ -0,0 +1,2 @@
+type Query
+type Mutation

tests/Pest.php

@@ -66,10 +66,11 @@
     );
 
     if (Str::endsWith($smartFileInfo->getRealPath(), '.skip.graphql.inc')) {
-        Collection::make($result->getProblemsHolder()->getProblems())
+        $descriptions = Collection::make($result->getProblemsHolder()->getProblems())
             ->map(fn(ProblemDescriptor $descriptor) => $descriptor->getDescription())
-            ->dump();
-        expect($result->getProblemsHolder()->getProblems())->toHaveCount(0);
+            ->all();
+        expect($descriptions)->toEqual([])
+            ->and($result->getProblemsHolder()->getProblems())->toHaveCount(0);
         return;
     }