Add phpdoc static methods for Novu SDK to facade #13
Conversation
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
erickmcarvalho
changed the title
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.
The Laravel facades normally should include PHPDoc to specify which methods are available on the accessor class.
In case of Novu Laravel SDK, the facade accesses the
Novu\SDK\Novuclass, but doesn't have the methods listed in the facade's PHP docs.As a side effect, some IDEs and code quality tools, like PHPStan, can't identify the SDK methods when using the facade.
In this PR, I'm adding all SDK methods as the PHPDoc static methods annotation, which will instruct the IDEs and tools to know which methods are accessed by the facade, like a good practice when developing facades for Laravel.