Fix: Remove RuleSet\AbstractRuleSet::DOCTRINE_IGNORED_TAGS

ergebnis · Sep 17, 2023 · bab9a8d · bab9a8d
1 parent 111cebb
commit bab9a8d
Show file tree

Hide file tree

Showing 28 changed files with 218 additions and 296 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -28,6 +28,7 @@ For a full diff see [`5.15.1...main`][5.15.1...main].
 - Removed `$targetPhpVersion` field and `targetPhpVersion()` method from `Config\Ruleset\AbstractRuleSet` ([#866]), by [@localheinz]
 - Removed `name()` method from `Config\Ruleset\AbstractRuleSet` ([#867]), by [@localheinz]
 - Removed `rules()` method from `Config\Ruleset\AbstractRuleSet` ([#868]), by [@localheinz]
+- Removed `DOCTRINE_IGNORED_TAGS` constant from `Config\Ruleset\AbstractRuleSet` ([#875]), by [@localheinz]
 
 ## [`5.15.1`][5.15.1]
 
@@ -1172,6 +1173,7 @@ For a full diff see [`d899e77...1.0.0`][d899e77...1.0.0].
 [#871]: https://github.com/ergebnis/php-cs-fixer-config/pull/871
 [#872]: https://github.com/ergebnis/php-cs-fixer-config/pull/872
 [#874]: https://github.com/ergebnis/php-cs-fixer-config/pull/874
+[#875]: https://github.com/ergebnis/php-cs-fixer-config/pull/875
 
 [@dependabot]: https://github.com/apps/dependabot
 [@linuxjuggler]: https://github.com/linuxjuggler

diff --git a/src/RuleSet/AbstractRuleSet.php b/src/RuleSet/AbstractRuleSet.php
@@ -17,106 +17,6 @@
 
 abstract class AbstractRuleSet implements RuleSet
 {
-    /**
-     * A list of tags that should be ignored by fixers related to Doctrine.
-     *
-     * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v3.1.0/doc/rules/doctrine_annotation/doctrine_annotation_array_assignment.rst
-     * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v3.1.0/doc/rules/doctrine_annotation/doctrine_annotation_braces.rst
-     * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v3.1.0/doc/rules/doctrine_annotation/doctrine_annotation_indentation.rst
-     * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v3.1.0/doc/rules/doctrine_annotation/doctrine_annotation_spaces.rst
-     */
-    protected const DOCTRINE_IGNORED_TAGS = [
-        'abstract',
-        'access',
-        'after',
-        'afterClass',
-        'api',
-        'author',
-        'backupGlobals',
-        'backupStaticAttributes',
-        'before',
-        'beforeClass',
-        'category',
-        'code',
-        'codeCoverageIgnore',
-        'codeCoverageIgnoreEnd',
-        'codeCoverageIgnoreStart',
-        'copyright',
-        'covers',
-        'coversDefaultClass',
-        'coversNothing',
-        'dataProvider',
-        'depends',
-        'deprec',
-        'deprecated',
-        'encode',
-        'enduml',
-        'example',
-        'exception',
-        'expectedException',
-        'expectedExceptionCode',
-        'expectedExceptionMessage',
-        'expectedExceptionMessageRegExp',
-        'filesource',
-        'final',
-        'fix',
-        'FIXME',
-        'fixme',
-        'global',
-        'group',
-        'ignore',
-        'ingroup',
-        'inheritdoc',
-        'inheritDoc',
-        'internal',
-        'large',
-        'license',
-        'link',
-        'magic',
-        'medium',
-        'method',
-        'name',
-        'noinspection',
-        'override',
-        'package',
-        'package_version',
-        'param',
-        'preserveGlobalState',
-        'private',
-        'property',
-        'property-read',
-        'property-write',
-        'requires',
-        'return',
-        'runInSeparateProcess',
-        'runTestsInSeparateProcesses',
-        'see',
-        'since',
-        'small',
-        'source',
-        'startuml',
-        'static',
-        'staticvar',
-        'staticVar',
-        'subpackage',
-        'SuppressWarnings',
-        'template',
-        'test',
-        'testdox',
-        'throw',
-        'throws',
-        'ticket',
-        'toc',
-        'todo',
-        'TODO',
-        'tutorial',
-        'usedBy',
-        'uses',
-        'uses',
-        'var',
-        'version',
-    ];
-
     /**
      * @var array<string, array<string, mixed>|bool>
      */

diff --git a/src/RuleSet/Doctrine.php b/src/RuleSet/Doctrine.php
@@ -0,0 +1,120 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2019-2023 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/php-cs-fixer-config
+ */
+
+namespace Ergebnis\PhpCsFixer\Config\RuleSet;
+
+/**
+ * @internal
+ */
+final class Doctrine
+{
+    /**
+     * A list of tags that should be ignored by fixers related to Doctrine.
+     *
+     * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v3.1.0/doc/rules/doctrine_annotation/doctrine_annotation_array_assignment.rst
+     * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v3.1.0/doc/rules/doctrine_annotation/doctrine_annotation_braces.rst
+     * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v3.1.0/doc/rules/doctrine_annotation/doctrine_annotation_indentation.rst
+     * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v3.1.0/doc/rules/doctrine_annotation/doctrine_annotation_spaces.rst
+     */
+    public const IGNORED_TAGS = [
+        'abstract',
+        'access',
+        'after',
+        'afterClass',
+        'api',
+        'author',
+        'backupGlobals',
+        'backupStaticAttributes',
+        'before',
+        'beforeClass',
+        'category',
+        'code',
+        'codeCoverageIgnore',
+        'codeCoverageIgnoreEnd',
+        'codeCoverageIgnoreStart',
+        'copyright',
+        'covers',
+        'coversDefaultClass',
+        'coversNothing',
+        'dataProvider',
+        'depends',
+        'deprec',
+        'deprecated',
+        'encode',
+        'enduml',
+        'example',
+        'exception',
+        'expectedException',
+        'expectedExceptionCode',
+        'expectedExceptionMessage',
+        'expectedExceptionMessageRegExp',
+        'filesource',
+        'final',
+        'fix',
+        'FIXME',
+        'fixme',
+        'global',
+        'group',
+        'ignore',
+        'ingroup',
+        'inheritdoc',
+        'inheritDoc',
+        'internal',
+        'large',
+        'license',
+        'link',
+        'magic',
+        'medium',
+        'method',
+        'name',
+        'noinspection',
+        'override',
+        'package',
+        'package_version',
+        'param',
+        'preserveGlobalState',
+        'private',
+        'property',
+        'property-read',
+        'property-write',
+        'requires',
+        'return',
+        'runInSeparateProcess',
+        'runTestsInSeparateProcesses',
+        'see',
+        'since',
+        'small',
+        'source',
+        'startuml',
+        'static',
+        'staticvar',
+        'staticVar',
+        'subpackage',
+        'SuppressWarnings',
+        'template',
+        'test',
+        'testdox',
+        'throw',
+        'throws',
+        'ticket',
+        'toc',
+        'todo',
+        'TODO',
+        'tutorial',
+        'usedBy',
+        'uses',
+        'uses',
+        'var',
+        'version',
+    ];
+}
diff --git a/src/RuleSet/Php53.php b/src/RuleSet/Php53.php
@@ -120,15 +120,15 @@ final class Php53 extends AbstractRuleSet implements ExplicitRuleSet
         'declare_strict_types' => true,
         'dir_constant' => true,
         'doctrine_annotation_array_assignment' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'operator' => ':',
         ],
         'doctrine_annotation_braces' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'syntax' => 'without_braces',
         ],
         'doctrine_annotation_indentation' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'indent_mixed_lines' => false,
         ],
         'doctrine_annotation_spaces' => [
@@ -140,7 +140,7 @@ final class Php53 extends AbstractRuleSet implements ExplicitRuleSet
             'before_argument_assignments' => false,
             'before_array_assignments_colon' => false,
             'before_array_assignments_equals' => false,
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
         ],
         'echo_tag_syntax' => [
             'format' => 'long',

diff --git a/src/RuleSet/Php54.php b/src/RuleSet/Php54.php
@@ -121,15 +121,15 @@ final class Php54 extends AbstractRuleSet implements ExplicitRuleSet
         'declare_strict_types' => true,
         'dir_constant' => true,
         'doctrine_annotation_array_assignment' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'operator' => ':',
         ],
         'doctrine_annotation_braces' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'syntax' => 'without_braces',
         ],
         'doctrine_annotation_indentation' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'indent_mixed_lines' => false,
         ],
         'doctrine_annotation_spaces' => [
@@ -141,7 +141,7 @@ final class Php54 extends AbstractRuleSet implements ExplicitRuleSet
             'before_argument_assignments' => false,
             'before_array_assignments_colon' => false,
             'before_array_assignments_equals' => false,
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
         ],
         'echo_tag_syntax' => [
             'format' => 'long',

diff --git a/src/RuleSet/Php55.php b/src/RuleSet/Php55.php
@@ -123,15 +123,15 @@ final class Php55 extends AbstractRuleSet implements ExplicitRuleSet
         'declare_strict_types' => true,
         'dir_constant' => true,
         'doctrine_annotation_array_assignment' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'operator' => ':',
         ],
         'doctrine_annotation_braces' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'syntax' => 'without_braces',
         ],
         'doctrine_annotation_indentation' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'indent_mixed_lines' => false,
         ],
         'doctrine_annotation_spaces' => [
@@ -143,7 +143,7 @@ final class Php55 extends AbstractRuleSet implements ExplicitRuleSet
             'before_argument_assignments' => false,
             'before_array_assignments_colon' => false,
             'before_array_assignments_equals' => false,
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
         ],
         'echo_tag_syntax' => [
             'format' => 'long',

diff --git a/src/RuleSet/Php56.php b/src/RuleSet/Php56.php
@@ -123,15 +123,15 @@ final class Php56 extends AbstractRuleSet implements ExplicitRuleSet
         'declare_strict_types' => true,
         'dir_constant' => true,
         'doctrine_annotation_array_assignment' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'operator' => ':',
         ],
         'doctrine_annotation_braces' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'syntax' => 'without_braces',
         ],
         'doctrine_annotation_indentation' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'indent_mixed_lines' => false,
         ],
         'doctrine_annotation_spaces' => [
@@ -143,7 +143,7 @@ final class Php56 extends AbstractRuleSet implements ExplicitRuleSet
             'before_argument_assignments' => false,
             'before_array_assignments_colon' => false,
             'before_array_assignments_equals' => false,
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
         ],
         'echo_tag_syntax' => [
             'format' => 'long',

diff --git a/src/RuleSet/Php70.php b/src/RuleSet/Php70.php
@@ -123,15 +123,15 @@ final class Php70 extends AbstractRuleSet implements ExplicitRuleSet
         'declare_strict_types' => true,
         'dir_constant' => true,
         'doctrine_annotation_array_assignment' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'operator' => ':',
         ],
         'doctrine_annotation_braces' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'syntax' => 'without_braces',
         ],
         'doctrine_annotation_indentation' => [
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
             'indent_mixed_lines' => false,
         ],
         'doctrine_annotation_spaces' => [
@@ -143,7 +143,7 @@ final class Php70 extends AbstractRuleSet implements ExplicitRuleSet
             'before_argument_assignments' => false,
             'before_array_assignments_colon' => false,
             'before_array_assignments_equals' => false,
-            'ignored_tags' => self::DOCTRINE_IGNORED_TAGS,
+            'ignored_tags' => Doctrine::IGNORED_TAGS,
         ],
         'echo_tag_syntax' => [
             'format' => 'long',