init

Author: noximo

.gitignore

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

README.md

@@ -1,2 +1,31 @@
 # PHPStan FileOutput
 An error formatter for 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 parameter is mandatory and specifies path to file in which data will be outputed.
+```
+services:
+	errorFormatter.fileoutput:  # Can be any name after errorFormatter
+		class: noximo\FileOutput(./example/phpstan.html) 
+```
+
+You can add second parameter to use one of the other formatters as well, so console output can be unaffected:
+```
+class: noximo\FileOutput(./example/phpstan.html, @errorFormatter.raw) 
+```
+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,42 @@
+{
+  "name": "noximo/phpstan-fileoutput",
+  "description": "An error formatter for PHPStan that exports analysis result into HTML file",
+  "keywords": [
+    "PHPStan",
+    "Error formatter",
+    "File output"
+  ],
+  "type": "library",
+  "authors": [
+    {
+      "name": "Tomas Pospisil",
+      "email": "[email protected]"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "noximo\\": [
+        "src/",
+        "tests/"
+      ]
+    }
+  },
+  "require": {
+    "php": "^7.1",
+    "phpstan/phpstan": "^0.10"
+  },
+  "license": "MIT",
+  "require-dev": {
+    "symplify/easy-coding-standard": "^5.1"
+  },
+  "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"
+  }
+}