refactor(!): remove 'package' annotation from DocBlock examples and update package description in composer.json

Author: jackd248

.gitignore

@@ -3,6 +3,7 @@
 /.php-cs-fixer.cache
 /.phpunit.result.cache
 /.build
+/coverage-report
 /php-cs-fixer.xml
 /phpstan.xml
 /site

README.md

@@ -36,7 +36,6 @@ class MyClass
  * MyClass.
  *
  * @author Your Name <your@email.org>
- * @package MyPackage
  */
 class MyClass
 {
@@ -58,6 +57,9 @@ composer require --dev konradmichalik/php-doc-block-header-fixer
 
 Add the PHP-CS-Fixer rule in your `.php-cs-fixer.php` file:
 
+> [!NOTE]
+> This fixer is compatible with standard PHP-CS-Fixer rules. It avoids adding annotations that conflict with rules like `phpdoc_no_package` and follows spacing conventions compatible with `phpdoc_separation`.
+
 ```php
 <?php
 // ...
@@ -71,7 +73,6 @@ return (new PhpCsFixer\Config())
             'annotations' => [
                 'author' => 'Konrad Michalik <hej@konradmichalik.dev>',
                 'license' => 'GPL-3.0-or-later',
-                'package' => 'PhpDocBlockHeaderFixer',
             ],
             'preserve_existing' => true,
             'separate' => 'none',
@@ -96,7 +97,6 @@ return (new PhpCsFixer\Config())
             [
                 'author' => 'Konrad Michalik <hej@konradmichalik.dev>',
                 'license' => 'GPL-3.0-or-later',
-                'package' => 'PhpDocBlockHeaderFixer',
             ],
             preserveExisting: true,
             separate: \KonradMichalik\PhpDocBlockHeaderFixer\Enum\Separate::None,

composer.json

@@ -1,6 +1,6 @@
 {
 	"name": "konradmichalik/php-doc-block-header-fixer",
-	"description": "",
+	"description": "This packages contains a PHP-CS-Fixer rule to automatically fix the class header regarding PHP DocBlocks.",
 	"license": "GPL-3.0-or-later",
 	"type": "library",
 	"authors": [

tests/src/Generators/DocBlockHeaderTest.php

@@ -125,7 +125,6 @@ public function testValidateAnnotationsWithValidKeys(): void
             'license' => 'MIT',
             'version' => '1.0.0',
             'since' => '1.0.0',
-            'package' => 'MyPackage',
             'subpackage' => 'SubPackage',
             'see' => 'https://example.com',
             'link' => 'https://example.com',

tests/src/Rules/DocBlockHeaderFixerTest.php

@@ -97,10 +97,9 @@ public function testBuildDocBlockWithMultipleAnnotations(): void
         $result = $method->invoke($this->fixer, [
             'author' => 'John Doe <john@example.com>',
             'license' => 'MIT',
-            'package' => 'MyPackage',
         ], '');
 
-        $expected = "/**\n * @author John Doe <john@example.com>\n * @license MIT\n * @package MyPackage\n */";
+        $expected = "/**\n * @author John Doe <john@example.com>\n * @license MIT\n */";
         self::assertSame($expected, $result);
     }