-
Notifications
You must be signed in to change notification settings - Fork 53
Add PHPDoc annotations and PHPStan for static analysis #46
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
Co-authored-by: rkoopmans <1124992+rkoopmans@users.noreply.github.com>
Co-authored-by: rkoopmans <1124992+rkoopmans@users.noreply.github.com>
Co-authored-by: rkoopmans <1124992+rkoopmans@users.noreply.github.com>
Co-authored-by: rkoopmans <1124992+rkoopmans@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
| level: max | ||
| paths: | ||
| - lib | ||
| phpVersion: 50300 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
50300 is not supported. Minimal supported version is 70100.
| "require-dev": { | ||
| "phpunit/phpunit": "^4.8 || ^5.7 || ^6.5 || ^7.5 || ^8.4 || ^9.3" | ||
| "phpunit/phpunit": "^4.8 || ^5.7 || ^6.5 || ^7.5 || ^8.4 || ^9.3", | ||
| "phpstan/phpstan": "^1.0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a newer version, use ^2.1
Static analysis tools like PHPStan and Psalm cannot infer types from the library's untyped methods and functions.
Changes
Added comprehensive PHPDoc annotations across all library classes:
@param) - method arguments and their types@return) - including union types (int|null,int|false) and nullable types (string|null)@throws) - all throwable exceptions documented on methods that can raise themAdded PHPStan integration for automated type checking:
phpstan/phpstan: ^1.0to dev dependenciesphpstan.neonwith max level analysis targeting thelib/directoryCoverage
lib/Tinify.php- Tinify class static methods + global helper functionslib/Tinify/Source.php- factory methods, transformation methods, output methodslib/Tinify/Result.php- result data access and file operationslib/Tinify/ResultMeta.php- metadata accessorslib/Tinify/Client.php- HTTP client request handlinglib/Tinify/Exception.php- exception factoryExample
The PHPStan integration ensures that all type annotations remain accurate and catches type-related issues automatically in CI/CD.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.