4
4
[ ![ Build Status] ( https://travis-ci.org/php-parallel-lint/PHP-Parallel-Lint.svg?branch=master )] ( https://travis-ci.org/php-parallel-lint/PHP-Parallel-Lint )
5
5
[ ![ License] ( https://poser.pugx.org/php-parallel-lint/php-parallel-lint/license.svg )] ( https://packagist.org/packages/php-parallel-lint/php-parallel-lint )
6
6
7
- This tool checks syntax of PHP files faster than serial check with a fancier output.
7
+ This application checks syntax of PHP files in parallel.
8
+ It can output in plain text, colored text, json and checksyntax formats.
9
+ Additionally ` blame ` can be used to show commits that introduced the breakage.
10
+
8
11
Running parallel jobs in PHP is inspired by Nette framework tests.
9
12
10
- This works from PHP 5.4 to 7.4
13
+ The application is officially supported for use with PHP 5.4 to 8.0.
11
14
12
15
## Table of contents
13
16
14
17
1 . [ Installation] ( #installation )
15
18
2 . [ Example output] ( #example-output )
16
- 3 . [ Fork ] ( #fork )
17
- 4 . [ Options for run ] ( #options-for-run )
18
- 5 . [ Options for Symfony] ( #recommended-setting -for-usage-with -symfony-framework )
19
+ 3 . [ History ] ( #history )
20
+ 4 . [ Command line options ] ( #command-line-options )
21
+ 5 . [ Recommended excludes for Symfony framework ] ( #recommended-excludes -for-symfony-framework )
19
22
6 . [ Create Phar package] ( #create-phar-package )
20
- 7 . [ How upgrade] ( #how-upgrade )
23
+ 7 . [ How to upgrade] ( #how-to -upgrade )
21
24
22
25
## Installation
23
26
24
- Just run the following command to install it :
27
+ Install with ` composer ` as development dependency :
25
28
26
29
composer require --dev php-parallel-lint/php-parallel-lint
27
30
28
- When you cannot use tool as dependency then you can install as project. Command for it :
31
+ Alternatively you can install as a standalone ` composer ` project :
29
32
30
33
composer create-project php-parallel-lint/php-parallel-lint /path/to/folder/php-parallel-lint
31
34
/path/to/folder/php-parallel-lint/parallel-lint # running tool
32
35
33
- For colored output also install the suggested package ` php-parallel-lint/php-console-highlighter ` :
36
+ For colored output, install the suggested package ` php-parallel-lint/php-console-highlighter ` :
34
37
35
38
composer require --dev php-parallel-lint/php-console-highlighter
36
39
@@ -39,14 +42,27 @@ For colored output also install the suggested package `php-parallel-lint/php-con
39
42
![ Example use of tool with error] ( /tests/examples/example-images/use-error.png?raw=true " Example use of tool with error ")
40
43
41
44
42
- ## Fork
43
- This is a fork of [ original project] ( https://github.com/JakubOnderka/PHP-Parallel-Lint ) . Why I forked it and why I am the right man?
45
+ ## History
46
+
47
+ This project was originally created by [ @JakubOnderka ] and released as
48
+ [ jakub-onderka/php-parallel-lint] .
49
+
50
+ Since then, Jakub has moved on to other interests and as of January 2020, the
51
+ second most active maintainer [ @grogy ] has taken over maintenance of the project
52
+ and given the project - and related dependencies - a new home in the PHP
53
+ Parallel Lint organisation.
54
+
55
+ It is strongly recommended for existing users of the (unmaintained)
56
+ [ jakub-onderka/php-parallel-lint] package to switch their dependency to
57
+ [ php-parallel-lint/php-parallel-lint] .
44
58
45
- - Project is used in many and projects.
46
- - I am [ second most active] ( https://github.com/JakubOnderka/PHP-Parallel-Lint/graphs/contributors ) contributor in original project.
47
- - Author does [ not responds to issues and PRs] ( https://github.com/JakubOnderka/PHP-Parallel-Lint/pulls ) and my mail messages.
59
+ [ php-parallel-lint/php-parallel-lint ] : https://github.com/php-parallel-lint/PHP-Parallel-Lint
60
+ [ grogy/php-parallel-lint ] : https://github.com/grogy/PHP-Parallel-Lint
61
+ [ jakub-onderka/php-parallel-lint ] : https://github.com/JakubOnderka/PHP-Parallel-Lint
62
+ [ @JakubOnderka ] : https://github.com/JakubOnderka
63
+ [ @grogy ] : https://github.com/grogy
48
64
49
- ## Options for run
65
+ ## Command line options
50
66
51
67
- ` -p <php> ` Specify PHP-CGI executable to run (default: 'php').
52
68
- ` -s, --short ` Set short_open_tag to On (default: Off).
@@ -58,7 +74,7 @@ This is a fork of [original project](https://github.com/JakubOnderka/PHP-Paralle
58
74
- ` --no-colors ` Disable colors in console output.
59
75
- ` --no-progress ` Disable progress in console output.
60
76
- ` --checkstyle ` Output results as Checkstyle XML.
61
- - ` --json ` Output results as JSON string (require PHP 5.4).
77
+ - ` --json ` Output results as JSON string (requires PHP 5.4).
62
78
- ` --blame ` Try to show git blame for row with error.
63
79
- ` --git <git> ` Path to Git executable to show blame message (default: 'git').
64
80
- ` --stdin ` Load files and folder to test from standard input.
@@ -68,9 +84,9 @@ This is a fork of [original project](https://github.com/JakubOnderka/PHP-Paralle
68
84
- ` -V, --version ` Display this application version.
69
85
70
86
71
- ## Recommended setting for usage with Symfony framework
87
+ ## Recommended excludes for Symfony framework
72
88
73
- For run from command line:
89
+ To run from the command line:
74
90
75
91
vendor/bin/parallel-lint --exclude app --exclude vendor .
76
92
@@ -82,14 +98,14 @@ PHP Parallel Lint supports [Box app](https://box-project.github.io/box2/) for cr
82
98
curl -LSs https://box-project.github.io/box2/installer.php | php
83
99
84
100
85
- and then run this command in parallel lint folder, which creates ` parallel-lint.phar ` file.
101
+ then run the build command in parallel lint folder, which creates ` parallel-lint.phar ` file.
86
102
87
103
88
104
box build
89
105
90
- ## How upgrade
106
+ ## How to upgrade
91
107
92
- Are you using original package? You can easy use this fork. Steps for upgrade are :
108
+ Are you using ` jakub-onderka/php-parallel-lint ` package? You can switch to ` php-parallel-lint/php-parallel-lint ` using :
93
109
94
110
composer remove --dev jakub-onderka/php-parallel-lint
95
111
composer require --dev php-parallel-lint/php-parallel-lint
0 commit comments