init commit

Author: noximo

.gitattributes

@@ -0,0 +1,2 @@
+* linguist-vendored
+*.php linguist-vendored=false

.gitignore

@@ -0,0 +1,2 @@
+/.idea/*
+/vendor/*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Tomas Pospisil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,44 @@
+# PHPStan FileOutput
+An error formatter for [Easy Coding Standard](https://github.com/phpstan/phpstan) that exports analysis result into HTML file
+
+## Installation
+```
+composer require noximo/phpstan-fileoutput
+```
+
+## Usage
+Edit or create your phpstan.neon file and register new error formatter. 
+First two parameters are mandatory.
+
+- First specifies path to file in which data will be outputed.
+
+- 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.
+```
+services:
+	errorFormatter.fileoutput:  # Can be any name after errorFormatter
+		class: noximo\FileOutput(./example/phpstan.html, null) 
+```
+
+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```
+
+_Check [PHPStan repository](https://github.com/phpstan/phpstan) for possible updates._ 
+
+Third parameter sets custom output template. 
+```
+class: noximo\FileOutput(./example/phpstan.html, null, ./tests/alternative_table.phtml) 
+```
+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)
+
+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. 

composer.json

@@ -0,0 +1,45 @@
+{
+  "name": "noximo/ecs-fileoutput",
+  "description": "An error formatter for Easy Coding Standard that exports analysis result into HTML file",
+  "keywords": [
+    "Easy Coding Standard",
+    "Error formatter",
+    "File output"
+  ],
+  "type": "library",
+  "authors": [
+    {
+      "name": "Tomas Pospisil",
+      "email": "[email protected]"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "noximo\\EasyCodingStandardFileoutput\\": [
+        "src/",
+        "tests/"
+      ]
+    }
+  },
+  "require": {
+    "php": "^7.1",
+    "symplify/easy-coding-standard": "^5.3",
+    "nette/utils": "2.5.*"
+  },
+  "license": "MIT",
+  "require-dev": {
+    "phpstan/phpstan": "^0.10",
+    "noximo/dbgr": "dev-master"
+  },
+  "scripts": {
+    "check": [
+      "@check-cs",
+      "@phpstan"
+    ],
+    "check-cs": "ecs check src",
+    "fix-cs": "ecs check src --fix",
+    "phpstan": "phpstan analyse src --level max --error-format=fileoutput",
+    "phpstan-test": "phpstan analyse src tests --level max --error-format=fileoutput --no-progress",
+    "check-cs-test": "ecs check tests "
+  }
+}