Download the PHP package nicksdot/phpstan-prettier-output without Composer
On this page you can find all versions of the php package nicksdot/phpstan-prettier-output. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nicksdot/phpstan-prettier-output
More information about nicksdot/phpstan-prettier-output
Files in nicksdot/phpstan-prettier-output
Package phpstan-prettier-output
Short Description Custom PHPStan formatters for a prettier output.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package phpstan-prettier-output
More Readable PHPStan Output
Important
This is a proof of concept. Things are rough, hacky and not cleaned up. However, it works.
Installation
Setup Formatters
IDE Output
If you also want prettier messages in your IDE you must override the default CheckstyleErrorFormatter. To do this,
override the service in your phpstan.non.
Wishlist
To make this package less hacky, we would need the following.
PHPStorm PHPStan Plugin
- allow custom formatter in settings
- allow line breaks in tooltip output.
- adjust processing and consumption of
PhpStanMessageProcessor.java so that inspection tooltips and inspection the inspections message window use different messages. Similar to how it already works in the HTML inspection.
Plugin repo: https://github.com/JetBrains/phpstorm-phpstan-plugin
PHPStan
Currently, we rely on Regex to re-format the reported messages (e.g. adding line-breaks). It would be nice, but it is no deal-breaker if not, if PHPStan would add support for formatted messages.
Possible approaches:
- keep track of all non
sprintf'ed messages in a static property (?) ofRuleErrorBuilder::message(). - make it a first class feature to have a formatted and unformatted variant of messages.
- add values required to build messages to
PHPStan\Command\AnalysisResult.
Considerations
Usage of "Tips"
Ondrej recommended the sole usage of "tips" output. However, this seems not sufficient for the following reasons.
- More often than not there are no "tips".
- There can be multiple tips per error.
- They are often simply external references like in the following example.
Given this example, the solution proposed by Ondrej would result in the following which is not much more readable and has the same cognitive load than before.
Using the approach from this repository, the output will result in.
So the current conclusion is, tips are not the way.
Known Issues
For some reason there are sometimes formatting issues based on the cursor postion. This would be avoidable if Jetbrains would allow line breaks as listed in the "Wishlist" section in this README.
Actual
Expected
Credits
All formatters are based on the PHPStan built-in ErrorFormatters.
Contributing
License
MIT
