Problem/Motivation
Since PHP CodeSniffer release 3.12 the following error popped up:
FILE: [....].module
-----------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------
15 | ERROR | [x] Expected 1 blank line before function; 0 found (Squiz.WhiteSpace.FunctionSpacing.Before)
-----------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------
I'm using Coder 8.3.28 and php_codesniffer 3.12.0.
When I'm downgraing php_codesniffer to 3.11.3 but using the same Coder 8.3.28 version this error is not reported.
The error pops only module or inc files where only one function is defined and no use statements.
My phpcs.xml.dist file includes Drupal and DrupalPractice rulesets, configures the use statements sorting, and disables the requirement of the blank line before file DockBlock comment on the top of the module files.
Steps to reproduce
Failing simple module file
/**
* @file
* MY module file.
*/
/**
* Implements hook_preprocess_field().
*/
function MYMODULE_preprocess_field(&$variables) {
if (
$variables['entity_type'] == 'node'
&& $variables['field_name'] == 'body'
) {
// ....
}
}
Same file not failing when there are any use statements before the single function.
/**
* @file
* MY module file.
*/
use Drupal\node\NodeInterface;
/**
* Implements hook_preprocess_field().
*/
function MYMODULE_preprocess_field(&$variables) {
if (
$variables['element']['#object'] instanceof NodeInterface
&& $variables['field_name'] == 'body'
) {
// ....
}
}