@caweb/cli 1.11.0 → 1.11.2

package/commands/webpack/webpack.js

@@ -8,8 +8,6 @@ import fs from 'fs';
  * Internal dependencies
  */
 import { 
-    appPath,
-    projectPath,
     runCmd
 } from '../../lib/index.js';
 
@@ -31,8 +29,8 @@ export default async function webpack({
 } ) {
     const webpackCommand = 'build' === process.argv[2] ? 'build' : 'serve' ;
 
-    // we use our default config from the @caweb/html-webpack-plugin
-    const defaultConfigPath = path.resolve('node_modules', '@caweb', 'html-webpack-plugin', 'webpack.config.js' );
+    // we use our default config from the @caweb/webpack
+    const defaultConfigPath = path.resolve('node_modules', '@caweb', 'webpack', 'webpack.config.js' );
 
     // Since we use @wordpress/scripts webpack config we can leverage
     // the environment variables as well.

package/lib/cli.js

@@ -12,6 +12,7 @@ import { Command, Argument, Option  } from 'commander';
 import * as env from '../commands/index.js';
 
 import {
+	appPath,
 	projectPath,
 	withSpinner
 } from './index.js';
@@ -55,7 +56,7 @@ function addWebpackCmds(){
     
   // Serve Command.
   program.command('serve')
-    .description('Serve the current project')
+    .description('Serves the current project using CAWebPublishing templates.')
     .addOption(new Option('--template <template>', 'Serves the project using templating.').choices(['default', 'blank']).default('default'))
     .addOption(new Option('--scheme <scheme>', 'Serves the project using template colorscheme.').choices([
 		'delta',
@@ -287,6 +288,118 @@ function addWPEnvCommands(){
 		
 }
 
+/**
+ * Adds commands for wp instances
+ */
+function addWPInstanceCommands(){
+	// Update Plugins Command.
+    program.command('update-plugins')
+		.description('Updates all plugins in the WordPress environment.')
+		.argument('[slug]', 'Plugin slug to update.', 'all')
+		.addOption(new Option('--environment <env>', 'Which environment to use.').choices(['development', 'tests']).default('development'))
+		.allowUnknownOption(true)
+		.allowExcessArguments(true)
+		.action( withSpinner(env.updatePlugins) )
+
+	// Sync changes from one WordPress instance to another.
+	program.command('sync')
+		.description('Sync changes from one WordPress instance to another.')
+		.argument('[target]', 'Target Site URL, this is the site containing the latest changes.')
+		.argument('[dest]', 'Destination Site URL, this is the site where the latest changes should go.')
+		.addOption(new Option(
+			'--interactive',
+			'Runs the sync process with prompts'
+		))
+		.addOption(
+			new Option(
+				'-t,--tax <tax...>',
+				'Taxonomy that should be synced. Default is full site sync.'
+			)
+			.choices(['media', 'menus', 'pages', 'posts', 'settings'])
+			.default(['media', 'menus', 'pages', 'posts', 'settings'])
+		)
+		.addOption(new Option(
+		'--media-ids <ids...>',
+		'Sync specific Media IDs.'
+		))
+		.addOption(new Option(
+		'--menu-ids <ids...>',
+		'Sync specific Menu IDs.'
+		))
+		.addOption(new Option(
+		'--page-ids <ids...>',
+		'Sync specific Page IDs.'
+		))
+		.addOption(new Option(
+		'--post-ids <ids...>',
+		'Sync specific Post IDs.'
+		))
+		.option(
+			'--debug',
+			'Enable debug output.',
+			false
+		)
+		.allowUnknownOption(true)
+		.allowExcessArguments(true)
+		.action( withSpinner(env.sync) )
+}
+
+/**
+ * Adds commands for blocks
+ */
+function addBlockCommands(){
+	// Create a Gutenberg Block Command.
+	program.command('create-block')
+		.description('Scaffold for WordPress plugin to register Gutenberg Blocks.')
+		.argument('<slug>', 'Plugin slug to use.')
+		.allowUnknownOption(true)
+		.allowExcessArguments(true)
+		.action( withSpinner(env.createBlock) )
+
+	// Update a Gutenberg Block Command.
+	program.command('update-block')
+		.description('Updates a Gutenberg Block.')
+		.argument('<slug>', 'Plugin slug to update.')
+		.allowUnknownOption(true)
+		.allowExcessArguments(true)
+		.action( withSpinner(env.updateBlock) )
+}
+
+/**
+ * Adds commands for sites
+ */
+function addSiteCommands(){
+	// Create a site command.
+	program.command('create-site')
+		.description('Creates a new CAWebPublishing Site Configuration file.')
+		.allowUnknownOption(true)
+		.allowExcessArguments(true)
+		.addOption(new Option(
+			'--site-title [title]',
+			'Site Title'
+			).default(path.basename( appPath ))
+		)
+		.addOption(new Option(
+			'--silent,-s',
+			'Runs the site creation process without prompts, this is useful for CI/CD pipelines.'
+			).default(false)
+		)
+		.action( withSpinner(env.createSite) )
+	
+
+	// Convert a site command.
+	program.command('convert-site')
+		.description('Attempts to convert a site.')
+		.allowUnknownOption(true)
+		.allowExcessArguments(true)
+		.addOption(new Option(
+			'--builder [builder]',
+			'Editor style to use for the pages.'
+			).choices(['plain', 'divi', 'gutenberg']).default('wp')
+		)
+		.action( withSpinner(env.convertSite) )
+}
+
 export default function cli() {
 
 	program
@@ -309,73 +422,15 @@ export default function cli() {
     // Add wp-env specific commands.
     addWPEnvCommands();
 
-    // Update Plugins Command.
-    program.command('update-plugins')
-    .description('Updates all plugins in the WordPress environment.')
-    .argument('[slug]', 'Plugin slug to update.', 'all')
-    .addOption(new Option('--environment <env>', 'Which environment to use.').choices(['development', 'tests']).default('development'))
-    .allowUnknownOption(true)
-	.allowExcessArguments(true)
-    .action( withSpinner(env.updatePlugins) )
-
-  // Create a Design System Block Command.
-  program.command('create-block')
-    .description('Scaffold for WordPress plugin to register CA.gov Design System Block.')
-    .argument('<slug>', 'Plugin slug to use.')
-    .allowUnknownOption(true)
-	.allowExcessArguments(true)
-    .action( withSpinner(env.createBlock) )
+	// Add wp-env specific commands.
+    addWPInstanceCommands()
 
-  // Update a Design System Block Command.
-  program.command('update-block')
-    .description('Updates a CA.gov Design System Block.')
-    .argument('<slug>', 'Plugin slug to update.')
-    .allowUnknownOption(true)
-	.allowExcessArguments(true)
-    .action( withSpinner(env.updateBlock) )
+	// Add block specific commands.
+  	addBlockCommands()
 
-    
-  // Update a Design System Block Command.
-  program.command('sync')
-    .description('Sync changes from one WordPress instance to another.')
-    .argument('[target]', 'Target Site URL, this is the site containing the latest changes.')
-    .argument('[dest]', 'Destination Site URL, this is the site where the latest changes should go.')
-	.addOption(new Option(
-		'--interactive',
-		'Runs the sync process with prompts'
-	))
-    .addOption(
-		new Option(
-      		'-t,--tax <tax...>',
-      		'Taxonomy that should be synced. Default is full site sync.'
-    	)
-		.choices(['media', 'menus', 'pages', 'posts', 'settings'])
-		.default(['media', 'menus', 'pages', 'posts', 'settings'])
-	)
-    .addOption(new Option(
-      '--media-ids <ids...>',
-      'Sync specific Media IDs.'
-    ))
-    .addOption(new Option(
-      '--menu-ids <ids...>',
-      'Sync specific Menu IDs.'
-    ))
-    .addOption(new Option(
-      '--page-ids <ids...>',
-      'Sync specific Page IDs.'
-    ))
-    .addOption(new Option(
-      '--post-ids <ids...>',
-      'Sync specific Post IDs.'
-    ))
-	.option(
-		'--debug',
-		'Enable debug output.',
-		false
-	)
-    .allowUnknownOption(true)
-	.allowExcessArguments(true)
-    .action( withSpinner(env.sync) )
+	// Add site specific commands.
+    addSiteCommands()
+  
     
   // Test Command.
   // Ensure this is commented out.

package/lib/helpers.js

@@ -2,6 +2,7 @@
  * External dependencies
  */
 import path from 'path';
+import chalk from 'chalk';
 import spawn from 'cross-spawn';
 import { fileURLToPath } from 'url';
 import { sync as resolveBin } from 'resolve-bin';
@@ -12,14 +13,22 @@ import * as dockerCompose from 'docker-compose';
  */
 
 /**
- * Path Directory Locations
- * - currentPath - Current Directory
- * - projectPath - Current Project Path
- * - appPath - Current Application Path
+ * Path Directory Definitions
+ * - currentPath - This files current location in the current project.
  */
 const currentPath = path.dirname(fileURLToPath(import.meta.url));
+
+/**
+ * Path Directory Definitions
+ * - projectPath - The cli project path in the current project.
+ */
 const projectPath = path.resolve( currentPath, '..' );
-const appPath = path.resolve( projectPath, '../../../' );
+
+/**
+ * Path Directory Definitions
+ * - appPath - Current Project Working Directory
+ */
+const appPath = process.cwd();
 
 /**
  * Runs command directly.
@@ -103,10 +112,91 @@ async function runCLICmds(
 	);
 }
 
+
+/**
+ * Write a line to the console.
+ *
+ * @param {string} text Text to write.
+ * @param {string} opts.color Color of the text.
+ * @param {string} opts.prefix Prefix of the text.
+ * @param {string} opts.bold Bold text.
+ * @param {string} opts.char Character to use for the border.
+ * @param {string} opts.borderColor Character border color.
+ */
+function writeLine(text, options = {}) {
+	let defaults = {
+		color: 'white', 
+		prefix: '', 
+		bold: false,
+		char: '', 
+		borderColor: 'white'
+	}
+
+	// combine the defaults with the opts
+	let opts = {
+		...defaults,
+		...options
+	}
+
+	let {
+		color, prefix, bold,char, borderColor
+	} = opts;
+
+	// set border options first
+	if( char ) {
+		// set border color
+		char = chalk[borderColor]( char );
+
+		// set bold
+		char = bold ? chalk.bold(char) : char;
+
+		// border repetition
+		char = char.repeat(text.length) + '\n';
+	}
+
+	// Add a prefix to the text if it is not empty.
+	text = prefix ? prefix + ' ' + text : text;
+
+	// Add a bold to the text if it is not empty.
+	text = bold ? chalk.bold(text) : text;
+
+	// Add a color to the text if it is not empty.
+	text = chalk[color](text);
+
+	// add a border to the top of the text if it is not empty.
+	// add a border to the bottom of the text if it is not empty.
+	
+	process.stdout.write(char + text + '\n' + char);
+}
+
+/**
+ * Write an error to the console.
+ *
+ * @param {string} text 
+ */
+function writeError(text) {
+	process.stderr.write(text + '\n');
+}
+
+/**
+ * Clear lines from the console
+ * @param {int} count Number of lines to clear.
+ */
+function clearLine(count = 1) {
+	do {
+		// process.stdout.write("\r\x1b[K");
+		process.stdout.moveCursor(0, -1) // up one line
+  		process.stdout.clearLine(1) // from cursor to end
+	} while (--count);
+}
+
 export {
 	currentPath,
 	projectPath,
 	appPath,
 	runCmd,
-	runCLICmds
+	runCLICmds,
+	writeLine,
+	writeError,
+	clearLine,
 };

package/lib/index.js

@@ -3,7 +3,10 @@ import {
     currentPath,
     projectPath,
     runCmd,
-    runCLICmds
+    runCLICmds,
+    writeLine,
+    writeError,
+    clearLine,
 } from './helpers.js';
 
 // Spinner
@@ -32,6 +35,9 @@ export {
     appPath,
     currentPath,
     projectPath,
+    writeLine,
+    writeError,
+    clearLine,
     runCmd,
     withSpinner,
     runCLICmds,

package/lib/wordpress/api.js

@@ -60,6 +60,8 @@ function processUrlParam( param ){
  * @returns {unknown}
  */
 async function getTaxonomies( request, tax = 'pages', debug = false ){
+    let collection = [];
+  
     const fields = request.fields ? request.fields : [
         'id',
         'type',
@@ -132,9 +134,8 @@ async function getTaxonomies( request, tax = 'pages', debug = false ){
     request.per_page = request.per_page && request.per_page <= 100 ? request.per_page : 100;
     urlParams.push( 'per_page=' + request.per_page  );
 
-    let collection = [];
     let results = false;
-    
+
     /**
      * Results are capped to 100 max per page
      * in order to return all results, we make the same requests and pass the page parameter.
@@ -177,7 +178,6 @@ async function getTaxonomies( request, tax = 'pages', debug = false ){
 
         page++;
     }while( results )
-   
     
     return collection;
 }
@@ -354,6 +354,7 @@ async function createTaxonomies( taxData, request, tax = 'pages', spinner ){
         
     }
 
+    return collection;
 
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.11.0",
+  "version": "1.11.2",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -19,7 +19,9 @@
     "template"
   ],
   "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,6 +42,7 @@
   "config": {
     "WP_VER": "6.8.1",
     "PHP_VER": "8.2",
+    "DIVI_VER": "4.27.4",
     "DEFAULTS": {
       "FS_METHOD": "direct",
       "WP_DEBUG": true,
@@ -48,6 +51,7 @@
       "WP_MEMORY_LIMIT": "256M",
       "WP_MAX_MEMORY_LIMIT": "512M",
       "WP_PERMALINK": "/%year%/%monthnum%/%postname%/",
+      "WP_POST_REVISIONS": true,
       "ADMIN_COOKIE_PATH": "/",
       "COOKIE_DOMAIN": "",
       "COOKIEPATH": "",
@@ -56,18 +60,24 @@
     }
   },
   "dependencies": {
-    "@caweb/webpack": "^1.3.44",
-    "@inquirer/prompts": "^7.5.0",
-    "@wordpress/create-block": "^4.66.0",
-    "@wordpress/env": "^10.23.0",
+    "@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",
+    "@inquirer/prompts": "^7.5.3",
+    "@wordpress/create-block": "^4.67.0",
+    "@wordpress/env": "^10.24.0",
     "axios": "^1.9.0",
     "axios-retry": "^4.5.0",
     "chalk": "^5.4.1",
-    "commander": "^13.1.0",
+    "commander": "^14.0.0",
     "cross-spawn": "^7.0.6",
     "docker-compose": "^1.2.0",
     "fs-extra": "^11.3.0",
+    "html-to-json-parser": "^2.0.1",
     "inquirer-select-pro": "^1.0.0-alpha.9",
+    "jsdom": "^26.1.0",
+    "node-html-parser": "^7.0.1",
     "ora": "^8.2.0",
     "resolve-bin": "^1.0.1",
     "rimraf": "^6.0.1",