Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generic/InlineControlStructure: fix error when handling else if #499

Merged

Conversation

rodrigoprimo
Copy link
Contributor

Description

This PR fixes a bug in the Generic.ControlStructures.InlineControlStructure sniff where it would not handle correctly else if statements when there is a comment between the else and if tokens.

The affected code was added in squizlabs/PHP_CodeSniffer@18f98cc to fix a similar bug when there is more than one whitespace between else and if, but it failed to consider that there might be comment tokens between else and if.

This change was originally part of PR #482, but it was decided to split it into multiple smaller PRs.

Suggested changelog entry

Generic.ControlStructures.InlineControlStructure: properly handle else if statements where there is a comment between else and if

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change.
  • I have read the Contribution Guidelines.
  • I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
  • I have added tests to cover my changes.
  • I have verified that the code complies with the projects coding standards.
  • [Required for new sniffs] I have added XML documentation for the sniff.

This commit fixes a bug in this sniff where it would not handle
correctly `else if` statements when there is a comment between the
`else` and `if` tokens.

The affected code was added in
squizlabs/PHP_CodeSniffer@18f98cc
to fix a similar bug when there is more than one whitespace between `else`
and `if`, but it failed to consider that there might be comment tokens
between `else` and `if`.
Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rodrigoprimo !

@jrfnl jrfnl added this to the 3.10.0 milestone May 18, 2024
@jrfnl jrfnl merged commit 4866ee3 into PHPCSStandards:master May 18, 2024
42 checks passed
@rodrigoprimo rodrigoprimo deleted the fix-inline-control-structure-bug branch May 20, 2024 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants