[Site] Custom TwigCsFixer config

[smnandre]

(will be rebased after #1947)

Answering you here @VincentLanglet (regarding #1935 (comment))

Would this be the "good/safe" way to go... ?

...or should we create a Standard (and just customize the demo/memory thing here) ?

[VincentLanglet]

should we create a Standard

I'm not sure about a SymfonyUX standard. I tried recently to make the Symfony standard compatible with the ux components with those changes VincentLanglet/Twig-CS-Fixer@35a824e.

So I would say:

• Demo folder seems specific here and should be in your config like you did
• If some "custom" rules like BlockNameSpacingRule, IncludeFunctionRule, etc are wanted by the symfony team we can add it to the Symfony standard. Currently my main issue was that I could only add to the Twig & Symfony standard what I could find on the docs, like
  • https://twig.symfony.com/doc/3.x/coding_standards.html
  • https://symfony.com/doc/current/templates.html#template-naming
  • https://symfony.com/doc/current/best_practices.html#templates
  • https://symfony.com/bundles/ux-twig-component/current/index.html

But the goal would be to have Symfony members adding rules directly in the Symfony standard :)

[VincentLanglet]

You might prefer

->addStandard(new Symfony())
->overrideRule(new DirectoryNameRule(baseDirectory: 'templates', ignoredSubDirectories: ['bundles', 'components', 'demos/live_memory/components']))
->overrideRule(new FileNameRule(baseDirectory: 'templates', ignoredSubDirectories: ['bundles', 'components', 'demos/live_memory/components'], optionalPrefix: '_'))
->addRule(new DirectoryNameRule(case: DirectoryNameRule::PASCAL_CASE, baseDirectory: 'templates/components'))
->addRule(new FileNameRule(case: DirectoryNameRule::PASCAL_CASE, baseDirectory: 'templates/components'))
->addRule(new DirectoryNameRule(case: DirectoryNameRule::PASCAL_CASE, baseDirectory: 'demos/live_memory/components'))
->addRule(new FileNameRule(case: DirectoryNameRule::PASCAL_CASE, baseDirectory: 'demos/live_memory/components'))

it includes the Symfony (in case some other rule are included), and avoid for instance to manually add FileExtensionRule.

[smnandre]

I'm feeling directory and filename always go by two.... or is it a specific case right there ?

[VincentLanglet]

I'm feeling directory and filename always go by two

Yes

[VincentLanglet]

Maybe some of these rules could be added to the Symfony standard but this need to be validated by a Symfony member.

[smnandre]

this is clearly out of the scope of this discussion 😅

[VincentLanglet]

Sure

[VincentLanglet]

Maybe this should be the "default" in the Twig Standard

The standard say Use lower cased and underscored variable names: cf https://twig.symfony.com/doc/3.x/coding_standards.html

Does allowing a _ prefix is "standard" for twig variable ?

[smnandre]

I'm not sure, to be honest, but it's a habit I've had for a long time 😊

[VincentLanglet]

I'm curious, when do you use _foo ?

[smnandre]

In a given template where you have "categories" (the list) and "category" (the current one) for instance

I often do stuff like that

{% for _category in categories %}

    <a href="#" class="{{ _category.id == category.id ? 'current' }}">{{ category.name }}</a>

{% endfor %}