Provide Psalm integration #29
Merged
Conversation
This file contains 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
- Adds Psalm and psalm PHPUnit plugin as dev requirements. - Adds Psalm configuration. - Fixes low-hanging fruit reported by Psalm. - Adds Psalm baseline file. Among the low-hanging fruit were the following `LinkCollection` signature changes: - `getLinks()` gets an `array` return typehint - `getLinksByRel()` gets an `array` return typehint - `withLink()` gets a `self` return typehint - `withoutLink()` gets a `self` return typehint These are all backwards compatible, but extensions will need to provide them. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
src/HalResource.php
Outdated
| @@ -360,7 +360,7 @@ private function aggregateEmbeddedCollection(string $name, array $collection, st | |||
| * Exists as array_shift is destructive, and we cannot necessarily know the | |||
| * index of the first element. | |||
| * | |||
| * @param null|HalResource[] $resources | |||
| * @param array $resources | |||
There was a problem hiding this comment.
This is the same information like in the method signature therefore it can be omitted.
There was a problem hiding this comment.
I'm a bit surprised that Psalm did that...
src/LinkCollection.php
Outdated
| @@ -43,8 +49,10 @@ public function getLinksByRel($rel) | |||
|
|
|||
| /** | |||
| * {@inheritDoc} | |||
| * | |||
| * @return HalResource | |||
There was a problem hiding this comment.
The same here. self as return type should be enough.
Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
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.
Among the low-hanging fruit were the following
LinkCollectionsignature changes:getLinks()gets anarrayreturn typehintgetLinksByRel()gets anarrayreturn typehintwithLink()gets aselfreturn typehintwithoutLink()gets aselfreturn typehintThese are all backwards compatible, but extensions will need to provide them.
Fixes #17