@caweb/cli 1.11.2 → 1.12.0

package/lib/wordpress/caweb.js

@@ -53,19 +53,18 @@ async function activateCAWeb(
  * @param {Object}        spinner     A CLI spinner which indicates progress.
  */
 async function configureCAWeb( environment, config, spinner ) {
-	
 
 	const isThemeActivated = await activateCAWeb( environment, config );
 
-	const {
-		DESIGN_SYSTEM_ENABLED
-	} = config.env[ environment ].config
-
 	// if our theme is active.
 	if( false !== isThemeActivated ){
+		
 		spinner.text = `Configuring CAWebPublishing ${environment} Environment...`;
 
-		let themeOptions = [];
+		// lets set the default theme to CAWeb.
+		let themeOptions = [
+			'wp config set WP_DEFAULT_THEME CAWeb',
+		];
 
 		// iterate over config options.
 		Object.entries(config.env[ environment ].config).forEach(([k,v]) => {
@@ -104,21 +103,8 @@ async function configureCAWeb( environment, config, spinner ) {
 				times: 2,
 			} ),
 		] );
+
 	}
-		
-	// Activate Design System plugin
-	if( undefined !== DESIGN_SYSTEM_ENABLED && DESIGN_SYSTEM_ENABLED ){
-		await runCLICmds(
-			environment,
-			[
-				'wp plugin is-installed design-system-wordpress', 
-				'wp plugin activate design-system-wordpress'
-			],
-			config,
-			spinner
-		)
-	}
-	
 	
 }
 

package/lib/wordpress/download-sources.js

@@ -17,6 +17,7 @@ import got from 'got';
 import stream from 'stream';
 import zip from 'extract-zip';
 import { rimraf } from 'rimraf';
+import { env } from 'process';
 
 /**
  * Internal dependencies
@@ -176,11 +177,25 @@ async function downloadZipSource( source, { onProgress, spinner, debug } ) {
 	onProgress( 1 );
 }
 
-function dowloadPlugins(pluginDir){
+function defaultSources(pluginDir, themeDir){
 	return [
+		{
+			basename: 'CAWeb Theme',
+			url: 'https://github.com/CAWebPublishing/CAWeb/archive/refs/tags/1.13.3.zip',
+			path: path.join(themeDir, 'CAWeb'),
+			type: 'zip',
+
+		},
+		{
+			basename: 'CAWebPublishing Development Plugin',
+			url: 'https://github.com/CAWebPublishing/caweb-dev/archive/refs/tags/1.1.1.zip',
+			path: path.join(pluginDir, 'caweb-dev'),
+			type: 'zip',
+
+		},
 		{
 			basename: 'Query Monitor',
-			url: 'https://downloads.wordpress.org/plugin/query-monitor.3.15.0.zip',
+			url: 'https://downloads.wordpress.org/plugin/query-monitor.3.17.2.zip',
 			path: path.join(pluginDir, 'query-monitor'),
 			type: 'zip',
 
@@ -191,10 +206,11 @@ function dowloadPlugins(pluginDir){
 /**
  * Download CAWeb Resources.
  * 
+ * @param {WPEnvironment} environment The environment to configure. Either 'development' or 'tests'.
  * @param {Object}   spinner The spinner object to show progress.
  * @return {WPConfig} The config object we've loaded.
  */
-export async function downloadSources( 
+export async function downloadSources( environment,
 	{ 
 		spinner,
 		config
@@ -216,10 +232,12 @@ export async function downloadSources(
 	const { workDirectoryPath } = config;
 	const { development: dev, tests: test } = config.env;
 
-	let pluginDir = path.resolve(workDirectoryPath, 'plugins');
-	let themeDir = path.resolve(workDirectoryPath, 'themes');
+	let instance = ('tests' === environment ? 'Tests-' : '') + 'WordPress';
+
+	let pluginDir = path.resolve(workDirectoryPath, instance , 'wp-content' , 'plugins');
+	let themeDir = path.resolve(workDirectoryPath, instance, 'wp-content' , 'themes');
 
-	let sources = dowloadPlugins(pluginDir);
+	let sources = defaultSources(pluginDir, themeDir);
 
 	// Add Divi Theme and plugin to sources.
 	if( (undefined !== dev.config.ET_USERNAME && 
@@ -249,16 +267,20 @@ export async function downloadSources(
 	}
 
 	// 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,
-			} )
-		)
+	// fs.ensureDir(themeDir);
+	// fs.ensureDir(pluginDir);
+
+	await Promise.all(
+		sources.map( ( source ) => {
+			if( 'development' === environment ){
+				downloadSource( source, {
+					onProgress: getProgressSetter( source.basename ),
+					spinner,
+				} )
+			}else{
+				downloadSource( source, {onProgress: () => {}, spinner} )
+			}
+		})
 	);
 	
 };

package/lib/wordpress/options.js

@@ -5,8 +5,6 @@
 /**
  * Missing options.
  * 
- * CAWEB_FAV_ICON
- * CAWEB_ORG_LOGO
  * Social Media Links
  * Custom CSS/JS
  * Alert Banners
@@ -15,47 +13,47 @@
  *  @todo Add missing options.
  */
 const caweb_general_options = {
-    CAWEB_TEMPLATE_VER: {
-		name: 'ca_site_version',
-		defaultValue: '5.5',
-		label: 'State Template Version'
+	CAWEB_FAV_ICON: {
+		name: 'ca_fav_ico',
+		defaultValue: '',
+		label: 'Fav Icon'
 	},
-    CAWEB_NAV_MENU_STYLE: {
+	CAWEB_NAV_MENU_STYLE: {
 		name: 'ca_default_navigation_menu',
 		defaultValue: 'singlelevel',
 		label: 'Header Menu Type'
 	},
-    CAWEB_COLORSCHEME: {
+	CAWEB_COLORSCHEME: {
 		name: 'ca_site_color_scheme',
 		defaultValue: 'oceanside',
 		label: 'Color Scheme'
 	},
-    CAWEB_TITLE_DISPLAY: {
+	CAWEB_TITLE_DISPLAY: {
 		name: 'ca_default_post_title_display',
 		defaultValue: false,
 		label: 'Title Display Default'
 	},
-    CAWEB_STICKY_NAV: {
+	CAWEB_STICKY_NAV: {
 		name: 'ca_sticky_navigation',
 		defaultValue: false,
 		label: 'Sticky Navigation'
 	},
-    CAWEB_MENU_HOME_LINK: {
+	CAWEB_MENU_HOME_LINK: {
 		name: 'ca_home_nav_link',
 		defaultValue: false,
 		label: 'Menu Home Link'
 	},
-    CAWEB_DISPLAY_POSTS_DATE: {
+	CAWEB_DISPLAY_POSTS_DATE: {
 		name: 'ca_default_post_date_display',
 		defaultValue: false,
 		label: 'Display Date for Non-Divi Posts'
 	},
-    CAWEB_X_UA_COMPATIBILITY: {
+	CAWEB_X_UA_COMPATIBILITY: {
 		name: 'ca_x_ua_compatibility',
 		defaultValue: false,
 		label: 'Legacy Browser Support'
 	},
-    CAWEB_FRONTPAGE_SEARCH: {
+	CAWEB_FRONTPAGE_SEARCH: {
 		name: 'ca_frontpage_search_enabled',
 		defaultValue: false,
 		label: 'Show Search on Front Page'
@@ -107,8 +105,13 @@ const caweb_utility_header_options = {
 };
 
 const page_header_options = {
-	CAWEB_CAWEB_ORG_LOGO_ALT_TEXT: {
-		name: '',
+	CAWEB_ORG_LOGO: {
+		name: 'header_ca_branding',
+		defaultValue: '',
+		label: 'Organization Logo-Brand'
+	},
+	CAWEB_ORG_LOGO_ALT_TEXT: {
+		name: 'header_ca_branding_alt_text',
 		defaultValue: '',
 		label: 'Organization Logo-Alt Text'
 	}
@@ -181,7 +184,7 @@ const github_options = {
 };
 
 const CAWEB_OPTIONS = {
-    ...caweb_general_options,
+	...caweb_general_options,
 	...caweb_utility_header_options,
 	...page_header_options,
 	...google_options,
@@ -254,6 +257,6 @@ const DIVI_OPTIONS = {
 }
 
 export {
-    CAWEB_OPTIONS,
+	CAWEB_OPTIONS,
 	DIVI_OPTIONS
 }

package/lib/wordpress/wordpress.js

@@ -3,12 +3,11 @@
  */
 import fs from 'fs';
 import path from 'path';
-
+import yaml from 'js-yaml';
 /**
  * Internal dependencies
  */
-import {runCLICmds} from '../helpers.js';
-
+import {appPath, runCLICmds} from '../helpers.js';
 
 /**
  * Checks whether WordPress environment is a multisite installation.
@@ -44,7 +43,8 @@ async function isMultisite( environment, config, spinner ){
  * @returns 
  */
 async function convertToMultisite( environment, config, subdomain, spinner ){
-	// before we can conver to multisite all plugins must be deactivated.
+	
+	// before we can convert to multisite all plugins must be deactivated.
 	// first lets get all plugins
 	let activePlugins = await runCLICmds(
 		environment,
@@ -65,23 +65,16 @@ async function convertToMultisite( environment, config, subdomain, spinner ){
 		)
 	}
 	
-	// convert to multisite.
-	let command = 'wp core multisite-convert';
-
-	if( subdomain ){
-		command += ' --subdomains'
-	}
-
 	await runCLICmds(
 		environment, 
-		[command],
+		[
+			// convert to multisite.
+			'wp core multisite-convert' + ( subdomain ? ' --subdomains' : '' ),
+		],
 		config,
 		spinner
 	)
 
-	// generate .htaccess
-	await generateHTAccess( environment, config.workDirectoryPath, subdomain );
-
 	// network activate all active plugins again.
 	if( activePlugins.length ){
 		await runCLICmds(
@@ -97,15 +90,39 @@ async function convertToMultisite( environment, config, subdomain, spinner ){
 /**
  * Generates .htaccess file content.
  * 
- * @param {string} 	environment Which environment to generate .htaccess for.
+ * @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, subdomain){
-	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]';
+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 /
@@ -120,14 +137,68 @@ async function generateHTAccess(environment, workDirectoryPath, subdomain){
 		RewriteRule ${writeRule1}
 		RewriteRule ${writeRule2}
 		RewriteRule . index.php [L]
-		`.replace(/\t/g, '').trim();
+		`;
+	}
+	
+	// write the .htaccess file.
+	fs.writeFileSync(path.join(workDirectoryPath, folder, '.htaccess'), htaccess.replace(/\t/g, '').trim());
+
+}
+
+/**
+ * Configures the application password for the given environment.
+ * 
+ * @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 configureApplicationPassword( environment, config, spinner ){
+	let cawebJson = fs.existsSync( path.join(appPath, 'caweb.json') ) ? 
+		JSON.parse(fs.readFileSync(path.join(appPath, 'caweb.json'))) 
+		: {};
+
+	// Check if application password exists.
+	const exists = await runCLICmds(
+		environment,
+		[ 'wp user application-password exists 1 caweb' ],
+		config, spinner
+	)
+	
+	if( exists ){
+		const uuid = await runCLICmds(
+			environment,
+			[ 'wp user application-password list 1 --field=uuid --name=caweb --porcelain' ],
+			config, spinner
+		);
 
-	let folder = 'development' === environment ? 'WordPress' : 'Tests-WordPress'
+		// delete the existing application password.
+		await runCLICmds(
+			environment,
+			[ `wp user application-password delete 1 ${uuid}` ],
+			config, spinner
+		)
+	}
 
-	fs.writeFileSync(path.join(workDirectoryPath, folder, '.htaccess'), htaccess);
+	let pwd = await runCLICmds(
+			environment,
+			[ 'wp user application-password create 1 caweb --porcelain' ],
+			config, spinner
+		)
+	
+	cawebJson['sync']['local'] = {
+		'url': config.env.development.config?.WP_SITEURL || 'http://localhost:8888',
+		'user': 'admin',
+		pwd,
+	}
 
+	// update the caweb.json file with the new sync information.
+	fs.writeFileSync(
+		path.join(appPath, 'caweb.json'),
+		JSON.stringify(cawebJson, null, 4)
+	);
 }
 
+
 /**
  * Configures WordPress for the given environment by installing WordPress,
  * activating all plugins, and activating the first theme. These steps are
@@ -140,32 +211,36 @@ async function generateHTAccess(environment, workDirectoryPath, subdomain){
  * @param {boolean} 	  subdomain   True if converting to multisite subdomain.
  */
 async function configureWordPress(environment, config, spinner, multisite, subdomain){
-	const { workDirectoryPath} = config;
 	const {
 		WP_PERMALINK
 	} = config.env[ environment ].config
 
+	// Create an Application Password for the user.
+	await configureApplicationPassword( environment, config, spinner );
 
 	// Convert to multisite if flag was passed.
 	if( multisite ){
-		spinner.text = 'Converting to multisite ' + ( subdomain ? 'subdomain' : 'subdirectory') + '...'
-		
 		await convertToMultisite( environment, config, subdomain, spinner )
 	}
-
+	
 	// rewrite and flush permalink structure.
 	await runCLICmds(
-		environment,
+		environment, 
 		[
 			`wp rewrite structure ${WP_PERMALINK} --hard`
 		],
-		config, 
+		config,
 		spinner
-	);
+	)
+
+	// generate .htaccess
+	await generateHTAccess( environment, config.workDirectoryPath, multisite, subdomain );
+	
 }
 
 export {
 	configureWordPress,
+	configureApplicationPassword,
 	isMultisite,
 	convertToMultisite,
 	generateHTAccess

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.11.2",
+  "version": "1.12.0",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -52,22 +52,26 @@
       "WP_MAX_MEMORY_LIMIT": "512M",
       "WP_PERMALINK": "/%year%/%monthnum%/%postname%/",
       "WP_POST_REVISIONS": true,
+      "WP_SITEURL": "http://localhost",
+      "WP_HOME": "http://localhost",
       "ADMIN_COOKIE_PATH": "/",
       "COOKIE_DOMAIN": "",
       "COOKIEPATH": "",
       "SITECOOKIEPATH": "",
-      "CONCATENATE_SCRIPTS": false
+      "CONCATENATE_SCRIPTS": false,
+      "WP_ENV_PHPMYADMIN_PORT": 9999,
+      "WP_ENV_TESTS_PHPMYADMIN_PORT": 9998
     }
   },
   "dependencies": {
     "@caweb/a11y-webpack-plugin": "^1.0.9",
     "@caweb/css-audit-webpack-plugin": "^1.0.12",
     "@caweb/jshint-webpack-plugin": "^2.0.1",
-    "@caweb/webpack": "^1.4.4",
+    "@caweb/webpack": "^1.5.0",
     "@inquirer/prompts": "^7.5.3",
-    "@wordpress/create-block": "^4.67.0",
-    "@wordpress/env": "^10.24.0",
-    "axios": "^1.9.0",
+    "@wordpress/create-block": "^4.68.0",
+    "@wordpress/env": "^10.25.0",
+    "axios": "^1.10.0",
     "axios-retry": "^4.5.0",
     "chalk": "^5.4.1",
     "commander": "^14.0.0",

package/commands/env/destroy.js

@@ -1,49 +0,0 @@
-
-/**
- * External dependencies
- */
-import { default as wpEnvDestroy } from '@wordpress/env/lib/commands/destroy.js';
-
-/**
- * Internal dependencies
- */
-import { runCmd } from '../../lib/index.js';
-
-/**
- * Destroys 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 destroy({
-	spinner,
-	scripts,
-	debug,
-}) {
-
-	await wpEnvDestroy({spinner, scripts, debug });
-
-	// wp-env destroy completed successfully if spinner.text reads.
-	if( 'Removed WordPress environment.' === spinner.text ){
-		spinner.text = "Cleaning up...";
-		
-		// Stop phpMyAdmin as well
-		// wp-env doesn't destroy the phpmyadmin image so we have to do it ourselves.
-		await runCmd(
-			'docker',
-			[
-				'image',
-				'rm',
-				'phpmyadmin'
-			],
-			{ stdio: 'ignore' }
-		)
-		
-		spinner.text = "Removed WordPress environment.'";
-
-	}
-
-}

package/commands/env/stop.js

@@ -1,35 +0,0 @@
-/**
- * External dependencies
- */
-import path from 'path';
-import loadConfig from '@wordpress/env/lib/config/load-config.js';
-import * as dockerCompose from 'docker-compose';
-
-import { default as wpEnvStop } from '@wordpress/env/lib/commands/stop.js';
-
-/**
- * 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,
-	} );
-
-}