From 8161b148164eca04e96893e3c9475f5af732d602 Mon Sep 17 00:00:00 2001 From: Vincent Langlet Date: Sun, 3 Dec 2023 20:20:40 +0100 Subject: [PATCH] Add Readme about reporter (#158) --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d2a65fda..27fc25cd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Twig CS Fixer +_# Twig CS Fixer [![PHP Version](http://poser.pugx.org/vincentlanglet/twig-cs-fixer/require/php)](https://packagist.org/packages/vincentlanglet/twig-cs-fixer) [![Latest Stable Version](http://poser.pugx.org/vincentlanglet/twig-cs-fixer/v)](https://packagist.org/packages/vincentlanglet/twig-cs-fixer) @@ -157,3 +157,14 @@ $config->addTokenParser(new App\Twig\CustomTokenParser()); return $config; ``` + +### Reporter + +The `--report` option allows to choose the output format for the linter report. + +Supported formats are: +- `text` selected by default. +- `checkstyle` following the common checkstyle XML schema. +- `github` if you want annotation on GitHub actions. +- `junit` followings JUnit schema XML from Jenkins. +- `null` if you don't want any reporting.