Skip to content

Requirements: document iconv as a recommended PHP extension #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrfnl merged 1 commit into from
Mar 4, 2026
Merged

Requirements: document iconv as a recommended PHP extension #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .cspell.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ words:
# Used in Wiki Reporting page, "emacs" file.
- defun

# Used in Wiki Requirements page.
- multibyte

# Used in CONTRIBUTING.
- maxlevel
- replacer
Expand Down
3 changes: 3 additions & 0 deletions wiki/Requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,7 @@ Additionally, PHP_CodeSniffer requires the following PHP extensions to be enable
- SimpleXML: used to process ruleset XML files
- XMLWriter: used to create some report formats

The following PHP extension is not required, but is strongly recommended:
- 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.

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.