minor #5608 DX: new cache filename (keradus)

This PR was merged into the 3.0 branch. Discussion ---------- DX: new cache filename Commits ------- 4c46c89 DX: new cache filename
PHP-CS-Fixer · Apr 12, 2021 · 0c049a6 · 0c049a6
2 parents 3cc811d + 4c46c89
commit 0c049a6
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 9 deletions.
diff --git a/UPGRADE-v3.md b/UPGRADE-v3.md
@@ -3,6 +3,13 @@ UPGRADE GUIDE FROM 2.x to 3.0
 
 This is guide for upgrade from version 2.x to 3.0 for using the CLI tool.
 
+Rename of files
+---------------
+
+| 2.x              | 3.0                      | Description                            |
+| ---------------- | ------------------------ | -------------------------------------- |
+| `.php_cs.cache`  | `.php-cs-fixer.cache`    | Cache file                             |
+
 CLI options
 -----------
 

diff --git a/doc/usage.rst b/doc/usage.rst
@@ -153,7 +153,7 @@ Cache file can be specified via ``--cache-file`` option or config file:
     <?php
 
     $config = new PhpCsFixer\Config();
-    return $config->setCacheFile(__DIR__.'/.php_cs.cache');
+    return $config->setCacheFile(__DIR__.'/.php-cs-fixer.cache');
 
 Using PHP CS Fixer on CI
 ------------------------

diff --git a/src/Config.php b/src/Config.php
@@ -23,7 +23,7 @@
  */
 class Config implements ConfigInterface
 {
-    private $cacheFile = '.php_cs.cache';
+    private $cacheFile = '.php-cs-fixer.cache';
     private $customFixers = [];
     private $finder;
     private $format = 'txt';

diff --git a/src/Console/Command/HelpCommand.php b/src/Console/Command/HelpCommand.php
@@ -263,7 +263,7 @@ public static function getHelpCopy(): string
 
     $config = new Config();
 
-    return $config->setCacheFile(__DIR__.'/.php_cs.cache');
+    return $config->setCacheFile(__DIR__.'/.php-cs-fixer.cache');
 
     ?>
 

diff --git a/tests/Cache/FileHandlerTest.php b/tests/Cache/FileHandlerTest.php
@@ -98,7 +98,7 @@ public function testReadReturnsCache(): void
 
     public function testWriteThrowsIOExceptionIfFileCanNotBeWritten(): void
     {
-        $file = __DIR__.'/non-existent-directory/.php_cs.cache';
+        $file = __DIR__.'/non-existent-directory/.php-cs-fixer.cache';
 
         $this->expectException(\Symfony\Component\Filesystem\Exception\IOException::class);
         $this->expectExceptionMessageMatches(sprintf(
@@ -183,7 +183,7 @@ public function testWriteCacheFilePermissions(): void
 
     private function getFile(): string
     {
-        return __DIR__.'/.php_cs.cache';
+        return __DIR__.'/.php-cs-fixer.cache';
     }
 
     private function createSignature(): SignatureInterface

diff --git a/tests/ConfigTest.php b/tests/ConfigTest.php
@@ -169,7 +169,7 @@ public function testThatCacheFileHasDefaultValue(): void
     {
         $config = new Config();
 
-        static::assertSame('.php_cs.cache', $config->getCacheFile());
+        static::assertSame('.php-cs-fixer.cache', $config->getCacheFile());
     }
 
     public function testThatCacheFileCanBeMutated(): void
@@ -206,7 +206,7 @@ public function testConfigDefault(): void
     {
         $config = new Config();
 
-        static::assertSame('.php_cs.cache', $config->getCacheFile());
+        static::assertSame('.php-cs-fixer.cache', $config->getCacheFile());
         static::assertSame([], $config->getCustomFixers());
         static::assertSame('txt', $config->getFormat());
         static::assertFalse($config->getHideProgress());

diff --git a/tests/Console/ConfigurationResolverTest.php b/tests/Console/ConfigurationResolverTest.php
@@ -1135,8 +1135,8 @@ public function provideGetDirectoryCases()
     {
         return [
             [null, '/my/path/my/file', 'path/my/file'],
-            ['/my/path2/dir/.php_cs.cache', '/my/path2/dir/dir2/file', 'dir2/file'],
-            ['dir/.php_cs.cache', '/my/path/dir/dir3/file', 'dir3/file'],
+            ['/my/path2/dir/.php-cs-fixer.cache', '/my/path2/dir/dir2/file', 'dir2/file'],
+            ['dir/.php-cs-fixer.cache', '/my/path/dir/dir3/file', 'dir3/file'],
         ];
     }