Add support for config files with .php extension (#247)

* Add support for config files with .php extension

* Mention config files with .php extensions in README

* Use config files with .php extensions in README examples

* Remove unused namespaced_loaders test data

* Make tests use config files with .php extension

* Fix: Run 'make static-code-analysis-baseline'

* Fix: Adjust tests

* Fix: Give non-distributable configuration files priority

Co-authored-by: Andreas Möller <am@localheinz.com>

README.md

@@ -121,7 +121,7 @@ For more complex needs, have a look at the [custom ruleset documentation](doc/ru
 Using configuration, you can easily store per-project settings:
 
 ```php
-// ~/.twig_cs.dist
+// ~/.twig_cs.dist.php
 <?php
 
 return \FriendsOfTwig\Twigcs\Config\Config::create()
@@ -140,15 +140,22 @@ you must use the `--config` option:
 
 ```
 cd ~/dirA
-twigcs --config ~/dirB/.twig_cs.dist # Will lint templates in ~/dirA with the config of ~/dirB
+twigcs --config ~/dirB/.twig_cs.dist.php # Will lint templates in ~/dirA with the config of ~/dirB
 ```
 
-By default, the files `.twig_cs` and `.twig_cs.dist` are looked up in your current working directory (CWD).
+By default, the files
+
+- `.twig_cs.php`
+- `.twig_cs`
+- `.twig_cs.dist.php`
+- `.twig_cs.dist`
+
+are looked up in your current working directory (CWD).
 
 You can also provide finders inside config files, they will completely replace the path in the CLI:
 
 ```php
-// ~/.twig_cs.dist
+// ~/.twig_cs.dist.php
 <?php
 
 $finderA = FriendsOfTwig\Twigcs\Finder\TemplateFinder::create()->in(__DIR__.'/dirA');

psalm-baseline.xml

@@ -88,7 +88,9 @@
     <MixedInferredReturnType occurrences="1">
       <code>string</code>
     </MixedInferredReturnType>
-    <MixedOperand occurrences="3">
+    <MixedOperand occurrences="5">
+      <code>$configDir</code>
+      <code>$configDir</code>
       <code>$configDir</code>
       <code>$configDir</code>
       <code>$cwd</code>

src/Config/ConfigResolver.php

@@ -337,7 +337,9 @@ private function computeConfigFiles()
         $configDir = $this->cwd;
 
         return [
+            $configDir.\DIRECTORY_SEPARATOR.'.twig_cs.php',
             $configDir.\DIRECTORY_SEPARATOR.'.twig_cs',
+            $configDir.\DIRECTORY_SEPARATOR.'.twig_cs.dist.php',
             $configDir.\DIRECTORY_SEPARATOR.'.twig_cs.dist',
         ];
     }

tests/Config/ConfigResolverTest.php

@@ -143,11 +143,34 @@ public function testGetConfigFileReturnsConfigFileWhenConfigOptionHasNotBeenSpec
     public function provideDefaultConfigFileNameAndAvailableDefaultConfigFileNames(): array
     {
         return [
+            [
+                '.twig_cs.php',
+                [
+                    '.twig_cs',
+                    '.twig_cs.dist',
+                    '.twig_cs.dist.php',
+                    '.twig_cs.php',
+                ],
+            ],
             [
                 '.twig_cs',
                 [
                     '.twig_cs',
                     '.twig_cs.dist',
+                    '.twig_cs.dist.php',
+                ],
+            ],
+            [
+                '.twig_cs.dist.php',
+                [
+                    '.twig_cs.dist',
+                    '.twig_cs.dist.php',
+                ],
+            ],
+            [
+                '.twig_cs.dist',
+                [
+                    '.twig_cs.dist',
                 ],
             ],
         ];
@@ -278,6 +301,8 @@ public function provideDefaultConfigFileName(): \Generator
         $defaultConfigFileNames = [
             '.twig_cs',
             '.twig_cs.dist',
+            '.twig_cs.dist.php',
+            '.twig_cs.php',
         ];
 
         foreach ($defaultConfigFileNames as $defaultConfigFileName) {

tests/Console/LintCommandTest.php

@@ -192,7 +192,7 @@ public function testConfigFileWithoutCliPath()
     {
         $this->commandTester->execute([
             'paths' => null,
-            '--config' => 'tests/data/config/external/.twig_cs.dist',
+            '--config' => 'tests/data/config/external/.twig_cs.dist.php',
         ]);
 
         $output = $this->commandTester->getDisplay();
@@ -209,7 +209,7 @@ public function testConfigFileWithCliPath()
     {
         $this->commandTester->execute([
             'paths' => ['tests/data/syntax_error'],
-            '--config' => 'tests/data/config/external/.twig_cs.dist',
+            '--config' => 'tests/data/config/external/.twig_cs.dist.php',
         ]);
 
         $output = $this->commandTester->getDisplay();
@@ -227,7 +227,7 @@ public function testConfigFileWithCliPath()
     public function testConfigFileWithDisplayAndSeverity()
     {
         $this->commandTester->execute([
-            '--config' => 'tests/data/config/external/.twig_cs_with_display_blocking.dist',
+            '--config' => 'tests/data/config/external/.twig_cs_with_display_blocking.dist.php',
         ]);
 
         $output = $this->commandTester->getDisplay();
@@ -271,7 +271,7 @@ public function testConfigFileSamePathWithRulesetOverrides()
     public function testUnusedWithFileLoader()
     {
         $this->commandTester->execute([
-            '--config' => 'tests/data/config/loaders/.twig_cs.dist',
+            '--config' => 'tests/data/config/loaders/.twig_cs.dist.php',
         ]);
 
         $output = $this->commandTester->getDisplay();