Skip to content

Commit a965341

Browse files
authored
Merge pull request #409 from rodrigoprimo/changelog-improvements-2-1-0
Add links to all issues in the 2.2.0, 2.1.0, and 2.0.0 sections of the changelog
2 parents 8b8ef25 + f2124c9 commit a965341

File tree

1 file changed

+94
-46
lines changed

1 file changed

+94
-46
lines changed

CHANGELOG.md

Lines changed: 94 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3800,53 +3800,77 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
38003800
- PHP and JS functions and closures are now treated the same way
38013801
- Squiz MultiLineFunctionDeclarationSniff now supports JS files
38023802
- Interactive mode no longer breaks if you also specify a report type on the command line
3803-
- PEAR InlineCommentSniff now fixes the Perl-style comments that it finds (request #375)
3803+
- PEAR InlineCommentSniff now fixes the Perl-style comments that it finds (request [#375][sq-375])
38043804
- PSR2 standard no longer fixes the placement of docblock open tags as comments are excluded from this standard
38053805
- PSR2 standard now sets a default tab width of 4 spaces
3806-
- Generic DocCommentSniff now only disallows lowercase letters at the start of a long/short comment (request #377)
3806+
- Generic DocCommentSniff now only disallows lowercase letters at the start of a long/short comment (request [#377][sq-377])
38073807
- All non-letter characters are now allowed, including markdown special characters and numbers
3808-
- Generic DisallowMultipleStatementsSniff now allows multiple open/close tags on the same line (request #423)
3809-
- Generic CharacterBeforePHPOpeningTagSniff now only checks the first PHP tag it finds (request #423)
3810-
- Generic CharacterBeforePHPOpeningTagSniff now allows a shebang line at the start of the file (request #20481)
3811-
- Generic InlineHTMLUnitTest now allows a shebang line at the start of the file (request #20481)
3808+
- Generic DisallowMultipleStatementsSniff now allows multiple open/close tags on the same line (request [#423][sq-423])
3809+
- Generic CharacterBeforePHPOpeningTagSniff now only checks the first PHP tag it finds (request [#423][sq-423])
3810+
- Generic CharacterBeforePHPOpeningTagSniff now allows a shebang line at the start of the file (request [#20481][pear-20481])
3811+
- Generic InlineHTMLUnitTest now allows a shebang line at the start of the file (request [#20481][pear-20481])
38123812
- PEAR ObjectOperatorIndentSniff now only checks object operators at the start of a line
38133813
- PEAR FileComment and ClassComment sniffs no longer have @ in their error codes
38143814
- E.g., PEAR.Commenting.FileComment.Missing@categoryTag becomes PEAR.Commenting.FileComment.MissingCategoryTag
38153815
- Thanks to [Grzegorz Rygielski][@grzr] for the patch
38163816
- Squiz ControlStructureSpacingSniff no longer enforces a blank line before CATCH statements
3817-
- Squiz FunctionCommentSniff now fixes the return type in the @return tag (request #392)
3817+
- Squiz FunctionCommentSniff now fixes the return type in the @return tag (request [#392][sq-392])
38183818
- Squiz BlockCommentSniff now only disallows lowercase letters at the start of the comment
38193819
- Squiz InlineCommentSniff now only disallows lowercase letters at the start of the comment
3820-
- Squiz OperatorSpacingSniff now has a setting to ignore newline characters around operators (request #348)
3820+
- Squiz OperatorSpacingSniff now has a setting to ignore newline characters around operators (request [#348][sq-348])
38213821
- Default remains FALSE, so newlines are not allowed
38223822
- Override the "ignoreNewlines" setting in a ruleset.xml file to change
38233823
- PSR2 ControlStructureSpacingSniff now checks for, and fixes, newlines after the opening parenthesis
38243824
- Added a markdown document generator (--generator=markdown to use)
38253825
- Thanks to [Stefano Kowalke][@Konafets] for the contribution
38263826

38273827
### Fixed
3828-
- Fixed bug #379 : Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast incorrectly detects comments
3829-
- Fixed bug #382 : JS tokenizer incorrect for inline conditionally created immediately invoked anon function
3830-
- Fixed bug #383 : Squiz.Arrays.ArrayDeclaration.ValueNoNewline incorrectly detects nested arrays
3831-
- Fixed bug #386 : Undefined offset in Squiz.FunctionComment sniff when param has no comment
3832-
- Fixed bug #390 : Indentation of non-control structures isn't adjusted when containing structure is fixed
3833-
- Fixed bug #400 : InlineControlStructureSniff fails to fix when statement has no semicolon
3834-
- Fixed bug #401 : PHPCBF no-patch option shows an error when there are no fixable violations in a file
3835-
- Fixed bug #405 : The "Squiz.WhiteSpace.FunctionSpacing" sniff removes class "}" during fixing
3836-
- Fixed bug #407 : PEAR.ControlStructures.MultiLineCondition doesn't account for comments at the end of lines
3837-
- Fixed bug #410 : The "Squiz.WhiteSpace.MemberVarSpacing" not respecting "var"
3838-
- Fixed bug #411 : Generic.WhiteSpace.ScopeIndent.Incorrect - false positive with multiple arrays in argument list
3839-
- Fixed bug #412 : PSR2 multi-line detection doesn't work for inline IF and string concats
3840-
- Fixed bug #414 : Squiz.WhiteSpace.MemberVarSpacing - inconsistent checking of member vars with comment
3841-
- Fixed bug #433 : Wrong detection of Squiz.Arrays.ArrayDeclaration.KeyNotAligned when key contains space
3842-
- Fixed bug #434 : False positive for spacing around "=>" in inline array within foreach
3843-
- Fixed bug #452 : Ruleset exclude-pattern for specific sniff code ignored when using CLI --ignore option
3844-
- Fixed bug #20482 : Scope indent sniff can get into infinite loop when processing a parse error
3828+
- Fixed bug [#379][sq-379] : Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast incorrectly detects comments
3829+
- Fixed bug [#382][sq-382] : JS tokenizer incorrect for inline conditionally created immediately invoked anon function
3830+
- Fixed bug [#383][sq-383] : Squiz.Arrays.ArrayDeclaration.ValueNoNewline incorrectly detects nested arrays
3831+
- Fixed bug [#386][sq-386] : Undefined offset in Squiz.FunctionComment sniff when param has no comment
3832+
- Fixed bug [#390][sq-390] : Indentation of non-control structures isn't adjusted when containing structure is fixed
3833+
- Fixed bug [#400][sq-400] : InlineControlStructureSniff fails to fix when statement has no semicolon
3834+
- Fixed bug [#401][sq-401] : PHPCBF no-patch option shows an error when there are no fixable violations in a file
3835+
- Fixed bug [#405][sq-405] : The "Squiz.WhiteSpace.FunctionSpacing" sniff removes class "}" during fixing
3836+
- Fixed bug [#407][sq-407] : PEAR.ControlStructures.MultiLineCondition doesn't account for comments at the end of lines
3837+
- Fixed bug [#410][sq-410] : The "Squiz.WhiteSpace.MemberVarSpacing" not respecting "var"
3838+
- Fixed bug [#411][sq-411] : Generic.WhiteSpace.ScopeIndent.Incorrect - false positive with multiple arrays in argument list
3839+
- Fixed bug [#412][sq-412] : PSR2 multi-line detection doesn't work for inline IF and string concats
3840+
- Fixed bug [#414][sq-414] : Squiz.WhiteSpace.MemberVarSpacing - inconsistent checking of member vars with comment
3841+
- Fixed bug [#433][sq-433] : Wrong detection of Squiz.Arrays.ArrayDeclaration.KeyNotAligned when key contains space
3842+
- Fixed bug [#434][sq-434] : False positive for spacing around "=>" in inline array within foreach
3843+
- Fixed bug [#452][sq-452] : Ruleset exclude-pattern for specific sniff code ignored when using CLI --ignore option
3844+
- Fixed bug [#20482][pear-20482] : Scope indent sniff can get into infinite loop when processing a parse error
3845+
3846+
[sq-348]: https://github.com/squizlabs/PHP_CodeSniffer/issues/348
3847+
[sq-375]: https://github.com/squizlabs/PHP_CodeSniffer/issues/375
3848+
[sq-377]: https://github.com/squizlabs/PHP_CodeSniffer/issues/377
3849+
[sq-379]: https://github.com/squizlabs/PHP_CodeSniffer/issues/379
3850+
[sq-382]: https://github.com/squizlabs/PHP_CodeSniffer/issues/382
3851+
[sq-383]: https://github.com/squizlabs/PHP_CodeSniffer/issues/383
3852+
[sq-386]: https://github.com/squizlabs/PHP_CodeSniffer/issues/386
3853+
[sq-390]: https://github.com/squizlabs/PHP_CodeSniffer/issues/390
3854+
[sq-392]: https://github.com/squizlabs/PHP_CodeSniffer/issues/392
3855+
[sq-400]: https://github.com/squizlabs/PHP_CodeSniffer/issues/400
3856+
[sq-401]: https://github.com/squizlabs/PHP_CodeSniffer/issues/401
3857+
[sq-405]: https://github.com/squizlabs/PHP_CodeSniffer/issues/405
3858+
[sq-407]: https://github.com/squizlabs/PHP_CodeSniffer/issues/407
3859+
[sq-410]: https://github.com/squizlabs/PHP_CodeSniffer/issues/410
3860+
[sq-411]: https://github.com/squizlabs/PHP_CodeSniffer/issues/411
3861+
[sq-412]: https://github.com/squizlabs/PHP_CodeSniffer/issues/412
3862+
[sq-414]: https://github.com/squizlabs/PHP_CodeSniffer/issues/414
3863+
[sq-423]: https://github.com/squizlabs/PHP_CodeSniffer/issues/423
3864+
[sq-433]: https://github.com/squizlabs/PHP_CodeSniffer/issues/433
3865+
[sq-434]: https://github.com/squizlabs/PHP_CodeSniffer/issues/434
3866+
[sq-452]: https://github.com/squizlabs/PHP_CodeSniffer/issues/452
3867+
[pear-20481]: https://pear.php.net/bugs/bug.php?id=20481
3868+
[pear-20482]: https://pear.php.net/bugs/bug.php?id=20482
38453869

38463870
## [2.1.0] - 2014-12-18
38473871
### Changed
3848-
- Time and memory output is now shown if progress information is also shown (request #335)
3849-
- A tilde can now be used to reference a user's home directory in a path to a standard (request #353)
3872+
- Time and memory output is now shown if progress information is also shown (request [#335][sq-335])
3873+
- A tilde can now be used to reference a user's home directory in a path to a standard (request [#353][sq-353])
38503874
- Added PHP_CodeSniffer_File::findStartOfStatement() to find the first non-whitespace token in a statement
38513875
- Possible alternative for code using PHP_CodeSniffer_File::findPrevious() with the local flag set
38523876
- Added PHP_CodeSniffer_File::findEndOfStatement() to find the last non-whitespace token in a statement
@@ -3855,7 +3879,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
38553879
- Affects OpeningFunctionBraceBsdAllmanSniff and OpeningFunctionBraceKernighanRitchieSniff
38563880
- Also enforced in PEAR FunctionDeclarationSniff and Squiz MultiLineFunctionDeclarationSniff
38573881
- Generic DisallowTabIndentSniff now replaces tabs everywhere it finds them, except in strings and here/now docs
3858-
- Generic EmptyStatementSniff error codes now contain the type of empty statement detected (request #314)
3882+
- Generic EmptyStatementSniff error codes now contain the type of empty statement detected (request [#314][sq-314])
38593883
- All messages generated by this sniff are now errors (empty CATCH was previously a warning)
38603884
- Message code Generic.CodeAnalysis.EmptyStatement.NotAllowed has been removed
38613885
- Message code Generic.CodeAnalysis.EmptyStatement.NotAllowedWarning has been removed
@@ -3865,7 +3889,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
38653889
- PEAR and Squiz FunctionCommentSniffs no longer ban @return tags for constructors and destructors
38663890
- Removed message PEAR.Commenting.FunctionComment.ReturnNotRequired
38673891
- Removed message Squiz.Commenting.FunctionComment.ReturnNotRequired
3868-
- Change initiated by request #324 and request #369
3892+
- Change initiated by request [#324][sq-324] and request [#369][sq-369]
38693893
- Squiz EmptyStatementSniff has been removed
38703894
- Squiz standard now includes Generic EmptyStatementSniff and turns off the empty CATCH error
38713895
- Squiz ControlSignatureSniff fixes now retain comments between the closing parenthesis and open brace
@@ -3874,21 +3898,41 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
38743898
- Squiz ArrayDeclarationSniff now skips function calls while checking multi-line arrays
38753899

38763900
### Fixed
3877-
- Fixed bug #337 : False positive with anonymous functions in Generic_Sniffs_WhiteSpace_ScopeIndentSniff
3878-
- Fixed bug #339 : reformatting brace location can result in broken code
3879-
- Fixed bug #342 : Nested ternary operators not tokenized correctly
3880-
- Fixed bug #345 : Javascript regex not tokenized when inside array
3881-
- Fixed bug #346 : PHP path can't be determined in some cases in "phpcs.bat" (on Windows XP)
3882-
- Fixed bug #358 : False positives for Generic_Sniffs_WhiteSpace_ScopeIndentSniff
3883-
- Fixed bug #361 : Sniff-specific exclude patterns don't work for Windows
3884-
- Fixed bug #364 : Don't interpret "use function" as declaration
3885-
- Fixed bug #366 : phpcbf with PSR2 errors on control structure alternative syntax
3886-
- Fixed bug #367 : Nested Anonymous Functions Causing False Negative
3887-
- Fixed bug #371 : Shorthand binary cast causes tokenizer errors
3901+
- Fixed bug [#337][sq-337] : False positive with anonymous functions in Generic_Sniffs_WhiteSpace_ScopeIndentSniff
3902+
- Fixed bug [#339][sq-339] : reformatting brace location can result in broken code
3903+
- Fixed bug [#342][sq-342] : Nested ternary operators not tokenized correctly
3904+
- Fixed bug [#345][sq-345] : Javascript regex not tokenized when inside array
3905+
- Fixed bug [#346][sq-346] : PHP path can't be determined in some cases in "phpcs.bat" (on Windows XP)
3906+
- Fixed bug [#358][sq-358] : False positives for Generic_Sniffs_WhiteSpace_ScopeIndentSniff
3907+
- Fixed bug [#361][sq-361] : Sniff-specific exclude patterns don't work for Windows
3908+
- Fixed bug [#364][sq-364] : Don't interpret "use function" as declaration
3909+
- Fixed bug [#366][sq-366] : phpcbf with PSR2 errors on control structure alternative syntax
3910+
- Fixed bug [#367][sq-367] : Nested Anonymous Functions Causing False Negative
3911+
- Fixed bug [#371][sq-371] : Shorthand binary cast causes tokenizer errors
38883912
- New token T_BINARY_CAST added for the b"string" cast format (the 'b' is the T_BINARY_CAST token)
3889-
- Fixed bug #372 : phpcbf parse problem, wrong brace placement for inline IF
3890-
- Fixed bug #373 : Double quote usage fix removing too many double quotes
3891-
- Fixed bug #20196 : 1.5.2 breaks scope_closer position
3913+
- Fixed bug [#372][sq-372] : phpcbf parse problem, wrong brace placement for inline IF
3914+
- Fixed bug [#373][sq-373] : Double quote usage fix removing too many double quotes
3915+
- Fixed bug [#20196][pear-20196] : 1.5.2 breaks scope_closer position
3916+
3917+
[sq-314]: https://github.com/squizlabs/PHP_CodeSniffer/issues/314
3918+
[sq-324]: https://github.com/squizlabs/PHP_CodeSniffer/issues/324
3919+
[sq-335]: https://github.com/squizlabs/PHP_CodeSniffer/issues/335
3920+
[sq-337]: https://github.com/squizlabs/PHP_CodeSniffer/issues/337
3921+
[sq-339]: https://github.com/squizlabs/PHP_CodeSniffer/issues/339
3922+
[sq-342]: https://github.com/squizlabs/PHP_CodeSniffer/issues/342
3923+
[sq-345]: https://github.com/squizlabs/PHP_CodeSniffer/issues/345
3924+
[sq-346]: https://github.com/squizlabs/PHP_CodeSniffer/issues/346
3925+
[sq-353]: https://github.com/squizlabs/PHP_CodeSniffer/issues/353
3926+
[sq-358]: https://github.com/squizlabs/PHP_CodeSniffer/issues/358
3927+
[sq-361]: https://github.com/squizlabs/PHP_CodeSniffer/issues/361
3928+
[sq-364]: https://github.com/squizlabs/PHP_CodeSniffer/pull/364
3929+
[sq-366]: https://github.com/squizlabs/PHP_CodeSniffer/issues/366
3930+
[sq-367]: https://github.com/squizlabs/PHP_CodeSniffer/issues/367
3931+
[sq-369]: https://github.com/squizlabs/PHP_CodeSniffer/issues/369
3932+
[sq-371]: https://github.com/squizlabs/PHP_CodeSniffer/issues/371
3933+
[sq-372]: https://github.com/squizlabs/PHP_CodeSniffer/issues/372
3934+
[sq-373]: https://github.com/squizlabs/PHP_CodeSniffer/issues/373
3935+
[pear-20196]: https://pear.php.net/bugs/bug.php?id=20196
38923936

38933937
## [2.0.0] - 2014-12-05
38943938
### Changed
@@ -3920,9 +3964,13 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
39203964
- Improved fixing of lines after cases statements in Squiz SwitchDeclarationSniff
39213965

39223966
### Fixed
3923-
- Fixed bug #311 : Suppression of function prototype breaks checking of lines within function
3924-
- Fixed bug #320 : Code sniffer indentation issue
3925-
- Fixed bug #333 : Nested ternary operators causing problems
3967+
- Fixed bug [#311][sq-311] : Suppression of function prototype breaks checking of lines within function
3968+
- Fixed bug [#320][sq-320] : Code sniffer indentation issue
3969+
- Fixed bug [#333][sq-333] : Nested ternary operators causing problems
3970+
3971+
[sq-311]: https://github.com/squizlabs/PHP_CodeSniffer/issues/311
3972+
[sq-320]: https://github.com/squizlabs/PHP_CodeSniffer/issues/320
3973+
[sq-333]: https://github.com/squizlabs/PHP_CodeSniffer/issues/333
39263974

39273975
## [1.5.6] - 2014-12-05
39283976
### Changed

0 commit comments

Comments
 (0)