moodle-extra multi-line control structure rule conflicts with moodle-plugin-ci

[james-cnz]

The moodle-extra rule set seems to have a rule that conflicts with moodle-plugin-ci.
The moodle-extra rules set has: The first expression of a multi-line control structure must be on the line after the opening parenthesis
moodle-plugin-ci has: Whitespace found after opening bracket of FOR loop (Squiz.ControlStructures.ForLoopDeclaration.SpacingAfterOpen)

[andrewnicols]

Can you please provide a code example of what it’s picking up and what you believe is correct Andrew Lyons Principal Architect Moodle HQ - moodle.com [image: Moodle - Empowering educators to improve our world]

…

On Tue, 9 Sep 2025 at 06:35, James C ***@***.***> wrote: *james-cnz* created an issue (moodlehq/moodle-cs#211) <#211> The moodle-extra rule set seems to have a rule that conflicts with moodle-plugin-ci. The moodle-extra rules set has: The first expression of a multi-line control structure must be on the line after the opening parenthesis moodle-plugin-ci has: Whitespace found after opening bracket of FOR loop (Squiz.ControlStructures.ForLoopDeclaration.SpacingAfterOpen) — Reply to this email directly, view it on GitHub <#211>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAC2K75UU3LLXBBL2EZIC3T3RZRI7AVCNFSM6AAAAACF7SCK52VHI2DSMVQWIX3LMV43ASLTON2WKOZTGM4TMNZQG44TMMI> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[james-cnz]

Thanks for your swift response. Here's a code example:

// The following code passes moodle rule set, but fails moodle-extra rule set.
for ($count = 0; /* ... */
    $count < 10; /* ... */
    $count++) {
    echo "<p>{$count}</p>";
}

// The following code passes moodle-extra rule set, but fails moodle rule set.
for (
    $count = 0;
    $count < 10;
    $count++
) {
    echo "<p>{$count}</p>";
}

I think the root issue is that the moodle rule set doesn't support multi-line for loop conditions, and the long-term solution would be to address that. However, I guess the moodle rule set is the more official one, so the short-term solution would be to temporarily remove the relevant rules from the moodle-extra rule set.

[andrewnicols]

Can I check what version of our coding standards you have. These are both working for me correctly on both the moodle and moodle-extra standards:

Test file:

<?php

for ($count = 0; /* ... */
    $count < 10; /* ... */
    $count++) {
    echo "<p>{$count}</p>";
}

// The following code passes moodle-extra rule set, but fails moodle rule set.
for (
    $count = 0;
    $count < 10;
    $count++
) {
    echo "<p>{$count}</p>";
}

With the moodle-extra standard:

➜  sm git:(MDL-86534-main) ✗ phpcs -s --standard=moodle-extra testcs.php

FILE: /Users/nicols/Sites/moodles/sm/moodle/testcs.php
----------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------------------------------------------
 1 | ERROR | [x] Moodle boilerplate not found (moodle.Files.BoilerplateComment.NoBoilerplateComment)
 1 | ERROR | [ ] Missing docblock for file testcs.php (moodle.Commenting.MissingDocblock.File)
 1 | ERROR | [ ] Missing @copyright tag (moodle.Commenting.FileExpectedTags.CopyrightTagMissing)
 1 | ERROR | [ ] Missing @license tag (moodle.Commenting.FileExpectedTags.LicenseTagMissing)
 3 | ERROR | [ ] Expected MOODLE_INTERNAL check or config.php inclusion. Change in global state detected.
   |       |     (moodle.Files.MoodleInternal.MoodleInternalGlobalState)
 3 | ERROR | [x] The first expression of a multi-line control structure must be on the line after the
   |       |     opening parenthesis
   |       |     (PSR12.ControlStructures.ControlStructureSpacing.FirstExpressionLine)
 5 | ERROR | [x] The closing parenthesis of a multi-line control structure must be on the line after the
   |       |     last expression (PSR12.ControlStructures.ControlStructureSpacing.CloseParenthesisLine)
----------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------

Time: 94ms; Memory: 16MB

And the moodle standard:

➜  sm git:(MDL-86534-main) ✗ phpcs -s --standard=moodle testcs.php

FILE: /Users/nicols/Sites/moodles/sm/moodle/testcs.php
----------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------------------------------------------
 1 | ERROR | [x] Moodle boilerplate not found (moodle.Files.BoilerplateComment.NoBoilerplateComment)
 1 | ERROR | [ ] Missing docblock for file testcs.php (moodle.Commenting.MissingDocblock.File)
 1 | ERROR | [ ] Missing @copyright tag (moodle.Commenting.FileExpectedTags.CopyrightTagMissing)
 1 | ERROR | [ ] Missing @license tag (moodle.Commenting.FileExpectedTags.LicenseTagMissing)
 3 | ERROR | [ ] Expected MOODLE_INTERNAL check or config.php inclusion. Change in global state detected.
   |       |     (moodle.Files.MoodleInternal.MoodleInternalGlobalState)
 3 | ERROR | [x] The first expression of a multi-line control structure must be on the line after the
   |       |     opening parenthesis
   |       |     (PSR12.ControlStructures.ControlStructureSpacing.FirstExpressionLine)
 5 | ERROR | [x] The closing parenthesis of a multi-line control structure must be on the line after the
   |       |     last expression (PSR12.ControlStructures.ControlStructureSpacing.CloseParenthesisLine)
----------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------

Time: 122ms; Memory: 16MB

[james-cnz]

I guess it is an old version. I ran these commands today:
composer global config minimum-stability dev
composer global require moodlehq/moodle-cs

Looking again I got this message:
Using version ^3.4 for moodlehq/moodle-cs

Then I ran this command to do the check:
~/.config/composer/vendor/squizlabs/php_codesniffer/bin/phpcs --standard=moodle [directory]

I did already have some stuff installed from a while back. So maybe something didn't get updated?
But I get the same results through moodle-plugin-ci.

[james-cnz]

I guess this is the issue I'm having with moodle-plugin-ci:
moodlehq/moodle-plugin-ci#366