Plans for caching?

[JoolsMcFly]

Hi,

thanks for this cool fixer.
It currently takes 13s to fix our templates folder and I was wondering if there was any plans to add a caching layer like PHP-CS-Fixer has?

Thanks!

[VincentLanglet]

Hi. Caching would be a great feature indeed.
I didn't look at how it was made in PHP-CS-Fixer, but we could try to do similar things.

Do you want to try ?

[VincentLanglet]

If it works for you and tests are working, I think we can merge this like this.
I'll be able to write tests on a separate PR and it will be easier to try the dev-main branch on some personal projects.

[JoolsMcFly]

OK, I added some basic tests for reading/writing cache files and refactored according to your latest suggestions.

If I add a call to setCacheFile in .twig-cs-fixer.php then custom cache file is used. Otherwise it defaults to .twig-cs-fixer.cache.

I tested adding / removing sniffs from .twig-cs-fixer.php and cache was invalidated accordingly.
If I don't make changes to a file after it was fixed then it's skipped. If content is different then it is parsed.

If you feel like testing a bit on your end then feel free! In the meantime I'll remove the draft status from my PR.

[VincentLanglet]

@JoolsMcFly I have a last issue I'd like to solve before the release.

I try the cache feature with

$config = new Config();
$config->setCacheFile('.build/twig-cs-fixer/.twig-cs-fixer.cache');

when the twig-cs-fixer directory does not exist.

I got the error Directory of cache file "%s" does not exists..
I'd like the directory to be created instead, in the same time than the file.

What I don't understand is the fact this check exists in PHP-CS-Fixer, and I don't have the error
https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/src/Cache/FileHandler.php#L80

Any idea ?

[VincentLanglet]

My bad, it seems like I had

if (!file_exists($dirCache)) {
    mkdir($dirCache, 0777, true);
}

in my php-cs-fixer config, so I have the same behavior.

So it seems ready to be released.

[JoolsMcFly]

Phew. ;)
All good then!