[TypeDeclarationDocblocks] Deprecate 3 data provider docblock rules - #8235
Merged
Conversation
…oviderParamRector Data provider docblock typing is not relevant to code quality. It adds maintenance cost and lowers readability of the test class.
…tor and AddParamArrayDocblockFromDataProviderRector Same reasoning as the data provider return docblock rule: docblock typing of data providers is not relevant to code quality, costs maintenance and lowers readability. Both rules are removed from the TypeDeclarationDocblocks level.
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
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.
Data provider docblock typing is not relevant to code quality. It increases maintenance cost and decreases readability of the test class.
Deprecated rules:
AddReturnArrayDocblockFromDataProviderParamRectorAddReturnDocblockDataProviderRectorAddParamArrayDocblockFromDataProviderRectorAll three now implement
DeprecatedInterface, so registering them prints a deprecation warning;refactor()throws. Tests and fixtures are removed.The last two were part of
TypeDeclarationDocblocksLeveland are dropped from it. The first was in no set.What the rules used to do:
final class SomeTest extends TestCase { + /** + * @param string[] $names + */ #[DataProvider('provideNames')] public function test(array $names) { } + /** + * @return array<array<string>> + */ public static function provideNames(): array { return [[['John', 'Jane']]]; } }Native type rules on data providers stay untouched:
ReturnIteratorInDataProviderRectorandAddParamTypeBasedOnPHPUnitDataProviderRector.