From 4b26a2ea4f81baa1a55e8714a18976656892f70d Mon Sep 17 00:00:00 2001
From: Javier Spagnoletti <phansys@gmail.com>
Date: Sun, 23 Apr 2023 15:42:48 -0300
Subject: [PATCH] Configure "SlevomatCodingStandard.Commenting.AnnotationName"
 rule

---
 lib/Doctrine/ruleset.xml        |  2 ++
 tests/expected_report.txt       |  7 ++++---
 tests/fixed/annotation-name.php | 29 +++++++++++++++++++++++++++++
 tests/input/annotation-name.php | 29 +++++++++++++++++++++++++++++
 tests/php72-compatibility.patch | 12 ++++++------
 tests/php73-compatibility.patch | 12 ++++++------
 tests/php74-compatibility.patch | 12 ++++++------
 tests/php80-compatibility.patch | 14 +++++++-------
 8 files changed, 89 insertions(+), 28 deletions(-)
 create mode 100644 tests/fixed/annotation-name.php
 create mode 100644 tests/input/annotation-name.php

diff --git a/lib/Doctrine/ruleset.xml b/lib/Doctrine/ruleset.xml
index ed99bc4e..6a8f667d 100644
--- a/lib/Doctrine/ruleset.xml
+++ b/lib/Doctrine/ruleset.xml
@@ -181,6 +181,8 @@
     <rule ref="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming"/>
     <!-- Forbid suffix "Trait" for traits -->
     <rule ref="SlevomatCodingStandard.Classes.SuperfluousTraitNaming"/>
+    <!-- Forbid invalid annotation names in standard PHPDoc tags -->
+    <rule ref="SlevomatCodingStandard.Commenting.AnnotationName"/>
     <!-- Require specific order of phpDoc annotations with empty newline between specific groups -->
     <rule ref="SlevomatCodingStandard.Commenting.DocCommentSpacing">
         <properties>
diff --git a/tests/expected_report.txt b/tests/expected_report.txt
index 17734237..814a2c3e 100644
--- a/tests/expected_report.txt
+++ b/tests/expected_report.txt
@@ -3,12 +3,13 @@ PHP CODE SNIFFER REPORT SUMMARY
 ----------------------------------------------------------------------
 FILE                                                  ERRORS  WARNINGS
 ----------------------------------------------------------------------
+tests/input/annotation-name.php                       8       0
 tests/input/array_indentation.php                     10      0
 tests/input/arrow-functions-format.php                10      0
 tests/input/assignment-operators.php                  4       0
 tests/input/attributes.php                            15      0
 tests/input/binary_operators.php                      9       0
-tests/input/class-references.php                      10      0
+tests/input/class-references.php                      10      2
 tests/input/ClassPropertySpacing.php                  2       0
 tests/input/concatenation_spacing.php                 49      0
 tests/input/constants-no-lsb.php                      2       0
@@ -52,9 +53,9 @@ tests/input/use-ordering.php                          1       0
 tests/input/useless-semicolon.php                     2       0
 tests/input/UselessConditions.php                     21      0
 ----------------------------------------------------------------------
-A TOTAL OF 453 ERRORS AND 0 WARNINGS WERE FOUND IN 48 FILES
+A TOTAL OF 461 ERRORS AND 2 WARNINGS WERE FOUND IN 49 FILES
 ----------------------------------------------------------------------
-PHPCBF CAN FIX 375 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
+PHPCBF CAN FIX 377 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
 ----------------------------------------------------------------------
 
 
diff --git a/tests/fixed/annotation-name.php b/tests/fixed/annotation-name.php
new file mode 100644
index 00000000..6596c306
--- /dev/null
+++ b/tests/fixed/annotation-name.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+interface Foo
+{
+    /**
+     * This method does something
+     */
+    public function doSomething(array $options): void;
+
+    /**
+     * This method does not perform any action
+     */
+    public function nothing(): void;
+}
+
+final class Bar implements Foo
+{
+    /** @inheritDoc */
+    public function doSomething(array $options): void
+    {
+    }
+
+    /** {@inheritDoc} */
+    public function nothing(): void
+    {
+    }
+}
diff --git a/tests/input/annotation-name.php b/tests/input/annotation-name.php
new file mode 100644
index 00000000..d5815bb4
--- /dev/null
+++ b/tests/input/annotation-name.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+interface Foo
+{
+    /**
+     * This method does something
+     */
+    public function doSomething(array $options): void;
+
+    /**
+     * This method does not perform any action
+     */
+    public function nothing(): void;
+}
+
+final class Bar implements Foo
+{
+    /** @inheritdoc */
+    public function doSomething(array $options): void
+    {
+    }
+
+    /** {@inheritdoc} */
+    public function nothing(): void
+    {
+    }
+}
diff --git a/tests/php72-compatibility.patch b/tests/php72-compatibility.patch
index d4846cb3..841e98eb 100644
--- a/tests/php72-compatibility.patch
+++ b/tests/php72-compatibility.patch
@@ -2,7 +2,7 @@ diff --git a/tests/expected_report.txt b/tests/expected_report.txt
 index 1773423..f6e6841 100644
 --- a/tests/expected_report.txt
 +++ b/tests/expected_report.txt
-@@ -16,26 +16,23 @@ tests/input/constants-var.php                         6       0
+@@ -17,26 +17,23 @@
  tests/input/ControlStructures.php                     28      0
  tests/input/doc-comment-spacing.php                   11      0
  tests/input/duplicate-assignment-variable.php         1       0
@@ -37,7 +37,7 @@ index 1773423..f6e6841 100644
  tests/input/semicolon_spacing.php                     3       0
  tests/input/single-line-array-spacing.php             5       0
  tests/input/spread-operator.php                       6       0
-@@ -44,17 +41,16 @@ tests/input/strings.php                               3       0
+@@ -45,17 +42,16 @@
  tests/input/superfluous-naming.php                    11      0
  tests/input/test-case.php                             8       0
  tests/input/trailing_comma_on_array.php               1       0
@@ -51,11 +51,11 @@ index 1773423..f6e6841 100644
 -tests/input/UselessConditions.php                     21      0
 +tests/input/UselessConditions.php                     20      0
  ----------------------------------------------------------------------
--A TOTAL OF 453 ERRORS AND 0 WARNINGS WERE FOUND IN 48 FILES
-+A TOTAL OF 406 ERRORS AND 0 WARNINGS WERE FOUND IN 44 FILES
+-A TOTAL OF 461 ERRORS AND 2 WARNINGS WERE FOUND IN 49 FILES
++A TOTAL OF 414 ERRORS AND 2 WARNINGS WERE FOUND IN 45 FILES
  ----------------------------------------------------------------------
--PHPCBF CAN FIX 375 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
-+PHPCBF CAN FIX 328 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
+-PHPCBF CAN FIX 377 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
++PHPCBF CAN FIX 330 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
  ----------------------------------------------------------------------
  
  
diff --git a/tests/php73-compatibility.patch b/tests/php73-compatibility.patch
index 4a22e06a..2afe84c3 100644
--- a/tests/php73-compatibility.patch
+++ b/tests/php73-compatibility.patch
@@ -2,7 +2,7 @@ diff --git a/tests/expected_report.txt b/tests/expected_report.txt
 index 1773423..0ea80d5 100644
 --- a/tests/expected_report.txt
 +++ b/tests/expected_report.txt
-@@ -16,26 +16,23 @@ tests/input/constants-var.php                         6       0
+@@ -17,26 +17,23 @@
  tests/input/ControlStructures.php                     28      0
  tests/input/doc-comment-spacing.php                   11      0
  tests/input/duplicate-assignment-variable.php         1       0
@@ -37,7 +37,7 @@ index 1773423..0ea80d5 100644
  tests/input/semicolon_spacing.php                     3       0
  tests/input/single-line-array-spacing.php             5       0
  tests/input/spread-operator.php                       6       0
-@@ -44,17 +41,17 @@ tests/input/strings.php                               3       0
+@@ -45,17 +42,17 @@
  tests/input/superfluous-naming.php                    11      0
  tests/input/test-case.php                             8       0
  tests/input/trailing_comma_on_array.php               1       0
@@ -52,11 +52,11 @@ index 1773423..0ea80d5 100644
 -tests/input/UselessConditions.php                     21      0
 +tests/input/UselessConditions.php                     20      0
  ----------------------------------------------------------------------
--A TOTAL OF 453 ERRORS AND 0 WARNINGS WERE FOUND IN 48 FILES
-+A TOTAL OF 408 ERRORS AND 0 WARNINGS WERE FOUND IN 45 FILES
+-A TOTAL OF 461 ERRORS AND 2 WARNINGS WERE FOUND IN 49 FILES
++A TOTAL OF 416 ERRORS AND 2 WARNINGS WERE FOUND IN 46 FILES
  ----------------------------------------------------------------------
--PHPCBF CAN FIX 375 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
-+PHPCBF CAN FIX 330 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
+-PHPCBF CAN FIX 377 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
++PHPCBF CAN FIX 332 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
  ----------------------------------------------------------------------
  
  
diff --git a/tests/php74-compatibility.patch b/tests/php74-compatibility.patch
index aff46630..6b738d3e 100644
--- a/tests/php74-compatibility.patch
+++ b/tests/php74-compatibility.patch
@@ -2,7 +2,7 @@ diff --git a/tests/expected_report.txt b/tests/expected_report.txt
 index 1773423..9422a54 100644
 --- a/tests/expected_report.txt
 +++ b/tests/expected_report.txt
-@@ -16,26 +16,23 @@ tests/input/constants-var.php                         6       0
+@@ -17,26 +17,23 @@
  tests/input/ControlStructures.php                     28      0
  tests/input/doc-comment-spacing.php                   11      0
  tests/input/duplicate-assignment-variable.php         1       0
@@ -35,7 +35,7 @@ index 1773423..9422a54 100644
  tests/input/semicolon_spacing.php                     3       0
  tests/input/single-line-array-spacing.php             5       0
  tests/input/spread-operator.php                       6       0
-@@ -44,17 +41,17 @@ tests/input/strings.php                               3       0
+@@ -45,17 +42,17 @@
  tests/input/superfluous-naming.php                    11      0
  tests/input/test-case.php                             8       0
  tests/input/trailing_comma_on_array.php               1       0
@@ -50,11 +50,11 @@ index 1773423..9422a54 100644
 -tests/input/UselessConditions.php                     21      0
 +tests/input/UselessConditions.php                     20      0
  ----------------------------------------------------------------------
--A TOTAL OF 453 ERRORS AND 0 WARNINGS WERE FOUND IN 48 FILES
-+A TOTAL OF 417 ERRORS AND 0 WARNINGS WERE FOUND IN 45 FILES
+-A TOTAL OF 461 ERRORS AND 2 WARNINGS WERE FOUND IN 49 FILES
++A TOTAL OF 425 ERRORS AND 2 WARNINGS WERE FOUND IN 46 FILES
  ----------------------------------------------------------------------
--PHPCBF CAN FIX 375 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
-+PHPCBF CAN FIX 339 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
+-PHPCBF CAN FIX 377 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
++PHPCBF CAN FIX 341 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
  ----------------------------------------------------------------------
  
  
diff --git a/tests/php80-compatibility.patch b/tests/php80-compatibility.patch
index 6fb3f584..41fe3169 100644
--- a/tests/php80-compatibility.patch
+++ b/tests/php80-compatibility.patch
@@ -2,7 +2,7 @@ diff --git a/tests/expected_report.txt b/tests/expected_report.txt
 index 1773423..449da88 100644
 --- a/tests/expected_report.txt
 +++ b/tests/expected_report.txt
-@@ -18,7 +18,6 @@ tests/input/doc-comment-spacing.php                   11      0
+@@ -19,7 +19,6 @@
  tests/input/duplicate-assignment-variable.php         1       0
  tests/input/EarlyReturn.php                           7       0
  tests/input/example-class.php                         47      0
@@ -10,7 +10,7 @@ index 1773423..449da88 100644
  tests/input/Exceptions.php                            1       0
  tests/input/forbidden-comments.php                    14      0
  tests/input/forbidden-functions.php                   6       0
-@@ -33,7 +32,7 @@ tests/input/null_coalesce_equal_operator.php          5       0
+@@ -34,7 +33,7 @@
  tests/input/null_coalesce_operator.php                3       0
  tests/input/null_safe_operator.php                    1       0
  tests/input/optimized-functions.php                   1       0
@@ -19,15 +19,15 @@ index 1773423..449da88 100644
  tests/input/return_type_on_closures.php               26      0
  tests/input/return_type_on_methods.php                22      0
  tests/input/semicolon_spacing.php                     3       0
-@@ -52,9 +51,9 @@ tests/input/use-ordering.php                          1       0
+@@ -53,9 +52,9 @@
  tests/input/useless-semicolon.php                     2       0
  tests/input/UselessConditions.php                     21      0
  ----------------------------------------------------------------------
--A TOTAL OF 453 ERRORS AND 0 WARNINGS WERE FOUND IN 48 FILES
-+A TOTAL OF 447 ERRORS AND 0 WARNINGS WERE FOUND IN 47 FILES
+-A TOTAL OF 461 ERRORS AND 2 WARNINGS WERE FOUND IN 49 FILES
++A TOTAL OF 455 ERRORS AND 2 WARNINGS WERE FOUND IN 48 FILES
  ----------------------------------------------------------------------
--PHPCBF CAN FIX 375 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
-+PHPCBF CAN FIX 369 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
+-PHPCBF CAN FIX 377 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
++PHPCBF CAN FIX 371 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
  ----------------------------------------------------------------------