Skip to content

TicketSwap/phpstan-error-formatter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

1a1f996 · Nov 11, 2024

History

38 Commits
Oct 2, 2024
Nov 11, 2024
Oct 3, 2024
Oct 2, 2024
Oct 2, 2024
Aug 26, 2024
Sep 9, 2024
Oct 30, 2024
Nov 11, 2024
Oct 3, 2024
Oct 2, 2024
Oct 2, 2024
Aug 26, 2024

Repository files navigation

A minimalistic error formatter for PHPStan

Screenshot

Latest Stable Version PHP Version Require Total Downloads License


Features

  • Every error has it's own clickable file + line link (default formatter shows the file once, and then displays the line + errors)
  • Errors don't wrap, so they take your while terminal (default formatter wraps in a table)
  • Highlighting of variables, fully qualified class names and other common types. This is done naively and there are cases where it does not work.
  • Long file paths are truncated visually (src/App/../Entity/User.php) while keeping the clickable link intact
  • The filename + line is clickable depending on your terminal and their support for clickable links. For example, in PHPStorm's built-in editor, it doesn't work and there we print file:///Volumes/CS/www/src/App/User.php.

Installation

To use this extension, require it in Composer:

composer require --dev ticketswap/phpstan-error-formatter

If you also install phpstan/extension-installer then you're all set!

Manual installation

If you don't want to use phpstan/extension-installer, include extension.neon in your project's PHPStan config:

includes:
    - vendor/ticketswap/phpstan-error-formatter/extension.neon

Usage

Configure PHPStan to use the ticketswap error formatter:

parameters:
    errorFormat: ticketswap

When you haven't done so, make sure to configure the editorUrl:

parameters:
    editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'