Release of mage-os/magento-cache-clean 1.1.0

Author: Vinai

Makefile

@@ -13,7 +13,7 @@ debug-build:
 	chmod +x bin/cache-clean.js
 
 install-dev-dir:
-	rsync -a ./ $(HOME)/.composer/vendor/mage2tv/magento-cache-clean/
+	rsync -a ./ $(HOME)/.composer/vendor/mage-os/magento-cache-clean/
 
 install-debug: debug-build install-dev-dir
 

bin/cache-clean.js

@@ -1,13 +1,13 @@
 {
-    "name": "mage2tv/magento-cache-clean",
+    "name": "mage-os/magento-cache-clean",
     "description": "A faster drop in replacement for bin/magento cache:clean with file watcher",
     "type": "library",
     "keywords": [
         "magento",
         "development",
         "utility"
     ],
-    "homepage": "https://github.com/mage2tv/magento-cache-clean",
+    "homepage": "https://github.com/mage-os/magento-cache-clean",
     "license": "BSD-3-Clause",
     "authors": [
         {
@@ -17,10 +17,7 @@
         }
     ],
     "support": {
-        "issues": "https://github.com/mage2tv/magento-cache-clean/issues"
-    },
-    "suggest": {
-        "magento/project-community-edition": "*"
+        "issues": "https://github.com/mage-os/magento-cache-clean/issues"
     },
     "bin": [
         "bin/cache-clean.js"

composer.json

@@ -7,14 +7,14 @@ In many situations the cache watcher "just works" when run inside the container.
 For example, if you are using [Warden](https://warden.dev), you can run the utility
 after running `warden shell`:
 ```
-$ composer global require mage2tv/magento-cache-clean
+$ composer global require mage-os/magento-cache-clean
 $ ~/.composer/vendor/bin/cache-clean.js -w
 ```
 
 Or, if you want to execute the commands from the host machine:
 
 ```
-$ warden env exec php-fpm composer global require mage2tv/magento-cache-clean
+$ warden env exec php-fpm composer global require mage-os/magento-cache-clean
 $ warden env exec php-fpm /home/www-data/.composer/vendor/bin/cache-clean.js -w
 ```
 
@@ -24,7 +24,7 @@ be done once for all projects.
 Simon Sprankel provided [a screenshot of the PHPStorm settings](https://github.com/davidalger/warden/issues/258#issuecomment-723576699) on how the command can be run automatically.
 
 However, there are a couple of common issues that can arrise when working
-with a virtualized environment in regards to the `cache-clean.js` watcher.
+with a virtualized environment in regard to the `cache-clean.js` watcher.
 
 For example, when the node based watcher is run in a different container than
 PHP based Magento, the file system path to the Magento directory might be
@@ -85,9 +85,9 @@ The script assumes it is run in a Magento base directory, or the Magento
 directory can be passed as an argument:
 
 ```bash
-$ php vendor/mage2tv/magento-cache-clean/bin/generate-cache-clean-config.php
+$ php vendor/mage-os/magento-cache-clean/bin/generate-cache-clean-config.php
 # or
-$ php vendor/mage2tv/magento-cache-clean/bin/generate-cache-clean-config.php path/to/magento
+$ php vendor/mage-os/magento-cache-clean/bin/generate-cache-clean-config.php path/to/magento
 ```
 
 The configuration dump is written to the file `var/cache-clean-config.json`.

doc/docker-and-vm.md

@@ -6,7 +6,7 @@ The API should be considered *beta* stability. It might still change in future i
 ### Quickstart
 
 ```js
-require('./vendor/mage2tv/magento-cache-clean/export/watcher');
+require('./vendor/mage-os/magento-cache-clean/export/watcher');
 
 const mageBaseDir = './';
 const logLevel = 2; // Log Levels: {debug: 3, info: 2, notice: 1, error: 0}
@@ -22,7 +22,7 @@ First, the file with the exported functions needs to be included.
 Assuming the package is installed as a Magento development composer dependency, and the current working directory is that Magento base dir, the functions can be imported into the global namespace via:
 
 ```js
-require('./vendor/mage2tv/magento-cache-clean/export/watcher');
+require('./vendor/mage-os/magento-cache-clean/export/watcher');
 ```
 
 Since the watcher is not a native node application, the exports are global functions on the `cache.watcher` pseudo "namespace".

doc/using-via-code.md

@@ -4,14 +4,12 @@
 
 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.
+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](https://github.com/mage2tv/magento-cache-clean/issues).
-
+Please report bugs by opening an issue on the [GitHub issue tracker](https://github.com/mage-os/magento-cache-clean/issues).
 
 ## Features
 
@@ -26,13 +24,13 @@ Please report bugs by opening an issue on the [GitHub issue tracker](https://git
 Installation:
 
 ``` shell
-composer require --dev mage2tv/magento-cache-clean
+composer require --dev mage-os/magento-cache-clean
 ```
 
 Update:
 
 ``` shell
-composer update --dev mage2tv/magento-cache-clean
+composer update --dev mage-os/magento-cache-clean
 ```
 
 The tool is commonly installed globally using `composer global require ...`.
@@ -50,13 +48,12 @@ For example:
 ``` shell
 vendor/bin/cache-clean.js config full_page
 ```
-(It's quicker because the start up time of `bin/magento` is so slow.)
+(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.
@@ -73,9 +70,8 @@ Clean the given cache types. If none are given, clean all cache types.
 --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
+Usually I run the command once with the `--watch` switch (or `-w`) 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
@@ -104,17 +100,16 @@ Use the `--keep-generated` switch if you want files in `generated/code` to remai
 
 ### 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:enable` to get the full benefit.
+* `node.js` (built on 18, but should work with older 10.x versions, too).
+* It's a good idea to turn on all Magento caches `bin/magento cache:enable` to 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.
+* 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.
 
@@ -141,31 +136,29 @@ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo s
 
 ## More information
 
-* Some words on using the watcher with [Docker & VMs](https://github.com/mage2tv/magento-cache-clean/blob/master/doc/docker-and-vm.md).
+* Some words on using the watcher with [Docker & VMs](https://github.com/mage-os/magento-cache-clean/blob/main/doc/docker-and-vm.md).
 
-* [Running the watcher from code](https://github.com/mage2tv/magento-cache-clean/blob/master/doc/using-via-code.md).
+* [Running the watcher from code](https://github.com/mage-os/magento-cache-clean/blob/main/doc/using-via-code.md).
 
-* The [rationale](https://github.com/mage2tv/magento-cache-clean/blob/master/doc/rationale.md) explains the reasons I wrote the utility.
+* The [rationale](https://github.com/mage-os/magento-cache-clean/blob/main/doc/rationale.md) explains the reasons I wrote the utility.
 
-* How to [build](https://github.com/mage2tv/magento-cache-clean/blob/master/doc/building.md) the tool from source.
+* How to [build](https://github.com/mage-os/magento-cache-clean/blob/main/doc/building.md) the tool from source.
 
-* Integrating the watcher with PHPStorm:
-  * [Mage2 TV] [How to set up the watcher as a PHPStorm startup task](https://www.mage2.tv/content/fundamentals/magento-cli-tool/configuring-the-magento-cache-clean.js-utility-phpstorm-startup-task/).
-  * [Mage2 TV] [How to enable the hotkeys in PHPStorm](https://www.mage2.tv/content/fundamentals/magento-cli-tool/enabling-the-hotkeys-for-the-cache-clean.js-utility-in-phpstorm/).
+* This package used to be called `mage2tv/magento-cache-clean`, but now it is part of Mage-OS, and thus the package name 
+  is `mage-os/magento-cache-clean`. The original package still works as it now is an empty wrapper that requires this 
+  package. Existing installations should continue to work.
 
 ## Thanks
 
 This script was inspired by [Timon de Groot](https://twitter.com/TimonGreat)'s
-[blog post](https://blog.timpack.org/speed-up-magento-development) 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.
+[blog post](https://blog.timpack.org/speed-up-magento-development) 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!
+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](https://github.com/mage2tv/magento-cache-clean/blob/master/LICENSE) file).
+the [LICENSE](https://github.com/mage-os/magento-cache-clean/blob/main/LICENSE) file).

export/watcher.js

@@ -7,7 +7,7 @@
 
 (set! *warn-on-infer* true)
 
-(defonce version "1.0.55")
+(defonce version "1.1.0")
 
 (defn node-version-str []
   (let [proc ^js/process (js/require "process")]

readme.md

@@ -125,7 +125,7 @@
          (file-cache-backend? config)
          (fpc-dir-bug-present? base-dir))
     (log/notice :without-time (str "NOTICE: Workaround for FPC cache dir bug enabled!\n"
-                                   "Please read https://github.com/mage2tv/magento-cache-clean/blob/master/doc/fpc-dir-bug.md"))
+                                   "Please read https://github.com/mage-os/magento-cache-clean/blob/master/doc/fpc-dir-bug.md"))
     true))
 
 (defn missing-cache-dir? [base-dir config cache-type]