@caweb/cli 1.0.5 → 1.2.0

package/lib/commands/test.js

@@ -1,50 +1,20 @@
-'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' );
-const run = require('@wordpress/env/lib/commands/run');
-const getHostUser = require( '@wordpress/env/lib/get-host-user' );
-const yaml = require( 'js-yaml' );
+import path from 'node:path';
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
+import fs from 'fs-extra';
 
 /**
  * Internal dependencies
  */
-const {
-	runDockerCmds, 
-} = require('../docker');
- 
-const { 
-	buildWPEnvConfig, 
-	buildDockerComposeConfig 
-} = require('../configs');
-
-const pkg = require( '../../package.json' );
-const { DIVI_OPTIONS } = require('../options');
-
-const { 
-	isDiviThemeActive, 
-	configureDivi 
-} = require('../divi');
-
-const {
-	activateCAWeb,
-	configureCAWeb
-} = require('../caweb');
-
-const {
-	generateHTAccess
-} = require( '../wordpress' );
+import { runCLICmds, runCmd } from '../utils.js';
+import generateOverridesMD from '../admin.js';
+import { CAWEB_OPTIONS, DIVI_OPTIONS } from '../options.js';
 
 /**
  * Promisified dependencies
  */
-const { writeFile } = fs.promises;
 
 /**
  * Test code.
@@ -54,46 +24,23 @@ const { writeFile } = fs.promises;
  * @param {boolean} options.environment   Which environment to test in.
  * @param {boolean} options.debug   True if debug mode is enabled.
  */
-module.exports = async function test({
+export default async function test({
 	spinner,
-	environment,
 	debug,
-	multisite,
-	subdomain
-}) {
+	environment
+} ) {
 
-	try {
+	spinner.text = "Testing Code Functionality";
 		const config = await loadConfig(path.resolve('.'));
-		const {WP_PERMALINK} = config.env[ environment ].config
-		const { workDirectoryPath} = config;
-		const {name} = getHostUser();
-		const containerName = path.basename(workDirectoryPath) + ('tests' === environment ? '-tests' : '') + '-cli';
-		//const containerID = await execSync(`docker ps -qf "name=${containerName}"`).toString().trim();
-	
-		spinner.text = "Testing code...";
-			
-
-		spinner.text = 'Completed Testing code...'
-
-		/*
-		let result = await runDockerCmds(
-			environment,
-			['wp theme is-installed CAWeb'],
-			config
+		
+		let result = await runCLICmds(
+			'development', 
+			['wp --version'], 
+			config, 
+			spinner
 		)
 
-		if( '' !== result.out ) {
-			console.log( JSON.parse(result.out))
-		}else{
-			console.log(result);
-		}
-		*/
-
 
-	} catch(error) {
-		console.log(error)
+		console.log( result );
 
-		process.exit( 1 );
-	}
-	
 };

package/lib/configs.js

@@ -1,27 +1,33 @@
 /**
  * External dependencies
  */
-const path = require( 'path' );
-const fs = require('fs-extra');
-const pkg = require( '../package.json' );
-const yaml = require( 'js-yaml' );
-const getHostUser = require( '@wordpress/env/lib/get-host-user' );
-
+import path from 'node:path';
+import fs from 'fs-extra';
+import yaml from 'js-yaml';
+import getHostUser from '@wordpress/env/lib/get-host-user.js';
 
 /**
  * Promisified dependencies
  */
 const { writeFile } = fs.promises;
 
+const localPath = path.resolve( path.join(process.cwd(), 'node_modules/@caweb/cli/package.json') )
+const pkg = JSON.parse( await fs.readFile(localPath) );
+
 /**
  * Build .wp-env.json
  * 
  * @param {boolean} bare   True if excluding any CAWeb Configurations.
  * @param {boolean} multisite   True if converting to multisite.
+ * @param {boolean} plugin   True if root directory is a plugin.
+ * @param {boolean} theme   True if root directory is a theme.
  * 
  * @returns object
  */
-const buildWPEnvConfig = (bare, multisite) => {
+const buildWPEnvConfig = (bare, multisite, plugin, theme) => {
+    let themes = [];
+    let plugins = [];
+
     let config = {
         core: `WordPress/WordPress#${pkg.config.WP_VER}`,
         phpVersion: `${pkg.config.PHP_VER}`,
@@ -32,12 +38,37 @@ const buildWPEnvConfig = (bare, multisite) => {
 
     // if not bare then include our theme.
     if( ! bare ){
-        config['themes'] = [`CA-CODE-Works/CAWeb`];
+        themes.push('CAWebPublishing/CAWeb')
     }
 
+    // if root directory is a theme
+    if( theme ){
+        themes.push( '.' );
+    }
+    
     // if is multisite
     if( multisite ){
         config.config['WP_ALLOW_MULTISITE'] = true;
+
+        // set CAWeb as Default Theme if it was downloaded
+        if( ! bare ){
+            config.config['WP_DEFAULT_THEME'] = 'CAWeb';
+        }
+    }
+
+    // if root directory is a plugin
+    if( plugin ){
+        plugins.push( '.' );
+    }
+
+    // add plugins if sources were added
+    if( plugins.length ){
+        config['plugins'] = plugins;
+    }
+
+    // add themes if sources were added
+    if( themes.length ){
+        config['themes'] = themes;
     }
 
     return config;
@@ -64,18 +95,7 @@ const buildDockerComposeConfig = (workDirectoryPath) => {
                 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',
+                    PMA_HOSTS : 'mysql,tests-mysql',
                     UPLOAD_LIMIT: '3G',
                     MEMORY_LIMIT: '5G',
                     MAX_EXECUTION_TIME: 7200
@@ -175,7 +195,7 @@ async function generateCLIConfig(workDirectoryPath){
         yaml.dump(yml));
 }
 
-module.exports = {
+export {
     buildWPEnvConfig,
     buildDockerComposeConfig
 }

package/lib/divi.js

@@ -1,31 +1,28 @@
-'use strict';
-/**
- * External dependencies
- */
-
-
 /**
  * Internal dependencies
  */
-const { runDockerCmds } = require('./docker');
-const { DIVI_OPTIONS } = require('./options');
+import { runCLICmds } from './utils.js';
+import { DIVI_OPTIONS } from './options.js';
 
 
 /**
  * Checks if Divi Theme is active for the WordPress Environment.
  * 
- * @param {string} environment   Which environment to activate the theme on.
- * @param {WPConfig} config      The wp-env config object.
+ * @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 isDiviThemeActive(
 	environment,
-	config
+	config,
+	spinner
 ){
 
-	return await runDockerCmds(
+	return await runCLICmds(
 		environment,
 		['wp theme is-active Divi'],
-		config
+		config,
+		spinner
 	);
 
 }
@@ -40,31 +37,34 @@ async function isDiviThemeActive(
  */
 async function configureDivi( environment, config, spinner ) {
 	
-	const activeTheme = await isDiviThemeActive( environment, config );
+	const activeTheme = await isDiviThemeActive( environment, config, spinner );
 
 	// if Divi theme is active.
 	if( false !== activeTheme ){
 		let cmds = [];
-		let diviOptions = await runDockerCmds(
+		let diviOptions = await runCLICmds(
 			environment,
 			[ 'wp option get et_divi --format=json' ], 
-			config
+			config,
+			spinner
 		)
-		let diviBuilderOptions = await runDockerCmds(
+		let diviBuilderOptions = await runCLICmds(
 			environment,
 			[ 'wp option get et_bfb_settings --format=json' ], 
-			config
+			config,
+			spinner
 		)
-		let diviUpdateOptions = await runDockerCmds(
+		let diviUpdateOptions = await runCLICmds(
 			environment,
 			[ 'wp option get et_automatic_updates_options --format=json' ], 
-			config
+			config,
+			spinner
 		)
 
 		// parse the options into a json object.
-		diviOptions = diviOptions ? JSON.parse( diviOptions ) : {};
-		diviBuilderOptions = diviBuilderOptions ? JSON.parse( diviBuilderOptions ) : {};
-		diviUpdateOptions = undefined !== diviUpdateOptions && diviUpdateOptions ? JSON.parse( diviUpdateOptions ) : {};
+		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]) => {
@@ -95,6 +95,7 @@ async function configureDivi( environment, config, spinner ) {
 		diviBuilderOptions = JSON.stringify( diviBuilderOptions );
 		diviUpdateOptions = JSON.stringify( diviUpdateOptions );
 
+		// update each option.
 		cmds.push(`wp option update et_divi '${diviOptions}' --format=json`);
 		cmds.push(`wp option update et_bfb_settings '${diviBuilderOptions}' --format=json`);
 		cmds.push(`wp option update et_automatic_updates_options '${diviUpdateOptions}' --format=json`);
@@ -109,17 +110,18 @@ async function configureDivi( environment, config, spinner ) {
 		}
 		
 		// Execute theme option commands.
-		await runDockerCmds(
+		await runCLICmds(
 			environment,
 			cmds,
-			config
+			config,
+			spinner
 		)
 	}
 		
 	
 }
 
-module.exports = {
+export {
 	configureDivi,
 	isDiviThemeActive
 };

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.
@@ -255,7 +256,7 @@ function dowloadPlugins(pluginDir){
 	return [
 		{
 			basename: 'Design System',
-			url: 'https://github.com/CA-CODE-Works/design-system-wordpress.git',
+			url: 'https://github.com/CAWebPublishing/design-system-wordpress.git',
 			ref: 'main',
 			path: path.join(pluginDir, 'design-system-wordpress'),
 			clonePath: path.join(pluginDir, 'design-system-wordpress'),
@@ -271,7 +272,6 @@ function dowloadPlugins(pluginDir){
 	]
 }
 
-module.exports = {
+export {
 	downloadSources
-	
 }

package/lib/env.js

@@ -1,12 +1,9 @@
-'use strict';
 /**
  * Internal dependencies
  */
 
-//const { ValidationError } = require( './config' );
-//const { LifecycleScriptError } = require( './execute-lifecycle-script' );
-const commands = require( './commands' );
+import * as commands from './commands/index.js';
 
-module.exports = {
+export default {
 	...commands
-};
+}

package/lib/options.js

@@ -170,7 +170,7 @@ const github_options = {
 	},
 	CAWEB_GIT_USER: {
 		name: 'caweb_username',
-		defaultValue: 'CA-CODE-Works',
+		defaultValue: 'CAWebPublishing',
 		label: 'Username'
 	},
 	CAWEB_ACCESS_TOKEN: {
@@ -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/template/assets/css/popover.css

@@ -0,0 +1,80 @@
+
+  .popover-content {
+    position: absolute;
+    display: flex;
+    flex-direction: column-reverse;
+    row-gap: .5rem;
+    left: -10000px;
+    top: auto;
+    width: 1px;
+    height: 1px;
+    background-color: white;
+    padding: 1rem;
+    z-index: 100;
+    outline: 0;
+    border-radius: .5rem;
+    overflow: visible;
+    pointer-events: none;
+    --shadow-color: 220 3% 15%;
+    --shadow-strength: 1%;
+    box-shadow:  5px 7px 15px grey;
+  }
+  .popover-content:focus {
+    outline: 2px solid var(--highlight-color, #fec02f);
+  }
+  
+  .popover-container {
+    position: relative;
+    width: fit-content;
+  }
+  
+  .popover-content::before {
+    content: '';
+    position: absolute;
+    width: 1rem;
+    height: 1rem;
+    left: 0;
+    top: 50%;
+    background-color: white;
+    transform: translate(-50%, -50%) rotate(45deg);
+  }
+  .popover-revealed {
+    width: max-content;
+    height: max-content;
+    left: var(--x);
+    top: var(--y);
+    transform: translateY(-50%);
+  }
+  @media screen and (max-width: 950px) {
+    .popover-content::before {
+      content: none;
+    }
+    .popover-revealed {
+      left: calc(50% + var(--x-offset-m, 0%));
+      transform: translate(-50%, 0);
+    }
+  }
+  
+  .popover-legend {
+    display: flex;
+    flex-direction: row;
+    gap: .75rem;
+    align-items: flex-start;
+  }
+  
+  .popover-legend svg {
+    height: 1.5em;
+  }
+
+  .popover-revealed p {
+    font-weight: 400;
+    font-size: 1em;
+  }
+  
+  .popover-header {
+    margin: 0;
+  }
+  
+  .popover-stat {
+    margin: 0 0 .5rem 0;
+  }

package/lib/template/assets/js/popover.js

@@ -0,0 +1,30 @@
+jQuery( document ).ready( function ( $ ) { // eslint-disable-line
+	$( document ).on( 'mouseover', '.popover', function ( ele ) {
+		togglePopover( ele.currentTarget.id );
+	} );
+
+	$( document ).on( 'mouseout', '.popover', function ( ele ) {
+		togglePopover( ele.currentTarget.id, false );
+	} );
+
+	function togglePopover( id, popin = true ) {
+		if ( undefined !== id ) {
+			const current = $( '#' + id );
+			const popver = $( '#' + id + '-popover' );
+
+			if ( popin ) {
+				current.addClass( 'highlighted' );
+
+				if ( undefined !== popver ) {
+					$( popver ).addClass( 'popover-revealed' );
+				}
+			} else {
+				current.removeClass( 'highlighted' );
+
+				if ( undefined !== popver ) {
+					$( popver ).removeClass( 'popover-revealed' );
+				}
+			}
+		}
+	}
+} );

package/lib/template/block/edit.js.mustache

@@ -0,0 +1,48 @@
+/**
+ * Retrieves the translation of text.
+ *
+ * @see https://developer.wordpress.org/block-editor/reference-guides/packages/packages-i18n/
+ */
+import { __ } from '@wordpress/i18n';
+
+/**
+ * React hook that is used to mark the block wrapper element.
+ * It provides all the necessary props like the class name.
+ *
+ * @see https://developer.wordpress.org/block-editor/reference-guides/packages/packages-block-editor/
+ * @see https://developer.wordpress.org/block-editor/reference-guides/packages/packages-block-editor/#useblockprops
+ * @see https://developer.wordpress.org/block-editor/reference-guides/packages/packages-block-editor/#richtext
+ * @see https://developer.wordpress.org/block-editor/reference-guides/packages/packages-block-editor/#innerblocks
+ */
+import { useBlockProps, RichText, InnerBlocks } from '@wordpress/block-editor';
+
+/**
+ * Lets webpack process CSS, SASS or SCSS files referenced in JavaScript files.
+ * Those files can contain any CSS code that gets applied to the editor.
+ *
+ * @see https://www.npmjs.com/package/@wordpress/scripts#using-css
+ */
+import './editor.scss';
+
+/**
+ * The edit function describes the structure of your block in the context of the
+ * editor. This represents what the editor will render when the block is used.
+ *
+ * @see https://developer.wordpress.org/block-editor/reference-guides/block-api/block-edit-save/#edit
+ *
+ * @return {WPElement} Element to render.
+ */
+export default function Edit(props) {
+	let { 
+		setAttributes, 
+		attributes: {}
+	} = props;
+
+	const blockProps = useBlockProps();
+
+    return(
+		<div {...blockProps}>
+			<p>Render Block Output</p>
+		</div>
+	);
+}

package/lib/template/block/editor.scss.mustache

@@ -0,0 +1,5 @@
+/**
+ * The following styles get applied inside the editor only.
+ *
+ * Replace them with your own styles or remove the file completely.
+ */