Skip to content

Commit

Permalink
Changelog for the 3.11.2 release
Browse files Browse the repository at this point in the history
For release this Wednesday (or earlier).
  • Loading branch information
jrfnl committed Dec 11, 2024
1 parent 3a44d3d commit 644fc29
Showing 1 changed file with 59 additions and 3 deletions.
62 changes: 59 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,61 @@ The file documents changes to the PHP_CodeSniffer project.

_Nothing yet._

## [3.11.2] - 2024-12-11

### Changed
- Generators/HTML + Markdown: the output will now be empty (no page header/footer) when there are no docs to display. [#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][@jrfnl] for the patch.
- Generators/HTML: only display a Table of Contents when there is more than one sniff with documentation. [#697]
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
- Generators/HTML: improved handling of line breaks in `<standard>` blocks. [#723]
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
- Generators/Markdown: improved compatibility with the variety of available markdown parsers. [#722]
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
- Generators/Markdown: improved handling of line breaks in `<standard>` blocks. [#737]
- This prevents additional paragraphs from being displayed as code blocks.
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
- Generic.NamingConventions.UpperCaseConstantName: the exact token containing the non-uppercase constant name will now be identified with more accuracy. [#665]
- Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
- Generic.Functions.OpeningFunctionBraceKernighanRitchie: minor improvement to the error message wording. [#736]
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
- Various housekeeping, including improvements to the tests and documentation.
- Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions.

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

[#527]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/527
[#665]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/665
[#687]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/687
[#688]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/688
[#697]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/697
[#698]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/698
[#722]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/722
[#723]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/723
[#736]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/736
[#737]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/737
[#738]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/738
[#739]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/739

## [3.11.1] - 2024-11-16

### Changed
Expand Down Expand Up @@ -337,7 +392,7 @@ _Nothing yet._
- Squiz.WhiteSpace.MemberVarSpacing
- Squiz.WhiteSpace.ScopeClosingBrace
- Squiz.WhiteSpace.SuperfluousWhitespace
- Thanks to [Jay McPartland][@jonmcp] and [Rodrigo Primo][@rodrigoprimo] for the patches.
- Thanks to [Jay McPartland][@jaymcp] and [Rodrigo Primo][@rodrigoprimo] for the patches.

### Changed
- The following sniffs have received performance related improvements:
Expand All @@ -350,7 +405,7 @@ _Nothing yet._
- External standards with sniff tests using the PHP_CodeSniffer native test framework will also benefit from these changes.
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
- Various housekeeping, including improvements to the tests and documentation.
- Thanks to [Jay McPartland][@jonmcp], [João Pedro Oliveira][@jpoliveira08], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions.
- Thanks to [Jay McPartland][@jaymcp], [João Pedro Oliveira][@jpoliveira08], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions.

### Fixed
- Fixed bug [#289] : Squiz.WhiteSpace.OperatorSpacing and PSR12.Operators.OperatorSpacing : improved fixer conflict protection by more strenuously avoiding handling operators in declare statements.
Expand Down Expand Up @@ -7152,6 +7207,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
-->

[Unreleased]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/master...HEAD
[3.11.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.1...3.11.2
[3.11.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.0...3.11.1
[3.11.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.3...3.11.0
[3.10.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.2...3.10.3
Expand Down Expand Up @@ -7350,6 +7406,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
[@ivuorinen]: https://github.com/ivuorinen
[@jasonmccreary]: https://github.com/jasonmccreary
[@javer]: https://github.com/javer
[@jaymcp]: https://github.com/jaymcp
[@JDGrimes]: https://github.com/JDGrimes
[@jedgell]: https://github.com/jedgell
[@jeffslofish]: https://github.com/jeffslofish
Expand All @@ -7360,7 +7417,6 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
[@johanderuijter]: https://github.com/johanderuijter
[@johnmaguire]: https://github.com/johnmaguire
[@johnpbloch]: https://github.com/johnpbloch
[@jonmcp]: https://github.com/jonmcp
[@JorisDebonnet]: https://github.com/JorisDebonnet
[@josephzidell]: https://github.com/josephzidell
[@joshdavis11]: https://github.com/joshdavis11
Expand Down

0 comments on commit 644fc29

Please sign in to comment.