Download the PHP package mage2tv/magento-cache-clean without Composer
On this page you can find all versions of the php package mage2tv/magento-cache-clean. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mage2tv/magento-cache-clean
More information about mage2tv/magento-cache-clean
Files in mage2tv/magento-cache-clean
Package magento-cache-clean
Short Description A faster drop in replacement for bin/magento cache:clean with file watcher
License BSD-3-Clause
Homepage https://github.com/mage2tv/magento-cache-clean
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package magento-cache-clean
"You know, hope is a mistake. If you can't fix what's broken, you'll, uh... you'll go insane." - Max Rockatansky
Magento 2 Cache Clean
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.
Features
- Supports file, redis and varnish cache backends
- Removes affected generated code classes when a source file is changed
- Zero configuration, all required information is read from
app/etc/env.php - Hotkeys for quick cache flushes while the watcher is running
Installation & Updating
Installation:
Update:
The tool is commonly installed globally using composer global require ....
Usage
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:
(It's quicker because the start up time of bin/magento is so slow.)
There are several options to customize the behavior:
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.
Hotkeys
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 Adminhtml or
the Frontend area or Integration test sandboxes or clean the Generated code directory.
Prerequisites:
node.js(built on 10, but should work with older 8.x versions, too).- It probably is a good idea to turn on all Magento caches
bin/magento cache:enableto get the full benefit.
Known issues
-
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 enablenodejs.console.use.terminaland 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 NOSPCorENOSPC: System limit for number of file watchers reachedon Linux, run the command: - In Magento 2.1.0 - 2.3.3 there is a bug that causes the full page cache
records to be written to the
var/cachedirectory instead ofvar/page_cache. This issue causes the cache cleaner behavior to be erratic. There is an easy workaround, namely removing all cache configuration from the defaultapp/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.
More information
-
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:
- [Mage2 TV] How to set up the watcher as a PHPStorm startup task.
- [Mage2 TV] How to enable the hotkeys in PHPStorm.
Thanks
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 & License
Copyright 2019 - present by Vinai Kopp, distributed under the BSD-3-Clause license (see the LICENSE file).
