By alex.skrypnyk: Fixed Twig standards violations in templates and replaced TwigCS with Twig-CS-Fixer. (#1411)

Co-authored-by: rgaunt <[email protected]>

Author: AlexSkrypnyk

.ahoy.yml

@@ -171,6 +171,7 @@ commands:
     usage: Lint front-end code (NodeJS dependencies should already be installed).
     cmd: |
       ahoy cli "npm run --prefix \${DREVOPS_WEBROOT}/themes/contrib/\${DRUPAL_THEME} lint"
+      ahoy cli "vendor/bin/twig-cs-fixer lint"
       ahoy cli "vendor/bin/twig-cs-fixer lint --config=/app/web/themes/contrib/civictheme/.twig-cs-fixer.php /app/web/themes/contrib/civictheme"
   lint-check:
     cmd: |

.circleci/config.yml

@@ -247,8 +247,8 @@ job-build: &job-build
         name: Lint code with PHPMD
         command: docker compose exec -T cli vendor/bin/phpmd . text phpmd.xml || [ "${DREVOPS_CI_PHPMD_IGNORE_FAILURE:-0}" -eq 1 ]
     - run:
-        name: Lint code with Twigcs
-        command: docker compose exec -T cli vendor/bin/twigcs || [ "${DREVOPS_CI_TWIGCS_IGNORE_FAILURE:-0}" -eq 1 ]
+        name: Lint code with Twig CS Fixer
+        command: docker compose exec -T cli vendor/bin/twig-cs-fixer lint --config=/app/web/themes/contrib/civictheme/.twig-cs-fixer.php /app/web/themes/contrib/civictheme || [ "${CI_TWIGCSFIXER_IGNORE_FAILURE:-0}" -eq 1 ]
     - run:
         name: Lint code with NPM linters
         command: docker compose exec -T cli bash -c "npm run --prefix \${DREVOPS_WEBROOT}/themes/contrib/\${DRUPAL_THEME} lint" || [ "${DREVOPS_CI_NPM_LINT_IGNORE_FAILURE:-0}" -eq 1 ]

.twig-cs-fixer.cache

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+$ruleset = new TwigCsFixer\Ruleset\Ruleset();
+$ruleset->addStandard(new TwigCsFixer\Standard\Twig());
+$ruleset->addRule(new TwigCsFixer\Rules\Delimiter\BlockNameSpacingRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Delimiter\DelimiterSpacingRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Function\NamedArgumentSpacingRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Operator\OperatorNameSpacingRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Operator\OperatorSpacingRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Punctuation\PunctuationSpacingRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Punctuation\TrailingCommaMultiLineRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Punctuation\TrailingCommaSingleLineRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Literal\HashQuoteRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Literal\SingleQuoteRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Variable\VariableNameRule(TwigCsFixer\Rules\Variable\VariableNameRule::SNAKE_CASE, '_'));
+$ruleset->addRule(new TwigCsFixer\Rules\Whitespace\BlankEOFRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Whitespace\EmptyLinesRule());
+$ruleset->addRule(new TwigCsFixer\Rules\Whitespace\IndentRule(2));
+$ruleset->addRule(new TwigCsFixer\Rules\Whitespace\TrailingSpaceRule());
+
+$finder = new TwigCsFixer\File\Finder();
+$finder->in(__DIR__ . '/web/modules/custom');
+$finder->in(__DIR__ . '/web/themes/contrib/civictheme/templates')->exclude([
+  '.components-civictheme',
+  'components_combined',
+]);
+
+$config = new TwigCsFixer\Config\Config();
+$config->setRuleset($ruleset);
+$config->setFinder($finder);
+$config->allowNonFixableRules();
+$config->addTokenParser(new Drupal\Core\Template\TwigTransTokenParser());
+
+return $config;

.twig-cs-fixer.php

@@ -35,15 +35,15 @@
         "drupal/core-dev": "^11",
         "drupal/drupal-extension": "^5",
         "ergebnis/composer-normalize": "^2.42",
-        "friendsoftwig/twigcs": "^6.2",
         "mglaman/phpstan-drupal": "^1.2",
         "palantirnet/drupal-rector": "^0.20",
         "php-parallel-lint/php-parallel-lint": "^1.3",
         "phpcompatibility/php-compatibility": "^9.3",
         "phpmd/phpmd": "^2.13",
         "phpspec/prophecy-phpunit": "^2.0",
         "phpstan/extension-installer": "^1.3",
-        "pyrech/composer-changelogs": "^1.8"
+        "pyrech/composer-changelogs": "^1.8",
+        "vincentlanglet/twig-cs-fixer": "^3.9"
     },
     "conflict": {
         "drupal/drupal": "*"

.twig_cs.php

@@ -1,6 +1,6 @@
 {
   "dependencies": {
-    "@civictheme/uikit": "github:civictheme/uikit#921eef60baf3dc4bd1aef23beb5c429d199e49b8"
+    "@civictheme/uikit": "github:civictheme/uikit#fe7fe80b114737aa579576a244c5c54618bcca86"
   },
   "scripts": {
     "uikit-change": "node scripts/civictheme-uikit-version-manager/index.mjs"

composer.json

@@ -124,7 +124,7 @@ info "Installing development dependencies."
 # for production images), so we are installing them here.
 #
 note "Copying development configuration files into container."
-docker compose cp -L .twig_cs.php cli:/app/ 2>"${composer_verbose_output}"
+docker compose cp -L .twig-cs-fixer.php cli:/app/ 2>"${composer_verbose_output}"
 docker compose cp -L behat.yml cli:/app/ 2>"${composer_verbose_output}"
 docker compose cp -L phpcs.xml cli:/app/ 2>"${composer_verbose_output}"
 docker compose cp -L phpmd.xml cli:/app/ 2>"${composer_verbose_output}"