README

A PHPStan error formatter that outputs errors in the TOON (Typed Object-Oriented Notation) format.

The purpose of this package is to make it easier to integrate PHPStan into your CI pipeline and reduce the amount of tokens spent when working with AI agents.

Installation

You can install the package via composer:

composer require peterfox/phpstan-toon-formatter --dev

If you have phpstan/extension-installer installed, you're all set! The formatter will be automatically registered.

If you don't use the extension installer, you can manually include the configuration in your phpstan.neon or phpstan.neon.dist file:

includes:
    - vendor/peterfox/phpstan-toon-formatter/extension.neon

Usage

To use the TOON formatter, run PHPStan with the --error-format=toon option:

vendor/bin/phpstan analyse --error-format=toon

Testing

If you want to further develop this package, please refer to the CONTRIBUTING guide.

Tests can be run using:

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Peter Fox
• All Contributors

License

The MIT License (MIT). Please see License File for more information.