Merge branch 'master' of github.com:noximo/easycodingstandard-fileoutput

Author: noximo

README.md

@@ -1,44 +1,45 @@
-# PHPStan FileOutput
-An error formatter for [Easy Coding Standard](https://github.com/phpstan/phpstan) that exports analysis result into HTML file
+# Easy Coding Standard FileOutput
+An error formatter for [Easy Coding Standard](https://github.com/Symplify/EasyCodingStandard) that exports analysis result into HTML file
 
 ## Installation
 ```
-composer require noximo/phpstan-fileoutput
+composer require noximo/easycodingstandard-fileoutput
 ```
 
-## Usage
-Edit or create your phpstan.neon file and register new error formatter. 
-First two parameters are mandatory.
+## Setup
+Edit or create your ecs.ym file and register new output formatter. 
+
+- $outputFile - path to file where analysis will be outputted (required)
 
-- First specifies path to file in which data will be outputed.
+- $defaultFormatter - specifies which other formatter will be used with FileOutput formatter running silently in the background. You can leave it unsetted if you wish to only work with FileOutput-generated files. (optional)
 
-- Second specifies which other formatter will be used with FileOutput formatter running silently in the background. You can set it to null if you wish to only work with FileOutput-generated files.
+- $customTemplate - this argument sets custom output template. See [table.phtml](/src/table.phtml) for implementation details and data structure. (optional)
 ```
 services:
-	errorFormatter.fileoutput:  # Can be any name after errorFormatter
-		class: noximo\FileOutput(./example/phpstan.html, null) 
+  noximo\EasyCodingStandardFileoutput\FileOutputFormatter:
+    autowire: true
+    arguments:
+      $outputFile: './log/test.html'
+      $defaultFormatter: '@Symplify\EasyCodingStandard\Console\Output\TableOutputFormatter'
+      $customTemplate: './tests/alternative_table.phtml'
 ```
 
-You can (and should) specify second parameter to use one of the other formatters as well, so console output will be unaffected:
-```
-class: noximo\FileOutput(./example/phpstan.html, @errorFormatter.raw) 
-```
-At the time of writing of this readme these formatters were available by default in PHPStan:
-- ```errorFormatter.checkstyle```,  
-- ```errorFormatter.json```, 
-- ```errorFormatter.prettyJson```, 
-- ```errorFormatter.raw```, 
-- ```errorFormatter.table```
+At the time of writing of this readme these formatters were available by default in ecs:
+- ```@Symplify\EasyCodingStandard\Console\Output\TableOutputFormatter```,  
+- ```@Symplify\EasyCodingStandard\Console\Output\JsonOutputFormatter```
 
-_Check [PHPStan repository](https://github.com/phpstan/phpstan) for possible updates._ 
+_Check [Easy Coding Standard repository](https://github.com/Symplify/EasyCodingStandard) for possible updates._ 
+
+## Usage
+
+simply change --output-format argument to *file*:
 
-Third parameter sets custom output template. 
 ```
-class: noximo\FileOutput(./example/phpstan.html, null, ./tests/alternative_table.phtml) 
+vendor\bin\ecs check someDir --output-format=file
 ```
-See [table.phtml](/src/table.phtml) for implementation details and data structure. 
+
 
 ## Output
-FileOutputer will generate HTML file (assuming default template) with hyperlinks directly into PHP files where errors were encountered. If you want to leverage clickable links, set up your enviromenent according to this article: [https://tracy.nette.org/en/open-files-in-ide](https://tracy.nette.org/en/open-files-in-ide)
+FileOutput will generate HTML file (assuming default template) with hyperlinks directly into PHP files where errors were encountered. If you want to leverage clickable links, set up your enviromenent according to this article: [https://tracy.nette.org/en/open-files-in-ide](https://tracy.nette.org/en/open-files-in-ide)
 
-Note: When you fix an error, file structure and line numbers can no longer correspond to line number at the time of analysis. You'll need to re-run PHPStan to regenerate output file. Errors are outputed in descending order (line-number wise) so there's bigger chance that you won't lines out of their current positions. 
+Note: When you fix an error, file structure and line numbers can no longer correspond to line number at the time of analysis. You'll need to re-run ecs to regenerate output file. Errors are outputed in descending order (line-number wise) so there's bigger chance that you won't lines out of their current positions. 

composer.json

@@ -1,5 +1,5 @@
 {
-  "name": "noximo/ecs-fileoutput",
+  "name": "noximo/easycodingstandard-fileoutput",
   "description": "An error formatter for Easy Coding Standard that exports analysis result into HTML file",
   "keywords": [
     "Easy Coding Standard",