PHPCSStandards / PHP_CodeSniffer

PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
BSD 3-Clause "New" or "Revised" License
906 stars 55 forks source link

Generic/InlineControlStructure: two issues when fixing some do-while statements #483

Open rodrigoprimo opened 5 months ago

rodrigoprimo commented 5 months ago

Describe the bug

While working on #482, I found two issues in the Generic.ControlStructures.InlineControlStructure sniff when fixing some do-while statements that contain syntax errors.

Code sample

Code sample 1:

<?php

// missing semicolon and nothing but empty tokens after the while closing parenthesis
foreach ($array as $item)
    do {
        echo $i;
        $i++;
    } while ($i < 5)

Code sample 2:

<?php

// missing semicolon after while condition and non-empty tokens after it
foreach ($array as $item)
    do {
        echo $i;
        $i++;
    } while ($i < 5)

if ($test)
    echo 'test';

To reproduce

Steps to reproduce the behavior:

  1. Create a file called test.php with one of the code samples above.
  2. Run phpcbf --standard=Generic --sniffs=Generic.ControlStructures.InlineControlStructure test.php
  3. Check the modified files.

Modified code sample 1 (note the semicolon and closing curly bracket added after the PHP opening tag):

<?php
; 
}
// missing semicolon and nothing but empty tokens after the while closing parenthesis
foreach ($array as $item) {
    do {
        echo $i;
        $i++;
    } while ($i < 5)

Modified code sample 2 (note the curly bracket added after the while closing parenthesis and after the if statement):

<?php

// missing semicolon after while condition and non-empty tokens after it
foreach ($array as $item) {
    do {
        echo $i;
        $i++;
    } while ($i < 5) {

if ($test) {
    echo 'test';
}
    }
}

Expected behavior

I would expect PHPCS to detect the syntax error in both cases (missing semicolon after while closing parenthesis) and to bail instead of attempting to fix the code sample, introducing even more problems.

Versions (please complete the following information)

Operating System Ubuntu 23.10
PHP version 8.3
PHP_CodeSniffer version master
Standard Generic
Install type git clone

Please confirm

jrfnl commented 4 months ago

I would expect PHPCS to detect the syntax error in both cases (missing semicolon after while closing parenthesis) and to bail instead of attempting to fix the code sample, introducing even more problems.

I think the bailing early should only happen if it is a while which is part of a do-while and there is no other code after it, otherwise, the sniff would start to ignore while structures which are perfectly fine to fix like:

foreach ($array as $item)
    while ($i < 5)
        if ($test)
            echo 'test';