Issue #276: Implemented Twig CS checker/fixer.

Signed-off-by: alexmerlin <[email protected]>
dotkernel · Sep 4, 2024 · 56e3ca8 · 56e3ca8
1 parent cf4c309
commit 56e3ca8
Show file tree

Hide file tree

Showing 14 changed files with 40 additions and 31 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@ clover.xml
 coveralls-upload.json
 .phpunit.result.cache
 .phpcs-cache
+.twig-cs-fixer.cache
 
 # Created by .ignore support plugin (hsz.mobi)
 ### JetBrains template

diff --git a/composer.json b/composer.json
@@ -63,7 +63,8 @@
         "mezzio/mezzio-tooling": "^2.9.0",
         "phpunit/phpunit": "^10.5.9",
         "roave/security-advisories": "dev-latest",
-        "vimeo/psalm": "^5.20.0"
+        "vimeo/psalm": "^5.20.0",
+        "vincentlanglet/twig-cs-fixer": "^3.0"
     },
     "autoload": {
         "psr-4": {
@@ -97,6 +98,8 @@
         "serve": "php -S 0.0.0.0:8080 -t public/",
         "static-analysis": "psalm --shepherd --stats",
         "test": "phpunit --colors=always",
-        "test-coverage": "phpunit --colors=always --coverage-clover clover.xml"
+        "test-coverage": "phpunit --colors=always --coverage-clover clover.xml",
+        "twig-cs-check": "vendor/bin/twig-cs-fixer lint --config=config/twig-cs-fixer.php",
+        "twig-cs-fix": "vendor/bin/twig-cs-fixer lint --config=config/twig-cs-fixer.php --fix"
     }
 }
diff --git a/config/twig-cs-fixer.php b/config/twig-cs-fixer.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+$config = new TwigCsFixer\Config\Config();
+$config->addTwigExtension(new Dot\Twig\Extension\DateExtension());
+$config->addTwigExtension(new Dot\Twig\Extension\TranslationExtension());
+
+return $config;
diff --git a/src/Admin/templates/admin/account.html.twig b/src/Admin/templates/admin/account.html.twig
@@ -4,7 +4,7 @@
 
 {% block content %}
     <div class="row m-5">
-        {{ messagesPartial('partial::alerts', { dismissible: true }) }}
+        {{ messagesPartial('partial::alerts', {dismissible: true}) }}
     </div>
     <div class="row gap-20 masonry pos-r">
         <div class="masonry-sizer col-md-6"></div>
@@ -14,7 +14,7 @@
                 <div class="mT-30">
 
                     {% set dummy = form.prepare() %}
-                    {{ form().openTag(form) | raw }}
+                    {{ form().openTag(form)|raw }}
 
                     {% set identity = form.getElements().identity %}
                     <div class="mb-3 form-group {% if identity.getMessages() %}has-error{% endif %}">
@@ -43,7 +43,7 @@
                     {% set dummy = submit.setAttribute('class', 'btn btn-primary btn-color') %}
                     {{ formSubmit(submit) }}
 
-                    {{ form().closeTag() | raw }}
+                    {{ form().closeTag()|raw }}
                 </div>
             </div>
         </div>
@@ -52,8 +52,8 @@
                 <h6 class="c-grey-900">Change password</h6>
                 <div class="mT-30">
                     {% set dummy = changePasswordForm.prepare() %}
-                    {% set dummy = changePasswordForm.setAttribute('action', path('admin', { action : "change-password" })) %}
-                    {{ form().openTag(changePasswordForm) | raw }}
+                    {% set dummy = changePasswordForm.setAttribute('action', path('admin', {action: 'change-password'})) %}
+                    {{ form().openTag(changePasswordForm)|raw }}
 
                     {% set currentPassword = changePasswordForm.get('currentPassword') %}
                     <div class="mb-3 form-group {% if currentPassword.getMessages() %}has-error{% endif %}">
@@ -82,7 +82,7 @@
                     {% set dummy = submit.setAttribute('class', 'btn btn-primary btn-color') %}
                     {{ formSubmit(submit) }}
 
-                    {{ form().closeTag() | raw }}
+                    {{ form().closeTag()|raw }}
                 </div>
             </div>
         </div>

diff --git a/src/Admin/templates/admin/delete.html.twig b/src/Admin/templates/admin/delete.html.twig
@@ -1,8 +1,8 @@
-{{ form().openTag(form) | raw }}
+{{ form().openTag(form)|raw }}
 <p>Are you sure you want to delete admin account with identity <span id="adminIdentity" class="fw-bold">{{ admin.identity }}</span>?</p>
 <div class="form-check">
     {{ formElement(form.get('confirmation')) }}
     <label class="form-check-label" for="confirmation">Yes, I want to delete <span class="fw-bold">{{ admin.identity }}</span></label>
 </div>
 {{ formElement(form.get('adminDeleteCsrf')) }}
-{{ form().closeTag() | raw }}
+{{ form().closeTag()|raw }}
diff --git a/src/Admin/templates/admin/list.html.twig b/src/Admin/templates/admin/list.html.twig
@@ -85,4 +85,3 @@
         </div>
     </div>
 {% endblock %}
-
diff --git a/src/Admin/templates/admin/login.html.twig b/src/Admin/templates/admin/login.html.twig
@@ -21,7 +21,7 @@
                 </div>
                 <div class="col-md-4">
                     {% set dummy = form.prepare() %}
-                    {{ form().openTag(form) | raw }}
+                    {{ form().openTag(form)|raw }}
                     <h4 class="fw-300 c-grey-900 mB-20">Login</h4>
                     <div class="mb-3">
                         {% set username = form.get('username') %}
@@ -45,7 +45,7 @@
 
                     {{ formSubmit(submit) }}
 
-                    {{ form().closeTag() | raw }}
+                    {{ form().closeTag()|raw }}
                 </div>
             </div>
         </div>

diff --git a/src/App/templates/layout/default.html.twig b/src/App/templates/layout/default.html.twig
@@ -21,9 +21,9 @@
         <![endif]-->
 </head>
 <body class="app">
-    {% include '@partial/left-menu.html.twig' %}
+    {{ include('@partial/left-menu.html.twig') }}
     <div class="page-container">
-        {% include '@partial/nav-bar.html.twig' %}
+        {{ include('@partial/nav-bar.html.twig') }}
         <main class='main-content bgc-grey-100'>
             <div id='mainContent'>
                 {% block content %}{% endblock %}

diff --git a/src/App/templates/partial/ajax-form.html.twig b/src/App/templates/partial/ajax-form.html.twig
@@ -3,9 +3,9 @@
 {% set dummy = form.setAttribute('action', formAction) %}
 {% set dummy = form.prepare() %}
 
-{{ form().openTag(form) | raw }}
-{% include '@partial/form-display-elements.html.twig' with {'form' : form, 'showLabels' : true} only %}
-{{ form().closeTag() | raw }}
+{{ form().openTag(form)|raw }}
+{{ include('@partial/form-display-elements.html.twig', {form: form, showLabels: true}, false) }}
+{{ form().closeTag()|raw }}
 
 <script type="application/javascript">
     $(document).ready(() => {

diff --git a/src/App/templates/partial/alerts.html.twig b/src/App/templates/partial/alerts.html.twig
@@ -1,9 +1,8 @@
-{% set classes = {'error': 'danger', 'info': 'info', 'warning': 'warning', 'success' : 'success'} %}
+{% set classes = {error: 'danger', info: 'info', warning: 'warning', success: 'success'} %}
 {% if dismissible is not defined %}
     {% set dismissible = false %}
 {% endif %}
 
-
 {% if messages is defined and messages is iterable %}
     {% for namespace in messages|keys %}
         {% if classes[namespace] is defined %}

diff --git a/src/App/templates/partial/form-display-elements.html.twig b/src/App/templates/partial/form-display-elements.html.twig
@@ -2,7 +2,7 @@
     {% set showLabels = false %}
 {% endif %}
 
-{% for k,v in form.getElements() %}
+{% for k, v in form.getElements() %}
     {% set element = form.get(k) %}
     {% if element is Captcha %}
         <div class="mb-3">
@@ -17,7 +17,7 @@
         </div>
     {% elseif element is MultiCheckbox %}
         {% set dummy = element.setAttribute('class', 'form-check-input') %}
-        {% set dummy = element.setLabelAttributes([]|merge({'class': 'form-label mR-25'})) %}
+        {% set dummy = element.setLabelAttributes([]|merge({class: 'form-label mR-25'})) %}
 
         <div class="form-check gap-10">
             {{ formElement(element) }}
@@ -49,7 +49,7 @@
         <div class="mb-3 {% if element.getMessages() %}has-error{% endif %}">
 
             {% set dummy = element.setAttribute('class', 'form-control') %}
-            {% set dummy = element.setLabelAttributes([]|merge({'class': 'form-label'})) %}
+            {% set dummy = element.setLabelAttributes([]|merge({class: 'form-label'})) %}
 
             {% if showLabels and element.getLabel() is defined and element.getLabel() is not empty %}
                 {{ formLabel(element) }}

diff --git a/src/App/templates/partial/left-menu.html.twig b/src/App/templates/partial/left-menu.html.twig
@@ -47,19 +47,19 @@
                 </a>
                 <ul class="dropdown-menu">
                     <li class="nav-item dropdown">
-                        <a href="{{ path('admin', { action : 'manage' }) }}">
+                        <a href="{{ path('admin', {action: 'manage'}) }}">
                             <span>List</span>
                         </a>
                     </li>
                     <li class="nav-item dropdown">
-                        <a href="{{ path('admin', { action : 'logins' }) }}">
+                        <a href="{{ path('admin', {action: 'logins'}) }}">
                             <span>View logins</span>
                         </a>
                     </li>
                 </ul>
             </li>
             <li class="nav-item dropdown">
-                <a class="sidebar-link" href="{{ path('page', { action : 'components' }) }}">
+                <a class="sidebar-link" href="{{ path('page', {action: 'components'}) }}">
                     <span class="icon-holder">
                         <i class="c-pink-500 ti-palette"></i>
                     </span>

diff --git a/src/App/templates/partial/menu.html.twig b/src/App/templates/partial/menu.html.twig
@@ -43,16 +43,14 @@
                         {% endif %}
                     {% endif %}
 
-
-
                     {% if page.hasChildren() %}
                         {% set subitemUlClass = 'children collapse' %}
                         {% if navigation.isActive(page) %}
                             {% set subitemUlClass = subitemUlClass ~ ' in' %}
                         {% endif %}
 
                         {% set ulId = 'sub-item-' ~ loop.index %}
-                        {{ navigationPartial(page, 'partial::menu', {'ulClass' : subitemUlClass, 'ulId': ulId, 'depth' : depth + 1}) }}
+                        {{ navigationPartial(page, 'partial::menu', {ulClass: subitemUlClass, ulId: ulId, depth: depth + 1}) }}
 
                     {% endif %}
 

diff --git a/src/App/templates/partial/nav-bar.html.twig b/src/App/templates/partial/nav-bar.html.twig
@@ -29,14 +29,14 @@
                     </a>
                     <ul class="dropdown-menu fsz-sm">
                         <li>
-                            <a href="{{ path('admin', { action : "account" }) }}" class="d-b td-n pY-5 bgcH-grey-100 c-grey-700">
+                            <a href="{{ path('admin', {action: 'account'}) }}" class="d-b td-n pY-5 bgcH-grey-100 c-grey-700">
                                 <i class="ti-user mR-10"></i>
                                 <span>Profile</span>
                             </a>
                         </li>
                         <li role="separator" class="divider"></li>
                         <li>
-                            <a href="{{ path('admin', { action : "logout" }) }}" class="d-b td-n pY-5 bgcH-grey-100 c-grey-700">
+                            <a href="{{ path('admin', {action: 'logout'}) }}" class="d-b td-n pY-5 bgcH-grey-100 c-grey-700">
                                 <i class="ti-power-off mR-10"></i>
                                 <span>Logout</span>
                             </a>