3.11.2 - 2024-12-11

[jrfnl]

Changed

• Generators/HTML + Markdown: the output will now be empty (no page header/footer) when there are no docs to display. Generators HTML/Markdown: don't print header/footer when there are no docs #687
  • This is in line with the Text Generator which already didn't produce output if there are no docs.
  • Thanks to Juliette Reinders Folmer for the patch.
• Generators/HTML: only display a Table of Contents when there is more than one sniff with documentation. Generators/HTML: only display a TOC when there is more than one doc #697
  • Thanks to Juliette Reinders Folmer for the patch.
• Generators/HTML: improved handling of line breaks in <standard> blocks. Generators/HTML: fix line break handling #723
  • Thanks to Juliette Reinders Folmer for the patch.
• Generators/Markdown: improved compatibility with the variety of available markdown parsers. Generators/Markdown: add blank line after title #722
  • Thanks to Juliette Reinders Folmer for the patch.
• Generators/Markdown: improved handling of line breaks in <standard> blocks. Generators/Markdown: fix line break and indentation handling #737
  • This prevents additional paragraphs from being displayed as code blocks.
  • Thanks to Juliette Reinders Folmer for the patch.
• Generic.NamingConventions.UpperCaseConstantName: the exact token containing the non-uppercase constant name will now be identified with more accuracy. Generic/UpperCaseConstantName: improve code coverage #665
  • Thanks to Rodrigo Primo for the patch.
• Generic.Functions.OpeningFunctionBraceKernighanRitchie: minor improvement to the error message wording. Generic/OpeningFunctionBraceKernighanRitchie: improve error message #736
  • Thanks to Juliette Reinders Folmer for the patch.
• Various housekeeping, including improvements to the tests and documentation.
  • Thanks to Rodrigo Primo and Juliette Reinders Folmer for their contributions.

Fixed

• Fixed bug Array destructuring in foreach - conflict between SpaceBeforeComma & NoSpaceAfterComma #527 : Squiz.Arrays.ArrayDeclaration: short lists within a foreach condition should be ignored.
  • Thanks to Rodrigo Primo for the patch.
• Fixed bug Generic/UpperCaseConstantName: improve code coverage #665 : Generic.NamingConventions.UpperCaseConstantName: false positives and false negatives when code uses unconventional spacing and comments when calling define().
  • Thanks to Rodrigo Primo for the patch.
• Fixed bug Generic/UpperCaseConstantName: improve code coverage #665 : Generic.NamingConventions.UpperCaseConstantName: false positive when a constant named DEFINE is encountered.
  • Thanks to Rodrigo Primo for the patch.
• Fixed bug Generic/UpperCaseConstantName: improve code coverage #665 : Generic.NamingConventions.UpperCaseConstantName: false positive for attribute class called define.
  • Thanks to Rodrigo Primo for the patch.
• Fixed bug Generic/UpperCaseConstantName: improve code coverage #665 : Generic.NamingConventions.UpperCaseConstantName: false positive when handling the instantiation of a class named define.
  • Thanks to Rodrigo Primo for the patch.
• Fixed bug Generators/Markdown: reset error_reporting to original value #688 : Generators/Markdown could leave error_reporting in an incorrect state.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Generators/Markdown: fix footer not parsing #698 : Generators/Markdown : link in the documentation footer would not parse as a link.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Generators/Text: trim code titles #738 : Generators/Text: stray blank lines after code sample titles.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Generators HTML/Markdown: fix whitespace handling in code title #739 : Generators/HTML + Markdown: multi-space whitespace within a code sample title was folded into a single space.
  • Thanks to Juliette Reinders Folmer for the patch.

Other

• On December 1st, one year after the repo was abandoned and revived, a retrospective of the past year was published for funders.
  • This retrospective is publicly available and also provides some insights into what's to come in the new year.

---

Statistics

Closed: 2 issues
Merged: 52 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.2 - 2024-12-11.