repository·4.x·Indexed 23 days ago
https://github.com/phpcsstandards/php_codesnifferA toolset for detecting and automatically fixing violations of PHP coding standards. It includes two primary utilities: phpcs for detecting violations in PHP, JS, and XML files, and phpcbf (PHP Code Beautifier and Fixer) for automatic correction. The tool supports various standards such as PSR12, PEAR, and Zend, and allows for custom configuration via ruleset.xml files, CLI flags, and installed_paths.
PHP_CodeSniffer consists of two primary scripts designed to maintain code cleanliness and consistency:
phpcs: Tokenizes PHP files to detect violations of defined coding standards.phpcbf: Automatically corrects coding standard violations found by phpcs.This package is the official continuation of the original Squizlabs PHP_CodeSniffer package.
Starting from version 3.10.0, PHP_CodeSniffer includes tokenizer support for PHP 8.2 Disjunctive Normal Form (DNF) types.
Key updates include:
T_TYPE_OPEN_PARENTHESIS and T_TYPE_CLOSE_PARENTHESIS are used to represent parentheses in DNF types. These tokens include parenthesis_opener and parenthesis_closer indexes, and tokens between them include a nested_parenthesis index.File::getMethodProperties(), File::getMethodParameters(), and File::getMemberProperties().Generic.PHP.LowerCaseType sniff has been updated to support DNF types.addFixableError() and addFixableWarning() were updated to return true only if the fixer is actually enabled. This allows developers to avoid manual checks like if ($phpcsFile->fixer->enabled === true) before attempting to apply a fix.PHP_CodeSniffer automatically searches for configuration files to define standards.
phpcs.xml in the current directory and parent directories.phpcs.xml and phpcs.xml.dist are present, phpcs.xml takes precedence.phpcs.xml file is ignored. However, if no standard is specified via CLI, the ruleset file is used.In version 3.9.0, the methods getBlacklist() and getWhitelist() in the PHP_CodeSniffer\Filters\ExactMatch class were deprecated and will be removed in version 4.0. They are replaced by getDisallowedFiles() and getAllowedFiles().
To ensure a custom filter is compatible with both PHP_CodeSniffer 3.9.0+ and 4.0+, implement both sets of methods. When both are present, the new methods (getDisallowedFiles and getAllowedFiles) take precedence.
Standard directory. When using external standards, you can also specify full paths within the CodingStandard.php include and exclude methods. Note that classes, directories, and files should be named as if the standard were part of the internal PHP_CodeSniffer structure.As of 4.0.0beta1, all status, debug, and progress output is sent to STDERR instead of STDOUT. Only report output is sent to STDOUT.
If you are piping output to a file and want to capture the entire run (including status and timing), you must pipe both STDERR and STDOUT to the same file.
\n or \r\n. Instead, use the EOL keyword or access the character via the $phpcsFile->eolChar property to ensure compatibility with the detected line endings.In version 3.8.0, the handling of invalid sniff properties in custom rulesets changed:
Internal.PropertyDoesNotExist error on line 1 of the scanned file but will not halt execution.For Sniff Developers: It is strongly recommended to explicitly declare any user-adjustable public properties. Using #[\\[AllowDynamicProperties\\]] will not affect properties being set via rulesets.
As part of the preparation for version 4.0, several print* methods in the Generator classes have been deprecated in favor of getFormatted* methods. You should update your custom generators to use the new naming convention to ensure compatibility with future versions.
Deprecated Text methods:
printTitle() $\rightarrow$ getFormattedTitle()printTextBlock() $\rightarrow$ getFormattedTextBlock()printCodeComparisonBlock() $\rightarrow$ getFormattedCodeComparisonBlock()Deprecated Markdown methods:
printHeader() $\rightarrow$ getFormattedHeader()printFooter() $\rightarrow$ getFormattedFooter()printTextBlock() $\rightarrow$ getFormattedTextBlock()printCodeComparisonBlock() $\rightarrow$ getFormattedCodeComparisonBlock()Deprecated HTML methods:
printHeader() $\rightarrow$ getFormattedHeader()printToc() $\rightarrow$ getFormattedToc()printFooter() $\rightarrow$ getFormattedFooter()printTextBlock() $\rightarrow$ getFormattedTextBlock()printCodeComparisonBlock() $\rightarrow$ getFormattedCodeComparisonBlock()