A faster drop in replacement for bin/magento cache:clean with file watcher
"You know, hope is a mistake. If you can't fix what's broken, you'll, uh... you'll go insane." - Max Rockatansky
A faster drop in replacement for bin/magento cache:clean
with a file watcher.
The file watcher automatically cleans affected cache types in the Magento 2
cache during development.
For example, if you make a change to a template, it only cleans the
block_html
and full_page
caches, not the config
or layout
caches.
The project is only tested on MacOS and Linux. Please report bugs by opening an issue on the GitHub issue tracker.
app/etc/env.php
Installation:
composer require --dev mage2tv/magento-cache-clean
Update:
composer update --dev mage2tv/magento-cache-clean
The tool is commonly installed globally using composer global require ...
.
In your Magento directory, run vendor/bin/cache-clean.js --watch
Press Ctrl-C
to exit the watcher process.
The script can also be used as a faster drop in replacement of bin/magento cache:clean
.
For example:
vendor/bin/cache-clean.js config full_page
(It's quicker because the start up time of bin/magento
is so slow.)
There are several options to customize the behavior:
vendor/bin/cache-clean.js --help
Sponsored by https://www.mage2.tv
Usage: cache-clean.js [options and flags] [cache-types...]
Clean the given cache types. If none are given, clean all cache types.
--directory|-d <dir> Magento base directory
--watch|-w Watch for file changes
--verbose|-v Display more information
--no-flood-guard|-n Disable the 5s debounce per cache type
--debug|-vv Display too much information
--silent|-s Display less information
--version Display the version
--help|-h This help message
Usually I run the command once with the --watch
switch when I start
development, and when I make a change that isn't automatically detected (yet),
I run vendor/bin/cache-clean.js
with the given cache types as a drop in
replacement for bin/magento cache:clean
.
When the watcher is running, segments of the cache can be cleaned with individual keystrokes:
Key | Cache Segment(s) |
---|---|
c |
config |
b |
block_html |
l |
layout |
f |
full_page |
a |
(a for all) |
v |
(v for view) block_html , layout , full_page , translate |
t |
translate |
There also are hotkeys to clean the static assets in the A
dminhtml or
the F
rontend area or I
ntegration test sandboxes or clean the G
enerated code directory.
node.js
(built on 10, but should work with older 8.x versions, too).bin/magento cache:enable
to get the full benefit.Currently, the watcher has to be restarted after a new theme is added, so it is added to the watchlist.
Changes to files on NFS mounts (e.g. in vagrant) do not trigger the watches. Depending on a given setup, it might be possible to run the watcher on the host system instead.
If you run the task in PHPStorm and the hotkeys are not working, search for
actions by pressing STRG+SHIFT+A
, then search for "registry...", then
enable nodejs.console.use.terminal
and restart the watcher process.
Not tested a lot on Windows, please open an issue if you want to contribute.
If you run into the error Error NOSPC
or ENOSPC: System limit for number of file watchers reached
on Linux, run the command:
echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
var/cache
directory instead of var/page_cache
.
This issue causes the cache cleaner behavior to be erratic.
There is an easy workaround, namely removing all cache configuration from
the default app/etc/env.php
. The bug only affects the default config with the
file system cache backend. Redis or Varnish are not affected.
The bug will be fixed in the (currently upcoming) Magento 2.3.4 release.Some words on using the watcher with Docker & VMs.
The rationale explains the reasons I wrote the utility.
How to build the tool from source.
Integrating the watcher with PHPStorm:
This script was inspired by Timon de Groot's
blog post where he
describes the idea to use a file watcher in PHPStorm to call redis-cli
to
clear the complete cache whenever a XML file is modified.
The only downside of that solution is that it always flushes the full cache and
only works with redis.
Thank you also to everybody who gave feedback, shared ideas and helped test new features! This tool would be impossible without you!
Copyright 2019 - present by Vinai Kopp, distributed under the BSD-3-Clause license (see the LICENSE file).