Skip to content

Use explicit Symfony attribute allowlist in StandaloneLineSymfonyAttributeParamFixer #58

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

Merged
TomasVotruba merged 1 commit into from
Jul 22, 2026
+28 −11
Merged

Use explicit Symfony attribute allowlist in StandaloneLineSymfonyAttributeParamFixer #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 28 additions & 11 deletions packages/coding-standard/src/Fixer/Spacing/StandaloneLineSymfonyAttributeParamFixer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,38 @@
/**
* Every argument of a Symfony attribute must be on a standalone line, to ease git diffs when arguments change.
*
* Only Symfony attributes are handled, so third-party attributes keep their original layout. Both fully-qualified
* names (#[\Symfony\...\AsCommand]) and short names imported via a use statement (#[AsCommand]) are recognized.
* Only a fixed allowlist of Symfony attributes is handled, so third-party attributes keep their original layout.
* Both fully-qualified names (#[\Symfony\...\AsCommand]) and short names imported via a use statement (#[AsCommand])
* are recognized. See self::SYMFONY_ATTRIBUTE_CLASSES.
*
* @see \Symplify\CodingStandard\Tests\Fixer\Spacing\StandaloneLineSymfonyAttributeParamFixer\StandaloneLineSymfonyAttributeParamFixerTest
*/
final class StandaloneLineSymfonyAttributeParamFixer extends AbstractSymplifyFixer
{
private const string ERROR_MESSAGE = 'Symfony attribute argument should be on a standalone line to ease git diffs on change';

private const string SYMFONY_NAMESPACE_PART = 'Symfony';
/**
* @var string[]
*/
private const array SYMFONY_ATTRIBUTE_CLASSES = [
'Symfony\Component\Console\Attribute\AsCommand',
'Symfony\Component\Routing\Attribute\Route',
'Symfony\Component\DependencyInjection\Attribute\Autowire',
'Symfony\Component\DependencyInjection\Attribute\AutowireIterator',
'Symfony\Component\DependencyInjection\Attribute\AutowireLocator',
'Symfony\Component\DependencyInjection\Attribute\AsAlias',
'Symfony\Component\DependencyInjection\Attribute\AsDecorator',
'Symfony\Component\DependencyInjection\Attribute\AsTaggedItem',
'Symfony\Component\DependencyInjection\Attribute\When',
'Symfony\Component\EventDispatcher\Attribute\AsEventListener',
'Symfony\Component\Messenger\Attribute\AsMessageHandler',
'Symfony\Component\HttpKernel\Attribute\AsController',
'Symfony\Component\HttpKernel\Attribute\MapRequestPayload',
'Symfony\Component\HttpKernel\Attribute\MapQueryParameter',
'Symfony\Component\HttpKernel\Attribute\MapQueryString',
'Symfony\Component\HttpKernel\Attribute\MapEntity',
'Symfony\Component\Security\Http\Attribute\IsGranted',
];

public function __construct(
private readonly TokensNewliner $tokensNewliner,
Expand Down Expand Up @@ -119,21 +141,16 @@ private function isSymfonyAttribute(Tokens $tokens, int $openBracketPosition, ar
{
$attributeName = $this->resolveAttributeName($tokens, $openBracketPosition);

// fully-qualified or partially-qualified Symfony name, e.g. #[\Symfony\...\AsCommand]
if (str_contains($attributeName, self::SYMFONY_NAMESPACE_PART)) {
return true;
}

// fully-qualified but not Symfony
// fully-qualified name, e.g. #[\Symfony\...\AsCommand]
if (str_starts_with($attributeName, '\\')) {
return false;
return in_array(ltrim($attributeName, '\\'), self::SYMFONY_ATTRIBUTE_CLASSES, true);
}

// short name imported via a use statement, e.g. #[AsCommand] with "use Symfony\...\AsCommand;"
$firstNamePart = explode('\\', $attributeName)[0];
$fullName = $shortNameToFullName[$firstNamePart] ?? null;

return $fullName !== null && str_contains($fullName, self::SYMFONY_NAMESPACE_PART);
return $fullName !== null && in_array($fullName, self::SYMFONY_ATTRIBUTE_CLASSES, true);
}

/**
Expand Down
Loading