Skip to content

Commit 159d41b

Browse files
committed
Wiki/Requirements: add more info about recommendations and links to other wiki docs
1 parent 1db2835 commit 159d41b

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

wiki/Requirements.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Additionally, PHP_CodeSniffer requires the following PHP extensions to be enable
99

1010
The following PHP extensions are not required, but are strongly recommended:
1111
- [DOM][dom]: used for displaying the sniff documentation via the `--generator=...` option.
12-
- [iconv]: used for accurate character length calculation in files containing multibyte characters. Without this extension, some sniffs, like `Generic.Files.LineLength`, may report incorrect results for lines containing non-ASCII characters, as PHP_CodeSniffer will fall back to byte-based length calculations.
13-
- [json]: required for the cache functionality, as well as for the JSON report output.
12+
- [iconv]: used for accurate character length calculation in files containing multibyte characters. Without this extension, some sniffs, like `Generic.Files.LineLength`, may report incorrect results for lines containing non-ASCII characters, as PHP_CodeSniffer will fall back to byte-based length calculations. Additionally, the following reports may not work correctly without this extension: [Checkstyle][wiki-report-checkstyle], [JUnit][wiki-report-junit] and [XML][wiki-report-xml].
13+
- [json]: required for the cache functionality, as well as for the [JSON report][wiki-report-json] output.
1414
- [PCNTL][pcntl]: required for parallel processing via the `--parallel` CLI option. Without this extension, PHP_CodeSniffer will not be able to check multiple files simultaneously.
1515

16-
Individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options) manual page for a list of these requirements.
16+
Individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options][wiki-config] manual page for a list of these requirements.
1717

1818
> [!WARNING]
1919
> The [gRPC PHP extension][grpc] is known to cause PHP_CodeSniffer to hang when running with parallel processing enabled. If the gRPC extension is loaded, either do not use the `--parallel` CLI option or configure the extension's ini settings as follows:
@@ -30,3 +30,9 @@ Individual sniffs may have additional requirements such as external applications
3030
[simplexml]: https://www.php.net/book.simplexml
3131
[tokenizer]: https://www.php.net/book.tokenizer
3232
[xmlwriter]: https://www.php.net/book.xmlwriter
33+
34+
[wiki-config]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options
35+
[wiki-report-checkstyle]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Reporting#printing-a-checkstyle-report
36+
[wiki-report-json]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Reporting#printing-a-json-report
37+
[wiki-report-junit]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Reporting#printing-a-junit-report
38+
[wiki-report-xml]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Reporting#printing-an-xml-report

0 commit comments

Comments
 (0)