@caweb/cli 1.13.7 → 1.14.0

package/lib/wordpress/setup/caweb.js

@@ -0,0 +1,62 @@
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+import { CAWEB_OPTIONS } from'../options.js';
+import { runCLICmds } from'../../helpers.js';
+
+/**
+ * Activates the CAWeb Theme for the WordPress Environment if it's installed.
+ * 
+ * @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 isCAWebActive({environment, cwd}){
+	return await runCLICmds({
+		environment,
+		cmds: ['wp theme is-installed CAWeb'],
+		cwd
+	});
+
+}
+
+/**
+ * Configures CAWebPublishing Service for the given environment by configure settings,
+ * and activating the CAWeb 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, cwd, configs} ) {
+
+	const isThemeActivated = await isCAWebActive({environment, cwd});
+	let cmds = [];
+
+	// if our theme is active.
+	if( false !== isThemeActivated ){
+		
+		// iterate over possible CAWeb Options.
+		for(const [k,v] of Object.entries(CAWEB_OPTIONS)){
+			// get option value from wp-config.php if exists.
+			if( configs[k] ){
+				cmds.push(
+					`wp option set '${v.name}' "${configs[k]}"`,
+				)
+			}
+		}
+	}
+	
+	// return CAWeb Theme Configuration commands.
+	return cmds;
+}
+
+export {
+	isCAWebActive,
+	configureCAWeb,
+};

package/lib/wordpress/setup/divi.js

@@ -0,0 +1,90 @@
+/**
+ * Internal dependencies
+ */
+import { runCLICmds } from '../../helpers.js';
+import { DIVI_OPTIONS } from '../options.js';
+import { isCAWebActive } from './caweb.js';
+
+
+/**
+ * Configures Divi for CAWebPublishing Service for the given environment by configure settings.
+ * 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 configureDivi( {environment, cwd, configs} ) {
+	
+	const isThemeActivated = await isCAWebActive( {environment, cwd} );
+	let cmds = [];
+
+	// if CAWeb theme is active.
+	if( false !== isThemeActivated ){
+		let diviOptions = await runCLICmds({
+			environment,
+			cmds: [ 'wp option get et_divi --format=json' ], 
+			cwd
+		});
+
+		let diviBuilderOptions = await runCLICmds({
+			environment,
+			cmds: [ 'wp option get et_bfb_settings --format=json' ], 
+			cwd
+		});
+
+		let diviUpdateOptions = await runCLICmds({
+			environment,
+			cmds: [ 'wp option get et_automatic_updates_options --format=json' ], 
+			cwd
+		})
+
+		// parse the options into a json object.
+		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]) => {
+			// iterate over each group options.
+			Object.entries(options).forEach(([key, data]) => {
+
+				// if user config has a Divi option variable use that, otherwise use our default.
+				let option_value = configs[key] || null;
+				
+				if( null !== option_value ){
+					// is a valid Divi Option.
+					if( 'et_divi' === group ){
+						diviOptions[data.name] = option_value;
+					// is a valid Divi Builder Option.
+					}else if( 'et_bfb_settings' === group ){
+						diviBuilderOptions[data.name] = option_value;
+					// is a valid Divi Update Option.
+					}else if( 'et_automatic_updates_options' === group ){
+						diviUpdateOptions[data.name] = option_value;
+					}
+				}
+			})
+		})
+
+		// parse option object back to string.
+		diviOptions = JSON.stringify( diviOptions );
+		diviBuilderOptions = JSON.stringify( diviBuilderOptions );
+		diviUpdateOptions = JSON.stringify( diviUpdateOptions );
+
+		// update each option.
+		cmds.push(
+			`wp option update et_divi '${diviOptions}' --format=json`,
+			`wp option update et_bfb_settings '${diviBuilderOptions}' --format=json`,
+			`wp option update et_automatic_updates_options '${diviUpdateOptions}' --format=json`
+		);
+
+		return cmds;
+	}
+		
+	
+}
+
+export {
+	configureDivi
+};

package/lib/wordpress/setup/index.js

@@ -0,0 +1,130 @@
+/**
+ * External dependencies
+ */
+import fs from 'fs';
+import path from 'path';
+import { format } from 'util';
+
+/**
+ * Internal dependencies
+ */
+import { runCLICmds } from '../../helpers.js';
+import { configureWordPress } from '../wordpress.js';
+import { configureCAWeb } from './caweb.js';
+import { configureDivi } from './divi.js';
+
+
+function processArgs( arr ){
+  let tmp = [];
+
+  arr.filter(Boolean).map((o) => {
+    return o.replaceAll("'", '').split('=').forEach((e => tmp.push(e)))
+  });
+
+  return tmp
+}
+
+function flagExists(flag){
+  return flags.includes(flag)
+}
+
+function getArgVal(flag){
+  return flagExists(flag) ? flags[flags.indexOf(flag) + 1] : false;
+}
+
+let flags = [].concat(
+    processArgs(process.argv),
+    // the following can be uncommented if ever needed to process those args.
+    // processArgs(process.argv0.split(' ')),
+    // processArgs(process.env)
+    // processArgs(process.env.NODE_OPTIONS ? process.env.NODE_OPTIONS.split(' ') : []),
+)
+
+const workingDirectoryPath = getArgVal('--cwd') ? getArgVal('--cwd') : process.cwd();
+
+// Collect existing wp-config.php values.
+process.stdout.write('Collecting CAWeb configuration data...');
+let configs = {};
+  JSON.parse(
+        await runCLICmds({ 
+            environment: 'development',
+            cmds: ['wp config list --format=json'],
+            cwd: workingDirectoryPath
+        })
+    ).forEach( ( item ) => {
+        configs[item.name] = item.value;
+    });
+
+// wp cli commands that will be ran.
+// process.stdout.write(`\nConfiguring WordPress...\n`);
+let cmds = [
+    ...await configureWordPress({
+        environment: 'development',
+        cwd: workingDirectoryPath,
+        multisite: flagExists('--multisite') ? getArgVal('--multisite') : false,
+        configs
+    })
+];
+
+// Download any resources required for CAWeb.
+if( ! flagExists('--bare') || ( flagExists('--bare') && getArgVal('--bare') ) ){
+    // Delete all default themes.
+    let defaultThemes = [ 
+        'twentyten', 
+        'twentyeleven', 
+        'twentytwelve',
+        'twentythirteen',
+        'twentyfourteen', 
+        'twentyfifteen', 
+        'twentysixteen',
+        'twentyseventeen',
+        'twentynineteen',
+        'twentytwenty', 
+        'twentytwentyone', 
+        'twentytwentytwo', 
+        'twentytwentythree', 
+        'twentytwentyfour', 
+        'twentytwentyfive' 
+    ];
+    cmds.push( `wp theme delete ${defaultThemes.join(' ')} --force` );
+
+    // If Elegant Themes credentials are available, download Divi.
+    if( configs.ET_USERNAME && configs.ET_API_KEY ){
+        // generate Divi download URL.
+        let et_url = `https://www.elegantthemes.com/api/api_downloads.php?api_update=1&theme=%s&api_key=${configs.ET_API_KEY}&username=${configs.ET_USERNAME}`;
+
+        // add command to install Divi theme.
+        cmds.push( `wp theme install '${format( et_url, 'Divi' )}' --force` );
+
+        // add command to install Divi Builder plugin.
+        cmds.push( `wp plugin install '${format( et_url, 'divi-builder' )}' --force` );
+    }
+
+    // Activate CAWeb theme.
+    cmds.push( 'wp theme activate CAWeb' );
+
+}
+
+
+cmds.push(
+    ...await configureCAWeb({
+        environment: 'development',
+        cwd: workingDirectoryPath,
+        configs,
+    }),
+    ...await configureDivi({
+        environment: 'development',
+        cwd: workingDirectoryPath,
+        configs,
+    })
+);
+
+if( cmds.length ){  
+    process.stdout.write(`\nConfiguring CAWeb...\n`);
+    await runCLICmds({ 
+        environment: 'development',
+        cmds,
+        cwd: workingDirectoryPath,
+        debug: true
+    });
+}

package/lib/wordpress/wordpress.js

@@ -3,38 +3,15 @@
  */
 import fs from 'fs';
 import path from 'path';
-import yaml from 'js-yaml';
+import dns from 'dns';
+
 /**
  * Internal dependencies
  */
 import {appPath, runCLICmds} from '../helpers.js';
 
 /**
- * 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, spinner ){
-
-	const result = await runCLICmds(
-		environment,
-		[ 'wp config get MULTISITE' ],
-		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.
+ * Network activate all active plugins.
  * 
  * @param {string} 		environment Which environment to convert into a multisite installation.
  * @param {WPConfig} 	config 		The wp-env config object.
@@ -42,106 +19,25 @@ async function isMultisite( environment, config, spinner ){
  * @param {Object} 		spinner     A CLI spinner which indicates progress.
  * @returns 
  */
-async function convertToMultisite( environment, config, subdomain, spinner ){
-	
-	// before we can convert to multisite all plugins must be deactivated.
-	// first lets get all plugins
-	let activePlugins = await runCLICmds(
+async function networkActivatePlugins( {environment, cwd} ){
+
+	// first lets get all active plugins
+	let activePlugins = await runCLICmds({
 		environment,
-		['wp option get active_plugins --format=json'],
-		config,
-		spinner
-	)
+		cmds: ['wp option get active_plugins --format=json'],
+		cwd
+	})
 
 	activePlugins = Object.values(JSON.parse( activePlugins ));
 
-	// deactivate all active plugins.
-	if( activePlugins.length ){
-		await runCLICmds(
-			environment,
-			['wp plugin deactivate ' + activePlugins.join(' ')],
-			config,
-			spinner
-		)
-	}
-	
-	await runCLICmds(
-		environment, 
-		[
-			// convert to multisite.
-			'wp core multisite-convert' + ( subdomain ? ' --subdomains' : '' ),
-		],
-		config,
-		spinner
-	)
-
 	// network activate all active plugins again.
 	if( activePlugins.length ){
-		await runCLICmds(
+		await runCLICmds({
 			environment,
-			['wp plugin activate ' + activePlugins.join(' ') + ' --network'],
-			config,
-			spinner
-		)
-	}
-
-}
-
-/**
- * Generates .htaccess file content.
- * 
- * @param {string}  environment Which environment to generate .htaccess for.
- * @param {boolean} multisite   True if converting to multisite.
- * @param {boolean} subdomain  	True if converting to multisite subdomain.
- */
-async function generateHTAccess(environment, workDirectoryPath, multisite, subdomain){
-	let folder = 'development' === environment ? 'WordPress' : 'Tests-WordPress';
-
-	// if .htaccess already exists, no need to generate.
-	if( fs.existsSync(path.join(workDirectoryPath, folder, '.htaccess')) ){
-		return; // .htaccess already exists, no need to generate.
-	}
-
-	// default htaccess for single site.
-	let htaccess = `
-		<IfModule mod_rewrite.c>
-		RewriteEngine On
-		RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
-		RewriteBase /
-		RewriteRule ^index\.php$ - [L]
-		RewriteCond %{REQUEST_FILENAME} !-f
-		RewriteCond %{REQUEST_FILENAME} !-d
-		RewriteRule . /index.php [L]
-		</IfModule>
-		`;
-
-
-	// if multisite, we need to add the multisite rules.
-	if( multisite ){
-		let trailingSlash = subdomain ? '^wp-admin$ wp-admin/ [R=301,L]' : '^([_0-9a-zA-Z-]+/)?wp-admin$ $1wp-admin/';
-		let writeRule1 = subdomain ? '^(wp-(content|admin|includes).*) $1 [L]' : '^([_0-9a-zA-Z-]+/)?(wp-(content|admin|includes).*) $2 [L]';
-		let writeRule2 = subdomain ? '^(.*\.php)$ $1 [L]' : '^([_0-9a-zA-Z-]+/)?(.*\.php)$ $2 [L]';
-
-		htaccess = `
-		RewriteEngine On
-		RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
-		RewriteBase /
-		RewriteRule ^index\.php$ - [L]
-
-		# add a trailing slash to /wp-admin
-		RewriteRule ${trailingSlash}
-
-		RewriteCond %{REQUEST_FILENAME} -f [OR]
-		RewriteCond %{REQUEST_FILENAME} -d
-		RewriteRule ^ - [L]
-		RewriteRule ${writeRule1}
-		RewriteRule ${writeRule2}
-		RewriteRule . index.php [L]
-		`;
+			cmds: ['wp plugin activate ' + activePlugins.join(' ') + ' --network'],
+			cwd
+		})
 	}
-	
-	// write the .htaccess file.
-	fs.writeFileSync(path.join(workDirectoryPath, folder, '.htaccess'), htaccess.replace(/\t/g, '').trim());
 
 }
 
@@ -152,7 +48,7 @@ async function generateHTAccess(environment, workDirectoryPath, multisite, subdo
  * @param {WPConfig}      config      The wp-env config object.
  * @param {Object}        spinner     A CLI spinner which indicates progress.
  */
-async function configureApplicationPassword( environment, config, spinner ){
+async function configureApplicationPassword( {environment, cwd, configs} ){
 	let cawebJson = fs.existsSync( path.join(appPath, 'caweb.json') ) ? 
 		JSON.parse(fs.readFileSync(path.join(appPath, 'caweb.json'))) 
 		: {};
@@ -163,35 +59,36 @@ async function configureApplicationPassword( environment, config, spinner ){
 	}
 
 	// Check if application password exists.
-	const exists = await runCLICmds(
+	const exists = await runCLICmds({
 		environment,
-		[ 'wp user application-password exists 1 caweb' ],
-		config, spinner
-	)
+		cmds: [ 'wp user application-password exists 1 caweb && echo $?' ],
+		cwd
+	})
 	
-	if( exists ){
-		const uuid = await runCLICmds(
+	if( '0' === exists ){
+		const uuid = await runCLICmds({
 			environment,
-			[ 'wp user application-password list 1 --field=uuid --name=caweb --porcelain' ],
-			config, spinner
-		);
+			cmds: [ 'wp user application-password list 1 --field=uuid --name=caweb --porcelain' ],
+			cwd
+		});
 
 		// delete the existing application password.
-		await runCLICmds(
+		await runCLICmds({
 			environment,
-			[ `wp user application-password delete 1 ${uuid}` ],
-			config, spinner
-		)
+			cmds: [ `wp user application-password delete 1 ${uuid}` ],
+			cwd
+		})
 	}
 
-	let pwd = await runCLICmds(
+	let pwd = await runCLICmds({
 			environment,
-			[ 'wp user application-password create 1 caweb --porcelain' ],
-			config, spinner
-		)
+			cmds: [ 'wp user application-password create 1 caweb --porcelain' ],
+			cwd
+	});
 	
+	// set the local sync information.	
 	cawebJson['sync']['local'] = {
-		'url': config.env.development.config?.WP_SITEURL || 'http://localhost:8888',
+		'url': configs.WP_SITEURL,
 		'user': 'admin',
 		pwd,
 	}
@@ -203,7 +100,6 @@ async function configureApplicationPassword( environment, config, spinner ){
 	);
 }
 
-
 /**
  * Configures WordPress for the given environment by installing WordPress,
  * activating all plugins, and activating the first theme. These steps are
@@ -215,38 +111,22 @@ async function configureApplicationPassword( environment, config, spinner ){
  * @param {boolean}   	  multisite   True if converting to multisite.
  * @param {boolean} 	  subdomain   True if converting to multisite subdomain.
  */
-async function configureWordPress(environment, config, spinner, multisite, subdomain){
-	const {
-		WP_PERMALINK
-	} = config.env[ environment ].config
-
+async function configureWordPress({environment, cwd, multisite, subdomain, configs}){
+	
 	// Create an Application Password for the user.
-	await configureApplicationPassword( environment, config, spinner );
+	await configureApplicationPassword( { environment, cwd, configs } );
 
-	// Convert to multisite if flag was passed.
 	if( multisite ){
-		await convertToMultisite( environment, config, subdomain, spinner )
+		await networkActivatePlugins( {environment, cwd} );
 	}
-	
-	// rewrite and flush permalink structure.
-	await runCLICmds(
-		environment, 
-		[
-			`wp rewrite structure ${WP_PERMALINK} --hard`
-		],
-		config,
-		spinner
-	)
-
-	// generate .htaccess
-	await generateHTAccess( environment, config.workDirectoryPath, multisite, subdomain );
-	
+
+	return [
+		`wp option update permalink_structure "${configs.WP_PERMALINK}"`,
+		`wp rewrite structure ${configs.WP_PERMALINK} --hard`
+	];
+
 }
 
 export {
-	configureWordPress,
-	configureApplicationPassword,
-	isMultisite,
-	convertToMultisite,
-	generateHTAccess
+	configureWordPress
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.13.7",
+  "version": "1.14.0",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -21,7 +21,6 @@
   "scripts": {
     "caweb": "node bin/caweb.js",
     "doc": "node ./docs/tool/index.js",
-    "testa": "node ./test.js",
     "test": "echo \"Error: run tests from root\" && exit 0"
   },
   "homepage": "https://github.com/CAWebPublishing/cli#readme",
@@ -40,9 +39,11 @@
     "access": "public"
   },
   "config": {
-    "WP_VER": "6.8.2",
+    "WP_VER": "6.8.3",
     "PHP_VER": "8.2",
+    "CAWEB_VER": "1.13.3",
     "DIVI_VER": "4.27.4",
+    "QUERY_MONITOR": "3.20.0",
     "DEFAULTS": {
       "FS_METHOD": "direct",
       "WP_DEBUG": true,
@@ -71,6 +72,8 @@
     "chalk": "^5.6.2",
     "commander": "^14.0.1",
     "cross-spawn": "^7.0.6",
+    "crypto": "^1.0.1",
+    "deepmerge": "^4.3.1",
     "docker-compose": "^1.3.0",
     "fs-extra": "^11.3.2",
     "html-to-json-parser": "^2.0.1",

package/commands/env/update-plugins.js

@@ -1,44 +0,0 @@
-/**
- * External dependencies
- */
-import path from 'path';
-import loadConfig from '@wordpress/env/lib/config/load-config.js';
-
-/**
- * Internal dependencies
- */
-import {runCLICmds} from '../../lib/index.js';
-
-/**
- * Promisified dependencies
- */
-
-/**
- * Updates all plugins for a given environment.
- * 
- * @param {Object}  options
- * @param {Object}  options.spinner A CLI spinner which indicates progress.
- * @param {string} options.environment   Which environment to updated.
- */
-export default async function updatePlugins({
-	spinner,
-	environment,
-	slug
-}) {
-
-	spinner.text = "Updating plugins...";
-	const config = await loadConfig(path.resolve('.'));
-
-	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/admin.js

@@ -1,40 +0,0 @@
-/**
- * External dependencies
- */
-import path from 'node:path';
-import fs from 'fs-extra';
-
-import { CAWEB_OPTIONS, DIVI_OPTIONS } from './options.js';
-
-/**
- * Generates the OVERRIDES.MD
- * 
- */
-export default async function generateOverridesMD() {
-
-	let output = [
-		'## [.wp-env.override.json](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#wp-env-override-json)',
-		'Any fields here will take precedence over .wp-env.json.',
-		'## <ins>Special Config Values</ins>',
-	];
-
-	// Generate CAWeb Options overrides.
-	output.push('### <ins>CAWeb Options</ins>');
-	for (const [key, option] of Object.entries(CAWEB_OPTIONS)) {
-		output.push(`\`${key}\` - Updates CAWeb ${option.label}  `);
-	}
-	  
-	// Generate Divi Options overrides.
-	output.push('### <ins>Divi Options</ins>');
-	for (const [group, options] of Object.entries(DIVI_OPTIONS)) {
-		for (const [key, option] of Object.entries(options)) {
-			output.push(`\`${key}\` - Updates CAWeb ${option.label}  `);
-		}
-	}
-
-	fs.writeFileSync(
-		path.join(process.cwd(), 'docs', 'OVERRIDES.MD'),
-		output.join('\n')
-	);
-
-};