@caweb/cli 1.0.4 → 1.1.0

package/lib/docker.js

@@ -1,10 +1,12 @@
-'use strict';
 /**
  * External dependencies
  */
-const dockerCompose = require( 'docker-compose' );
-const path = require( 'path' );
-const loadConfig = require( '@wordpress/env/lib/config/load-config' );
+import { spawn } from 'node:child_process';
+import dockerCompose from 'docker-compose';
+import path from 'node:path';
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
+import getHostUser from '@wordpress/env/lib/get-host-user.js';
+import { env } from 'node:process';
 
 
 /**
@@ -17,24 +19,30 @@ const loadConfig = require( '@wordpress/env/lib/config/load-config' );
  * @param {string}		environment	Which environment to run docker command on.
  * @param {string[]} 	cmds   		Array of commands to run.
  * @param {WPConfig} 	config      The wp-env config object.
+ * @param {Object}   	spinner A CLI spinner which indicates progress.
  * 
- * @returns {Object}
+ * @returns {Promise}
  */
-async function runDockerCmds(
+async function runCLICmds(
 	environment,
 	cmds,
-	config
+	config,
+	spinner
 ) {
 
-	try {
-		// Execute all setup commands in a batch.
-		return await dockerCompose.run(
+	// We return the promise whether there is an output or an error.
+	return await dockerCompose.run(
 			environment === 'development' ? 'cli' : 'tests-cli',
 			[ 'bash', '-c', cmds.join( ' && ' ) ],
 			{
 				cwd: config.workDirectoryPath,
-				commandOptions: [ '--rm' ],
+				commandOptions: [],
 				log: config.debug,
+				callback: (buffer, result) => {
+					if( config.debug ){
+						spinner.text = buffer.toString();
+					}
+				}
 			}
 		).then(
 			(output) => {
@@ -44,23 +52,17 @@ async function runDockerCmds(
 
 				return '' !== output.out ? output.out : output.err;
 			},
-			(output) => {
+			(error) => {
 				// Remove the Container information and new lines.
-				output.err = output.err.replace(/\s*Container .*Running\n|\n/g, '')
+				error.err = error.err.replace(/\s*Container .*Running\n|\n/g, '')
 
-				return false;
+				return error;
 			}
 		);
 
-	} catch(error) {
-		console.log(error)
-
-		process.exit( 1 );
-	}
-	
 }
 
 
-module.exports = {
-	runDockerCmds
+export {
+	runCLICmds
 };

package/lib/download-sources.js

@@ -1,20 +1,22 @@
 /**
- * Modified from wp-env 8.11.0
+ * Modified from wp-env 
  * 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' );
+import util from 'util';
+import path from 'path';
+import fs from 'fs-extra';
+import SimpleGit from 'simple-git';
+import got from 'got';
+import stream from 'stream';
+import zip from 'extract-zip';
+import rim from 'rimraf';
 
 /**
  * Internal dependencies
@@ -23,9 +25,9 @@ const got = require( 'got' );
 /**
  * Promisified dependencies
  */
-const pipeline = util.promisify( require( 'stream' ).pipeline );
-const extractZip = util.promisify( require( 'extract-zip' ) );
-const rimraf = util.promisify( require( 'rimraf' ) );
+const pipeline = util.promisify( stream.pipeline );
+const extractZip = util.promisify( zip );
+const rimraf = util.promisify( rim );
 
 /**
  * Download CAWeb Resources.
@@ -120,7 +122,6 @@ async function downloadSource(src, { onProgress, spinner, debug } ){
     }
 }
 
-
 /**
  * Clones the git repository at `source.url` into `source.path`. If the
  * repository already exists, it is updated instead.
@@ -271,7 +272,6 @@ function dowloadPlugins(pluginDir){
 	]
 }
 
-module.exports = {
+export {
 	downloadSources
-	
 }

package/lib/env.js

@@ -1,12 +1,17 @@
-'use strict';
 /**
  * Internal dependencies
  */
+import start from './start.js';
+import destroy from './destroy.js';
+import test from './test.js';
+import shell from './shell.js';
 
-//const { ValidationError } = require( './config' );
-//const { LifecycleScriptError } = require( './execute-lifecycle-script' );
-const commands = require( './commands' );
+import updatePlugins from './tasks/update-plugins.js'
 
-module.exports = {
-	...commands
-};
+export {
+	start,
+	destroy,
+	test,
+	shell,
+	updatePlugins
+}

package/lib/options.js

@@ -253,7 +253,7 @@ const DIVI_OPTIONS = {
 	}
 }
 
-module.exports = {
+export {
     CAWEB_OPTIONS,
 	DIVI_OPTIONS
 }

package/lib/spinner.js

@@ -0,0 +1,70 @@
+import chalk from 'chalk';
+import ora from 'ora';
+
+// 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();
+
+		// commander passes arguments/options differently than yargs.
+		// lets combine arguments with options
+		const cmd = args.pop();
+
+		cmd.registeredArguments.forEach(arg => {
+			// get arg from list.
+			let v = args.shift();
+
+			// add arg to options.
+			args[args.length - 1][arg._name] = v;
+		});
+
+		// add any global options.
+		args[0] = {
+			...args[0],
+			...cmd.parent.opts()
+		}
+
+		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 );
+				}
+			}
+		);
+	};
+
+export {
+    wpPrimary,
+    wpGreen,
+    wpRed,
+    wpYellow,
+    withSpinner
+}

package/lib/wordpress.js

@@ -1,58 +1,71 @@
-'use strict';
-const { writeFile } = require('fs-extra');
-const path = require( 'path' );
-const getHostUser = require( '@wordpress/env/lib/get-host-user' );
-const { execSync } = require( 'child_process' );
-
 /**
  * External dependencies
  */
+import fs from 'fs-extra';
+import path from 'node:path';
 
 /**
  * Internal dependencies
  */
-const {runDockerCmds} = require('./docker');
+import {runCLICmds} from './docker.js';
+
+/**
+ * Promisified dependencies
+ */
+const { writeFile } = fs.promises;
 
 /**
  * Checks whether WordPress environment is a multisite installation.
  * 
  * @param {string}		environment	Which environment to check for multisite installation.
  * @param {WPConfig}    config      The wp-env config object.
+ * @param {Object} 		spinner     A CLI spinner which indicates progress.
  * @returns 
  */
-async function isMultisite( environment, config ){
-	return await runDockerCmds(
+async function isMultisite( environment, config, spinner ){
+
+	const result = await runCLICmds(
 		environment,
 		[ 'wp config get MULTISITE' ],
-		config
+		config,
+		spinner
 	)
+
+	/**
+	 * If the constant doesn't exist the wp cli returns an exit code of 1
+	 * we have to return false, otherwise we can just return the cli result.
+	 */
+	return typeof result === 'object' && result.exitCode ? false : result;
 }
 
 /**
  * Transforms an existing single-site installation into a multisite installation.
  * 
- * @param {string} environment Which environment to convert into a multisite installation.
- * @param {WPConfig} config The wp-env config object.
- * @param {boolean} subdomain   True if converting to multisite subdomain.
+ * @param {string} 		environment Which environment to convert into a multisite installation.
+ * @param {WPConfig} 	config 		The wp-env config object.
+ * @param {boolean} 	subdomain   True if converting to multisite subdomain.
+ * @param {Object} 		spinner     A CLI spinner which indicates progress.
  * @returns 
  */
-async function convertToMultisite( environment, config, subdomain ){
+async function convertToMultisite( environment, config, subdomain, spinner ){
 	// before we can conver to multisite all plugins must be deactivated.
 	// first lets get all plugins
-	let activePlugins = await runDockerCmds(
+	let activePlugins = await runCLICmds(
 		environment,
 		['wp option get active_plugins --format=json'],
-		config
+		config,
+		spinner
 	)
 
 	activePlugins = Object.values(JSON.parse( activePlugins ));
 
 	// deactivate all active plugins.
 	if( activePlugins.length ){
-		await runDockerCmds(
+		await runCLICmds(
 			environment,
 			['wp plugin deactivate ' + activePlugins.join(' ')],
-			config
+			config,
+			spinner
 		)
 	}
 	
@@ -63,10 +76,11 @@ async function convertToMultisite( environment, config, subdomain ){
 		command += ' --subdomains'
 	}
 
-	await runDockerCmds(
+	await runCLICmds(
 		environment, 
 		[command],
-		config
+		config,
+		spinner
 	)
 
 	// generate .htaccess
@@ -74,10 +88,11 @@ async function convertToMultisite( environment, config, subdomain ){
 
 	// network activate all active plugins again.
 	if( activePlugins.length ){
-		await runDockerCmds(
+		await runCLICmds(
 			environment,
 			['wp plugin activate ' + activePlugins.join(' ') + ' --network'],
-			config
+			config,
+			spinner
 		)
 	}
 
@@ -86,8 +101,8 @@ async function convertToMultisite( environment, config, subdomain ){
 /**
  * Generates .htaccess file content.
  * 
- * @param {string} environment Which environment to generate .htaccess for.
- * @param {boolean} subdomain True if converting to multisite subdomain.
+ * @param {string} 	environment Which environment to generate .htaccess for.
+ * @param {boolean} subdomain  	True if converting to multisite subdomain.
  */
 async function generateHTAccess(environment, workDirectoryPath, subdomain){
 	let trailingSlash = subdomain ? '^wp-admin$ wp-admin/ [R=301,L]' : '^([_0-9a-zA-Z-]+/)?wp-admin$ $1wp-admin/';
@@ -116,6 +131,7 @@ async function generateHTAccess(environment, workDirectoryPath, subdomain){
 	await writeFile(path.join(workDirectoryPath, folder, '.htaccess'), htaccess);
 
 }
+
 /**
  * Configures WordPress for the given environment by installing WordPress,
  * activating all plugins, and activating the first theme. These steps are
@@ -133,32 +149,26 @@ async function configureWordPress(environment, config, spinner, multisite, subdo
 		WP_PERMALINK
 	} = config.env[ environment ].config
 
-	const {name} = getHostUser();
-	
-	const containerName = path.basename(workDirectoryPath) + ('tests' === environment ? '-tests' : '') + '-cli';
-	const containerID = await execSync(`docker ps -qf "name=${containerName}"`).toString().trim();
-
-	// Add cli config.yml to cli container.
-	await execSync(`docker exec ${containerID} mkdir -p /home/${name}/.wp-cli/ && docker cp ./lib/config.yml ${containerID}:/home/${name}/.wp-cli/config.yml`);
 
 	// Convert to multisite if flag was passed.
 	if( multisite ){
 		spinner.text = 'Converting to multisite ' + ( subdomain ? 'subdomain' : 'subdirectory') + '...'
 		
-		await convertToMultisite( environment, config, subdomain )
+		await convertToMultisite( environment, config, subdomain, spinner )
 	}
 
 	// rewrite and flush permalink structure.
-	await runDockerCmds(
+	await runCLICmds(
 		environment,
 		[
 			`wp rewrite structure ${WP_PERMALINK} --hard`
 		],
-		config
+		config, 
+		spinner
 	);
 }
 
-module.exports = {
+export {
 	configureWordPress,
 	isMultisite,
 	convertToMultisite,

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "@caweb/cli",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "CAWebPublishing Command Line Interface.",
-  "main": "lib/env.js",
+  "exports": "./lib/env.js",
+  "type": "module",
+  "node": ">=16",
   "files": [
     "bin",
     "lib"
@@ -16,6 +18,7 @@
   },
   "scripts": {
     "caweb": "caweb",
+    "wp-env": "wp-env",
     "local": "npm pack && npm i caweb-cli-%npm_package_version%.tgz",
     "test": "echo \"Error: run tests from root\" && exit 0"
   },
@@ -39,6 +42,7 @@
   "dependencies": {
     "@wordpress/env": "^9.0.0",
     "chalk": "^4.0.0",
+    "commander": "^11.1.0",
     "fs-extra": "^11.1.1"
   },
   "config": {
@@ -56,7 +60,8 @@
       "ADMIN_COOKIE_PATH": "/",
       "COOKIE_DOMAIN": "",
       "COOKIEPATH": "",
-      "SITECOOKIEPATH": ""
+      "SITECOOKIEPATH": "",
+      "CONCATENATE_SCRIPTS": false
     }
   }
 }

package/lib/commands/tasks/index.js

@@ -1,13 +0,0 @@
-'use strict';
-/**
- * External dependencies
- */
-
-/**
- * Internal dependencies
- */
-const updatePlugins = require('./update-plugins')
-
-module.exports = {
-	updatePlugins,
-};

package/lib/config.yml

@@ -1,3 +0,0 @@
-path: /var/www/html
-apache_modules:
-  - mod_rewrite