Add doc

Author: arxeiss

README.md

@@ -48,23 +48,24 @@ This is a fork of [original project](https://github.com/JakubOnderka/PHP-Paralle
 
 ## Options for run
 
-- `-p <php>`        Specify PHP-CGI executable to run (default: 'php').
-- `-s, --short`     Set short_open_tag to On (default: Off).
-- `-a, --asp`        Set asp_tags to On (default: Off).
-- `-e <ext>`        Check only files with selected extensions separated by comma. (default: php,php3,php4,php5,phtml,phpt)
-- `--exclude`       Exclude a file or directory. If you want exclude multiple items, use multiple exclude parameters.
-- `-j <num>`        Run <num> jobs in parallel (default: 10).
-- `--colors`        Force enable colors in console output.
-- `--no-colors`     Disable colors in console output.
-- `--no-progress`   Disable progress in console output.
-- `--checkstyle`    Output results as Checkstyle XML.
-- `--json`          Output results as JSON string (require PHP 5.4).
-- `--blame`         Try to show git blame for row with error.
-- `--git <git>`     Path to Git executable to show blame message (default: 'git').
-- `--stdin`         Load files and folder to test from standard input.
-- `--ignore-fails`  Ignore failed tests.
-- `-h, --help`      Print this help.
-- `-V, --version`   Display this application version.
+- `-p <php>`        		Specify PHP-CGI executable to run (default: 'php').
+- `-s, --short`     		Set short_open_tag to On (default: Off).
+- `-a, --asp`       		Set asp_tags to On (default: Off).
+- `-e <ext>`        		Check only files with selected extensions separated by comma. (default: php,php3,php4,php5,phtml,phpt)
+- `--exclude`       		Exclude a file or directory. If you want exclude multiple items, use multiple exclude parameters.
+- `-j <num>`        		Run <num> jobs in parallel (default: 10).
+- `--colors`        		Force enable colors in console output.
+- `--no-colors`     		Disable colors in console output.
+- `--no-progress`   		Disable progress in console output.
+- `--checkstyle`    		Output results as Checkstyle XML.
+- `--json`          		Output results as JSON string (require PHP 5.4).
+- `--blame`         		Try to show git blame for row with error.
+- `--git <git>`     		Path to Git executable to show blame message (default: 'git').
+- `--stdin`         		Load files and folder to test from standard input.
+- `--ignore-fails`  		Ignore failed tests.
+- `--syntax-error-callback` File with syntax error callback for ability to modify error, see more in [example](doc/syntax-error-callback.md)
+- `-h, --help`      		Print this help.
+- `-V, --version`   		Display this application version.
 
 
 ## Recommended setting for usage with Symfony framework

doc/syntax-error-callback.md

@@ -0,0 +1,31 @@
+# Syntax Error Callback
+
+1. Set a path to a file with custom error callback to `--syntax-error-callback` option.
+1. Create a class implementing `JakubOnderka\PhpParallelLint\Contracts\SyntaxErrorCallback` interface. File with the class must have the same name as the class inside.
+1. Modify error before it is printed to the output.
+
+## Configuration
+
+File `MyCustomErrorHandler.php` will be passed as an argument like `./parallel-lint --syntax-error-callback ./path/to/MyCustomErrorHandler.php .`.
+The content should look like:
+
+```php
+
+use JakubOnderka\PhpParallelLint\Contracts\SyntaxErrorCallback;
+use JakubOnderka\PhpParallelLint\SyntaxError;
+
+class MyCustomErrorHandler implements SyntaxErrorCallback {
+	/**
+     * @param SyntaxError $error
+     * @return SyntaxError
+     */
+    public function errorFound(SyntaxError $error){
+    	// Return new SyntaxError with custom modification to FilePath or Message
+    	// Or return completely new SyntaxError extending the original one...
+    	return new SyntaxError(
+    		$error->getFilePath(),
+    		$error->getMessage()
+    	);
+    }
+}
+```

src/Application.php

@@ -92,7 +92,7 @@ private function showOptions()
     --git <git>             Path to Git executable to show blame message (default: 'git').
     --stdin                 Load files and folder to test from standard input.
     --ignore-fails          Ignore failed tests.
-    --syntax-error-callback File with syntax error callback for modifying error
+    --syntax-error-callback File with syntax error callback for ability to modify error
     -h, --help              Print this help.
     -V, --version           Display this application version