@caweb/cli 1.2.0 → 1.3.1

package/README.md

@@ -7,10 +7,11 @@ The following WordPress packages are used:
 [create-block](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/)
 
 ## Prerequisites
-- Latest version of [Docker Desktop](https://www.docker.com/products/docker-desktop), which includes [Compose v2}(https://docs.docker.com/compose/migrate/), is installed.
+- Latest version of [Docker Desktop](https://www.docker.com/products/docker-desktop), which includes [Compose v2](https://docs.docker.com/compose/migrate/), is installed.
   - <strong>For Debian-Based Linux distributions:</strong> <code>docker-compose</code> may need to be installed with: <code>sudo apt-get install docker-compose</code>.
   - <strong>For Windows users:</strong> [WSL should be set to version 2 for Windows Docker Desktop compatibility](https://docs.docker.com/desktop/windows/wsl/).
 - git is installed.
+- php is installed.
 
 ## Additional Features
 - Downloads and configures the [CAWeb Theme](https://github.com/CAWebPublishing/CAWeb)
@@ -20,13 +21,17 @@ The following WordPress packages are used:
   - phpMyAdmin development site starts at http://localhost:8080  
   - phpMyAdmin test site started at http://localhost:9090
 - Uses CAWebPublishing [External Project Template Configuration](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/packages-create-block-external-template/) when creating Gutenberg Blocks, see configurations [here](https://github.com/CAWebPublishing/cli/lib/template)
-- Adds config.yml to both cli containers 
+- Allows for syncing of WordPress instance via Rest API and CLI, requires ssh. 
+- Adds config.yml to both cli containers, alias are added for each ssh connection.  
+<b>Example config.yml file</b>
 <pre>
-path: /var/www/html
-apache_modules:
-  - mod_rewrite
+    path: /var/www/html
+    apache_modules:
+      - mod_rewrite
+    @staging:
+        ssh: wpcli@staging.wp-cli.org
 </pre>
-.
+
 
 ## Command Reference
 ### `caweb start`  

package/bin/caweb

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import cli from '../lib/cli.js';
 

package/commands/a11y.js

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+
+/**
+ * External dependencies
+ */
+import path from 'path';
+import fs from 'fs';
+import resolveBin from 'resolve-bin';
+
+/**
+ * Internal dependencies
+ */
+// Our default A11y Checker Configuration 
+import defaultConfig from '../configs/aceconfig.js';
+
+import { 
+    runCmd, 
+} from '../lib/index.js';
+
+
+
+/**
+ * Run accessibility checks
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.debug   True if debug mode is enabled.
+ */
+export default async function a11y({
+	spinner,
+	debug, 
+} ) {
+
+    // Spinner not needed at the moment
+	spinner.stop()
+    const {
+        ruleArchive,
+        policies,
+        failLevels,
+        reportLevels,
+        outputFolder,
+        outputFormat,
+        outputFilenameTimestamp
+    } = defaultConfig;
+
+    
+    // pass any arguments from the cli
+    // overwriting our default config flags.
+    // users can overwrite any values by creating a .achecker.yml or aceconfig.js.
+    let acheckerArgs = [
+        '--ruleArchive',
+        ruleArchive,
+        '--policies',
+        Array.isArray(policies) ? policies.join(',') : policies,
+        '--failLevels',
+        Array.isArray(failLevels) ? failLevels.join(',') : failLevels,
+        '--reportLevels',
+        Array.isArray(reportLevels) ? reportLevels.join(',') : reportLevels,
+        '--outputFolder',
+        outputFolder,
+        '--outputFormat',
+        outputFormat,
+        '---outputFilenameTimestamp',
+        outputFilenameTimestamp,
+        process.argv.pop()
+    ];
+
+    // run webpack with our arguments.
+    await runCmd(
+		'achecker', 
+		acheckerArgs, 
+	)
+
+};

package/{lib/commands → commands}/blocks/create-block.js

@@ -1,19 +1,18 @@
 /**
  * External dependencies
  */
-import path from 'node:path';
-import fs from 'fs-extra';
-import { spawn } from 'node:child_process';
+import path from 'path';
+import fs from 'fs';
 import inquirer from 'inquirer';
 
 /**
  * Internal dependencies
  */
-import {runCmd} from '../../utils.js';
+import {runCmd, projectPath} from '../../lib/index.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) );
+const localFile = path.join(projectPath, 'package.json');
+const pkg = JSON.parse( fs.readFileSync(localFile) );
 
 /**
  * Get NPM Package Latest Version
@@ -74,7 +73,7 @@ export default async function createBlock({
 				[
 					`@wordpress/create-block`,
 					slug,
-					'--template=' + path.resolve( path.join(process.cwd(), 'node_modules/@caweb/cli/lib/template/index.cjs') )
+					'--template=' + path.join(projectPath, 'template', 'index.cjs')
 				],
 				spinner,
 				{
@@ -96,7 +95,7 @@ export default async function createBlock({
 					],
 					spinner,
 					{
-						cwd: path.resolve( path.join(process.cwd(), slug ) ),
+						cwd: path.join(process.cwd(), slug ),
 						stdio: 'inherit'
 					}
 				)

package/{lib/commands → commands}/blocks/update-block.js

@@ -1,22 +1,16 @@
 /**
  * External dependencies
  */
-import path from 'node:path';
-import fs from 'fs-extra';
-import { spawn } from 'node:child_process';
+import path from 'path';
+import fs from 'fs';
 
 /**
  * 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
+ * Update Block
  * 
  * @param {Object}  options
  * @param {Object}  options.spinner A CLI spinner which indicates progress.

package/commands/build.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+
+/**
+ * External dependencies
+ */
+import path from 'path';
+import fs from 'fs';
+
+/**
+ * Internal dependencies
+ */
+import { 
+    runCmd, 
+    projectPath,
+    appPath
+} from '../lib/index.js';
+
+
+/**
+ * Build the current project
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.debug   True if debug mode is enabled.
+ */
+export default async function build({
+	spinner,
+	debug, 
+} ) {
+
+    // Spinner not needed at the moment
+	spinner.stop()
+
+    // Since we use @wordpress/scripts webpack config we can leverage
+    // the environment variables as well.
+    process.env.WP_COPY_PHP_FILES_TO_DIST  = true;
+
+    // Our default Webpack Configuration 
+    const defaultConfig = path.join( projectPath, 'configs', 'webpack.config.js' );
+
+    // pass any arguments from the cli
+    // add our default config as an extension.
+    // users can overwrite any values by creating a webconfig of their own.
+    let webPackArgs = [
+        '--mode=none',
+        '--progress',
+        '--config',
+        defaultConfig
+    ];
+
+    // CommonJS
+    if( fs.existsSync( path.join(appPath, 'webpack.config.cjs' ))){
+        webPackArgs.push(
+            '--config',
+            path.join(appPath, 'webpack.config.cjs' ),
+            '--merge'
+        )
+    // ESM
+    }else if( fs.existsSync(path.join(appPath, 'webpack.config.js' )) ){
+        webPackArgs.push(
+            '--config',
+            path.join(appPath, 'webpack.config.js' ),
+            '--merge'
+        )
+    }
+
+    // run webpack with our arguments.
+    await runCmd(
+		'webpack', 
+		webPackArgs, 
+	)
+
+};

package/{lib/commands → commands/env}/destroy.js

@@ -2,9 +2,13 @@
 /**
  * External dependencies
  */
-import { spawn } from 'node:child_process';
 import { default as wpEnvDestroy } from '@wordpress/env/lib/commands/destroy.js';
 
+/**
+ * Internal dependencies
+ */
+import { runCmd } from '../../lib/index.js';
+
 /**
  * Destroys the development server.
  * 
@@ -28,27 +32,16 @@ export default async function destroy({
 		
 		// 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 }` );
-				}
-			} );
-		});
+		await runCmd(
+			'docker',
+			[
+				'image',
+				'rm',
+				'phpmyadmin'
+			],
+			{ stdio: 'ignore' }
+		)
+		
 		spinner.text = "Removed WordPress environment.'";
 
 	}

package/{lib/commands → commands/env}/start.js

@@ -1,36 +1,36 @@
-import path from 'node:path';
-import util from 'node:util';
-import fs from 'fs-extra';
+/**
+ * External dependencies
+ */
+import path from 'path';
+import fs from 'fs';
+import { v2 as dockerCompose } from 'docker-compose';
 import yaml from 'js-yaml';
-import dockerCompose from 'docker-compose';
 
+/**
+ * WordPress dependencies
+ */
 import { default as wpEnvStart} from '@wordpress/env/lib/commands/start.js';
-import {	
-	checkDatabaseConnection, 
-	canAccessWPORG 
-} from '@wordpress/env/lib/wordpress.js';
-
+import loadConfig from '@wordpress/env/lib/config/load-config.js';
 import retry from '@wordpress/env/lib/retry.js';
+import { didCacheChange, getCache } from '@wordpress/env/lib/cache.js';
+import { canAccessWPORG } from '@wordpress/env/lib/wordpress.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
  */
+import { 
+	appPath,
+	projectPath,
+	configureCAWeb,
+	downloadSources,
+	configureWordPress,
+	runCmd
+} from '../../lib/index.js';
+import wpEnvConfig from '../../configs/wp-env.js';
+import dockerConfig from '../../configs/docker-compose.js';
 
-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 sleep = util.promisify( setTimeout );
-const { writeFile } = fs.promises;
 
 /**
  * Starts the development server.
@@ -64,9 +64,9 @@ export default async function start({
 	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, plugin, theme), null, 4 )
+	fs.writeFileSync(
+		path.join(appPath, '.wp-env.json'),
+		JSON.stringify( wpEnvConfig(bare, multisite, plugin, theme), null, 4 )
 	);
 
 	// Get current wp-env cache key
@@ -107,9 +107,9 @@ export default async function start({
 	}
 		
 	// Write docker-compose.override.yml file to workDirectoryPath.
-	await writeFile(
+	fs.writeFileSync(
 		path.join(workDirectoryPath, 'docker-compose.override.yml'),
-		yaml.dump( buildDockerComposeConfig(workDirectoryPath) )
+		yaml.dump( dockerConfig(workDirectoryPath) )
 	);
 
 	// Only run configurations when config has changed.
@@ -147,6 +147,19 @@ export default async function start({
 			} ),
 		] );
 
+		// Create an Application Password for the user.
+		/*
+		const devAppPwd = await runCmd(
+				'php',
+					[
+						path.join(projectPath, 'bin', 'wp-cli.phar'),
+						`--ssh=docker:${path.basename(workDirectoryPath)}-cli-1`,
+						`user application-password create 1 caweb`,
+						'--porcelain'
+					]
+				);
+		*/
+		
 	}
 
 	// Start phpMyAdmin Service.
@@ -164,6 +177,7 @@ export default async function start({
 	spinner.prefixText = preText + 
 		`phpMyAdmin site started at http://localhost:8080\n\n`;
 
+
 	spinner.text = 'Done!';
 
 };

package/{lib/commands → commands/env}/stop.js

@@ -1,18 +1,12 @@
-import path from 'node:path';
-import { spawn } from 'node:child_process';
+/**
+ * External dependencies
+ */
+import path from 'path';
 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.
  * 

package/{lib/commands → commands}/index.js

@@ -1,44 +1,52 @@
-/**
- * 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
- */
-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'
-
-import test from './test.js';
-
-/**
- * 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,
-	shell,
-	updatePlugins,
-	createBlock,
-	updateBlock
+/**
+ * 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
+ */
+import build from './build.js';
+import serve from './serve.js';
+import a11y from './a11y.js';
+import shell from './tasks/shell.js';
+
+import sync from './sync.js';
+
+import updatePlugins from './tasks/update-plugins.js'
+import createBlock from './blocks/create-block.js'
+import updateBlock from './blocks/update-block.js'
+
+import test from './test.js';
+
+/**
+ * These are default wp-env commands, we overwrite these commands so we can run additional steps.
+ */
+import start from './env/start.js';
+import destroy from './env/destroy.js';
+import stop from './env/stop.js';
+
+export {
+    clean,
+	logs,
+	run,
+	installPath,
+    start,
+	stop,
+    destroy,
+    build,
+    serve,
+    a11y,
+    sync,
+    updatePlugins,
+    shell,
+    createBlock,
+    updateBlock,
+    test
 }

package/commands/serve.js

@@ -0,0 +1,78 @@
+#!/usr/bin/env node
+
+/**
+ * External dependencies
+ */
+import path from 'path';
+import fs from 'fs';
+
+/**
+ * Internal dependencies
+ */
+import { 
+    projectPath,
+    appPath,
+    runCmd
+ } from '../lib/index.js';
+
+/**
+ * Serves the current project
+ * 
+ * @param {Object}  options
+ * @param {Object}  options.spinner A CLI spinner which indicates progress.
+ * @param {boolean} options.debug   True if debug mode is enabled.
+ * @param {boolean} options.template   Disables inclusion of the template page header & footer, starting off with a plain html page.
+ */
+export default async function serve({
+	spinner,
+	debug,
+	template,
+} ) {
+    spinner.stop();
+    
+    // Since we use @wordpress/scripts webpack config we can leverage
+    // the environment variables as well.
+    process.env.WP_COPY_PHP_FILES_TO_DIST  = true;
+
+
+    // This lets the parser know to include the template 
+    // Otherwise we load a blank html page
+    process.env.CDT_TEMPLATE = template;
+    
+
+   // Our default Webpack Configuration 
+   const defaultConfig = path.join( projectPath, 'configs', 'webpack.config.js' );
+
+   let webPackArgs = [
+      'serve',
+      '--open',
+      '--mode=development',
+      '--config',
+      defaultConfig
+    ];
+
+   // merge user configurations
+   // CommonJS
+   if( fs.existsSync(path.join( appPath, 'webpack.config.cjs' ))){
+       webPackArgs.push(
+           '--config',
+           path.join( appPath, 'webpack.config.cjs' ),
+           '--merge'
+       )
+   // ESM
+   }else if( fs.existsSync(path.join( appPath, 'webpack.config.js' )) ){
+       webPackArgs.push(
+           '--config',
+           path.join( appPath, 'webpack.config.js' ),
+           '--merge'
+       )
+   }
+
+    // run webpack with our configuration.
+    await runCmd(
+		  'webpack', 
+      webPackArgs
+    )
+    
+
+};