@fishawack/lab-env 1.18.1 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 2.0.0 (2022-04-05)
+* [Feature] Craftcms now an option in `fw new` command
+* [Change] Wordpress repos now works differently and will flag unsupported unless they change their folder structure - see [migration guide](https://demo.fishawack.solutions/Lab/Doc/#lab-env-migrating-200)
+* [Docs] Wordpress migration guide
+
 ### 1.18.1 (2022-03-30)
 * [Bug] Craftcms now correctly calls reinstall and deploy commands
 

package/README.md

@@ -195,3 +195,300 @@ Or you can target specific node_modules and hand pick which ones to remove. For
 ```bash
 docker volume rm boilerplate_node_modules
 ```
+
+## Migrating
+
+### 2.0.0
+
+Wordpress repo's are now structured slightly differently to better match laravel, drupal and craftcms setups. Follow these steps to upgrade a wordpress build and get lab-env working again.
+
+#### Reset repository
+
+Before starting this migration ensure all code is committed so you don't run the risk of losing anything afterwhich run one of the following.
+
+```bash
+fw nuke
+
+# or
+
+Remove / Re-clone repository
+```
+
+#### wp-content
+
+Move the plugins, themes and uploads folder a new wp-content folder at the root of the project.
+
+```bash
+# Old way
+./themes
+./plugins
+./uploads
+
+# New way
+./wp-content/themes
+./wp-content/plugins
+./wp-content/uploads
+```
+
+#### .env.example
+
+Replace the contents of the .env.example with the following.
+
+```bash
+# Old way
+DB_DATABASE=wordpress
+DB_USERNAME=wordpress
+DB_PASSWORD=password
+JWT_SECRET=
+
+# New way
+DEBUG=true
+
+DB_DATABASE=wordpress
+DB_USERNAME=wordpress
+DB_PASSWORD=password
+DB_HOST=mysql
+DB_CHARSET=utf8
+DB_COLLATE=
+
+TABLE_PREFIX=wp_
+
+AUTH_KEY=5c94a709b751faeed445f29b92f8513b8bce1652
+SECURE_AUTH=09e370e7bfc34b17fc96d80cda1a281427053afd
+LOGGED_IN=405de7e577398c86b6975fc4a8bba1df179666dd
+NONCE_KEY=10c232cb86bb257af4c0434a7e3b9f993f18ba11
+AUTH_SALT=07a08cb5a6c3318633c505fcf1ffffa4d01ab375
+SECURE_AUTH=df11e32128f8d5403a7c681d0e5cc4145be2b2ab
+LOGGED_IN=a99860e8150b15e11caada875f56421165659a7d
+NONCE_SALT=51c6eba59477027e612fc13e38a53acaa2b73d92
+
+CONFIG_EXTRA="
+    define( 'WP_HOME', 'http://localhost:3000' );
+    define( 'WP_SITEURL', 'http://localhost:3000' );
+"
+```
+
+#### .gitignore
+
+There's a new more complex gitignore now that takes into account the wordpress files that are reverse mounted back to the host machine.
+
+```bash
+# Old way
+# These are some examples of commonly ignored file patterns.
+# You should customize this list as applicable to your project.
+# Learn more about .gitignore:
+#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
+
+# Node artifact files
+node_modules/
+dist/
+
+# Compiled Java class files
+*.class
+
+# Compiled Python bytecode
+*.py[cod]
+
+# Log files
+*.log
+
+# Package files
+*.jar
+
+# Maven
+target/
+dist/
+
+# JetBrains IDE
+.idea/
+
+# Unit test reports
+TEST*.xml
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+.env
+
+
+.tmp/
+generated/
+_Zips/
+_Pdfs/
+coverage/
+**/generated/**/*
+_Build/**/pulled/**/*
+_Output
+_Login
+_Packages
+_Build/content
+_Build/media/content
+_App
+_Electron
+_Node/stats
+ssh-*
+.ftppass
+id_rsa
+misc.json
+.cache/
+themes/twenty*
+themes/thirty*
+themes/*/css
+themes/*/js
+plugins/akismet
+plugins/hello.php
+uploads
+
+# New way
+# These are some examples of commonly ignored file patterns.
+# You should customize this list as applicable to your project.
+# Learn more about .gitignore:
+#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
+
+# Node artifact files
+node_modules/
+dist/
+
+# Compiled Java class files
+*.class
+
+# Compiled Python bytecode
+*.py[cod]
+
+# Log files
+*.log
+
+# Package files
+*.jar
+
+# Maven
+target/
+dist/
+
+# JetBrains IDE
+.idea/
+
+# Unit test reports
+TEST*.xml
+
+# Generated by Windows
+Thumbs.db
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+.env
+
+.tmp/
+generated/
+_Zips/
+_Pdfs/
+coverage/
+**/generated/**/*
+_Build/**/pulled/**/*
+_Output
+_Login
+_Packages
+_Build/content
+_Build/media/content
+_App
+_Electron
+_Node/stats
+ssh-*
+.ftppass
+id_rsa
+misc.json
+.cache/
+
+# Wordpress docker image files
+.htaccess
+license.txt
+readme.html
+index.php
+xmlrpc.php
+wp-*
+!wp-content**/*
+wp-content/index.php
+wp-content/plugins/index.php
+wp-content/themes/index.php
+wp-content/themes/twenty*
+wp-content/themes/thirty*
+wp-content/themes/fishawack/css
+wp-content/themes/fishawack/js
+wp-content/plugins/akismet
+wp-content/plugins/hello.php
+wp-content/uploads
+
+# Generated by MacOS
+.DS_Store
+```
+
+#### Default theme location
+
+The default root attribute needs updating to take into account the new folder structure.
+
+```json
+// Old way
+"attributes": {
+    "root": "themes/fishawack",
+}
+
+// New way
+"attributes": {
+    "root": "wp-content/themes/fishawack",
+}
+```
+
+#### Deploy files
+
+The deploy paths also need updating to take into account the new folder structure.
+
+```json
+// Old way
+"paths": [
+    {
+        "src": "plugins",
+        "dest": "wp-content/plugins"
+    },
+    {
+        "src": "themes",
+        "dest": "wp-content/themes"
+    }
+]
+
+// New way
+"paths": [
+    {
+        "src": "wp-content/plugins",
+        "dest": "wp-content/plugins"
+    },
+    {
+        "src": "wp-content/themes",
+        "dest": "wp-content/themes"
+    }
+]
+```

package/cli.js

@@ -45,6 +45,10 @@ if(!_.services && !(args[0] === 'origin' || args[0] === '--version')) return;
             commands.push('drush');
         }
 
+        if(_.platform === "wordpress"){
+            commands.push('wp');
+        }
+
         if(_.platform === "laravel" || _.platform === "drupal" || _.platform === "craftcms"){
             commands.push('composer', 'php');
         }

package/commands/create/libs/vars.js

@@ -66,6 +66,10 @@ module.exports.templates = [
         "name": "boilerplate-drupal",
         "type": "boilerplate"
     },
+    {
+        "name": "boilerplate-craftcms",
+        "type": "boilerplate"
+    },
     {
         "name": "sprinkle-base",
         "type": "framework",

package/commands/wp.js

@@ -0,0 +1,15 @@
+const _ = require('../globals.js');
+
+const execSync = require('child_process').execSync;
+
+module.exports = [
+    ['wp [command...]', 'wordpress'],
+    'run wp-cli command',
+    yargs => {
+        yargs.positional('command', {
+                describe: 'command to run',
+                default: ''
+            });
+    },
+    argv => _.up(() => execSync(`${_.docker} ${_.exec} wordpress bash -lc "wp ${argv.command.join(' ')} --allow-root"`, _.opts))
+];

package/globals.js

@@ -3,6 +3,7 @@ const path = require('path');
 const { lstatSync, readdirSync, copyFileSync, existsSync } = require('fs');
 const semver = require('semver');
 const getPort = require('get-port');
+const utilities = require('./commands/create/libs/utilities');
 
 process.env.DIRNAME = __dirname;
 
@@ -31,7 +32,7 @@ try{ pkg = require(path.join(process.cwd(), 'package.json')); } catch(e){}
 
 try{ composer = require(path.join(process.cwd(), 'composer.json')); } catch(e){}
 
-try{ wordpress = existsSync(path.join(process.cwd(), 'themes/')); } catch(e){}
+try{ wordpress = existsSync(path.join(process.cwd(), 'wp-content/')); } catch(e){}
 
 if(composer && composer.require && composer.require['laravel/framework']){
     platform = 'laravel';
@@ -42,6 +43,14 @@ if(composer && composer.require && composer.require['laravel/framework']){
 } else if(wordpress) {
     platform = 'wordpress';
 } else {
+    // Check for old wordpress repo stucture and show warning
+    try{ 
+        if(existsSync(path.join(process.cwd(), 'themes/'))){
+            console.log(`This wordpress repo needs migrating to the new repo structure: \n${utilities.colorize(`https://demo.fishawack.solutions/Lab/Doc/#lab-env-migrating-200`, 'title')}`)
+            process.exit(1);
+        }
+    } catch(e){}
+
     platform = 'core';
 }
 

package/intercept.sh

@@ -20,6 +20,10 @@ craft(){
     command lab-env craft "$@"
 }
 
+wp(){
+    command lab-env wp "$@"
+}
+
 php(){
     command lab-env php "$@"
 }
@@ -41,6 +45,7 @@ export -f composer;
 export -f drush;
 export -f artisan;
 export -f craft;
+export -f wp;
 export -f php;
 export -f chown;
 export -f chmod;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishawack/lab-env",
-  "version": "1.18.1",
+  "version": "2.0.0",
   "description": "Docker manager for FW",
   "main": "cli.js",
   "scripts": {

package/wordpress/5.7.2/docker-compose.yml

@@ -13,22 +13,32 @@ services:
     volumes:
       - mysql:/var/lib/mysql
   wordpress:
-    image: wordpress:5.7.2
+    build: 
+      context: ./wordpress/
+      dockerfile: Dockerfile
+    image: lab-env/wordpress/5.7.2/wordpress:0.0.1
     networks:
       - default
     environment:
-      WORDPRESS_DB_HOST: mysql
+      WORDPRESS_DB_NAME: ${DB_DATABASE}
       WORDPRESS_DB_USER: ${DB_USERNAME}
       WORDPRESS_DB_PASSWORD: ${DB_PASSWORD}
-      WORDPRESS_DB_NAME: ${DB_DATABASE}
-      WORDPRESS_CONFIG_EXTRA: |
-        define('JWT_AUTH_SECRET_KEY', '${JWT_SECRET}');
-        define('JWT_AUTH_CORS_ENABLE',true);
-        define('WP_DEBUG',true);
+      WORDPRESS_DB_HOST: ${DB_HOST}
+      WORDPRESS_DB_CHARSET: ${DB_CHARSET}
+      WORDPRESS_DB_COLLATE: ${DB_COLLATE}
+      WORDPRESS_AUTH_KEY: ${AUTH_KEY}
+      WORDPRESS_SECURE_AUTH: ${SECURE_AUTH}
+      WORDPRESS_LOGGED_IN: ${LOGGED_IN}
+      WORDPRESS_NONCE_KEY: ${NONCE_KEY}
+      WORDPRESS_AUTH_SALT: ${AUTH_SALT}
+      WORDPRESS_SECURE_AUTH: ${SECURE_AUTH}
+      WORDPRESS_LOGGED_IN: ${LOGGED_IN}
+      WORDPRESS_NONCE_SALT: ${NONCE_SALT}
+      WORDPRESS_TABLE_PREFIX: ${TABLE_PREFIX}
+      WORDPRESS_DEBUG: ${DEBUG}
+      WORDPRESS_CONFIG_EXTRA: ${CONFIG_EXTRA}
     volumes:
-      - $CWD/themes:/var/www/html/wp-content/themes
-      - $CWD/plugins:/var/www/html/wp-content/plugins
-      - $CWD/uploads:/var/www/html/wp-content/uploads
+      - $CWD/:/var/www/html
       - ./apache/uploads.ini:/usr/local/etc/php/conf.d/uploads.ini
       - ./apache/.htaccess:/var/www/html/.htaccess
     ports:

package/wordpress/5.7.2/wordpress/Dockerfile

@@ -0,0 +1,16 @@
+FROM wordpress:5.7.2
+
+MAINTAINER Mike Mellor
+
+# Install mysql client
+RUN apt-get update && \
+    apt-get install -y mariadb-client
+
+# Install wordpress cli
+RUN curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar && \
+    chmod +x wp-cli.phar && \
+    mv wp-cli.phar /usr/local/bin/wp
+
+# Cleanup apt-get install folders
+RUN apt-get clean && \
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*