This PR can be summarized in the following changelog entry:
Enable PHPCS caching
Relevant technical choices:
Since PHPCS 3.0.0, PHPCS has a caching feature available. In this PR, this caching feature is now turned on for this repo.
This means in effect that the very first run of PHPCS with this feature will be marginally slower (on any individual machine). Most runs after that though, will be significantly faster as PHPCS will only scan the files which have changed since the previous run.
The cache will automatically be invalidated and rebuild whenever relevant, like when the version of one of the PHPCS dependencies has changed or when PHPCS itself has been changed.
To (temporarily) turn caching off, run PHPCS like so:
composer check-cs -- --no-cache
The cache file is set to be saved to a .cache directory to allow Travis to benefit from this feature as well.
As this directory has to exist for the cache file to be written to it, it is created and committed to the repo with a .gitkeep file
Commit details:
/.cache/ directory:
Create the directory and place a .gitkeep file in it to allow it to be committed.
PHPCS config file:
Enable the caching feature to a fixed file called /.cache/phpcs.cache.
.gitignore:
Prevent committing of the cache file.
.gitattributes:
Do not include the .cache directory in distributable archives.
Travis:
Use the Travis caching feature to cache the new .cache directory (including the cache file) between runs to allow Travis to benefit from the PHPCS caching as well.
Test instructions
This PR can be tested by following these steps:
Testing this PR
Check out this branch.
Run composer check-cs and take note of the time the run has taken at the bottom of the report.
Verify that the .cache directory on your machine now contains a phpcs.cache file.
Run composer check-cs again. If all went well, the run should be significantly faster compared to the earlier run.
Also verify that Travis correctly caches the .cache directory. While that won't make a difference for this build, it should for future builds.
Summary
This PR can be summarized in the following changelog entry:
Relevant technical choices:
Since PHPCS 3.0.0, PHPCS has a caching feature available. In this PR, this caching feature is now turned on for this repo.
This means in effect that the very first run of PHPCS with this feature will be marginally slower (on any individual machine). Most runs after that though, will be significantly faster as PHPCS will only scan the files which have changed since the previous run.
The cache will automatically be invalidated and rebuild whenever relevant, like when the version of one of the PHPCS dependencies has changed or when PHPCS itself has been changed.
To (temporarily) turn caching off, run PHPCS like so:
The cache file is set to be saved to a
.cachedirectory to allow Travis to benefit from this feature as well. As this directory has to exist for the cache file to be written to it, it is created and committed to the repo with a.gitkeepfileCommit details:
/.cache/directory:.gitkeepfile in it to allow it to be committed.PHPCS config file:
/.cache/phpcs.cache..gitignore:.gitattributes:.cachedirectory in distributable archives.Travis:
.cachedirectory (including the cache file) between runs to allow Travis to benefit from the PHPCS caching as well.Test instructions
This PR can be tested by following these steps:
Testing this PR
composer check-csand take note of the time the run has taken at the bottom of the report..cachedirectory on your machine now contains aphpcs.cachefile.composer check-csagain. If all went well, the run should be significantly faster compared to the earlier run.Also verify that Travis correctly caches the
.cachedirectory. While that won't make a difference for this build, it should for future builds.