@caweb/cli 1.0.5 → 1.2.0

package/lib/commands/blocks/create-block.js

@@ -0,0 +1,110 @@
+/**
+ * External dependencies
+ */
+import path from 'node:path';
+import fs from 'fs-extra';
+import { spawn } from 'node:child_process';
+import inquirer from 'inquirer';
+
+/**
+ * Internal dependencies
+ */
+import {runCmd} from '../../utils.js';
+import updateBlock from './update-block.js';
+
+const localPath = path.resolve( path.join(process.cwd(), 'node_modules/@caweb/cli/package.json') )
+const pkg = JSON.parse( await fs.readFile(localPath) );
+
+/**
+ * Get NPM Package Latest Version
+ * @param {string}  options.slug   Block slug.
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ */
+async function getNPMPackageVersion(pkg, spinner){
+	return await runCmd(
+		'npm',
+		[
+			'view',
+			`${pkg}`,
+			'version'
+		],
+		spinner
+	)
+	
+}
+
+/**
+ * Create Block
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.debug   True if debug mode is enabled.
+ * @param {string} options.slug   Block slug.
+ */
+export default async function createBlock({
+	spinner,
+	debug,
+	slug
+} ) {
+		// if block directory already exists.	
+		if( fs.existsSync(path.resolve(process.cwd(), slug)) ){
+			spinner.info(`${slug} already exists.`)
+
+			const { yesUpdate } = await inquirer.prompt( [
+				{
+					type: 'confirm',
+					name: 'yesUpdate',
+					message: 'Would you like to update it?',
+					default: false,
+				},
+			] );
+
+			if( yesUpdate ){
+				spinner.text = `Updating ${slug}...`;
+				await updateBlock({spinner, debug, slug});
+			}
+		// create a new block
+		}else{
+			// Get cagov component version if it exists.
+			let version = await getNPMPackageVersion(`@cagov/${slug}`, spinner);
+
+			// call the wordpress create-block command using our template.
+			await runCmd(
+				'npx',
+				[
+					`@wordpress/create-block`,
+					slug,
+					'--template=' + path.resolve( path.join(process.cwd(), 'node_modules/@caweb/cli/lib/template/index.cjs') )
+				],
+				spinner,
+				{
+					stdio: 'inherit'
+				}
+			)
+
+			// install cagov npm package if it exists.
+			if( version ){
+				// capture spinner.text result
+				let spinnerText = spinner.text;
+				spinner.text = '';
+
+				await runCmd(
+					'npm',
+					[
+						'install',
+						`@cagov/${slug}@${version}`,
+					],
+					spinner,
+					{
+						cwd: path.resolve( path.join(process.cwd(), slug ) ),
+						stdio: 'inherit'
+					}
+				)
+				
+				spinner.text = spinnerText;
+
+			}
+		}
+		
+		
+};

package/lib/commands/blocks/update-block.js

@@ -0,0 +1,66 @@
+/**
+ * External dependencies
+ */
+import path from 'node:path';
+import fs from 'fs-extra';
+import { spawn } from 'node:child_process';
+
+/**
+ * Internal dependencies
+ */
+import {runCmd} from '../../utils.js';
+import createBlock from './create-block.js';
+
+const localPath = path.resolve( path.join(process.cwd(), 'node_modules/@caweb/cli/package.json') )
+const pkg = JSON.parse( await fs.readFile(localPath) );
+
+
+/**
+ * Create Block
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.debug   True if debug mode is enabled.
+ * @param {string} options.slug   Block slug.
+ */
+export default async function updateBlock({
+	spinner,
+	debug,
+	slug
+} ) {
+	
+		// if block directory exists.	
+		if( fs.existsSync(path.resolve(process.cwd(), slug)) ){
+			spinner.text = `Updating ${slug} block plugin.`;
+
+			// make tmp directory
+			fs.ensureDir( `${slug}.tmp`);
+
+			// move inc directory to tmp directory
+			fs.copySync(`${slug}/inc/`, `${slug}.tmp/inc/`);
+			
+			// move src directory to tmp directory
+			fs.copySync(`${slug}/src/`, `${slug}.tmp/src/`);
+
+			// delete old block.
+			fs.removeSync( `${slug}` );
+
+			// Recreate the block.
+			await createBlock({spinner, debug, slug});
+
+			// move inc directory back to block directory
+			fs.copySync(`${slug}.tmp/inc/`, `${slug}/inc/` );
+			
+			// move src directory back to block directory
+			fs.copySync(`${slug}.tmp/src/`, `${slug}/src/`);
+
+			// delete tmp directory.
+			fs.removeSync( `${slug}.tmp` );
+
+			spinner.succeed(`${slug} has been updated!`); 
+
+		}else{
+			spinner.fail(`${slug} plugin directory not found.`)
+		}			
+		
+};

package/lib/commands/destroy.js

@@ -0,0 +1,56 @@
+
+/**
+ * External dependencies
+ */
+import { spawn } from 'node:child_process';
+import { default as wpEnvDestroy } from '@wordpress/env/lib/commands/destroy.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 new Promise( (resolve, reject) => {
+			const childProc = spawn(
+				'docker',
+				[
+					'image',
+					'rm',
+					'phpmyadmin'
+				],
+				{ stdio: 'ignore' },
+				spinner
+			);
+
+			childProc.on( 'error', reject );
+			childProc.on( 'exit', ( code ) => {
+				if ( code === 0 ) {
+					resolve();
+				} else {
+					reject( `Command failed with exit code ${ code }` );
+				}
+			} );
+		});
+		spinner.text = "Removed WordPress environment.'";
+
+	}
+
+}

package/lib/commands/index.js

@@ -1,20 +1,44 @@
-'use strict';
 /**
  * External dependencies
  */
 
+/**
+ * These are default wp-env commands. No need to overwrite these commands
+ */
+import clean from '@wordpress/env/lib/commands/clean.js';
+import logs from '@wordpress/env/lib/commands/logs.js';
+import run from '@wordpress/env/lib/commands/run.js';
+import installPath from '@wordpress/env/lib/commands/install-path.js';
+
 /**
  * Internal dependencies
  */
-const shell = require('./shell')
-const start = require('./start')
-const test = require( './test' );
+import shell from './shell.js';
+import updatePlugins from './tasks/update-plugins.js'
+import createBlock from './blocks/create-block.js'
+import updateBlock from './blocks/update-block.js'
 
-const tasks = require('./tasks');
+import test from './test.js';
 
-module.exports = {
-	shell,
+/**
+ * These are default wp-env commands, we overwrite these commands so we can run additional steps.
+ */
+import start from './start.js';
+import destroy from './destroy.js';
+import stop from './stop.js';
+
+
+export {
+	clean,
+	logs,
+	run,
+	installPath,
 	start,
+	stop,
+	destroy,
 	test,
-	...tasks
-};
+	shell,
+	updatePlugins,
+	createBlock,
+	updateBlock
+}

package/lib/commands/shell.js

@@ -1,8 +1,7 @@
-'use strict';
 /**
  * External dependencies
  */
-const run = require( '@wordpress/env/lib/commands/run' );
+import run from '@wordpress/env/lib/commands/run.js';
 
 /**
  * Internal dependencies
@@ -16,7 +15,7 @@ const run = require( '@wordpress/env/lib/commands/run' );
  * @param {boolean} options.environment   Which environment to open terminal in.
  * @param {boolean} options.debug   True if debug mode is enabled.
  */
-module.exports = async function shell({
+export default async function shell({
 	spinner,
 	environment,
 	debug

package/lib/commands/start.js

@@ -1,40 +1,36 @@
-/**
- * Modified from wp-env 8.11.0
- * @see @wordpress/env/lib/commands/start
- */
-'use strict';
-/**
- * External dependencies
- */
-const path = require( 'path' );
-const fs = require( 'fs-extra' );
-const wpEnvStart = require('@wordpress/env/lib/commands/start');
-const util = require( 'util' );
-const { didCacheChange, getCache } = require( '@wordpress/env/lib/cache' );
-const {	
+import path from 'node:path';
+import util from 'node:util';
+import fs from 'fs-extra';
+import yaml from 'js-yaml';
+import dockerCompose from 'docker-compose';
+
+import { default as wpEnvStart} from '@wordpress/env/lib/commands/start.js';
+import {	
 	checkDatabaseConnection, 
 	canAccessWPORG 
-} = require( '@wordpress/env/lib/wordpress' );
-const loadConfig = require( '@wordpress/env/lib/config/load-config' );
-const retry = require( '@wordpress/env/lib/retry' );
-const yaml = require( 'js-yaml' );
-const dockerCompose = require( 'docker-compose' );
+} from '@wordpress/env/lib/wordpress.js';
+
+import retry from '@wordpress/env/lib/retry.js';
 
 const CONFIG_CACHE_KEY = 'config_checksum';
 
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
+import { didCacheChange, getCache } from '@wordpress/env/lib/cache.js';
+
 /**
  * Internal dependencies
  */
-const { configureCAWeb } = require('../caweb');
-const { buildWPEnvConfig, buildDockerComposeConfig } = require('../configs');
-const {downloadSources } = require('../download-sources');
-const { configureWordPress } = require('../wordpress');
+
+import { configureCAWeb } from '../caweb.js';
+import {downloadSources } from '../download-sources.js';
+import { configureWordPress } from '../wordpress.js';
+import { buildWPEnvConfig, buildDockerComposeConfig } from '../configs.js';
 
 /**
  * Promisified dependencies
  */
-const { writeFile } = fs.promises;
 const sleep = util.promisify( setTimeout );
+const { writeFile } = fs.promises;
 
 /**
  * Starts the development server.
@@ -46,26 +42,31 @@ const sleep = util.promisify( setTimeout );
  * @param {boolean} options.scripts Indicates whether or not lifecycle scripts should be executed.
  * @param {boolean} options.debug   True if debug mode is enabled.
  * @param {boolean} options.bare   True if excluding any CAWeb Configurations.
+ * @param {boolean} options.plugin   True if root directory is a plugin.
+ * @param {boolean} options.theme   True if root directory is a theme.
  * @param {boolean} options.multisite   True if converting to multisite.
  * @param {boolean} options.subdomain   True if converting to multisite subdomain.
  * 
  */
-module.exports = async function start({
+export default async function start({
 	spinner,
 	update,
 	xdebug,
 	scripts,
 	debug,
 	bare,
+	plugin,
+	theme,
 	multisite,
 	subdomain
 }) {
+
 	spinner.text = 'Writing configuration file...';
 	
 	// Write CAWeb .wp-env.json file.
 	await writeFile(
 		path.join(process.cwd(), '.wp-env.json'),
-		JSON.stringify( buildWPEnvConfig(bare, multisite), null, 4 )
+		JSON.stringify( buildWPEnvConfig(bare, multisite, plugin, theme), null, 4 )
 	);
 
 	// Get current wp-env cache key
@@ -93,38 +94,26 @@ module.exports = async function start({
 		( await canAccessWPORG() );
 		
 		
-	// Only run configurations when config has changed.
-	if( shouldConfigureWp ){
-		// Save pretext from wp-env if it exists for later.
-		let preText = undefined !== spinner.prefixText ? spinner.prefixText.slice(0, -1) : '';
-
-		try {
-			// We aren't done lets clear the default WordPress text.			
-			spinner.prefixText = '';
-			spinner.text = '';
-
-			await checkDatabaseConnection( config );
-		} catch ( error ) {
-			// Wait 30 seconds for MySQL to accept connections.
-			await retry( () => checkDatabaseConnection( config ), {
-				times: 30,
-				delay: 1000,
-			} );
-
-			// It takes 3-4 seconds for MySQL to be ready after it starts accepting connections.
-			await sleep( 4000 );
-		}
+	// Save pretext from wp-env if it exists for later.
+	let preText = undefined !== spinner.prefixText ? spinner.prefixText.slice(0, -1) : '';
 
-		// Download any resources required for CAWeb.
-		if( ! bare ){
-			await downloadSources({spinner, config});
-		}
+	// We aren't done lets clear the default WordPress text.			
+	spinner.prefixText = '';
+	spinner.text = '';
+
+	// Download any resources required for CAWeb.
+	if( shouldConfigureWp && ! bare ){
+		await downloadSources({spinner, config});
+	}
+		
+	// Write docker-compose.override.yml file to workDirectoryPath.
+	await writeFile(
+		path.join(workDirectoryPath, 'docker-compose.override.yml'),
+		yaml.dump( buildDockerComposeConfig(workDirectoryPath) )
+	);
 
-		// Write docker-compose.override.yml file to workDirectoryPath.
-		await writeFile(
-			path.join(workDirectoryPath, 'docker-compose.override.yml'),
-			yaml.dump( buildDockerComposeConfig(workDirectoryPath) )
-		);
+	// Only run configurations when config has changed.
+	if( shouldConfigureWp ){
 
 		// We need to bring the WordPress and CLI instances up again so they pick up
 		// any config changes that may have been added to the docker-compose.override.yml.
@@ -158,24 +147,23 @@ module.exports = async function start({
 			} ),
 		] );
 
-		// Start phpMyAdmin Service.
-		spinner.text = 'Starting phpMyAdmin Service';
+	}
 
-		await dockerCompose.upMany(
-			[
-				'phpmyadmin','tests-phpmyadmin',
-			], {
+	// Start phpMyAdmin Service.
+	spinner.text = 'Starting phpMyAdmin Service';
+
+	await dockerCompose.upOne(
+		'phpmyadmin', 
+		{
 			cwd: workDirectoryPath,
 			commandOptions: ['--build', '--force-recreate'],
 			log: debug
-		})
-
-		spinner.prefixText = preText + 
-			`phpMyAdmin development site started at http://localhost:8080\n` +
-			`phpMyAdmin test site started at http://localhost:9090\n\n`;
+		}
+	)
 
-		spinner.text = 'Done!';
+	spinner.prefixText = preText + 
+		`phpMyAdmin site started at http://localhost:8080\n\n`;
 
-	}
+	spinner.text = 'Done!';
 
 };

package/lib/commands/stop.js

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

package/lib/commands/tasks/update-plugins.js

@@ -1,15 +1,13 @@
-'use strict';
 /**
  * External dependencies
  */
-const run = require('@wordpress/env/lib/commands/run');
+import path from 'node:path';
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
 
 /**
  * Internal dependencies
  */
-const { runDockerCmds } = require('../../docker');
-const path = require( 'path' );
-const loadConfig = require( '@wordpress/env/lib/config/load-config' );
+import {runCLICmds} from '../../utils.js';
 
 /**
  * Promisified dependencies
@@ -22,15 +20,24 @@ const loadConfig = require( '@wordpress/env/lib/config/load-config' );
  * @param {Object}  options.spinner A CLI spinner which indicates progress.
  * @param {string} options.environment   Which environment to updated.
  */
-module.exports = async function updatePlugins({
+export default async function updatePlugins({
 	spinner,
-	environment
+	environment,
+	slug
 }) {
 
 	spinner.text = "Updating plugins...";
 	const config = await loadConfig(path.resolve('.'));
 
-	await runDockerCmds( environment, ['wp plugin update --all'], config );
+	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!'