@caweb/cli 1.2.0 → 1.3.0

package/lib/cli.js

@@ -3,66 +3,54 @@
  */
 //const wpenv_cli = require('@wordpress/env/lib/cli');
 
-import path from 'node:path';
+import path from 'path';
 import chalk from 'chalk';
-import parseXdebugMode from '@wordpress/env/lib/parse-xdebug-mode.js';
-import fs from 'fs-extra';
+import fs from 'fs';
 import terminalLink from  'terminal-link';
-import { Command, Argument, Option } from 'commander';
+import { Command, Argument, Option  } from 'commander';
 
 /**
  * Internal dependencies
  */
-import * as env from './commands/index.js';
+import * as env from '../commands/index.js';
 import {
 	wpPrimary,
 	wpGreen,
 	wpYellow,
 	wpRed,
-	withSpinner
-} from './spinner.js';
+	withSpinner,
+	projectPath,
+} from './index.js';
 
-const localPath = path.resolve( path.join(process.cwd(), 'node_modules/@caweb/cli/package.json') )
-const pkg = JSON.parse( await fs.readFile(localPath) );
+const localFile = path.join(projectPath, 'package.json');
+const pkg = JSON.parse( fs.readFileSync(localFile) );
 const program = new Command();
 
-export default function cli() {
-	const envArg = new Argument('[environment]', 'Which environment to use.')
-		.choices([
-			'development', 
-			'tests', 
-			'all'
-		])
-		.default('development');
-
-	const containerArg = new Argument('<container>', 'The underlying Docker service to run the command on.')
-		.choices([
-			'mysql',
-			'tests-mysql',
-			'wordpress',
-			'tests-wordpress',
-			'cli',
-			'tests-cli',
-		])
-		.default('development');
+const containerArg = new Argument('<container>', 'The underlying Docker service to run the command on.')
+	.choices([
+		'mysql',
+		'tests-mysql',
+		'wordpress',
+		'tests-wordpress',
+		'cli',
+		'tests-cli',
+	])
+	.default('development');
 
-	program
-		.name(wpPrimary( 'caweb'))
-		.usage( wpYellow( '<command>' ) )
-		.description('Command Line Interface utilized by CAWebPublishing to accomplish several tasks.')
-		.version( pkg.version )
-		.option(
-			'--debug',
-			'Enable debug output.',
-			false
-		)
-		.allowUnknownOption(true)
-		.configureHelp({ 
-			sortSubcommands: true,
-			sortOptions: true,
-			showGlobalOptions: true,
-		})
-		.addHelpCommand(false)
+const envArg = new Argument('[environment]', 'Which environment to use.')
+	.choices([
+		'development', 
+		'tests', 
+		'all'
+	])
+	.default('development');
+
+
+/**
+ * Adds commands for wp-env 
+ */
+function addWPEnvCommands(){
+	
 
 	// Start command.
 	program.command('start')
@@ -128,13 +116,6 @@ export default function cli() {
 		.allowUnknownOption(true)
 		.action( withSpinner(env.destroy) )
 
-	// Shell Command.
-	program.command('shell')
-		.description('Open shell terminal in WordPress environment.')
-		.addArgument(envArg)
-		.allowUnknownOption(true)
-		.action( withSpinner(env.shell) )
-
 	// Stop Command.
 	program.command('stop')
 		.description(
@@ -145,6 +126,12 @@ export default function cli() {
 		.allowUnknownOption(true)
 		.action( withSpinner(env.stop) )
 
+	// Install Path Command.
+	program.command('install-path')
+		.description('Get the path where all of the environment files are stored. This includes the Docker files, WordPress, PHPUnit files, and any sources that were downloaded.')
+		.allowUnknownOption(true)
+		.action( withSpinner(env.installPath) )
+
 	// Clean Command.
 	program.command('clean')
 		.description(
@@ -172,7 +159,7 @@ export default function cli() {
 		)
 		.allowUnknownOption(true)
 		.action( withSpinner(env.logs) )
-	
+
 		
 	// Run Command.
 	program.command('run')
@@ -189,12 +176,60 @@ export default function cli() {
 		.allowUnknownOption(true)
 		.action( withSpinner(env.run) )
 
+
+	// Shell Command.
+	program.command('shell')
+		.description('Open shell terminal in WordPress environment.')
+		.addArgument(envArg)
+		.allowUnknownOption(true)
+		.action( withSpinner(env.shell) )
+		
+}
+
+export default function cli() {
+
+
+	program
+		.name(wpPrimary( 'caweb'))
+		.usage( wpYellow( '<command>' ) )
+		.description('Command Line Interface utilized by CAWebPublishing to accomplish several tasks.')
+		.version( pkg.version )
+		.option(
+			'--debug',
+			'Enable debug output.',
+			false
+		)
+		.allowUnknownOption(true)
+		.configureHelp({ 
+			sortSubcommands: true,
+			sortOptions: true,
+			showGlobalOptions: true,
+		})
+		.helpCommand(false)
+
 		
-	// Install Path Command.
-	program.command('install-path')
-		.description('Get the path where all of the environment files are stored. This includes the Docker files, WordPress, PHPUnit files, and any sources that were downloaded.')
+	// Build Command.
+	program.command('build')
+		.description('Builds the current project.')
 		.allowUnknownOption(true)
-		.action( withSpinner(env.installPath) )
+		.action(withSpinner(env.build))
+			
+		
+	// Serve Command.
+	program.command('serve')
+	.description('Serve the current project')
+		.option(
+			'--no-template',
+			'Disables inclusion of the template page header & footer, starting off with a plain html page.'
+		)
+		.allowUnknownOption(true)
+		.action(withSpinner(env.serve))
+
+	// a11y Command.
+	program.command('a11y')
+		.description('Runs accessibility checks.')
+		.allowUnknownOption(true)
+		.action(withSpinner(env.a11y))
 
 	// Update Plugins Command.
 	program.command('update-plugins')
@@ -218,18 +253,25 @@ export default function cli() {
 		.allowUnknownOption(true)
 		.action( withSpinner(env.updateBlock) )
 
+		
+	// Update a Design System Block Command.
+	program.command('sync')
+		.description('Sync changes from one destination to another.')
+		.argument('<from>', 'Target Site URL with current changes.')
+		.argument('<to>', 'Destination Site URL that should be synced.')
+		.allowUnknownOption(true)
+		.action( withSpinner(env.sync) )
+		
 	// Test Command.
 	// Ensure this is commented out.
 	program.command('test')
 		.description('Test commands on a WordPress environment')
-		.addArgument(envArg)
-		.option( 
-			'--scripts', 
-			'Execute any configured lifecycle scripts.',
-			true
-		)
+		//.addArgument(envArg)
 		.allowUnknownOption(true)
 		.action(withSpinner(env.test))
+		
+	
+	addWPEnvCommands();
 
 	return program;
 };

package/lib/helpers.js

@@ -0,0 +1,109 @@
+/**
+ * External dependencies
+ */
+import path from 'path';
+import spawn from 'cross-spawn';
+import { fileURLToPath } from 'url';
+import { sync as resolveBin } from 'resolve-bin';
+import { v2 as dockerCompose } from 'docker-compose';
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Path Directory Locations
+ * - currentPath - Current Directory
+ * - projectPath - Current Project Path
+ * - appPath - Current Application Path
+ */
+const currentPath = path.dirname(fileURLToPath(import.meta.url));
+const projectPath = path.resolve( currentPath, '..' );
+const appPath = path.resolve( projectPath, '../../../' );
+
+/**
+ * Runs command directly.
+ * 
+ * @param string 		cmd		Command to run.
+ * @param string[] 	args	List of command arguments.
+ * @param string[]  opts   List of spawn options.
+ * 
+ * @returns {Promise}
+ */
+async function runCmd(cmd, args,opts = { stdio: 'inherit' }){
+	// fix various commands.
+	switch (cmd) {
+		case 'npm':
+		case 'npx':
+			/**
+			 * On Windows we run npm.cmd, on Linux we run npm
+			 */
+			cmd += /^win/.test(process.platform) ? '.cmd' : '';
+			break;
+		case 'webpack':
+			cmd = resolveBin(cmd)
+			break
+	}
+
+	return spawn.sync( cmd, args, {...opts, env: process.env});
+
+}
+
+/**
+ * Runs commands on the given WordPress environment.
+ * 
+ * @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 {Promise}
+ */
+async function runCLICmds(
+	environment,
+	cmds,
+	config,
+	spinner
+) {
+
+	// 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,
+			env: process.env,
+			commandOptions: [],
+			log: config.debug,
+			callback: (buffer, result) => {
+				if( config.debug ){
+					spinner.text = buffer.toString();
+				}
+			}
+		}
+	).then(
+		(output) => {
+			// Remove the Container information and new lines.
+			output.err = output.err.replace(/\s*Container .*Running\n|\n/g, '')
+			output.out = output.out.replace(/\s*Container .*Running\n|\n/g, '')
+
+			return '' !== output.out ? output.out : output.err;
+		},
+		(error) => {
+			// Remove the Container information and new lines.
+			error.err = error.err.replace(/\s*Container .*Running\n|\n/g, '')
+
+			return error;
+		}
+	);
+}
+
+
+
+export {
+	currentPath,
+	projectPath,
+	appPath,
+	runCLICmds,
+	runCmd
+};

package/lib/index.js

@@ -0,0 +1,28 @@
+import {
+    wpPrimary,
+    wpGreen,
+    wpRed,
+    wpYellow,
+    withSpinner,
+} from './spinner.js';
+
+import {
+	runCmd,
+    runCLICmds,
+	currentPath,
+    projectPath,
+    appPath
+} from './helpers.js';
+
+export {
+    currentPath,
+    projectPath,
+    appPath,
+    wpPrimary,
+    wpGreen,
+    wpRed,
+    wpYellow,
+    withSpinner,
+	runCmd,
+    runCLICmds
+}

package/lib/spinner.js

@@ -18,13 +18,16 @@ const withSpinner =
 		// 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;
-		});
+		if( cmd.registeredArguments ){
+			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] = {

package/lib/{caweb.js → wordpress/caweb.js}

@@ -7,7 +7,7 @@ import retry from '@wordpress/env/lib/retry.js';
  * Internal dependencies
  */
 import { CAWEB_OPTIONS } from'./options.js';
-import { runCLICmds } from'./utils.js';
+import { runCLICmds } from'../helpers.js';
 import { isMultisite } from'./wordpress.js';
 import { configureDivi } from'./divi.js';
 

package/lib/{divi.js → wordpress/divi.js}

@@ -1,7 +1,7 @@
 /**
  * Internal dependencies
  */
-import { runCLICmds } from './utils.js';
+import { runCLICmds } from '../helpers.js';
 import { DIVI_OPTIONS } from './options.js';
 
 

package/lib/{download-sources.js → wordpress/download-sources.js}

@@ -29,81 +29,6 @@ const pipeline = util.promisify( stream.pipeline );
 const extractZip = util.promisify( zip );
 const rimraf = util.promisify( rim );
 
-/**
- * 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 pluginDir = path.resolve(workDirectoryPath, 'plugins');
-	let themeDir = path.resolve(workDirectoryPath, 'themes');
-
-	let sources = dowloadPlugins(pluginDir);
-
-	// 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(themeDir, 'Divi'),
-				type: 'zip'
-			},
-			{
-				basename: 'Divi Plugin',
-				url: `${url}?api_update=1&theme=divi-builder&api_key=${key}&username=${user}`,
-				path: path.join(pluginDir, 'divi-builder'),
-				type: 'zip'
-			}
-		]);
-	}
-
-	// Ensure plugin/theme directory exists for downloading resources.
-	fs.ensureDir(themeDir);
-	fs.ensureDir(pluginDir);
-
-	 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.
@@ -272,6 +197,77 @@ function dowloadPlugins(pluginDir){
 	]
 }
 
-export {
-	downloadSources
-}
+/**
+ * Download CAWeb Resources.
+ * 
+ * @param {Object}   spinner The spinner object to show progress.
+ * @return {WPConfig} The config object we've loaded.
+ */
+export 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 pluginDir = path.resolve(workDirectoryPath, 'plugins');
+	let themeDir = path.resolve(workDirectoryPath, 'themes');
+
+	let sources = dowloadPlugins(pluginDir);
+
+	// 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(themeDir, 'Divi'),
+				type: 'zip'
+			},
+			{
+				basename: 'Divi Plugin',
+				url: `${url}?api_update=1&theme=divi-builder&api_key=${key}&username=${user}`,
+				path: path.join(pluginDir, 'divi-builder'),
+				type: 'zip'
+			}
+		]);
+	}
+
+	// Ensure plugin/theme directory exists for downloading resources.
+	fs.ensureDir(themeDir);
+	fs.ensureDir(pluginDir);
+
+	 await Promise.all(
+		sources.map( ( source ) =>
+			downloadSource( source, {
+				onProgress: getProgressSetter( source.basename ),
+				spinner,
+			} )
+		)
+	);
+	
+};

package/lib/wordpress/index.js

@@ -0,0 +1,16 @@
+import { activateCAWeb, configureCAWeb } from "./caweb.js";
+import { downloadSources } from "./download-sources.js";
+import { configureDivi, isDiviThemeActive } from "./divi.js";
+import { configureWordPress, isMultisite, convertToMultisite, generateHTAccess } from "./wordpress.js";
+
+export {
+    activateCAWeb,
+    configureCAWeb,
+    downloadSources,
+	configureDivi,
+	isDiviThemeActive,
+	configureWordPress,
+	isMultisite,
+	convertToMultisite,
+	generateHTAccess
+}

package/lib/{wordpress.js → wordpress/wordpress.js}

@@ -1,18 +1,14 @@
 /**
  * External dependencies
  */
-import fs from 'fs-extra';
-import path from 'node:path';
+import fs from 'fs';
+import path from 'path';
 
 /**
  * Internal dependencies
  */
-import {runCLICmds} from './utils.js';
+import {runCLICmds} from '../helpers.js';
 
-/**
- * Promisified dependencies
- */
-const { writeFile } = fs.promises;
 
 /**
  * Checks whether WordPress environment is a multisite installation.
@@ -128,7 +124,7 @@ async function generateHTAccess(environment, workDirectoryPath, subdomain){
 
 	let folder = 'development' === environment ? 'WordPress' : 'Tests-WordPress'
 
-	await writeFile(path.join(workDirectoryPath, folder, '.htaccess'), htaccess);
+	fs.writeFileSync(path.join(workDirectoryPath, folder, '.htaccess'), htaccess);
 
 }