Add rule about file double extension (.html.twig) (#173)

docs/rules.md

@@ -43,3 +43,4 @@
 - Twig
 - DirectoryNameRule
 - FileNameRule
+- FileExtensionRule

src/Rules/File/FileExtensionRule.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigCsFixer\Rules\File;
+
+use TwigCsFixer\File\FileHelper;
+use TwigCsFixer\Rules\AbstractRule;
+
+/**
+ * Ensures file name uses two extensions (e.g. index.html.twig).
+ */
+final class FileExtensionRule extends AbstractRule
+{
+    protected function process(int $tokenPosition, array $tokens): void
+    {
+        if (0 !== $tokenPosition) {
+            return;
+        }
+
+        $token = $tokens[$tokenPosition];
+        $fileName = FileHelper::getFileName($token->getFilename());
+        $fileParts = explode('.', $fileName ?? '');
+
+        $fileExtension = array_pop($fileParts);
+        if ('twig' !== $fileExtension) {
+            return;
+        }
+
+        $formatExtension = array_pop($fileParts);
+        if ([] === $fileParts || null === $formatExtension) {
+            $this->addFileError(
+                sprintf('The file must use two extensions; found ".%s".', $fileExtension),
+                $token,
+            );
+        }
+    }
+}

src/Standard/Symfony.php

@@ -5,6 +5,7 @@
 namespace TwigCsFixer\Standard;
 
 use TwigCsFixer\Rules\File\DirectoryNameRule;
+use TwigCsFixer\Rules\File\FileExtensionRule;
 use TwigCsFixer\Rules\File\FileNameRule;
 
 /**
@@ -21,6 +22,7 @@ public function getRules(): array
             ...(new Twig())->getRules(),
             new FileNameRule(baseDirectory: 'templates', ignoredSubDirectories: ['bundles']),
             new DirectoryNameRule(baseDirectory: 'templates', ignoredSubDirectories: ['bundles']),
+            new FileExtensionRule(),
         ];
     }
 }

tests/Rules/File/FileExtension/.dotfile.html.twig

@@ -0,0 +1 @@
+Nothing

tests/Rules/File/FileExtension/.dotfile.twig

@@ -0,0 +1 @@
+Nothing

tests/Rules/File/FileExtension/FileExtensionRuleTest.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rules\File\FileExtension;
+
+use TwigCsFixer\Rules\File\FileExtensionRule;
+use TwigCsFixer\Tests\Rules\AbstractRuleTestCase;
+
+final class FileExtensionRuleTest extends AbstractRuleTestCase
+{
+    public function testRule(): void
+    {
+        $this->checkRule(new FileExtensionRule(), ['FileExtension.Error']);
+    }
+
+    public function testRuleIgnoredFile(): void
+    {
+        $this->checkRule(new FileExtensionRule(), [], __DIR__.'/FileExtensionRuleTest.php');
+    }
+
+    public function testRuleValidFile(): void
+    {
+        $this->checkRule(new FileExtensionRule(), [], __DIR__.'/file_extension_rule_test.html.twig');
+    }
+
+    public function testRuleValidDotFile(): void
+    {
+        $this->checkRule(new FileExtensionRule(), [], __DIR__.'/.dotfile.twig');
+    }
+
+    public function testRuleValidDotFileWithFormatExtension(): void
+    {
+        $this->checkRule(new FileExtensionRule(), [], __DIR__.'/.dotfile.html.twig');
+    }
+
+    public function testRuleMissingFormatExtension(): void
+    {
+        $this->checkRule(new FileExtensionRule(), ['FileExtension.Error'], __DIR__.'/file_extension_rule_test_missing.twig');
+    }
+}

tests/Rules/File/FileExtension/FileExtensionRuleTest.twig

@@ -0,0 +1 @@
+Nothing

tests/Rules/File/FileExtension/file_extension_rule_test.html.twig

@@ -0,0 +1 @@
+Nothing

tests/Rules/File/FileExtension/file_extension_rule_test_missing.twig

@@ -0,0 +1 @@
+Nothing

tests/Standard/SymfonyTest.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\TestCase;
 use TwigCsFixer\Rules\Delimiter\DelimiterSpacingRule;
 use TwigCsFixer\Rules\File\DirectoryNameRule;
+use TwigCsFixer\Rules\File\FileExtensionRule;
 use TwigCsFixer\Rules\File\FileNameRule;
 use TwigCsFixer\Rules\Operator\OperatorNameSpacingRule;
 use TwigCsFixer\Rules\Operator\OperatorSpacingRule;
@@ -28,6 +29,7 @@ public function testGetRules(): void
             new VariableNameRule(),
             new FileNameRule(baseDirectory: 'templates', ignoredSubDirectories: ['bundles']),
             new DirectoryNameRule(baseDirectory: 'templates', ignoredSubDirectories: ['bundles']),
+            new FileExtensionRule(),
         ], $standard->getRules());
     }
 }