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.

Sign up for GitHub

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

Squiz/FunctionDeclarationArgumentSpacing: handle constructor property promotion #792

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Squiz/FunctionDeclarationArgumentSpacing: handle constructor property promotion #792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
23e551b
Squiz/FunctionDeclarationArgumentSpacing: refactor logic for for "spa…
jrfnl Jan 10, 2025
68c96b5
Squiz/FunctionDeclarationArgumentSpacing: special case "spacing after…
jrfnl Jan 10, 2025
62c1100
Squiz/FunctionDeclarationArgumentSpacing: handle modifiers for constr…
jrfnl Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 109 additions & 48 deletions src/Standards/Squiz/Sniffs/Functions/FunctionDeclarationArgumentSpacingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,71 @@ public function processBracket($phpcsFile, $openBracket)
}//end if
}//end if

if (isset($param['visibility_token']) === true && $param['visibility_token'] !== false) {
$visibilityToken = $param['visibility_token'];
$afterVisibilityToken = $phpcsFile->findNext(T_WHITESPACE, ($visibilityToken + 1), $param['token'], true);

$spacesAfter = 0;
if ($afterVisibilityToken !== false
&& $tokens[$visibilityToken]['line'] !== $tokens[$afterVisibilityToken]['line']
) {
$spacesAfter = 'newline';
} else if ($tokens[($visibilityToken + 1)]['code'] === T_WHITESPACE) {
$spacesAfter = $tokens[($visibilityToken + 1)]['length'];
}

if ($spacesAfter !== 1) {
$error = 'Expected 1 space after visibility modifier "%s"; %s found';
$data = [
$tokens[$visibilityToken]['content'],
$spacesAfter,
];

$fix = $phpcsFile->addFixableError($error, $visibilityToken, 'SpacingAfterVisbility', $data);
if ($fix === true) {
$phpcsFile->fixer->beginChangeset();
$phpcsFile->fixer->addContent($visibilityToken, ' ');

for ($i = ($visibilityToken + 1); $tokens[$i]['code'] === T_WHITESPACE; $i++) {
$phpcsFile->fixer->replaceToken($i, '');
}

$phpcsFile->fixer->endChangeset();
}
}//end if
}//end if

if (isset($param['readonly_token']) === true) {
$readonlyToken = $param['readonly_token'];
$afterReadonlyToken = $phpcsFile->findNext(T_WHITESPACE, ($readonlyToken + 1), $param['token'], true);

$spacesAfter = 0;
if ($afterReadonlyToken !== false
&& $tokens[$readonlyToken]['line'] !== $tokens[$afterReadonlyToken]['line']
) {
$spacesAfter = 'newline';
} else if ($tokens[($readonlyToken + 1)]['code'] === T_WHITESPACE) {
$spacesAfter = $tokens[($readonlyToken + 1)]['length'];
}

if ($spacesAfter !== 1) {
$error = 'Expected 1 space after readonly modifier; %s found';
$data = [$spacesAfter];

$fix = $phpcsFile->addFixableError($error, $readonlyToken, 'SpacingAfterReadonly', $data);
if ($fix === true) {
$phpcsFile->fixer->beginChangeset();
$phpcsFile->fixer->addContent($readonlyToken, ' ');

for ($i = ($readonlyToken + 1); $tokens[$i]['code'] === T_WHITESPACE; $i++) {
$phpcsFile->fixer->replaceToken($i, '');
}

$phpcsFile->fixer->endChangeset();
}
}//end if
}//end if

$commaToken = false;
if ($paramNumber > 0 && $params[($paramNumber - 1)]['comma_token'] !== false) {
$commaToken = $params[($paramNumber - 1)]['comma_token'];
Expand Down Expand Up @@ -370,55 +435,51 @@ public function processBracket($phpcsFile, $openBracket)
}

if ($checkComma === true) {
if ($param['type_hint_token'] === false) {
$spacesAfter = 0;
if ($tokens[($commaToken + 1)]['code'] === T_WHITESPACE) {
$spacesAfter = $tokens[($commaToken + 1)]['length'];
}
$typeOfNext = 'argument';
$typeOfNextShort = 'Arg';
$contentOfNext = $param['name'];

if (isset($param['property_visibility']) === true) {
$typeOfNext = 'property modifier';
$typeOfNextShort = 'PropertyModifier';
$modifier = $phpcsFile->findNext(Tokens::$emptyTokens, ($commaToken + 1), $param['token'], true);
$contentOfNext = $tokens[$modifier]['content'];
} else if ($param['type_hint_token'] !== false) {
$typeOfNext = 'type hint';
$typeOfNextShort = 'Hint';
$contentOfNext = $param['type_hint'];
}

if ($spacesAfter === 0) {
$error = 'Expected 1 space between comma and argument "%s"; 0 found';
$data = [$param['name']];
$fix = $phpcsFile->addFixableError($error, $commaToken, 'NoSpaceBeforeArg', $data);
if ($fix === true) {
$phpcsFile->fixer->addContent($commaToken, ' ');
}
} else if ($spacesAfter !== 1) {
$error = 'Expected 1 space between comma and argument "%s"; %s found';
$data = [
$param['name'],
$spacesAfter,
];

$fix = $phpcsFile->addFixableError($error, $commaToken, 'SpacingBeforeArg', $data);
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($commaToken + 1), ' ');
}
}//end if
} else {
$hint = $param['type_hint'];

if ($tokens[($commaToken + 1)]['code'] !== T_WHITESPACE) {
$error = 'Expected 1 space between comma and type hint "%s"; 0 found';
$data = [$hint];
$fix = $phpcsFile->addFixableError($error, $commaToken, 'NoSpaceBeforeHint', $data);
if ($fix === true) {
$phpcsFile->fixer->addContent($commaToken, ' ');
}
} else {
$gap = $tokens[($commaToken + 1)]['length'];
if ($gap !== 1) {
$error = 'Expected 1 space between comma and type hint "%s"; %s found';
$data = [
$hint,
$gap,
];
$fix = $phpcsFile->addFixableError($error, $commaToken, 'SpacingBeforeHint', $data);
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($commaToken + 1), ' ');
}
}
}//end if
$spacesAfter = 0;
if ($tokens[($commaToken + 1)]['code'] === T_WHITESPACE) {
$spacesAfter = $tokens[($commaToken + 1)]['length'];
}

if ($spacesAfter === 0) {
$error = 'Expected 1 space between comma and %s "%s"; 0 found';
$errorCode = 'NoSpaceBefore'.$typeOfNextShort;
$data = [
$typeOfNext,
$contentOfNext,
];

$fix = $phpcsFile->addFixableError($error, $commaToken, $errorCode, $data);
if ($fix === true) {
$phpcsFile->fixer->addContent($commaToken, ' ');
}
} else if ($spacesAfter !== 1) {
$error = 'Expected 1 space between comma and %s "%s"; %s found';
$errorCode = 'SpacingBefore'.$typeOfNextShort;
$data = [
$typeOfNext,
$contentOfNext,
$spacesAfter,
];

$fix = $phpcsFile->addFixableError($error, $commaToken, $errorCode, $data);
if ($fix === true) {
$phpcsFile->fixer->replaceToken(($commaToken + 1), ' ');
}
}//end if
}//end if
}//end if
Expand Down
15 changes: 15 additions & 0 deletions src/Standards/Squiz/Tests/Functions/FunctionDeclarationArgumentSpacingUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,3 +195,18 @@ function newlineBeforeCommaFixerRespectsComments(
, $paramC=30
, string $paramC='foo'
) {}

class PropertyPromotionSpacingAfterComma {
public function __construct(private string|int $propA, protected bool $correctSpace, public MyClass $tooMuchSpace,readonly string $noSpace) {}
}

class PropertyPromotionSpacingAfterModifier {
public function __construct(
private$noSpace,
public MyClass $tooMuchSpace,
protected readonly string $tooMuchSpaceX2,
readonly
public
string $tooMuchSpaceNewLines,
) {}
}
13 changes: 13 additions & 0 deletions src/Standards/Squiz/Tests/Functions/FunctionDeclarationArgumentSpacingUnitTest.1.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,3 +171,16 @@ function newlineBeforeCommaFixerRespectsComments(
$paramC=30,
string $paramC='foo'
) {}

class PropertyPromotionSpacingAfterComma {
public function __construct(private string|int $propA, protected bool $correctSpace, public MyClass $tooMuchSpace, readonly string $noSpace) {}
}

class PropertyPromotionSpacingAfterModifier {
public function __construct(
private $noSpace,
public MyClass $tooMuchSpace,
protected readonly string $tooMuchSpaceX2,
readonly public string $tooMuchSpaceNewLines,
) {}
}
6 changes: 6 additions & 0 deletions src/Standards/Squiz/Tests/Functions/FunctionDeclarationArgumentSpacingUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,12 @@ public function getErrorList($testFile='')
193 => 1,
195 => 1,
196 => 1,
200 => 2,
205 => 1,
206 => 1,
207 => 2,
208 => 1,
209 => 1,
];

default:
Expand Down
Loading