lando-mutagen
Automatically start and stop mutagen syncs when starting and stopping a Lando project.
One of the main issues in having your development environment fully Dockerized on Windows and Mac is performance. Jumping the filesystem boundary (e.g. Mac FS -> Linux container FS or vice versa) causes performance to tank dramatically.
Luckily, Lando provides us with a nice performance feature where directories defined in excludes get one-way synced from the host to Docker named volumes. These Docker named volumes are then mounted at the appropriate locations in the containers. This solves the 'jumping-filesystem-boundary' performance issue.
A drawback of this is once files are in the named volumes, any changes to them do not get synced back to the host. This is problematic when developing, where your IDE needs the package folders (e.g. vendor or node_modules) for proper intellisense.
This is where this plugin comes in. Add a base Mutagen configuration file to your project, add some excludes in your Lando file and the plugin will do the following:
- On
lando start, create an amended mutagen configuration file with the appropriate directory syncs - After
lando start, start up the mutagen syncs, such that modified files in theexcludesdirectories will be synced back to the host - On
lando stop, stop the mutagen syncs - After
lando stop, remove the temporary amended mutagen configuration file
Requirements
- Mutagen installed and running on your host
- Lando (obviously :))
Installation
One-liner
# rm -rf ~/.lando/plugins/lando-mutagen # Delete previous install
mkdir -p ~/.lando/plugins && wget https://github.com/francoisvdv/lando-mutagen/releases/latest/download/release.zip -O /tmp/lando-mutagen.zip && unzip -o /tmp/lando-mutagen.zip -d ~/.lando/plugins && rm /tmp/lando-mutagen.zip
Manual
Add the plugin in ~/.lando/plugins. Your directory will look like this:
~/.lando/plugins/lando-mutagen:
-rw-r--r--@ 1 user group 193 Feb 21 17:07 BaseError.js
-rw-r--r--@ 1 user group 455 Feb 21 17:07 Logger.js
-rw-r--r--@ 1 user group 2338 Feb 21 17:07 Mutagen.js
-rw-r--r--@ 1 user group 3766 Feb 21 17:07 MutagenConfigManipulator.js
-rw-r--r--@ 1 user group 2465 Feb 21 17:07 app.js
-rw-r--r--@ 1 user group 193 Feb 21 17:07 index.js
drwxr-xr-x@ 6 user group 192 Feb 21 17:07 node_modules
-rw-r--r--@ 1 user group 1277 Feb 21 17:07 package.json
-rw-r--r--@ 1 user group 96577 Feb 21 17:07 yarn.lock
Lando will now load the plugin automatically on any lando CLI command. You can verify this by running lando info -v and searching for the line DEBUG ==> plugin lando-mutagen loaded from /Users/user/.lando/plugins/lando-mutagen/index.js
Usage
- Have an existing Lando project containing a
.lando.ymlfile - Add an excludes configuration section to it. E.g.
Note that you might have to do a
excludes: - var - vendorlando rebuildafter this. - Add a
.lando.mutagen.ymlfile, which contains your base mutagen configuration. Example contents (enough to get started):sync: defaults: flushOnCreate: true ignore: vcs: false permissions: defaultFileMode: 644 defaultDirectoryMode: 755 - Run
lando start. This might take some time due to the file syncs. - Profit! File changes in the
excludesdirectories will now be synced back to the host and you can enjoy close-to linux-native Docker filesystem performance.
Development
Setup
- yarn install
- lefthook install
4 May 3, 2022
14 Jan 3, 2023
74 Aug 20, 2022
11 Dec 24, 2022
3 Jun 6, 2022
3 Jun 6, 2022
6 Dec 3, 2022
14 Dec 12, 2022
103 Dec 22, 2022
49 Nov 28, 2022
1 Jan 1, 2022
1.7k Jan 8, 2023
14 Oct 5, 2022
47 Nov 29, 2022
3 Sep 4, 2022
3 Feb 18, 2022
44 Dec 30, 2022
5 Nov 14, 2022