3.11.0 - 2024-11-12

[jrfnl]

Added

• Runtime support for PHP 8.4. All known PHP 8.4 deprecation notices have been fixed.
  • Syntax support for new PHP 8.4 features will follow in a future release.
  • If you find any PHP 8.4 deprecation notices which were missed, please report them.
  • Thanks to Juliette Reinders Folmer for the patches.
• Tokenizer support for PHP 8.3 "yield from" expressions with a comment between the keywords. Reminder: revisit yield from tokenization #529, PHP 8.3 | Tokenizer/PHP: support "yield from" with comments #647
  • Sniffs explicitly handling T_YIELD_FROM tokens may need updating. The PR description contains example code for use by sniff developers.
  • Additionally, the following sniff has been updated to support "yield from" expressions with comments:
    • Generic.WhiteSpace.LanguageConstructSpacing
  • Thanks to Juliette Reinders Folmer for the patch.
• New Generic.WhiteSpace.HereNowdocIdentifierSpacing sniff. ✨ New Generic.WhiteSpace.HereNowdocIdentifierSpacing sniff #586, Generic/HereNowdocIdentifierSpacing: add metrics #637
  • Forbid whitespace between the <<< and the identifier string in heredoc/nowdoc start tokens.
  • Thanks to Juliette Reinders Folmer for the patch.
• New Generic.Strings.UnnecessaryHeredoc sniff. ✨ New Generic.Strings.UnnecessaryHeredoc sniff #633
  • Warns about heredocs without interpolation or expressions in the body text and can auto-fix these to nowdocs.
  • Thanks to Juliette Reinders Folmer for the patch.
• Documentation for the following sniffs:
  • Generic.Arrays.ArrayIndent
  • Squiz.PHP.Heredoc
  • Thanks to Rodrigo Primo and Juliette Reinders Folmer for the patches.

Changed

• The Common::getSniffCode() method will now throw an InvalidArgumentException exception if an invalid $sniffClass is passed. Common::getSniffCode(): add tests, more defensive coding and minor simplification #524, Runner::processFile()/error handling: add more defensive coding #625
  • Thanks to Juliette Reinders Folmer for the patch.
• Documentation generated using the --generator=... feature will now always be presented in natural order based on the sniff name(s). Generators: always present docs in alphabetical order #668
  • Thanks to Juliette Reinders Folmer for the patch.
• Minor improvements to the display of runtime information. Util\Timing::getHumanReadableDuration: improve time display #658
  • Thanks to Juliette Reinders Folmer for the patch.
• Squiz.Commenting.PostStatementComment: trailing annotations in PHP files will now be reported under a separate, non-auto-fixable error code AnnotationFound. Squiz.Commenting.PostStatementComment should allow trailing annotations from popular PHP tools #560, Squiz/PostStatementComment: use a different error code for annotations #627
  • This prevents (tooling related) annotations from taking on a different meaning when moved by the fixer.
  • The separate error code also allows for selectively excluding it to prevent the sniff from triggering on trailing annotations, while still forbidding other trailing comments.
  • Thanks to Rodrigo Primo for the patch.
• Squiz.ControlStructures.ForEachLoopDeclaration: the SpacingAfterOpen error code has been replaced by the SpaceAfterOpen error code. The latter is a pre-existing code. The former appears to have been a typo. Correct error code in Squiz.ControlStructures.ForEachLoopDeclaration #582
  • Thanks to Dan Wallis for the patch.
• The following sniff(s) have received efficiency improvements:
  • Generic.Classes.DuplicateClassName
  • Generic.NamingConventions.ConstructorName
  • Thanks to Rodrigo Primo and Juliette Reinders Folmer for the patches.
• Various housekeeping, including improvements to the tests and documentation.
  • Thanks to Rodrigo Primo and Juliette Reinders Folmer for their contributions.

Fixed

• Fixed bug #3808 : Generic.WhiteSpace.ScopeIndent would throw false positive for tab indented multi-token yield from expression.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug Tokeniser issue for function call parenthesis - inside switch #630 : The tokenizer could inadvertently transform "normal" parentheses to DNF parentheses, when a function call was preceded by a switch-case / alternative syntax control structure colon.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug Tokenizer/PHP: add tests for tokenization of yield and yield from + minor bug fix #645 : On PHP 5.4, if yield was used as the declaration name for a function declared to return by reference, the function name would incorrectly be tokenized as T_YIELD instead of T_STRING.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug PHP 8.3 | Tokenizer/PHP: support "yield from" with comments #647 : Tokenizer not applying tab replacement in single token "yield from" keywords.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug PHP 8.3 | Tokenizer/PHP: support "yield from" with comments #647 : Generic.WhiteSpace.DisallowSpaceIndent did not flag space indentation in multi-line yield from.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug PHP 8.3 | Tokenizer/PHP: support "yield from" with comments #647 : Generic.WhiteSpace.DisallowTabIndent did not flag tabs inside yield from.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug Generic/ConstructorName: bug fix x 2 #652 : Generic.NamingConventions.ConstructorName: false positives for PHP-4 style calls to PHP-4 style parent constructor when a method with the same name as the parent class was called on another class.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug Generic/ConstructorName: bug fix x 2 #652 : Generic.NamingConventions.ConstructorName: false negatives for PHP-4 style calls to parent constructor for function calls with whitespace and comments in unconventional places.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug Generic/DuplicateClassName: 4 bug fixes + performance improvement #653 : Generic.Classes.DuplicateClassName : the sniff did not skip namespace keywords used as operators, which could lead to false positives.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug Generic/DuplicateClassName: 4 bug fixes + performance improvement #653 : Generic.Classes.DuplicateClassName : sniff going into an infinite loop during live coding.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug Generic/DuplicateClassName: 4 bug fixes + performance improvement #653 : Generic.Classes.DuplicateClassName : false positives/negatives when a namespace declaration contained whitespace or comments in unconventional places.
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug Generic/DuplicateClassName: 4 bug fixes + performance improvement #653 : Generic.Classes.DuplicateClassName : namespace for a file going in/out of PHP was not remembered/applied correctly.
  • Thanks to Juliette Reinders Folmer for the patch

---

Statistics

Closed: 4 issues
Merged: 42 pull requests

If you like to stay informed about releases and more, follow @phpcs on Mastodon or @PHP_CodeSniffer on X.

Please consider funding the PHP_CodeSniffer project. If you already do so: thank you!

---

This discussion was created from the release 3.11.0 - 2024-11-12.