@caweb/cli 1.0.0

package/README.md

@@ -0,0 +1,15 @@
+# caweb-cli
+`caweb-cli` rapidly sets up a local WordPress environment using [wp-env](https://www.npmjs.com/package/@wordpress/env), fully configured to the [CAWebPublishing Service](https://caweb.cdt.ca.gov/). The cli will automatically generate the necessary [.wp-env.json](https://www.npmjs.com/package/@wordpress/env#wp-envjson) file, to override or add additional configuration options use the [.wp-env.override.json](https://www.npmjs.com/package/@wordpress/env#wp-envoverridejson) file.
+
+## Additional Features
+- phpMyAdmin Service  
+- Downloads and configures the [CAWeb Theme](https://github.com/CA-cODE-Works/CAWeb)  
+- Downloads and configures the [Divi Theme](https://www.elegantthemes.com/gallery/divi/) (*requires valid ElegantThemes Username and API Key*)
+
+## Command Reference
+`caweb-cli` is a wrapper for [wp-env](https://www.npmjs.com/package/@wordpress/env); therefore, all commands from wp-env are readily available, for more information on those commands [see](https://www.npmjs.com/package/@wordpress/env#command-referenced). ***Note:** substitute `wp-env` command with `caweb`. 
+
+### `caweb start`  
+Starts the CAWebPublishing WordPress Environment.  
+### `caweb shell`  
+Open a shell session in the WordPress environment.

package/bin/caweb

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+'use strict';
+
+// Remove 'node' and the name of the script from the arguments.
+let command = process.argv.slice( 2 );
+// Default to help text when they aren't running any commands.
+if ( ! command.length ) {
+	command = [ '--help' ];
+}
+
+// Rather than just executing the current CLI we will attempt to find a local version
+// and execute that one instead. This prevents users from accidentally using the
+// global CLI when a potentially different local version is expected.
+const localPath = require.resolve( '@caweb/cli/lib/cli.js', {
+	paths: [ process.cwd(), __dirname ],
+} );
+const cli = require( localPath )();
+
+// Now we can execute the CLI with the given command.
+cli.parse( command );

package/lib/caweb.js

@@ -0,0 +1,140 @@
+'use strict';
+/**
+ * External dependencies
+ */
+const dockerCompose = require( 'docker-compose' );
+const path = require( 'path' );
+const loadConfig = require( '@wordpress/env/lib/config/load-config' );
+
+
+/**
+ * Internal dependencies
+ */
+const { CAWEB_OPTIONS } = require('./options');
+
+/**
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.environment   Which environment to open terminal in.
+ * @param {Array} options.cmds   Array of commands to run.
+ * 
+ * @returns {Object}
+ */
+async function runDockerCmd({
+	spinner,
+	environment,
+	cmds
+}) {
+
+	try {
+		const config = await loadConfig(path.resolve('.'));
+
+		// -eo pipefail exits the command as soon as anything fails in bash.
+		//const setupCommands = [ 'set -eo pipefail' ];
+
+		// Execute all setup commands in a batch.
+		return await dockerCompose.run(
+			environment === 'development' ? 'cli' : 'tests-cli',
+			[ 'bash', '-c', cmds.join( ' && ' ) ],
+			{
+				cwd: config.workDirectoryPath,
+				commandOptions: [ '--rm' ],
+				log: config.debug,
+			}
+		).then(
+			(result) => {
+				if( '' !== result.out ){
+					console.log( result.out )
+				}else{
+					console.log(result.err)
+				}
+				return result;
+			},
+			(err) => {
+				return false;
+			}
+		)
+
+	} catch(error) {
+		console.log(error)
+
+		process.exit( 1 );
+	}
+	
+};
+
+/**
+ * Activates the CAWeb Theme for the WordPress Environment if it's installed.
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.environment   Which environment to activate the theme on.
+ */
+async function activateCAWeb({
+	spinner,
+	environment
+}){
+	return await runDockerCmd( {
+		spinner,
+		environment,
+		cmds: ['wp theme is-installed CAWeb && wp theme activate CAWeb']
+	}).then(
+		(result) => {
+			return true;
+		},
+		(err) => {
+			return false;
+		}
+	)
+
+}
+
+/**
+ * Configures WordPress for the given environment by installing WordPress,
+ * activating all plugins, and activating the first theme. These steps are
+ * performed sequentially so as to not overload the WordPress instance.
+ *
+ * @param {WPEnvironment} environment The environment to configure. Either 'development' or 'tests'.
+ * @param {WPConfig}      config      The wp-env config object.
+ * @param {Object}        spinner     A CLI spinner which indicates progress.
+ */
+async function configureCAWeb( environment, config, spinner ) {
+	
+
+	const isThemeActivated = await activateCAWeb( {
+		spinner,
+		environment
+	})
+
+	// if our theme is active.
+	if( isThemeActivated ){
+		let themeOptions = [];
+
+		// iterate over config options.
+		Object.entries(config.env[ environment ].config).forEach(([k,v]) => {
+			// if the option is prefixed with CAWEB_ and is a valid CAWeb Option.
+			if ( `${k}`.startsWith('CAWEB_') && undefined !== CAWEB_OPTIONS[k] ){
+				// set the option.
+				themeOptions.push(
+					`wp option set '${CAWEB_OPTIONS[k]}' "${v}"`
+				);
+			}
+		})
+
+
+		await runDockerCmd({
+			spinner,
+			environment,
+			cmds: themeOptions
+		})
+	}
+		
+	
+}
+
+module.exports = {
+	activateCAWeb,
+	configureCAWeb,
+	runDockerCmd
+};

package/lib/cli.js

@@ -0,0 +1,135 @@
+'use strict';
+/**
+ * External dependencies
+ */
+const wpenv_cli = require('@wordpress/env/lib/cli');
+
+const chalk = require( 'chalk' );
+const ora = require( 'ora' );
+let yargs = require( 'yargs' );
+const terminalLink = require( 'terminal-link' );
+const { execSync } = require( 'child_process' );
+
+/**
+ * Internal dependencies
+ */
+const pkg = require( '../package.json' );
+const env = require( './commands' );
+const parseXdebugMode = require( '@wordpress/env/lib/parse-xdebug-mode' );
+
+// Colors.
+const boldWhite = chalk.bold.white;
+const wpPrimary = boldWhite.bgHex( '#00669b' );
+const wpGreen = boldWhite.bgHex( '#4ab866' );
+const wpRed = boldWhite.bgHex( '#d94f4f' );
+const wpYellow = boldWhite.bgHex( '#f0b849' );
+
+// Spinner.
+const withSpinner =
+	( command ) =>
+	( ...args ) => {
+		const spinner = ora().start();
+		args[ 0 ].spinner = spinner;
+		let time = process.hrtime();
+		return command( ...args ).then(
+			( message ) => {
+				time = process.hrtime( time );
+				spinner.succeed(
+					`${ message || spinner.text } (in ${ time[ 0 ] }s ${ (
+						time[ 1 ] / 1e6
+					).toFixed( 0 ) }ms)`
+				);
+				process.exit( 0 );
+			},
+			( error ) => {
+				if( error ){
+					// Error is an unknown error. That means there was a bug in our code.
+					spinner.fail(
+						typeof error === 'string' ? error : error.message
+					);
+					// Disable reason: Using console.error() means we get a stack trace.
+					console.error( error );
+					process.exit( 1 );
+				}else{
+					spinner.fail( 'An unknown error occurred.' );
+					process.exit( 1 );
+				}
+			}
+		);
+	};
+
+module.exports = function cli() {
+	yargs = wpenv_cli();
+
+	// we are overwriting the default wp-env start command with our own.
+	yargs.command(
+		'start',
+		wpGreen(
+			chalk`Starts WordPress for development on port {bold.underline ${ terminalLink(
+				'8888',
+				'http://localhost:8888'
+			) }} (override with WP_ENV_PORT) and tests on port {bold.underline ${ terminalLink(
+				'8889',
+				'http://localhost:8889'
+			) }} (override with WP_ENV_TESTS_PORT). The current working directory must be a WordPress installation, a plugin, a theme, or contain a .wp-env.json file. After first install, use the '--update' flag to download updates to mapped sources and to re-apply WordPress configuration options.`
+		),
+		( args ) => {
+			args.option( 'update', {
+				type: 'boolean',
+				describe:
+					'Download source updates and apply WordPress configuration.',
+				default: false,
+			} );
+			args.option( 'xdebug', {
+				describe:
+					'Enables Xdebug. If not passed, Xdebug is turned off. If no modes are set, uses "debug". You may set multiple Xdebug modes by passing them in a comma-separated list: `--xdebug=develop,coverage`. See https://xdebug.org/docs/all_settings#mode for information about Xdebug modes.',
+				coerce: parseXdebugMode,
+				type: 'string',
+			} );
+			args.option( 'scripts', {
+				type: 'boolean',
+				describe: 'Execute any configured lifecycle scripts.',
+				default: true,
+			} );
+			args.option( 'bare', {
+				type: 'boolean',
+				describe: 'True if excluding any downloads from CAWeb, use this if you want to use a local version of the CAWeb Theme, Configurations will still be applied.',
+				default: false,
+			} );
+			
+		},
+		withSpinner( env.start )
+	);
+
+	// Shell Terminal Command.
+	yargs.command(
+		'shell  ',
+		'Open shell terminal in WordPress environment.', 
+		(args) => {
+			args.positional( 'environment', {
+				type: 'string',
+				describe: "Which environment to open terminal in.",
+				choices: [ 'development', 'tests' ],
+				default: 'development',
+			} );
+		}, 
+		withSpinner( env.shell )
+	)
+
+	// Test Command.
+	yargs.command(
+		'test [environment]',
+		'Test commands on a WordPress environment', 
+		(args) => {
+			args.positional( 'environment', {
+				type: 'string',
+				describe: "Which environment to test in.",
+				choices: [ 'development', 'tests' ],
+				default: 'development',
+			} );
+		}, 
+		withSpinner( env.test )
+	)
+	
+	return yargs;
+};

package/lib/commands/index.js

@@ -0,0 +1,17 @@
+'use strict';
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+const shell = require('./shell')
+const start = require('./start')
+const test = require( './test' );
+
+module.exports = {
+	shell,
+	start,
+	test
+};

package/lib/commands/shell.js

@@ -0,0 +1,36 @@
+'use strict';
+/**
+ * External dependencies
+ */
+const wpEnvRun = require( '@wordpress/env/lib/commands/run' );
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Opens shell terminal in WordPress environment
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.environment   Which environment to open terminal in.
+ * @param {boolean} options.debug   True if debug mode is enabled.
+ */
+module.exports = async function shell({
+	spinner,
+	environment,
+	debug
+}) {
+
+	const container = 'tests' === environment ? 'tests-cli' : 'cli';
+
+	await wpEnvRun({
+		container: container,
+		command: ['bash'],
+		"": "",
+		envCwd: '.',
+		spinner,
+		debug
+	});
+
+};

package/lib/commands/start.js

@@ -0,0 +1,160 @@
+/**
+ * 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 {	
+	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' );
+
+const CONFIG_CACHE_KEY = 'config_checksum';
+
+/**
+ * Internal dependencies
+ */
+const { configureCAWeb } = require('../caweb');
+const { buildWPEnvConfig, buildDockerComposeConfig } = require('../configs');
+const {downloadSources } = require('../download-sources');
+
+/**
+ * Promisified dependencies
+ */
+const { writeFile } = fs.promises;
+const sleep = util.promisify( setTimeout );
+
+/**
+ * Starts the development server.
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.update  If true, update sources.
+ * @param {string}  options.xdebug  The Xdebug mode to set.
+ * @param {boolean} options.scripts Indicates whether or not lifecycle scripts should be executed.
+ * @param {boolean} options.debug   True if debug mode is enabled.
+ * @param {boolean} options.bare   True if excluding any CAWeb Configurations.
+ * 
+ */
+module.exports = async function start({
+	spinner,
+	update,
+	xdebug,
+	scripts,
+	debug,
+	bare
+}) {
+	spinner.text = 'Writing configuration file...';
+	
+	// Write CAWeb .wp-env.json file.
+	await writeFile(
+		path.join(process.cwd(), '.wp-env.json'),
+		JSON.stringify( buildWPEnvConfig({bare}), null, 4 )
+	);
+
+	// Get current wp-env cache key
+	const config = await loadConfig(path.resolve('.'));
+	const { workDirectoryPath } = config;
+	const cacheKey = await getCache(CONFIG_CACHE_KEY, {workDirectoryPath});
+	
+	// wp-env launch.
+	await wpEnvStart({
+		spinner,
+		update,
+		xdebug,
+		scripts,
+		debug,
+	})
+
+	// Check if we should configure settings.
+	const shouldConfigureWp = ( update || 
+		( await didCacheChange( CONFIG_CACHE_KEY, cacheKey, {
+			workDirectoryPath,
+		} ) )) &&
+		// Don't reconfigure everything when we can't connect to the internet because
+		// the majority of update tasks involve connecting to the internet. (Such
+		// as downloading sources and pulling docker images.)
+		( await canAccessWPORG() );
+		
+		
+	// 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 );
+		}
+
+		// 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) )
+		);
+
+		// 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'
+			], {
+			cwd: workDirectoryPath,
+			commandOptions: ['--build', '--force-recreate'],
+			log: debug
+		})
+
+		spinner.text = 'Configuring CAWebPublishing Environments...';
+
+		// Make CAWeb WordPress Configurations.
+		await Promise.all( [
+			retry( () => configureCAWeb( 'development', config, spinner ), {
+				times: 2,
+			} ),
+			retry( () => configureCAWeb( 'tests', config, spinner ), {
+				times: 2,
+			} ),
+		] );
+		
+		spinner.prefixText = preText + 
+			`phpMyAdmin development site started at http://localhost:8080\n` +
+			`phpMyAdmin development site started at http://localhost:9090\n\n`;
+
+		spinner.text = 'Done!';
+
+	}
+
+};

package/lib/commands/test.js

@@ -0,0 +1,87 @@
+'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' );
+
+/**
+ * Internal dependencies
+ */
+const {
+	runDockerCmd,
+} = require('../caweb');
+
+const { buildWPEnvConfig, buildDockerComposeConfig } = require('../configs');
+
+const pkg = require( '../../package.json' );
+const { CAWEB_OPTIONS } = require('../options');
+
+
+/**
+ * Promisified dependencies
+ */
+const { writeFile } = fs.promises;
+
+/**
+ * Test code.
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.environment   Which environment to test in.
+ */
+module.exports = async function test({
+	spinner,
+	environment
+}) {
+
+	try {
+		const config = await loadConfig(path.resolve('.'));
+		/*
+		let themeOptions = [];
+
+		Object.entries(config.env[ 'development' ].config).forEach(([k,v]) => {
+			// if the option is prefixed with CAWEB_ and is a valid CAWeb Option.
+			if ( `${k}`.startsWith('CAWEB_') && undefined !== CAWEB_OPTIONS[k] ){
+				console.log(CAWEB_OPTIONS[k])
+				// set the option.
+				themeOptions.push(
+					`wp option set '${CAWEB_OPTIONS[k]}' "${v}"`
+				);
+			}
+		})
+
+		console.log(themeOptions);
+
+
+		// Write CAWeb .wp-env.json file.
+		await writeFile(
+			path.join(process.cwd(), '.wp-env.json'),
+			JSON.stringify( buildWPEnvConfig({bare: false}), null, 4 )
+		);
+
+		let result = await runDockerCmd( {
+			spinner,
+			environment,
+			cmds: [`wp option set 'ca_site_version' "5.5"`]
+		})
+		
+		
+		Object.entries(result).forEach((k,v) => {
+			//console.log(`${k}:${v}`)
+		})
+
+		//console.log(`Result: ${result}`)
+		*/
+
+	} catch(error) {
+		console.log(error)
+
+		process.exit( 1 );
+	}
+	
+};

package/lib/configs.js

@@ -0,0 +1,120 @@
+/**
+ * External dependencies
+ */
+const path = require( 'path' );
+const fs = require('fs-extra');
+const pkg = require( '../package.json' );
+
+
+/**
+ * Build .wp-env.json
+ * 
+ * @param {boolean} options.bare   True if excluding any CAWeb Configurations.
+ * @returns object
+ */
+const buildWPEnvConfig = ({bare}) => {
+    let config = {
+        core: `WordPress/WordPress#${pkg.config.WP_VER}`,
+        phpVersion: `${pkg.config.PHP_VER}`,
+        config: {
+            ...pkg.config.DEFAULTS
+        }
+    }
+
+    // if not bare then include our theme.
+    if( ! bare ){
+        config['themes'] = [`CA-CODE-Works/CAWeb`];
+    }
+
+    return config;
+    
+}
+
+/**
+ * Build docker-compose.override.yml
+ * 
+ * @param {string}  workDirectoryPath Path to the work directory located in ~/.wp-env.
+ * @returns object
+ */
+const buildDockerComposeConfig = (workDirectoryPath) => {
+    let dockerConfig = {
+        version: '3.7',
+        services: {
+            phpmyadmin: {
+                image: `phpmyadmin:latest`,
+                restart: 'always',
+                ports: ['8080:80'],
+                environment: {
+                    PMA_HOST : '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
+                }
+            }
+        }
+      
+    };
+
+    let extraVolumes = [];
+
+    // Divi theme to wordpress services volumes.
+    if( fs.existsSync(path.join(workDirectoryPath, 'Divi')) ){
+        extraVolumes = extraVolumes.concat(path.join(workDirectoryPath, 'Divi') + ':/var/www/html/wp-content/themes/Divi');
+    }
+
+    // Divi plugin to wordpress services volumes.
+    if( fs.existsSync(path.join(workDirectoryPath, 'divi-builder')) ){
+        extraVolumes = extraVolumes.concat(path.join(workDirectoryPath, 'divi-builder') + ':/var/www/html/wp-content/plugins/divi-builder');
+    }
+
+    // Add extra volumes to WordPress instances.
+    if( extraVolumes.length ){
+
+        dockerConfig.services.wordpress = {
+            build: {
+                context: '.',
+                dockerfile: 'WordPress.Dockerfile'
+            },
+            volumes: extraVolumes,
+        };
+        dockerConfig.services.cli = {
+            build: {
+                context: '.',
+                dockerfile: 'CLI.Dockerfile'
+            },
+            volumes: extraVolumes,
+        };
+        dockerConfig.services['tests-wordpress'] = {
+            build: {
+                context: '.',
+                dockerfile: 'Tests-WordPress.Dockerfile'
+            },
+            volumes: extraVolumes,
+        };
+        dockerConfig.services['tests-cli'] = {
+            build: {
+                context: '.',
+                dockerfile: 'Tests-CLI.Dockerfile'
+            },
+            volumes: extraVolumes,
+        };
+    }
+
+    return dockerConfig;
+}
+
+module.exports = {
+    buildWPEnvConfig,
+    buildDockerComposeConfig
+}

package/lib/download-sources.js

@@ -0,0 +1,256 @@
+/**
+ * Modified from wp-env 8.11.0
+ * Few modifications made:
+ * - Downloads CAWebPublishing Resources, excluding WordPress.
+ * - Target directory for downloadZipSource is expected to be absolute.
+ * - Ensure  parent directory of source.path exists before attempting to extract in downloadZipSource, otherwise it will complain that file/directory doesn't exist.
+ * @see @wordpress/env/lib/download-sources.js
+ */
+'use strict';
+/**
+ * External dependencies
+ */
+const util = require( 'util' );
+const path = require( 'path' );
+const fs = require( 'fs-extra' );
+const SimpleGit = require( 'simple-git' );
+const got = require( 'got' );
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Promisified dependencies
+ */
+const pipeline = util.promisify( require( 'stream' ).pipeline );
+const extractZip = util.promisify( require( 'extract-zip' ) );
+const rimraf = util.promisify( require( 'rimraf' ) );
+
+/**
+ * Download CAWeb Resources.
+ * 
+ * @param {Object}   spinner The spinner object to show progress.
+ * @return {WPConfig} The config object we've loaded.
+ */
+async function downloadSources( 
+	{ 
+		spinner,
+		config
+	}  
+	) {
+	const progresses = {};
+	const getProgressSetter = ( id ) => ( progress ) => {
+		progresses[ id ] = progress;
+		spinner.text =
+			`Downloading ${id}.\n` +
+			Object.entries( progresses )
+				.map(
+					( [ key, value ] ) =>
+						`  - ${ key }: ${ ( value * 100 ).toFixed( 0 ) }/100%`
+				)
+				.join( '\n' );
+	};
+
+	const { workDirectoryPath } = config;
+	const { development: dev, tests: test } = config.env;
+	let sources = [];
+
+	// Add Divi Theme and plugin to sources.
+	if( (undefined !== dev.config.ET_USERNAME && 
+		undefined !== dev.config.ET_API_KEY) || 
+		(undefined !== test.config.ET_USERNAME && 
+		undefined !== test.config.ET_API_KEY)
+	){
+		let url = 'https://www.elegantthemes.com/api/api_downloads.php';
+		let user = undefined !== dev.config.ET_USERNAME ? dev.config.ET_USERNAME : test.config.ET_USERNAME;
+		let key = undefined !== dev.config.ET_API_KEY ? dev.config.ET_API_KEY : test.config.ET_API_KEY;
+		
+		// Add Divi sources.
+		sources = sources.concat( [
+			{
+				basename: 'Divi',
+				url: `${url}?api_update=1&theme=Divi&api_key=${key}&username=${user}`,
+				path: path.join(workDirectoryPath, 'Divi'),
+				type: 'zip'
+			},
+			{
+				basename: 'Divi Plugin',
+				url: `${url}?api_update=1&theme=divi-builder&api_key=${key}&username=${user}`,
+				path: path.join(workDirectoryPath, 'divi-builder'),
+				type: 'zip'
+			}
+		]);
+	}
+
+
+	// filter any undefined sources.
+	/*sources = sources.filter(function( element ) {
+		return element !== undefined;
+	 });
+	 
+	 */
+	 await Promise.all(
+		sources.map( ( source ) =>
+			downloadSource( source, {
+				onProgress: getProgressSetter( source.basename ),
+				spinner,
+			} )
+		)
+	);
+	
+};
+
+/**
+ * Downloads the given source if necessary. The specific action taken depends
+ * on the source type. The source is downloaded to source.path.
+ *
+ * @param {WPSource} source             The source to download.
+ * @param {Object}   options
+ * @param {Function} options.onProgress A function called with download progress. Will be invoked with one argument: a number that ranges from 0 to 1 which indicates current download progress for this source.
+ * @param {Object}   options.spinner    A CLI spinner which indicates progress.
+ * @param {boolean}  options.debug      True if debug mode is enabled.
+ */
+async function downloadSource(src, { onProgress, spinner, debug } ){
+    if( 'git' == src.type ){
+        await downloadGitSource(src, { onProgress, spinner, debug });
+    }else if( 'zip' == src.type ) {
+        await downloadZipSource(src, { onProgress, spinner, debug });
+    }
+}
+
+
+/**
+ * Clones the git repository at `source.url` into `source.path`. If the
+ * repository already exists, it is updated instead.
+ *
+ * @param {WPSource} source             The source to download.
+ * @param {Object}   options
+ * @param {Function} options.onProgress A function called with download progress. Will be invoked with one argument: a number that ranges from 0 to 1 which indicates current download progress for this source.
+ * @param {Object}   options.spinner    A CLI spinner which indicates progress.
+ * @param {boolean}  options.debug      True if debug mode is enabled.
+ */
+async function downloadGitSource( source, { onProgress, spinner, debug } ) {
+	const log = debug
+		? ( message ) => {
+				spinner.info( `SimpleGit: ${ message }` );
+				spinner.start();
+		  }
+		: () => {};
+	onProgress( 0 );
+
+	const progressHandler = ( { progress } ) => {
+		onProgress( progress / 100 );
+	};
+
+	log( 'Cloning or getting the repo.' );
+	const git = SimpleGit( { progress: progressHandler } );
+
+	const isRepo =
+		fs.existsSync( source.clonePath ) &&
+		( await git.cwd( source.clonePath ).checkIsRepo( 'root' ) );
+
+	// repository already exists.
+	if ( isRepo ) {
+		log( 'Repo already exists, using it.' );
+	} else {
+		// repository doesn't exists, but the directory does.
+		if( fs.existsSync( source.clonePath ) ){
+			// reinitialize repo.
+			await git.cwd( source.clonePath );
+
+			await git.init().addRemote('origin', source.url );
+		}else{
+
+			await git.clone( source.url, source.clonePath, {
+				'--depth': '1',
+				'--no-single-branch': null
+			} );
+			await git.cwd( source.clonePath );
+		}
+	}
+
+	log( 'Fetching the specified ref.' );
+	await git.fetch( 'origin', source.ref, {
+		'--tags': null,
+	} );
+
+	log( 'Checking out the specified ref.' );
+	await git.checkout( source.ref, {
+		'--force': null
+	});
+
+	onProgress( 1 );
+}
+
+/**
+ * Downloads and extracts the zip file at `source.url` into `source.path`.
+ *
+ * @param {WPSource} source             The source to download.
+ * @param {Object}   options
+ * @param {Function} options.onProgress A function called with download progress. Will be invoked with one argument: a number that ranges from 0 to 1 which indicates current download progress for this source.
+ * @param {Object}   options.spinner    A CLI spinner which indicates progress.
+ * @param {boolean}  options.debug      True if debug mode is enabled.
+ */
+async function downloadZipSource( source, { onProgress, spinner, debug } ) {
+	const log = debug
+		? ( message ) => {
+				spinner.info( `NodeGit: ${ message }` );
+				spinner.start();
+		  }
+		: () => {};
+	onProgress( 0 );
+
+	log( 'Downloading zip file.' );
+	const zipName = `${ source.path }.zip`;
+	const zipFile = fs.createWriteStream( zipName );
+	const responseStream = got.stream( source.url );
+	responseStream.on( 'downloadProgress', ( { percent } ) =>
+		onProgress( percent )
+	);
+
+	await pipeline( responseStream, zipFile );
+
+	log( 'Extracting to temporary directory.' );
+    // Target directory is expected to be absolute.
+	const tempDir = `${ source.path }.temp`;
+	await extractZip( zipName, { dir: tempDir } );
+
+	const files = (
+		await Promise.all( [
+			rimraf( zipName ),
+			rimraf( source.path ),
+			fs.promises.readdir( tempDir ),
+		] )
+	)[ 2 ];
+	/**
+	 * The plugin container is the extracted directory which is the direct parent
+	 * of the contents of the plugin. It seems a zip file can have two fairly
+	 * common approaches to where the content lives:
+	 * 1. The .zip is the direct container of the files. So after extraction, the
+	 *    extraction directory contains plugin contents.
+	 * 2. The .zip contains a directory with the same name which is the container.
+	 *    So after extraction, the extraction directory contains another directory.
+	 *    That subdirectory is the actual container of the plugin contents.
+	 *
+	 * We support both situations with the following check.
+	 */
+	let pluginContainer = tempDir;
+	const firstSubItem = path.join( tempDir, files[ 0 ] );
+	if (
+		files.length === 1 &&
+		( await fs.promises.lstat( firstSubItem ) ).isDirectory()
+	) {
+		// In this case, only one sub directory exists, so use that as the container.
+		pluginContainer = firstSubItem;
+	}
+	await fs.promises.rename( pluginContainer, source.path );
+	await rimraf( tempDir );
+
+	onProgress( 1 );
+}
+
+module.exports = {
+	downloadSources
+	
+}

package/lib/env.js

@@ -0,0 +1,12 @@
+'use strict';
+/**
+ * Internal dependencies
+ */
+
+//const { ValidationError } = require( './config' );
+//const { LifecycleScriptError } = require( './execute-lifecycle-script' );
+const commands = require( './commands' );
+
+module.exports = {
+	...commands
+};

package/lib/options.js

@@ -0,0 +1,23 @@
+/**
+ * External dependencies
+ */
+
+const caweb_general_options = {
+    CAWEB_TEMPLATE_VER: 'ca_site_version', // State Template Version
+    CAWEB_NAV_MENU_STYLE: 'ca_default_navigation_menu', // Header Menu Type
+    CAWEB_COLORSCHEME: 'ca_site_color_scheme', // Color Scheme
+    CAWEB_TITLE_DISPLAY: 'ca_default_post_title_display', // Title Display Default
+    CAWEB_STICKY_NAV: 'ca_sticky_navigation', // Sticky Navigation
+    CAWEB_MENU_HOME_LINK: 'ca_home_nav_link', // Menu Home Link
+    CAWEB_DISPLAY_POSTS_DATE: 'ca_default_post_date_display', // Display Date for Non-Divi Posts
+    CAWEB_X_UA_COMPATIBILITY: 'ca_x_ua_compatibility', // Legacy Browser Support
+    CAWEB_FRONTPAGE_SEARCH: 'ca_frontpage_search_enabled', // Show Search on Front Page
+}
+
+const CAWEB_OPTIONS = {
+    ...caweb_general_options
+}
+
+module.exports = {
+    CAWEB_OPTIONS
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@caweb/cli",
+  "version": "1.0.0",
+  "description": "CAWebPublishing Command Line Interface.",
+  "main": "lib/env.js",
+  "files": [
+    "bin",
+    "lib"
+  ],
+  "bin": {
+    "caweb": "bin/caweb"
+  },
+  "scripts": {
+    "caweb": "caweb",
+    "launch": "caweb start",
+    "pretest": "npm uninstall @caweb/cli",
+    "test": "npm pack && npm i caweb-cli-%npm_package_version%.tgz",
+    "posttest": "del caweb-cli-%npm_package_version%.tgz"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CAWebPublishing/caweb-cli.git"
+  },
+  "keywords": [
+    "caweb",
+    "cagov"
+  ],
+  "author": "CAWebPublishing",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/CAWebPublishing/caweb-cli/issues"
+  },
+  "homepage": "https://github.com/CAWebPublishing/caweb-cli#readme",
+  "dependencies": {
+    "@wordpress/env": "^8.11.0",
+    "chalk": "^4.0.0",
+    "fs-extra": "^11.1.1"
+  },
+  "config": {
+    "WP_VER": "6.3.1",
+    "PHP_VER": "8.1",
+    "DEFAULTS": {
+      "WP_DEFAULT_THEME": "CAWeb",
+      "FS_METHOD": "direct",
+      "WP_DEBUG": true,
+      "WP_DEBUG_LOG": true,
+      "WP_DEBUG_DISPLAY": false,
+      "ADMIN_COOKIE_PATH": "/",
+      "COOKIE_DOMAIN": "",
+      "COOKIEPATH": "",
+      "SITECOOKIEPATH": ""
+    }
+  },
+  "directories": {
+    "doc": "docs",
+    "lib": "lib"
+  },
+  "devDependencies": {}
+}