Fix some cs issues and remove visitor.php from phpcs.xml.dist (#136)

* Exclude "must be overriden" from adding return never

* Remove NodeDumper

* Add missing `use` statement

* Fix some cs issues and remove visitor.php from phpcs.xml.dist

* Exclude Squiz.PHP.CommentedOutCode.Found sniff

Author: IanDelMar

finder.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return \StubsGenerator\Finder::create()
     ->in('source/wordpress')
     // Shim for load-styles.php and load-scripts.php.
@@ -41,5 +43,4 @@
     //->notPath('wp-includes/theme-compat/footer.php')
     //->notPath('wp-includes/theme-compat/header.php')
     //->notPath('wp-includes/theme-compat/sidebar.php')
-    ->sortByName()
-;
+    ->sortByName();

functionMap.php

@@ -1,8 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 $httpReturnType = 'array{headers: \WpOrg\Requests\Utility\CaseInsensitiveDictionary, body: string, response: array{code: int,message: string}, cookies: array<int, \WP_HTTP_Cookie>, filename: string|null, http_response: \WP_HTTP_Requests_Response}|\WP_Error';
 
-if (file_exists(__DIR__ . '/source/wordpress/wp-includes/Requests/Cookie/Jar.php')) {
+if (file_exists(sprintf('%s/source/wordpress/wp-includes/Requests/Cookie/Jar.php', __DIR__))) {
     $httpReturnType = 'array{headers: \Requests_Utility_CaseInsensitiveDictionary, body: string, response: array{code: int,message: string}, cookies: array<int, \WP_HTTP_Cookie>, filename: string|null, http_response: \WP_HTTP_Requests_Response}|\WP_Error';
 }
 $cronArgsType = 'list<mixed>';
@@ -81,11 +83,11 @@
     'get_attachment_taxonomies' => ["(\$output is 'names' ? array<int, string> : array<string, \WP_Taxonomy>)"],
     'get_taxonomies_for_attachments' => ["(\$output is 'names' ? array<int, string> : array<string, \WP_Taxonomy>)"],
     'get_post_stati' => ["(\$output is 'names' ? array<string, string> : array<string, \stdClass>)"],
-    'get_comment' => ["(\$comment is \WP_Comment ? array<array-key, mixed>|\WP_Comment : array<array-key, mixed>|\WP_Comment|null) & (\$output is 'ARRAY_A' ? array<string, mixed>|null : (\$output is 'ARRAY_N' ? array<int, mixed>|null : \WP_Comment|null))", 'output'=>"'OBJECT'|'ARRAY_A'|'ARRAY_N'"],
-    'get_post' => ["(\$post is \WP_Post ? array<array-key, mixed>|\WP_Post : array<array-key, mixed>|\WP_Post|null) & (\$output is 'ARRAY_A' ? array<string, mixed>|null : (\$output is 'ARRAY_N' ? array<int, mixed>|null : \WP_Post|null))", 'output'=>"'OBJECT'|'ARRAY_A'|'ARRAY_N'" ],
+    'get_comment' => ["(\$comment is \WP_Comment ? array<array-key, mixed>|\WP_Comment : array<array-key, mixed>|\WP_Comment|null) & (\$output is 'ARRAY_A' ? array<string, mixed>|null : (\$output is 'ARRAY_N' ? array<int, mixed>|null : \WP_Comment|null))", 'output' => "'OBJECT'|'ARRAY_A'|'ARRAY_N'"],
+    'get_post' => ["(\$post is \WP_Post ? array<array-key, mixed>|\WP_Post : array<array-key, mixed>|\WP_Post|null) & (\$output is 'ARRAY_A' ? array<string, mixed>|null : (\$output is 'ARRAY_N' ? array<int, mixed>|null : \WP_Post|null))", 'output' => "'OBJECT'|'ARRAY_A'|'ARRAY_N'" ],
     'get_term_by' => ["(\$output is 'ARRAY_A' ? array<string, string|int>|\WP_Error|false : (\$output is 'ARRAY_N' ? list<string|int>|\WP_Error|false : \WP_Term|\WP_Error|false))"],
     'get_page_by_path' => ["(\$output is 'ARRAY_A' ? array<string, mixed>|null : (\$output is 'ARRAY_N' ? array<int, mixed>|null : \WP_Post|null))"],
-    'get_term' => ["(\$output is 'ARRAY_A' ? array<string, string|int>|\WP_Error|null : (\$output is 'ARRAY_N' ? list<string|int>|\WP_Error|null : \WP_Term|\WP_Error|null))", 'output'=>"'OBJECT'|'ARRAY_A'|'ARRAY_N'"],
+    'get_term' => ["(\$output is 'ARRAY_A' ? array<string, string|int>|\WP_Error|null : (\$output is 'ARRAY_N' ? list<string|int>|\WP_Error|null : \WP_Term|\WP_Error|null))", 'output' => "'OBJECT'|'ARRAY_A'|'ARRAY_N'"],
     'has_action' => ['($callback is false ? bool : false|int)'],
     'has_filter' => ['($callback is false ? bool : false|int)'],
     'get_permalink' => ['($post is \WP_Post ? string : string|false)'],

phpcs.xml.dist

@@ -2,11 +2,13 @@
 <ruleset>
     <file>finder.php</file>
     <file>functionMap.php</file>
-    <file>visitor.php</file>
+    <!-- <file>visitor.php</file> -->
 
     <rule ref="PSR12NeutronRuleset">
         <exclude name="Generic.Files.LineLength"/>
         <exclude name="PEAR.Commenting.ClassComment"/>
         <exclude name="PEAR.Commenting.FileComment"/>
+        <exclude name="Squiz.PHP.CommentedOutCode.Found"/>
     </rule>
+
 </ruleset>

visitor.php

@@ -18,6 +18,7 @@
 use PhpParser\Node\Name;
 use PhpParser\Node\Expr\Exit_;
 use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Expression;
@@ -88,7 +89,7 @@ public function format(): array
                     '%s %s%s',
                     $this->tag,
                     $this->type,
-                    ($this->name !== null) ? (' $' . $this->name) : ''
+                    $this->name !== null ? " \$$this->name" : ''
                 ),
             ];
         }
@@ -113,7 +114,7 @@ public function format(): array
             return [];
         }
 
-        $name = ($this->name !== null) ? (' $' . $this->name) : '';
+        $name = $this->name !== null ? " \$$this->name" : '';
 
         if ($this->isArrayShape()) {
             $strings[] = sprintf(
@@ -143,7 +144,7 @@ public function format(): array
         $description = '';
 
         if ($this->description !== null) {
-            $description = ' ' . $this->description;
+            $description = " $this->description";
         }
 
         $strings[] = $this->isArrayShape()
@@ -210,10 +211,10 @@ public function format(int $level = 1): array
 
             if ($this->isArrayShape()) {
                 if ($this->name !== null) {
-                    $strings[] = $padding . '},';
+                    $strings[] = "$padding},";
                 }
             } else {
-                $strings[] = $padding . '}>,';
+                $strings[] = "$padding}>,";
             }
         } else {
             $strings[] = sprintf(
@@ -624,7 +625,7 @@ static function (WordPressTag $tag) use ($matchNames): bool {
     }
 
     /**
-     * @return string[]
+     * @return list<string>
      */
     private function getAdditionalTagsFromMap(string $symbolName): array
     {
@@ -866,10 +867,15 @@ private static function getTypeNameFromString(string $tagVariable): ?string
             return null;
         }
 
-        $tagVariableType = str_replace([
+        $tagVariableType = str_replace(
+            [
             'stdClass',
             '\\object',
-        ], 'object', $tagVariableType);
+            ],
+            'object',
+            $tagVariableType
+        );
+
         $supportedTypes = [
             'object',
             'array',