Nos Twig Code Sniffer

andreas.penz

Hey folks 👋

I'd like to introduce you to a tool I've developed called "Nos Twig Code Sniffer." This tool aims to identify invalid Twig templates and uphold the official Twig coding standards with a few exceptions in to your PYZ/Yves Codebase.

If you find this project to be useful or encounter any issues, please don't hesitate to reach out to me, create an issue or submit a pull request. 😀

https://github.com/project-nos/spryker-twig-code-sniffer

ynnoig

We use in our project this twig lint ( https://github.com/friendsoftwig/twigcs ) but of course your code sniffer seems to be suitable for spryker customizations (define, widget.. etc..).

Good idea!

@Guido X Jansen can u maybe put this in the community repos, even if @andreas.penz is agree with it?

andreas.penz

@ynnoig initially i wanted to use the "twigcs" lib also until I encountered this issue: https://github.com/friendsoftwig/twigcs/issues/304

@Guido X Jansen i would agree to add this to the community repositories

sven.ommer

Hey,

this seems like a nice tool-addition :)

I have a suggestion: use every Namespace-Entry from $config[KernelConstants::PROJECT_NAMESPACES] inside of TwigCodeSnifferConfig , when return the paths ;)
This way, every project won't need to overwrite the config just for their namespace

Samuel Pais

Props to you! Looks extremely promising!

https://media.giphy.com/media/MaJ7An3EUgLCCh4lXS/giphy.gif

Lauren Kulwicki

Goooo @andreas.penz !! 🙌🤩

andreas.penz

https://commercequest.space/discussion/comment/28634#Comment_28634

@sven.ommer perhaps it would be more optimal to configure the paths in config/Shared/config_xyz.php and substitute the Pyz segment with an asterisk (*) to automatically scan all Yves templates within the src folder by default.What do you think about that?

I also just found out that "GLOB_BRACE" ("{a,b,c}") inside the path is not support by on all plattforms - i will also implement support for this stuff in the next release.

Would you be so kind as to create your feature request as an issue on GitHub? 😁

Guido X Jansen

@andreas.penz awesome! And done @ynnoig:

https://github.com/spryker-community/twig-code-sniffer

sven.ommer

https://commercequest.space/discussion/comment/28638#Comment_28638

I wouldn't do the "scan all", because sometimes you don't want other stuff to check, but the config is a good solution :)

andreas.penz

@sven.ommer Thanks for your feature request. The tool now uses all configured project namespaces in order to generate the appropriate theme paths. These changes are already part of the newest release ->  https://github.com/project-nos/spryker-twig-code-sniffer/releases/tag/v1.1.0