@caweb/cli 1.1.0 → 1.3.0

package/gen/site-generator.js

@@ -0,0 +1,111 @@
+/**
+ * External dependencies
+ */
+import path from 'path';
+import fs from 'fs';
+import HtmlWebpackPlugin from 'html-webpack-plugin';
+import jsdom from 'jsdom';
+import { fileURLToPath } from 'url';
+
+/**
+ * Internal dependencies
+ */
+import {
+  generatePages
+} from './parser.js';
+
+import {
+  projectPath,
+  appPath
+} from '../lib/helpers.js';
+
+const srcPath = path.join( appPath, 'src');
+const dataPath = path.join( srcPath, 'data');
+const assetsPath = path.join( srcPath, 'assets');
+
+// default meta used for site generation when no meta is passed
+const meta = {
+  "Author": "CAWebPublishing",
+  "Description": "State of California",
+  "Keywords": "California,government",
+  "viewport": "width=device-width, initial-scale=1.0, minimum-scale=1.0"
+}
+
+
+/**
+ * Returns an object containing all data from site.json and src/data/examples.json
+ *
+ * @returns {Object}
+ */
+function getSiteData(){
+
+  // grab any sample data if it exists.
+  let sample = fs.existsSync( path.join(dataPath, 'examples.json') ) ? JSON.parse( fs.readFileSync( path.join(dataPath, 'examples.json') ) ) : {};
+  
+  // grab any site data if it exists.
+  let site = fs.existsSync( path.join(appPath, 'site.json') ) ? JSON.parse( fs.readFileSync( path.join(appPath, 'site.json') ) ) : {};
+  
+  // merge datasets together
+  let siteData = {
+    ...sample,
+    ...site
+  };
+  
+  return siteData;
+}
+
+export default (webpackConfig) => {
+  // we only proceed if and index.html exists
+  if( ! fs.existsSync( path.join( srcPath, 'index.html' )) ){
+    return;
+  }
+
+  // we only want to display errors and warnings
+  webpackConfig.stats = 'errors-warnings';
+
+  // get site data
+  let siteData = getSiteData();
+
+  // if favicon doesn't exist use fallback asset.
+  let favicon = fs.existsSync(path.join(assetsPath, 'images', 'favicon.ico')) ?
+    path.join(assetsPath, 'images', 'favicon.ico') :
+    path.join(projectPath, 'assets', 'favicon.ico') ;
+
+  let defaultPage = {
+    minify: false,
+    favicon,
+    meta: siteData.meta || meta,
+  }
+
+  // add html
+  webpackConfig.plugins = [
+    ...webpackConfig.plugins,
+    new HtmlWebpackPlugin({
+      filename: path.join( process.cwd(), 'public', 'index.html'),
+      template: path.join(srcPath, 'index.html'),
+      //templateContent: generatePages(siteData),
+      title: 'Test Site',
+      ...defaultPage
+    })
+  ]
+
+  // add devServer
+  webpackConfig.devServer = {
+    devMiddleware: {
+      writeToDisk: true,
+    },
+    hot: false,
+    allowedHosts: 'auto',
+    host: 'localhost',
+    port: 9000,
+    compress: true,
+    proxy: {
+      '/public': {
+        pathRewrite: {
+          '^/build': '',
+        },
+      },
+    },
+  }  
+
+};

package/lib/admin.js

@@ -0,0 +1,40 @@
+/**
+ * External dependencies
+ */
+import path from 'node:path';
+import fs from 'fs-extra';
+
+import { CAWEB_OPTIONS, DIVI_OPTIONS } from './options.js';
+
+/**
+ * Generates the OVERRIDES.MD
+ * 
+ */
+export default async function generateOverridesMD() {
+
+	let output = [
+		'## [.wp-env.override.json](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#wp-env-override-json)',
+		'Any fields here will take precedence over .wp-env.json.',
+		'## <ins>Special Config Values</ins>',
+	];
+
+	// Generate CAWeb Options overrides.
+	output.push('### <ins>CAWeb Options</ins>');
+	for (const [key, option] of Object.entries(CAWEB_OPTIONS)) {
+		output.push(`\`${key}\` - Updates CAWeb ${option.label}  `);
+	}
+	  
+	// Generate Divi Options overrides.
+	output.push('### <ins>Divi Options</ins>');
+	for (const [group, options] of Object.entries(DIVI_OPTIONS)) {
+		for (const [key, option] of Object.entries(options)) {
+			output.push(`\`${key}\` - Updates CAWeb ${option.label}  `);
+		}
+	}
+
+	fs.writeFileSync(
+		path.join(process.cwd(), 'docs', 'OVERRIDES.MD'),
+		output.join('\n')
+	);
+
+};

package/lib/cli.js

@@ -3,66 +3,54 @@
  */
 //const wpenv_cli = require('@wordpress/env/lib/cli');
 
-import path from 'node:path';
+import path from 'path';
 import chalk from 'chalk';
-import parseXdebugMode from '@wordpress/env/lib/parse-xdebug-mode.js';
-import fs from 'fs-extra';
+import fs from 'fs';
 import terminalLink from  'terminal-link';
-import { Command, Argument, Option } from 'commander';
+import { Command, Argument, Option  } from 'commander';
 
 /**
  * Internal dependencies
  */
-import * as env from './commands/index.js';
+import * as env from '../commands/index.js';
 import {
 	wpPrimary,
 	wpGreen,
 	wpYellow,
 	wpRed,
-	withSpinner
-} from './spinner.js';
+	withSpinner,
+	projectPath,
+} from './index.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) );
 const program = new Command();
 
-export default function cli() {
-	const envArg = new Argument('[environment]', 'Which environment to use.')
-		.choices([
-			'development', 
-			'tests', 
-			'all'
-		])
-		.default('development');
-
-	const containerArg = new Argument('<container>', 'The underlying Docker service to run the command on.')
-		.choices([
-			'mysql',
-			'tests-mysql',
-			'wordpress',
-			'tests-wordpress',
-			'cli',
-			'tests-cli',
-		])
-		.default('development');
+const containerArg = new Argument('<container>', 'The underlying Docker service to run the command on.')
+	.choices([
+		'mysql',
+		'tests-mysql',
+		'wordpress',
+		'tests-wordpress',
+		'cli',
+		'tests-cli',
+	])
+	.default('development');
 
-	program
-		.name(wpPrimary( 'caweb'))
-		.usage( wpYellow( '<command>' ) )
-		.description('Command Line Interface utilized by CAWebPublishing to accomplish several tasks.')
-		.version( pkg.version )
-		.option(
-			'--debug',
-			'Enable debug output.',
-			false
-		)
-		.allowUnknownOption(true)
-		.configureHelp({ 
-			sortSubcommands: true,
-			sortOptions: true,
-			showGlobalOptions: true,
-		})
-		.addHelpCommand(false)
+const envArg = new Argument('[environment]', 'Which environment to use.')
+	.choices([
+		'development', 
+		'tests', 
+		'all'
+	])
+	.default('development');
+
+
+/**
+ * Adds commands for wp-env 
+ */
+function addWPEnvCommands(){
+	
 
 	// Start command.
 	program.command('start')
@@ -90,6 +78,16 @@ export default function cli() {
 			'True if excluding any downloads from CAWeb, use this if you want to use a local version of the CAWeb Theme, Configurations will still be applied.',
 			false
 		)
+		.option(
+			'-p, --plugin',
+			'True if root directory is a plugin.',
+			false
+		)
+		.option(
+			'-t, --theme',
+			'True if root directory is a theme.',
+			false
+		)
 		.option(
 			'-m, --multisite',
 			'True if converting to multisite.',
@@ -118,13 +116,6 @@ export default function cli() {
 		.allowUnknownOption(true)
 		.action( withSpinner(env.destroy) )
 
-	// Shell Command.
-	program.command('shell')
-		.description('Open shell terminal in WordPress environment.')
-		.addArgument(envArg)
-		.allowUnknownOption(true)
-		.action( withSpinner(env.shell) )
-
 	// Stop Command.
 	program.command('stop')
 		.description(
@@ -135,6 +126,12 @@ export default function cli() {
 		.allowUnknownOption(true)
 		.action( withSpinner(env.stop) )
 
+	// Install Path Command.
+	program.command('install-path')
+		.description('Get the path where all of the environment files are stored. This includes the Docker files, WordPress, PHPUnit files, and any sources that were downloaded.')
+		.allowUnknownOption(true)
+		.action( withSpinner(env.installPath) )
+
 	// Clean Command.
 	program.command('clean')
 		.description(
@@ -162,7 +159,7 @@ export default function cli() {
 		)
 		.allowUnknownOption(true)
 		.action( withSpinner(env.logs) )
-	
+
 		
 	// Run Command.
 	program.command('run')
@@ -179,12 +176,60 @@ export default function cli() {
 		.allowUnknownOption(true)
 		.action( withSpinner(env.run) )
 
+
+	// Shell Command.
+	program.command('shell')
+		.description('Open shell terminal in WordPress environment.')
+		.addArgument(envArg)
+		.allowUnknownOption(true)
+		.action( withSpinner(env.shell) )
 		
-	// Install Path Command.
-	program.command('install-path')
-		.description('Get the path where all of the environment files are stored. This includes the Docker files, WordPress, PHPUnit files, and any sources that were downloaded.')
+}
+
+export default function cli() {
+
+
+	program
+		.name(wpPrimary( 'caweb'))
+		.usage( wpYellow( '<command>' ) )
+		.description('Command Line Interface utilized by CAWebPublishing to accomplish several tasks.')
+		.version( pkg.version )
+		.option(
+			'--debug',
+			'Enable debug output.',
+			false
+		)
 		.allowUnknownOption(true)
-		.action( withSpinner(env.installPath) )
+		.configureHelp({ 
+			sortSubcommands: true,
+			sortOptions: true,
+			showGlobalOptions: true,
+		})
+		.helpCommand(false)
+
+		
+	// Build Command.
+	program.command('build')
+		.description('Builds the current project.')
+		.allowUnknownOption(true)
+		.action(withSpinner(env.build))
+			
+		
+	// Serve Command.
+	program.command('serve')
+	.description('Serve the current project')
+		.option(
+			'--no-template',
+			'Disables inclusion of the template page header & footer, starting off with a plain html page.'
+		)
+		.allowUnknownOption(true)
+		.action(withSpinner(env.serve))
+
+	// a11y Command.
+	program.command('a11y')
+		.description('Runs accessibility checks.')
+		.allowUnknownOption(true)
+		.action(withSpinner(env.a11y))
 
 	// Update Plugins Command.
 	program.command('update-plugins')
@@ -194,18 +239,39 @@ export default function cli() {
 		.allowUnknownOption(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)
+		.action( withSpinner(env.createBlock) )
+
+	// 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)
+		.action( withSpinner(env.updateBlock) )
+
+		
+	// Update a Design System Block Command.
+	program.command('sync')
+		.description('Sync changes from one destination to another.')
+		.argument('<from>', 'Target Site URL with current changes.')
+		.argument('<to>', 'Destination Site URL that should be synced.')
+		.allowUnknownOption(true)
+		.action( withSpinner(env.sync) )
+		
 	// Test Command.
 	// Ensure this is commented out.
 	program.command('test')
 		.description('Test commands on a WordPress environment')
-		.addArgument(envArg)
-		.option( 
-			'--scripts', 
-			'Execute any configured lifecycle scripts.',
-			true
-		)
+		//.addArgument(envArg)
 		.allowUnknownOption(true)
 		.action(withSpinner(env.test))
+		
+	
+	addWPEnvCommands();
 
 	return program;
 };

package/lib/env.js

@@ -1,17 +1,9 @@
 /**
  * Internal dependencies
  */
-import start from './start.js';
-import destroy from './destroy.js';
-import test from './test.js';
-import shell from './shell.js';
 
-import updatePlugins from './tasks/update-plugins.js'
+import * as commands from './commands/index.js';
 
-export {
-	start,
-	destroy,
-	test,
-	shell,
-	updatePlugins
+export default {
+	...commands
 }

package/lib/helpers.js

@@ -0,0 +1,109 @@
+/**
+ * External dependencies
+ */
+import path from 'path';
+import spawn from 'cross-spawn';
+import { fileURLToPath } from 'url';
+import { sync as resolveBin } from 'resolve-bin';
+import { v2 as dockerCompose } from 'docker-compose';
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Path Directory Locations
+ * - currentPath - Current Directory
+ * - projectPath - Current Project Path
+ * - appPath - Current Application Path
+ */
+const currentPath = path.dirname(fileURLToPath(import.meta.url));
+const projectPath = path.resolve( currentPath, '..' );
+const appPath = path.resolve( projectPath, '../../../' );
+
+/**
+ * Runs command directly.
+ * 
+ * @param string 		cmd		Command to run.
+ * @param string[] 	args	List of command arguments.
+ * @param string[]  opts   List of spawn options.
+ * 
+ * @returns {Promise}
+ */
+async function runCmd(cmd, args,opts = { stdio: 'inherit' }){
+	// fix various commands.
+	switch (cmd) {
+		case 'npm':
+		case 'npx':
+			/**
+			 * On Windows we run npm.cmd, on Linux we run npm
+			 */
+			cmd += /^win/.test(process.platform) ? '.cmd' : '';
+			break;
+		case 'webpack':
+			cmd = resolveBin(cmd)
+			break
+	}
+
+	return spawn.sync( cmd, args, {...opts, env: process.env});
+
+}
+
+/**
+ * Runs commands on the given WordPress environment.
+ * 
+ * @param {string}		environment	Which environment to run docker command on.
+ * @param {string[]} 	cmds   		Array of commands to run.
+ * @param {WPConfig} 	config      The wp-env config object.
+ * @param {Object}   	spinner A CLI spinner which indicates progress.
+ * 
+ * @returns {Promise}
+ */
+async function runCLICmds(
+	environment,
+	cmds,
+	config,
+	spinner
+) {
+
+	// We return the promise whether there is an output or an error.
+	return await dockerCompose.run(
+		environment === 'development' ? 'cli' : 'tests-cli',
+		[ 'bash', '-c', cmds.join( ' && ' ) ],
+		{
+			cwd: config.workDirectoryPath,
+			env: process.env,
+			commandOptions: [],
+			log: config.debug,
+			callback: (buffer, result) => {
+				if( config.debug ){
+					spinner.text = buffer.toString();
+				}
+			}
+		}
+	).then(
+		(output) => {
+			// Remove the Container information and new lines.
+			output.err = output.err.replace(/\s*Container .*Running\n|\n/g, '')
+			output.out = output.out.replace(/\s*Container .*Running\n|\n/g, '')
+
+			return '' !== output.out ? output.out : output.err;
+		},
+		(error) => {
+			// Remove the Container information and new lines.
+			error.err = error.err.replace(/\s*Container .*Running\n|\n/g, '')
+
+			return error;
+		}
+	);
+}
+
+
+
+export {
+	currentPath,
+	projectPath,
+	appPath,
+	runCLICmds,
+	runCmd
+};

package/lib/index.js

@@ -0,0 +1,28 @@
+import {
+    wpPrimary,
+    wpGreen,
+    wpRed,
+    wpYellow,
+    withSpinner,
+} from './spinner.js';
+
+import {
+	runCmd,
+    runCLICmds,
+	currentPath,
+    projectPath,
+    appPath
+} from './helpers.js';
+
+export {
+    currentPath,
+    projectPath,
+    appPath,
+    wpPrimary,
+    wpGreen,
+    wpRed,
+    wpYellow,
+    withSpinner,
+	runCmd,
+    runCLICmds
+}

package/lib/spinner.js

@@ -18,13 +18,16 @@ const withSpinner =
 		// 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;
-		});
+		if( cmd.registeredArguments ){
+			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] = {

package/lib/{caweb.js → wordpress/caweb.js}

@@ -7,7 +7,7 @@ import retry from '@wordpress/env/lib/retry.js';
  * Internal dependencies
  */
 import { CAWEB_OPTIONS } from'./options.js';
-import { runCLICmds } from'./docker.js';
+import { runCLICmds } from'../helpers.js';
 import { isMultisite } from'./wordpress.js';
 import { configureDivi } from'./divi.js';
 

package/lib/{divi.js → wordpress/divi.js}

@@ -1,7 +1,7 @@
 /**
  * Internal dependencies
  */
-import { runCLICmds } from './docker.js';
+import { runCLICmds } from '../helpers.js';
 import { DIVI_OPTIONS } from './options.js';