Since Version 3.12.0 I get a new warning about function spacing

[ahtux]

Hi all!

I'm not sure, if this is an issue or a code problem, so I'd like to discuss it first...
The code looks as follows:

<?php
/**
 * Description of file
 *
 * @package foo
 */


/**
 * Description of function
 */
function foo($x)
{
}

The rule looks as follows:

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="PHPCS rule set">
    <rule ref="Squiz.WhiteSpace.FunctionSpacing">
        <properties>
            <property name="spacingBeforeFirst" value="0" />
            <property name="spacingAfterLast" value="0" />
        </properties>
    </rule>
</ruleset>

With version 3.11.3 this was fine, but since 3.12.0 I get the following:
foo.php:12:1: error - Expected 2 blank lines before function; 0 found

From my point of view there are two blank lines...
Am I wrong?

Please help.
Tank you in advance!
Andre

[rodrigoprimo]

Thanks for reporting this problem, @ahtux.

I could reproduce it and confirm that the behavior of the Squiz.WhiteSpace.FunctionSpacing sniff changed from 3.11.3 to 3.12.0. As far as I can test, it is not necessary to change the default values of the spacingBeforeFirst and spacingAfterLast properties to get this error. I get the same error you get just running phpcs --standard=Squiz --sniffs=Squiz.WhiteSpace.FunctionSpacing test.php (where test.php is a file with the code snippet you provided).

#826 caused this change in the Squiz.WhiteSpace.FunctionSpacing sniff behavior, and by reading the PR description, I believe this change was not intentional.

I would also note that PHPCBF "fixes" this error by adding two spaces between the PHP open tag and the file docblock:

<?php


/**
 * Description of file
 *
 * @package foo
 */


/**
 * Description of function
 */
function foo($x)
{
}

I suggest creating a bug report for this: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/new?template=bug_report.md

Tip: use ```php when sharing PHP snippets to enable syntax highlighting.

[jrfnl]

Bug report was opened: #945

[jrfnl]

Closing as solved via PR #946