Skip to content

Commit 31328b7

Browse files
committed
Changelog for the 3.11.2 release
For release this Wednesday (or earlier).
1 parent 6ff8b99 commit 31328b7

File tree

1 file changed

+59
-3
lines changed

1 file changed

+59
-3
lines changed

CHANGELOG.md

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,61 @@ The file documents changes to the PHP_CodeSniffer project.
108108

109109
_Nothing yet._
110110

111+
## [3.11.2] - 2024-12-11
112+
113+
### Changed
114+
- Generators/HTML + Markdown: the output will now be empty (no page header/footer) when there are no docs to display. [#687]
115+
- This is in line with the Text Generator which already didn't produce output if there are no docs.
116+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
117+
- Generators/HTML: only display a Table of Contents when there is more than one sniff with documentation. [#697]
118+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
119+
- Generators/HTML: improved handling of line breaks in `<standard>` blocks. [#723]
120+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
121+
- Generators/Markdown: improved compatibility with the variety of available markdown parsers. [#722]
122+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
123+
- Generators/Markdown: improved handling of line breaks in `<standard>` blocks. [#737]
124+
- This prevents additional paragraphs from being displayed as code blocks.
125+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
126+
- Generic.NamingConventions.UpperCaseConstantName: the exact token containing the non-uppercase constant name will now be identified with more accuracy. [#665]
127+
- Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
128+
- Generic.Functions.OpeningFunctionBraceKernighanRitchie: minor improvement to the error message wording. [#736]
129+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
130+
- Various housekeeping, including improvements to the tests and documentation.
131+
- Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions.
132+
133+
### Fixed
134+
- Fixed bug [#527] : Squiz.Arrays.ArrayDeclaration: short lists within a foreach condition should be ignored.
135+
- Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
136+
- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positives and false negatives when code uses unconventional spacing and comments when calling `define()`.
137+
- Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
138+
- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positive when a constant named `DEFINE` is encountered.
139+
- Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
140+
- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positive for attribute class called `define`.
141+
- Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
142+
- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positive when handling the instantiation of a class named `define`.
143+
- Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch.
144+
- Fixed bug [#688] : Generators/Markdown could leave error_reporting in an incorrect state.
145+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
146+
- Fixed bug [#698] : Generators/Markdown : link in the documentation footer would not parse as a link.
147+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
148+
- Fixed bug [#738] : Generators/Text: stray blank lines after code sample titles.
149+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
150+
- Fixed bug [#739] : Generators/HTML + Markdown: multi-space whitespace within a code sample title was folded into a single space.
151+
- Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch.
152+
153+
[#527]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/527
154+
[#665]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/665
155+
[#687]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/687
156+
[#688]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/688
157+
[#697]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/697
158+
[#698]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/698
159+
[#722]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/722
160+
[#723]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/723
161+
[#736]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/736
162+
[#737]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/737
163+
[#738]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/738
164+
[#739]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/739
165+
111166
## [3.11.1] - 2024-11-16
112167

113168
### Changed
@@ -439,7 +494,7 @@ _Nothing yet._
439494
- Squiz.WhiteSpace.MemberVarSpacing
440495
- Squiz.WhiteSpace.ScopeClosingBrace
441496
- Squiz.WhiteSpace.SuperfluousWhitespace
442-
- Thanks to [Jay McPartland][@jonmcp] and [Rodrigo Primo][@rodrigoprimo] for the patches.
497+
- Thanks to [Jay McPartland][@jaymcp] and [Rodrigo Primo][@rodrigoprimo] for the patches.
443498

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

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

72567311
[Unreleased]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/master...HEAD
7312+
[3.11.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.1...3.11.2
72577313
[3.11.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.0...3.11.1
72587314
[3.11.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.3...3.11.0
72597315
[3.10.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.2...3.10.3
@@ -7452,6 +7508,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
74527508
[@ivuorinen]: https://github.com/ivuorinen
74537509
[@jasonmccreary]: https://github.com/jasonmccreary
74547510
[@javer]: https://github.com/javer
7511+
[@jaymcp]: https://github.com/jaymcp
74557512
[@JDGrimes]: https://github.com/JDGrimes
74567513
[@jedgell]: https://github.com/jedgell
74577514
[@jeffslofish]: https://github.com/jeffslofish
@@ -7462,7 +7519,6 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
74627519
[@johanderuijter]: https://github.com/johanderuijter
74637520
[@johnmaguire]: https://github.com/johnmaguire
74647521
[@johnpbloch]: https://github.com/johnpbloch
7465-
[@jonmcp]: https://github.com/jonmcp
74667522
[@JorisDebonnet]: https://github.com/JorisDebonnet
74677523
[@josephzidell]: https://github.com/josephzidell
74687524
[@joshdavis11]: https://github.com/joshdavis11

0 commit comments

Comments
 (0)