@fishawack/lab-env 1.6.3

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto

package/CHANGELOG.md

@@ -0,0 +1,234 @@
+## Changelog
+
+### 1.6.3 (2021-09-16)
+* [Bug] Fixed mySql volume path now syntax has been deprecated
+
+### 1.6.2 (2021-08-26)
+* [Bug] Fixed missing const
+
+### 1.6.1 (2021-08-25)
+* [Bug] Fixed a typo
+* [Bug] Removed need for esm module, use es5 syntax throughout
+
+### 1.6.0 (2021-08-25)
+* [Feature] Diagnose command now checks gitlab credentials
+* [Feature] Diagnose now checks for ssh keys and ssh folder
+* [Feature] Diagnose now checks for ssh config and settings
+* [Feature] Diagnose now prompts for dev type and skips certain tests for freelancers
+* [Change] All ssh keys and config now mounted into container
+
+### 1.5.0 (2021-08-25)
+* [Feature] Diagnose command now prompts for fixes if available
+* [Feature] Diagnose now checks egnyte details are correct
+* [Feature] Diagnose now attempts to connect to bitbucket before trying to fork
+
+### 1.4.0 (2021-08-24)
+* [Feature] Added boilerplate-laravel and boilerplate-wordpress
+* [Change] Debug flag set on wordpress by default
+* [Bug] Fork the sprinkle-base instead of sprinkle
+
+### 1.3.0 (2021-08-23)
+* [Feature] Can now interface with lab-env via the fw namespace
+* [Feature] Added thre new commands - new/delete/diagnose
+* [Feature] Added lab-cli features into lab-env
+* [Change] Bumped update-notifier
+
+### 1.2.0 (2021-08-05)
+* [Feature] New volumes command
+* [Change] Nuke now uses volumes command
+
+### 1.1.3 (2021-07-23)
+* [Bug] Deploy command now correctly throws errors
+
+### 1.1.2 (2021-07-23)
+* [Bug] Moved env.sh load to .profile rather than entrypoint as that fires on each login
+
+### 1.1.1 (2021-07-23)
+* [Feature] Deploy scripts for wordpress/laravel now defer to deploy.sh just like the setup scripts do
+* [Bug] Setup/Deploy now preface script with /bin/bash to circumvent permission issues
+
+### 1.1.0 (2021-07-23)
+* [Feature] Connect command now takes a service or defaults to core if none provided
+* [Feature] Auto load a env.sh file if it exists in the project root
+* [Change] Laravel uses app working directory to be consistent
+* [Change] Laravel/Wordpress both use the core config rather than duplicating
+* [Change] Moved configs internally to consistent folder structure
+* [Change] Bumped core `0.0.17` to `0.0.18`
+
+### 1.0.0 (2021-07-20)
+* [Change] Look in _Scripts for setup.sh on laravel/wordpress builds
+* [Change] Intercept all npm commands
+
+### 0.21.1 (2021-06-30)
+* [Bug] Use xvfb-run on production command now that webdriverio is used instead of casperjs for ui tests
+
+### 0.21.0 (2021-06-28)
+* [Feature] Added in support for wordpress
+* [Feature] Intercept sed commands in setup.sh
+* [Change] Renamed nginx to web in console table
+* [Change] Renamed node to core in console table
+
+### 0.20.2 (2021-06-09)
+* [Bug] Don't throw errors on lab-env nuke if no files there to nuke
+* [Bug] Suppress 130 exit code errors when stopping watch
+
+### 0.20.1 (2021-05-27)
+* [Bug] Always shut down containers if they've been automatically up'd
+* [Bug] Updates to nginx.conf to fix cors issues for assets
+
+### 0.20.0 (2021-05-25)
+* [Change] Output error message from lab-env intself
+* [Bug] New check for Gitlab variable to toggle TTY setting on docker compose exec
+
+### 0.19.0 (2021-05-25)
+* [Change] Bumped core `0.0.16` to `0.0.17`
+
+### 0.18.0 (2021-05-25)
+* [Change] Locked dart-sass version to 1.34.0
+* [Change] Install dart-sass from github rather than dartsass pub
+
+### 0.17.0 (2021-04-28)
+* [Change] Intercept chmod/chown
+* [Change] Run ./setup.sh script directly on laravel builds
+* [Bug] Set shell to bash explicitly
+
+### 0.16.0 (2021-04-28)
+* [Feature] BrowserSync ports are now mapped to the ports shown
+* [Change] Bumped core `0.0.15` to `0.0.16`
+* [Change] Core stays alive in frontend builds so that tests can be more consistent
+* [Change] Ports are now shown in a table view rather than an echo statement
+* [Change] Laravel now uses core instead of node container
+* [Change] Now the core being used more of the base lab-env commands can now be used
+* [Change] Replaced hardcoded working directory with $PWD in core dockerfile profile overrides
+* [Change] Test command more consistent now core used in laravel
+* [Change] Nuke removes only volumes created by project
+* [Change] Core now sets Lang to en_US.UTF-8
+* [Change] The check for laravel now looks in composer for laravel framework now that mix removed
+
+### 0.15.0 (2021-04-23)
+* [Change] All commands now work work with laravel build
+* [Change] Network now named default to be more consistent with core projects
+* [Bug] Ports are now correctly checked and mapped in laravel projects
+* [Bug] Network now correctly removes after stand alone run commands on laravel projects
+
+### 0.14.0 (2021-04-20)
+* [Feature] Can now detect and process laravel 8 builds
+* [Feature] When running inside a laravel project there's 4 new commands - php, node, artisan, composer
+* [Bug] Use node process.cwd instead of bash $PWD as $PWD has issues with case sensitivity
+* [Misc] Internally split out all commands and refactored lab-env code
+
+### 0.13.0 (2021-04-06)
+* [Change] Bumped core `0.0.14` to `0.0.15`
+* [Bug] Added missing chrome flags to sprinkle stand alone banner process so they work inside the container
+
+### 0.12.1 (2021-03-17)
+* [Bug] Create full slugs from bitbucket project names to handle spaces and symbols
+* [Bug] Handle spaces in local path to project repo
+
+### 0.12.0 (2021-03-12)
+* [Feature] New `reinstall` command
+* [Change] Removed the `docker-nuke` and `docker-clean` commands in favor of adding docker system commands to the docs.
+* [Bug] No longer throw error when removing the network if the network was never created
+
+### 0.11.0 (2021-03-08)
+* [Change] Bumped core `0.0.13` to `0.0.14`
+* [Bug] Network now deleted after lab-env finishes
+* [Bug] npm version command now doesn't trigger npm install custom scripts
+* [Bug] Listen for exit code 131
+
+### 0.10.2 (2021-03-01)
+* [Change] Bumped core `0.0.12` to `0.0.13`
+
+### 0.10.1 (2021-03-01)
+* [Bug] Ftp passive overwrite now done by finding exact string
+
+### 0.10.0 (2021-02-18)
+* [Feature] New uninstall command
+* [Change] Bumped core `0.0.11` to `0.0.12`
+* [Bug] Locked npm to version 6 to fix bin issue
+* [Bug] Capture SIGINT calls and silence them
+* [Bug] Capture ELIFECYCLE calls and silence them
+
+### 0.9.6 (2021-02-16)
+* [Change] Bumped core `0.0.10` to `0.0.11`
+* [Bug] Moved from colons to || true in bash profile to fix issue with banner repo's not chaining setup command
+
+### 0.9.5 (2021-02-16)
+* [Change] Bumped core `0.0.9` to `0.0.10`
+* [Bug] Overwrite lftp uploads to egnyte so they don't do it in parallel as it isn't supported by egnyte
+* [Bug] Overwrite lftp upload on deploys so they upload regardless of timestamps
+* [Bug] Only installs chrome and firefox on selinium custom downloads
+
+### 0.9.4 (2021-02-12)
+* [Change] Bumped core `0.0.8` to `0.0.9`
+* [Change] Stream npx and sed commands just so things don't look like they've hung
+* [Bug] Bug fix for repo's with dots in their name
+* [Bug] Overwrite npm variables in package.jsons' as they aren't supported in windows/linux enviroments
+
+### 0.9.3 (2021-02-11)
+* [Bug] Trim repo names
+
+### 0.9.2 (2021-02-11)
+* [Bug] Removed `git-repo-name` dep as it didn't handle dots in repo names
+
+### 0.9.1 (2021-02-11)
+* [Bug] `lab-env origin` command now sets permissions for groups
+* [Bug] `lab-env origin` command no longer checks out branches to set remote tracking
+
+### 0.9.0 (2021-02-10)
+* [Feature] `lab-env origin` command now creates the group and project on gitlab if it doesn't exist
+* [Feature] Added chalk as a dep for some nice coloring
+
+### 0.8.1 (2021-02-05)
+* [Bug] added process.exit(1) to properly exit the cli on error
+
+### 0.8.0 (2021-02-05)
+* [Change] Bumped core `0.0.7` to `0.0.8`
+* [Change] yargs wrapped in try catch to catch cli errors
+* [Change] Removed all exit 0's from cli, should fail properly or gitlab doesn't know when jobs failed
+* [Bug] Removed empty spaces in .bash_profile to stop future errors in docker
+
+### 0.7.0 (2021-02-01)
+* [Change] Bumped core `0.0.6` to `0.0.7`
+* [Bug] Added apt-get update call before pulling imagemagick to stop issue with updates
+
+### 0.6.0 (2021-01-29)
+* [Change] Bumped core `0.0.5` to `0.0.6`
+* [Bug] Added more lang settings
+* [Bug] Fixes weren't being applied to config-grunt node_modules
+
+### 0.5.0 (2021-01-29)
+* [Change] Added save exact flag to npm
+* [Change] Bumped core `0.0.4` to `0.0.5`
+* [Bug] Added lang to dockerfile to fix Unicode characters breaking scripts
+
+### 0.4.0 (2021-01-22)
+* [Feature] Added origin command
+* [Feature] Added rebuild command
+* [Change] Bumped core `0.0.3` to `0.0.4`
+* [Change] Locked chrome and firefox browser versions as well as webdriver drivers
+* [Change] Update notifier now checks instantly
+
+### 0.3.0 (2021-01-20)
+* [Change] Bumped core `0.0.2` to `0.0.3`
+
+### 0.2.0 (2021-01-20)
+* [Feature] Can now pass flags to run and start commands
+* [Feature] Watch command
+* [Change] lab-env docker-nuke and docker-clean now use dockers system functions
+* [Bug] Insert polling option into browser-sync task to fix windows browser reloading
+* [Bug] Hardcoded the cli name to fix windows showing cli.js
+* [Bug] Only overwrite git commit if git not initialized
+* [Bug] Overwrite ftp to no longer toggle passive as passive is default on these days and it was turning it back off
+* [Bug] chmod the id_rsa as windows doesn't persist file permissions and was defaulting to 777
+* [Bug] Now correctly throws errors on git/npm overwritten commands so they can be chained correctly
+* [Docs] Added pre/post publish scripts
+
+### 0.1.0 (2021-01-12)
+* [Bug] Added flag `--disable-dev-shm-usage` to chrome to fix issue when pdf'ing large repo's
+* [Change] Bumped core `0.0.1` to `0.0.2`
+* [Change] Always use the latest core until the first major release of `1.0.0` is done
+* [Docs] Added readme and changelog to repo
+
+### 0.0.1 (2021-01-11)
+* [Misc] Initial release

package/README.md

@@ -0,0 +1,197 @@
+## Background
+
+### What
+
+A command line utility to spin up and manage FW specific docker containers.
+
+### Why
+
+To automate the spinning up of our tech stack and to provide a consistent environment for dev and production.
+
+## Dependencies
+
+Click on the following links and follow the instructions.
+
+* [Docker](https://docs.docker.com/get-docker/)
+* [npm](https://nodejs.org/en/download/)
+
+Alternatively you can install via `brew` or `choco` depending on your platform.
+
+### Mac
+
+Install brew package manager
+
+```bash
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+Install dependencies
+
+```bash
+brew install node
+brew cask install docker
+```
+
+Optionally install `git`
+
+```bash
+brew install git
+```
+
+### Windows
+
+Install choco package manager.
+
+> The install command needs to be run in an administrative powershell terminal.
+
+```bash
+Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
+```
+
+Install dependancies
+
+```bash
+choco install nodejs
+choco install docker-desktop
+```
+
+Optionally install `git`
+
+```bash
+choco install git
+```
+
+## Getting started
+
+### Install
+
+```bash
+npm install @fishawack/lab-env -g
+```
+
+### Basic usage
+
+```bash
+lab-env setup && lab-env start
+```
+
+## Commands
+
+To see the full command list and a description of each command run the following command.
+
+```bash
+lab-env --help
+```
+
+## Troubleshooting
+
+### Permission denied when mounting nginx conf (Laravel)
+
+#### Problem
+
+This happens when your using NodeJs installed into the root filesystem (/usr/local/bin), you may see errors similar to this:
+
+```bash
+ERROR: for nginx  Cannot start service nginx: OCI runtime create failed: container_linux.go:367: starting container process caused: process_linux.go:495: container init caused: rootfs_linux.go:60: mounting "/usr/local/lib/node_modules/@fishawack/lab-env/laravel/8/nginx/nginx.conf" to rootfs at "/var/lib/docker/overlay2/1ea9b758b732df7b4fe4dd5e1bd57836967bfde1d9a1ae44ca1a5c0d6e95db5c/merged/etc/nginx/conf.d/default.conf" caused: not a directory: unknown: Are you trying to mount a directory onto a file (or vice-versa)? Check if the specified host path exists and is the expected type
+```
+
+#### Solution
+
+Purge your NodeJs installation and install it via NVM [https://github.com/nvm-sh/nvm](https://github.com/nvm-sh/nvm)
+
+### mySql creds
+
+
+### No space left
+
+#### Problem
+
+Docker has 64gb of space by default. If you see the below message you need to have a sping clean and free up some space or give docker more memory.
+
+```bash
+npm WARN tar ENOSPC: no space left on device, write
+```
+
+#### Solution
+
+[Clean](#lab-env-troubleshooting-memory-limit) up your docker.
+
+### mySql creds
+
+#### Problem
+
+When a project is first setup the mysql container will create any tables needed based on whats found in the .env file. If the database details are modified in the .env file after the first run those new tables will not be created resulting in the site not being able to connect to mysql.
+
+```bash
+Illuminate\Database\QueryException  : SQLSTATE[HY000] [2002] php_network_getaddresses: getaddrinfo failed: Name or service not known (SQL: select * from information_schema.tables where table_schema = fide and table_name = migrations)
+```
+
+#### Solution
+
+The volume needs removing and re-setting up, the easiest way to do this is to commit everything in and re-setup the project.
+
+```bash
+# Commit/Stash so you don't lose any work
+git stash
+
+lab-env nuke
+lab-env setup
+
+git stash pop
+```
+
+### Watch / Case sensitive issues
+
+#### Problem
+
+As of docker desktop 3.2.2, if you cd into a directory without correctly matching the case of the folders in your working tree, then you can run into some strange issues, one of them being laravel mix not triggering a watch on javascript or sass files correctly but still working fine for html/twig/blade files.
+
+#### Solution
+
+Always match the case as it exists in your directory structure.
+
+```bash
+// Bad (but will work fine for the most part)
+cd /Users/mmellor/sites/boilerplate
+
+// Good (notice the case in the 'Sites' folder name)
+cd /Users/mmellor/Sites/boilerplate
+```
+
+### Memory limit
+
+By default Docker will assign 64gb of memory for Docker to utilize. After a while of using `lab-env` and potentially other docker setups you may come close to or exceed that limit. To see how much memory docker is using type the following command.
+
+```bash
+docker system df -v
+```
+
+If you want a full clean up of docker then running the following command will remove all containers, volumes, images and caches.
+
+```bash
+docker system prune --all --volumes -f
+```
+
+If you just want to remove the images and containers so they can be built fresh then run the following.
+
+```bash
+docker system prune --all -f
+```
+
+You can also run the slightly less impactful clean command but this command wouldn't do much if you're only use of docker is through `lab-env` as this tool doesn't currently persist any containers between runs.
+
+```bash
+docker system prune -f
+```
+
+If you notice it's mainly the volumes that are taking up all the space then you can either clean out all volumes (this will remove every projects node_modules folder meaning they'll need re-installing).
+
+```bash
+docker volume rm $(docker volume ls -q)
+```
+
+Or you can target specific node_modules and hand pick which ones to remove. For example:
+
+```bash
+docker volume rm boilerplate_node_modules
+```

package/cli.js

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+
+const _ = require('./globals.js');
+
+const updateNotifier = require('update-notifier');
+const pkg = require('./package.json');
+updateNotifier({pkg, updateCheckInterval: 0}).notify();
+
+const execSync = require('child_process').execSync;
+
+const getPort = require('get-port');
+
+const yargs = require('yargs/yargs');
+const { hideBin } = require('yargs/helpers');
+
+const args = hideBin(process.argv);
+
+(async () => {
+    process.env.PORT = await getPort({port: getPort.makeRange(3000, 3100)});
+    process.env.PORT_OPT = +process.env.PORT + 1;
+    process.env.REPO = _.repo;
+    process.env.CWD = process.cwd();
+
+    if(_.platform === "laravel" || _.platform === "wordpress"){
+        process.env.PORT_WEB = await getPort({port: getPort.makeRange(8000, 8100)});
+        process.env.PORT_DB = await getPort({port: getPort.makeRange(3306, 3406)});
+    }
+
+    try{
+        let cli = yargs(args)
+            .scriptName("fw")
+            .parserConfiguration({
+                'unknown-options-as-args': true
+            });
+        
+        // Repo commands
+        let commands = ['start', 'watch', 'setup', 'content', 'production', 'test', 'deploy', 'reinstall', 'install', 'uninstall', 'run', 'check', 'clean', 'nuke', 'regenerate', 'connect', 'execute', 'origin', 'npm'];
+
+        if(_.platform === "laravel"){
+            commands.push('artisan', 'composer', 'php');
+        }
+
+        commands.forEach(d => cli.command(...require(`./commands/${d}.js`)));
+
+        // Docker commands
+        ['build', 'config', 'down', 'mocha', 'rebuild', 'up', 'volumes'].forEach(d => cli.command(...require(`./commands/docker/${d}.js`)));
+
+        // Create commands
+        ['new', 'diagnose', 'delete'].forEach(d => cli.command(...require(`./commands/create/cmds/${d}.js`)));
+
+        cli.demandCommand(1, '')
+            .wrap(null)
+            .strict()
+            .argv;
+    } catch(e){
+        if(e.status !== 130){
+            console.log(e.message);
+        }
+             
+        shutdown();
+
+        process.exit(1);
+    }
+
+    shutdown();
+})();
+
+// Remove network leftover by docker-compose run
+function shutdown(){
+    try{ execSync(`docker network rm ${_.repo_safe}_default &>/dev/null`, _.opts); } catch(e){}
+}