@caweb/cli 1.0.4 → 1.1.0

package/lib/commands/start.js

@@ -1,40 +1,36 @@
-/**
- * Modified from wp-env 8.11.0
- * @see @wordpress/env/lib/commands/start
- */
-'use strict';
-/**
- * External dependencies
- */
-const path = require( 'path' );
-const fs = require( 'fs-extra' );
-const wpEnvStart = require('@wordpress/env/lib/commands/start');
-const util = require( 'util' );
-const { didCacheChange, getCache } = require( '@wordpress/env/lib/cache' );
-const {	
+import path from 'node:path';
+import util from 'node:util';
+import fs from 'fs-extra';
+import yaml from 'js-yaml';
+import dockerCompose from 'docker-compose';
+
+import { default as wpEnvStart} from '@wordpress/env/lib/commands/start.js';
+import {	
 	checkDatabaseConnection, 
 	canAccessWPORG 
-} = require( '@wordpress/env/lib/wordpress' );
-const loadConfig = require( '@wordpress/env/lib/config/load-config' );
-const retry = require( '@wordpress/env/lib/retry' );
-const yaml = require( 'js-yaml' );
-const dockerCompose = require( 'docker-compose' );
+} from '@wordpress/env/lib/wordpress.js';
+
+import retry from '@wordpress/env/lib/retry.js';
 
 const CONFIG_CACHE_KEY = 'config_checksum';
 
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
+import { didCacheChange, getCache } from '@wordpress/env/lib/cache.js';
+
 /**
  * Internal dependencies
  */
-const { configureCAWeb } = require('../caweb');
-const { buildWPEnvConfig, buildDockerComposeConfig } = require('../configs');
-const {downloadSources } = require('../download-sources');
-const { configureWordPress } = require('../wordpress');
+
+import { configureCAWeb } from '../caweb.js';
+import {downloadSources } from '../download-sources.js';
+import { configureWordPress } from '../wordpress.js';
+import { buildWPEnvConfig, buildDockerComposeConfig } from '../configs.js';
 
 /**
  * Promisified dependencies
  */
-const { writeFile } = fs.promises;
 const sleep = util.promisify( setTimeout );
+const { writeFile } = fs.promises;
 
 /**
  * Starts the development server.
@@ -50,7 +46,7 @@ const sleep = util.promisify( setTimeout );
  * @param {boolean} options.subdomain   True if converting to multisite subdomain.
  * 
  */
-module.exports = async function start({
+export default async function start({
 	spinner,
 	update,
 	xdebug,
@@ -60,6 +56,7 @@ module.exports = async function start({
 	multisite,
 	subdomain
 }) {
+
 	spinner.text = 'Writing configuration file...';
 	
 	// Write CAWeb .wp-env.json file.
@@ -93,27 +90,38 @@ module.exports = async function start({
 		( await canAccessWPORG() );
 		
 		
+	// Save pretext from wp-env if it exists for later.
+	let preText = undefined !== spinner.prefixText ? spinner.prefixText.slice(0, -1) : '';
+
+	// We aren't done lets clear the default WordPress text.			
+	spinner.prefixText = '';
+	spinner.text = '';
+
+	// Download any resources required for CAWeb.
+	if( shouldConfigureWp && ! bare ){
+		await downloadSources({spinner, config});
+	}
+		
+	// Write docker-compose.override.yml file to workDirectoryPath.
+	await writeFile(
+		path.join(workDirectoryPath, 'docker-compose.override.yml'),
+		yaml.dump( buildDockerComposeConfig(workDirectoryPath) )
+	);
+
 	// Only run configurations when config has changed.
 	if( shouldConfigureWp ){
-		// Save pretext from wp-env if it exists for later.
-		let preText = undefined !== spinner.prefixText ? spinner.prefixText.slice(0, -1) : '';
-
-		try {
-			// We aren't done lets clear the default WordPress text.			
-			spinner.prefixText = '';
-			spinner.text = '';
-
-			await checkDatabaseConnection( config );
-		} catch ( error ) {
-			// Wait 30 seconds for MySQL to accept connections.
-			await retry( () => checkDatabaseConnection( config ), {
-				times: 30,
-				delay: 1000,
-			} );
-
-			// It takes 3-4 seconds for MySQL to be ready after it starts accepting connections.
-			await sleep( 4000 );
-		}
+
+		// We need to bring the WordPress and CLI instances up again so they pick up
+		// any config changes that may have been added to the docker-compose.override.yml.
+		await dockerCompose.upMany(
+			[
+				'wordpress', 'tests-wordpress',
+				'cli', 'tests-cli'
+			], {
+			cwd: workDirectoryPath,
+			commandOptions: ['--build', '--force-recreate'],
+			log: debug
+		})
 
 		// Make additional WordPress Configurations.
 		await Promise.all( [
@@ -125,17 +133,6 @@ module.exports = async function start({
 			} )
 		] );
 
-		// Download any resources required for CAWeb.
-		if( ! bare ){
-			await downloadSources({spinner, config});
-		}
-
-		// Write docker-compose.override.yml file to workDirectoryPath.
-		await writeFile(
-			path.join(workDirectoryPath, 'docker-compose.override.yml'),
-			yaml.dump( buildDockerComposeConfig(workDirectoryPath) )
-		);
-
 		// Make CAWeb WordPress Configurations.
 		await Promise.all( [
 			retry( () => configureCAWeb( 'development', config, spinner ), {
@@ -146,28 +143,23 @@ module.exports = async function start({
 			} ),
 		] );
 
-		// Start phpMyAdmin Service.
-		spinner.text = 'Starting phpMyAdmin Service';
+	}
+
+	// Start phpMyAdmin Service.
+	spinner.text = 'Starting phpMyAdmin Service';
 
-		// We need to bring the WordPress instances up again so they pick up
-		// any config changes that may have been added to the docker-compose.override.yml.
-		await dockerCompose.upMany(
-			[
-				'phpmyadmin','tests-phpmyadmin',
-				'wordpress', 'tests-wordpress',
-				'cli', 'tests-cli'
-			], {
+	await dockerCompose.upOne(
+		'phpmyadmin', 
+		{
 			cwd: workDirectoryPath,
 			commandOptions: ['--build', '--force-recreate'],
 			log: debug
-		})
-
-		spinner.prefixText = preText + 
-			`phpMyAdmin development site started at http://localhost:8080\n` +
-			`phpMyAdmin test site started at http://localhost:9090\n\n`;
+		}
+	)
 
-		spinner.text = 'Done!';
+	spinner.prefixText = preText + 
+		`phpMyAdmin site started at http://localhost:8080\n\n`;
 
-	}
+	spinner.text = 'Done!';
 
 };

package/lib/commands/stop.js

@@ -0,0 +1,41 @@
+import path from 'node:path';
+import { spawn } from 'node:child_process';
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
+import { v2 as dockerCompose } from 'docker-compose';
+
+import { default as wpEnvStop } from '@wordpress/env/lib/commands/stop.js';
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Promisified dependencies
+ */
+
+/**
+ * Starts the development server.
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.scripts Indicates whether or not lifecycle scripts should be executed.
+ * @param {boolean} options.debug   True if debug mode is enabled.
+ * 
+ */
+export default async function stop({
+	spinner,
+	debug,
+}) {
+	const config = await loadConfig(path.resolve('.'));
+	const { workDirectoryPath } = config;
+
+	// Stop wp-env services
+	await wpEnvStop({spinner, debug });
+
+	// Stop phpMyAdmin as well
+	await dockerCompose.down( {
+		config: path.join(workDirectoryPath, 'docker-compose.override.yml'),
+		log: debug,
+	} );
+
+}

package/lib/commands/tasks/update-plugins.js

@@ -1,15 +1,13 @@
-'use strict';
 /**
  * External dependencies
  */
-const run = require('@wordpress/env/lib/commands/run');
+import path from 'node:path';
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
 
 /**
  * Internal dependencies
  */
-const { runDockerCmds } = require('../../docker');
-const path = require( 'path' );
-const loadConfig = require( '@wordpress/env/lib/config/load-config' );
+import {runCLICmds} from '../../docker.js';
 
 /**
  * Promisified dependencies
@@ -22,15 +20,24 @@ const loadConfig = require( '@wordpress/env/lib/config/load-config' );
  * @param {Object}  options.spinner A CLI spinner which indicates progress.
  * @param {string} options.environment   Which environment to updated.
  */
-module.exports = async function updatePlugins({
+export default async function updatePlugins({
 	spinner,
-	environment
+	environment,
+	slug
 }) {
 
 	spinner.text = "Updating plugins...";
 	const config = await loadConfig(path.resolve('.'));
 
-	await runDockerCmds( environment, ['wp plugin update --all'], config );
+	let plugin = 'all' === slug ? '--all' : slug;
+
+	let result = await runCLICmds( 
+		environment, 
+		[`wp plugin update ${plugin}`], 
+		config 
+	);
+
+	spinner.prefixText = `${result}\n`;
 
 	spinner.text = 'Completed updating plugins!'
 	

package/lib/commands/test.js

@@ -1,49 +1,18 @@
-'use strict';
 /**
  * External dependencies
  */
-const path = require( 'path' );
-const fs = require( 'fs-extra' );
-const SimpleGit = require( 'simple-git' );
-const { execSync } = require( 'child_process' );
-const dockerCompose = require( 'docker-compose' );
-const loadConfig = require( '@wordpress/env/lib/config/load-config' );
-const run = require('@wordpress/env/lib/commands/run');
-const getHostUser = require( '@wordpress/env/lib/get-host-user' );
+import path from 'node:path';
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
 
 /**
  * Internal dependencies
  */
-const {
-	runDockerCmds, 
-} = require('../docker');
-
-const { 
-	buildWPEnvConfig, 
-	buildDockerComposeConfig 
-} = require('../configs');
-
-const pkg = require( '../../package.json' );
-const { DIVI_OPTIONS } = require('../options');
-
-const { 
-	isDiviThemeActive, 
-	configureDivi 
-} = require('../divi');
-
-const {
-	activateCAWeb,
-	configureCAWeb
-} = require('../caweb');
-
-const {
-	generateHTAccess
-} = require( '../wordpress' );
+import { runCLICmds } from '../docker.js';
+import { activateCAWeb } from '../caweb.js';
 
 /**
  * Promisified dependencies
  */
-const { writeFile } = fs.promises;
 
 /**
  * Test code.
@@ -53,42 +22,25 @@ const { writeFile } = fs.promises;
  * @param {boolean} options.environment   Which environment to test in.
  * @param {boolean} options.debug   True if debug mode is enabled.
  */
-module.exports = async function test({
+export default async function test({
 	spinner,
-	environment,
 	debug,
-	multisite,
-	subdomain
-}) {
+	environment
+} ) {
 
-	try {
+	spinner.text = "Testing Code Functionality";
 		const config = await loadConfig(path.resolve('.'));
-		const {WP_PERMALINK} = config.env[ environment ].config
-		const { workDirectoryPath} = config;
-		const {name} = getHostUser();
-
-		spinner.text = "Testing code...";
 		
-		/*
-		let result = await runDockerCmds(
-			environment,
-			['wp theme is-installed CAWeb'],
-			config
+		let result = await runCLICmds(
+			'development', 
+			['wp --version'], 
+			config, 
+			spinner
 		)
 
-		if( '' !== result.out ) {
-			console.log( JSON.parse(result.out))
-		}else{
-			console.log(result);
-		}
-		*/
-
-		spinner.text = 'Completed Testing code...'
 
-	} catch(error) {
-		console.log(error)
+		console.log( result );
 
-		process.exit( 1 );
-	}
+		spinner.text = "Done!";
 	
 };

package/lib/configs.js

@@ -1,10 +1,18 @@
 /**
  * External dependencies
  */
-const path = require( 'path' );
-const fs = require('fs-extra');
-const pkg = require( '../package.json' );
+import path from 'node:path';
+import fs from 'fs-extra';
+import yaml from 'js-yaml';
+import getHostUser from '@wordpress/env/lib/get-host-user.js';
 
+/**
+ * Promisified dependencies
+ */
+const { writeFile } = fs.promises;
+
+const localPath = path.resolve( path.join(process.cwd(), 'node_modules/@caweb/cli/package.json') )
+const pkg = JSON.parse( await fs.readFile(localPath) );
 
 /**
  * Build .wp-env.json
@@ -44,6 +52,11 @@ const buildWPEnvConfig = (bare, multisite) => {
  * @returns object
  */
 const buildDockerComposeConfig = (workDirectoryPath) => {
+	const {name} = getHostUser();
+    
+    // generate cli config file for cli containers.
+    generateCLIConfig(workDirectoryPath);
+
     let dockerConfig = {
         version: '3.7',
         services: {
@@ -52,21 +65,36 @@ const buildDockerComposeConfig = (workDirectoryPath) => {
                 restart: 'always',
                 ports: ['8080:80'],
                 environment: {
-                    PMA_HOST : 'mysql',
+                    PMA_HOSTS : 'mysql,tests-mysql',
                     UPLOAD_LIMIT: '3G',
                     MEMORY_LIMIT: '5G',
                     MAX_EXECUTION_TIME: 7200
                 }
             },
-            "tests-phpmyadmin": {
-                image: `phpmyadmin:latest`,
-                restart: 'always',
-                ports: ['9090:80'],
-                environment: {
-                    PMA_HOST : 'tests-mysql',
-                    UPLOAD_LIMIT: '3G',
-                    MEMORY_LIMIT: '5G',
-                    MAX_EXECUTION_TIME: 7200
+            cli: {
+                build: {
+                    context: '.',
+                    dockerfile: 'CLI.Dockerfile'
+                },
+                volumes: [ path.join(workDirectoryPath, 'config.yml')  + `:/home/${name}/.wp-cli/config.yml`  ]
+            },
+            "tests-cli": {
+                build: {
+                    context: '.',
+                    dockerfile: 'Tests-CLI.Dockerfile'
+                },
+                volumes: [ path.join(workDirectoryPath, 'config.yml')  + `:/home/${name}/.wp-cli/config.yml`]
+            },
+            wordpress: {
+                build: {
+                    context: '.',
+                    dockerfile: 'WordPress.Dockerfile'
+                }
+            },
+            "tests-wordpress": {
+                build: {
+                    context: '.',
+                    dockerfile: 'Tests-WordPress.Dockerfile'
                 }
             }
         }
@@ -87,41 +115,57 @@ const buildDockerComposeConfig = (workDirectoryPath) => {
 
     // Add extra volumes to WordPress instances.
     if( extraVolumes.length ){
-
         dockerConfig.services.wordpress = {
-            build: {
-                context: '.',
-                dockerfile: 'WordPress.Dockerfile'
-            },
-            volumes: extraVolumes,
+            ...dockerConfig.services.wordpress,
+            volumes: [
+                ...extraVolumes
+            ],
         };
         dockerConfig.services.cli = {
-            build: {
-                context: '.',
-                dockerfile: 'CLI.Dockerfile'
-            },
-            volumes: extraVolumes,
+            ...dockerConfig.services.cli,
+            volumes: [
+                ...dockerConfig.services.cli.volumes,
+                ...extraVolumes
+            ],
         };
         dockerConfig.services['tests-wordpress'] = {
-            build: {
-                context: '.',
-                dockerfile: 'Tests-WordPress.Dockerfile'
-            },
-            volumes: extraVolumes,
+            ...dockerConfig.services['tests-wordpress'],
+            volumes: [
+                ...extraVolumes
+            ],
         };
         dockerConfig.services['tests-cli'] = {
-            build: {
-                context: '.',
-                dockerfile: 'Tests-CLI.Dockerfile'
-            },
-            volumes: extraVolumes,
+            ...dockerConfig.services['tests-cli'],
+            volumes: [
+                ...dockerConfig.services['tests-cli'].volumes,
+                ...extraVolumes
+            ],
         };
+
     }
 
     return dockerConfig;
 }
 
-module.exports = {
+/**
+ * Generate config.yml
+ * 
+ * @param {string}  workDirectoryPath Path to the work directory located in ~/.wp-env.
+ * 
+ * @returns void
+ */
+async function generateCLIConfig(workDirectoryPath){
+    const yml = {
+        path: '/var/www/html',
+        apache_modules: ['mod_rewrite']
+    };
+
+    await writeFile(
+        path.join(workDirectoryPath, 'config.yml'),
+        yaml.dump(yml));
+}
+
+export {
     buildWPEnvConfig,
     buildDockerComposeConfig
 }

package/lib/divi.js

@@ -1,31 +1,28 @@
-'use strict';
-/**
- * External dependencies
- */
-
-
 /**
  * Internal dependencies
  */
-const { runDockerCmds } = require('./docker');
-const { DIVI_OPTIONS } = require('./options');
+import { runCLICmds } from './docker.js';
+import { DIVI_OPTIONS } from './options.js';
 
 
 /**
  * Checks if Divi Theme is active for the WordPress Environment.
  * 
- * @param {string} environment   Which environment to activate the theme on.
- * @param {WPConfig} config      The wp-env config object.
+ * @param {string} 		environment Which environment to activate the theme on.
+ * @param {WPConfig} 	config      The wp-env config object.
+ * @param {Object}		spinner     A CLI spinner which indicates progress.
  */
 async function isDiviThemeActive(
 	environment,
-	config
+	config,
+	spinner
 ){
 
-	return await runDockerCmds(
+	return await runCLICmds(
 		environment,
 		['wp theme is-active Divi'],
-		config
+		config,
+		spinner
 	);
 
 }
@@ -40,31 +37,34 @@ async function isDiviThemeActive(
  */
 async function configureDivi( environment, config, spinner ) {
 	
-	const activeTheme = await isDiviThemeActive( environment, config );
+	const activeTheme = await isDiviThemeActive( environment, config, spinner );
 
 	// if Divi theme is active.
 	if( false !== activeTheme ){
 		let cmds = [];
-		let diviOptions = await runDockerCmds(
+		let diviOptions = await runCLICmds(
 			environment,
 			[ 'wp option get et_divi --format=json' ], 
-			config
+			config,
+			spinner
 		)
-		let diviBuilderOptions = await runDockerCmds(
+		let diviBuilderOptions = await runCLICmds(
 			environment,
 			[ 'wp option get et_bfb_settings --format=json' ], 
-			config
+			config,
+			spinner
 		)
-		let diviUpdateOptions = await runDockerCmds(
+		let diviUpdateOptions = await runCLICmds(
 			environment,
 			[ 'wp option get et_automatic_updates_options --format=json' ], 
-			config
+			config,
+			spinner
 		)
 
 		// parse the options into a json object.
-		diviOptions = diviOptions ? JSON.parse( diviOptions ) : {};
-		diviBuilderOptions = diviBuilderOptions ? JSON.parse( diviBuilderOptions ) : {};
-		diviUpdateOptions = undefined !== diviUpdateOptions && diviUpdateOptions ? JSON.parse( diviUpdateOptions ) : {};
+		diviOptions = typeof result === 'object' && ! diviOptions.exitCode ? JSON.parse( diviOptions ) : {};
+		diviBuilderOptions = typeof result === 'object' && ! diviBuilderOptions.exitCode ? JSON.parse( diviBuilderOptions ) : {};
+		diviUpdateOptions = typeof result === 'object' && ! diviUpdateOptions.exitCode ? JSON.parse( diviUpdateOptions ) : {};
 
 		// iterate over mapped Divi option groups.
 		Object.entries(DIVI_OPTIONS).forEach(([group, options]) => {
@@ -95,6 +95,7 @@ async function configureDivi( environment, config, spinner ) {
 		diviBuilderOptions = JSON.stringify( diviBuilderOptions );
 		diviUpdateOptions = JSON.stringify( diviUpdateOptions );
 
+		// update each option.
 		cmds.push(`wp option update et_divi '${diviOptions}' --format=json`);
 		cmds.push(`wp option update et_bfb_settings '${diviBuilderOptions}' --format=json`);
 		cmds.push(`wp option update et_automatic_updates_options '${diviUpdateOptions}' --format=json`);
@@ -109,17 +110,18 @@ async function configureDivi( environment, config, spinner ) {
 		}
 		
 		// Execute theme option commands.
-		await runDockerCmds(
+		await runCLICmds(
 			environment,
 			cmds,
-			config
+			config,
+			spinner
 		)
 	}
 		
 	
 }
 
-module.exports = {
+export {
 	configureDivi,
 	isDiviThemeActive
 };