remove rule doc examples, as description is good enough for 12 rules

symplify · Jul 25, 2023 · 4ed99b1 · 4ed99b1
1 parent 8026635
commit 4ed99b1
Show file tree

Hide file tree

Showing 14 changed files with 12 additions and 559 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,3 @@ composer require symplify/easy-coding-standard --dev
  return static function (ECSConfig $ecsConfig): void {
 +    $ecsConfig->sets([SetList::SYMPLIFY]);
 ```
-
-## Rules Overview
-
-- [Rules Overview](/docs/rules_overview.md)
diff --git a/composer.json b/composer.json
@@ -5,14 +5,12 @@
     "require": {
         "php": ">=8.1",
         "nette/utils": "^3.2",
-        "friendsofphp/php-cs-fixer": "^3.18",
-        "symplify/rule-doc-generator-contracts": "^11.1"
+        "friendsofphp/php-cs-fixer": "^3.22"
     },
     "require-dev": {
         "symplify/easy-coding-standard": "^12.0.1",
         "squizlabs/php_codesniffer": "^3.7.2",
         "phpunit/phpunit": "^10.2",
-        "symplify/rule-doc-generator": "^11.2",
         "php-parallel-lint/php-parallel-lint": "^1.3",
         "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan": "^1.10.26",
@@ -42,7 +40,6 @@
         "check-cs": "vendor/bin/ecs check --ansi",
         "fix-cs": "vendor/bin/ecs check --fix --ansi",
         "phpstan": "vendor/bin/phpstan analyse --ansi  --error-format symplify",
-        "rector": "vendor/bin/rector process --dry-run --ansi",
-        "docs": "vendor/bin/rule-doc-generator generate src --output-file docs/rules_overview.md --ansi"
+        "rector": "vendor/bin/rector process --dry-run --ansi"
     }
 }
diff --git a/docs/rules_overview.md b/docs/rules_overview.md
diff --git a/src/Fixer/Annotation/RemovePHPStormAnnotationFixer.php b/src/Fixer/Annotation/RemovePHPStormAnnotationFixer.php
@@ -12,14 +12,11 @@
 use SplFileInfo;
 use Symplify\CodingStandard\Fixer\AbstractSymplifyFixer;
 use Symplify\CodingStandard\TokenRunner\Traverser\TokenReverser;
-use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
-use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
-use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
  * @see \Symplify\CodingStandard\Tests\Fixer\Annotation\RemovePHPStormAnnotationFixer\RemovePHPStormAnnotationFixerTest
  */
-final class RemovePHPStormAnnotationFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
+final class RemovePHPStormAnnotationFixer extends AbstractSymplifyFixer
 {
     /**
      * @see https://regex101.com/r/nGZBzj/2
@@ -72,29 +69,4 @@ public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
             $tokens->clearAt($index);
         }
     }
-
-    public function getRuleDefinition(): RuleDefinition
-    {
-        return new RuleDefinition(self::ERROR_MESSAGE, [
-            new CodeSample(
-                <<<'CODE_SAMPLE'
-/**
- * Created by PhpStorm.
- * User: ...
- * Date: 17/10/17
- * Time: 8:50 AM
- */
-class SomeClass
-{
-}
-CODE_SAMPLE
-                ,
-                <<<'CODE_SAMPLE'
-class SomeClass
-{
-}
-CODE_SAMPLE
-            ),
-        ]);
-    }
 }
diff --git a/src/Fixer/ArrayNotation/ArrayListItemNewlineFixer.php b/src/Fixer/ArrayNotation/ArrayListItemNewlineFixer.php
@@ -14,14 +14,11 @@
 use Symplify\CodingStandard\TokenRunner\Arrays\ArrayItemNewliner;
 use Symplify\CodingStandard\TokenRunner\Traverser\ArrayBlockInfoFinder;
 use Symplify\CodingStandard\TokenRunner\ValueObject\TokenKinds;
-use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
-use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
-use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
  * @see \Symplify\CodingStandard\Tests\Fixer\ArrayNotation\ArrayListItemNewlineFixer\ArrayListItemNewlineFixerTest
  */
-final class ArrayListItemNewlineFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
+final class ArrayListItemNewlineFixer extends AbstractSymplifyFixer
 {
     /**
      * @var string
@@ -71,20 +68,4 @@ public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
             $this->arrayItemNewliner->fixArrayOpener($tokens, $arrayBlockInfo);
         }
     }
-
-    public function getRuleDefinition(): RuleDefinition
-    {
-        return new RuleDefinition(self::ERROR_MESSAGE, [
-            new CodeSample(
-                <<<'CODE_SAMPLE'
-$value = ['simple' => 1, 'easy' => 2];
-CODE_SAMPLE
-                ,
-                <<<'CODE_SAMPLE'
-$value = ['simple' => 1,
-'easy' => 2];
-CODE_SAMPLE
-            ),
-        ]);
-    }
 }
diff --git a/src/Fixer/ArrayNotation/ArrayOpenerAndCloserNewlineFixer.php b/src/Fixer/ArrayNotation/ArrayOpenerAndCloserNewlineFixer.php
@@ -16,14 +16,11 @@
 use Symplify\CodingStandard\TokenRunner\Traverser\ArrayBlockInfoFinder;
 use Symplify\CodingStandard\TokenRunner\ValueObject\TokenKinds;
 use Symplify\CodingStandard\ValueObject\BlockInfoMetadata;
-use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
-use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
-use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
  * @see \Symplify\CodingStandard\Tests\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer\ArrayOpenerAndCloserNewlineFixerTest
  */
-final class ArrayOpenerAndCloserNewlineFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
+final class ArrayOpenerAndCloserNewlineFixer extends AbstractSymplifyFixer
 {
     /**
      * @var string
@@ -52,23 +49,6 @@ public function getPriority(): int
         return 34;
     }
 
-    public function getRuleDefinition(): RuleDefinition
-    {
-        return new RuleDefinition(self::ERROR_MESSAGE, [
-            new CodeSample(
-                <<<'CODE_SAMPLE'
-$items = [1 => 'Hey'];
-CODE_SAMPLE
-                ,
-                <<<'CODE_SAMPLE'
-$items = [
-1 => 'Hey'
-];
-CODE_SAMPLE
-            ),
-        ]);
-    }
-
     /**
      * @param Tokens<Token> $tokens
      */