docs: Add rule interface so we can publish docs on getrector.com#408
Merged
Conversation
PR #408 added the interface to rules extending base classes and a subset of standalone rules, but 38 concrete rules extending AbstractRector directly still lacked it. Rector's getrector.com docs build the rule filter metadata from DocumentedRuleInterface, so these rules would not be published. Adds the interface (all already define getRuleDefinition()) so every rule is documented.
getrector.com's rule-docs build rejects code samples whose 'after' (good code) is empty (Symplify AbstractCodeSample: "Good sample good code cannot be empty"), so 11 code-removal rules were being skipped and not shown on the site. Each now pairs the removed statement with an adjacent statement the rule leaves untouched, so the diff renders the removal and the after sample is non-empty. Reported by TomasVotruba.
bbrala
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
To get rule docs on getrector.php we need to extend an interface. See rectorphp/rector#9778 (comment)
Drupal.org issue
Provide a link to the issue from https://www.drupal.org/project/rector/issues. If no issue exists, please create one and link to this PR.