@caweb/cli 1.11.1 → 1.12.0

package/configs/prompts.js

@@ -0,0 +1,64 @@
+/**
+ * External dependencies
+ */
+import { select } from 'inquirer-select-pro';
+import chalk from 'chalk';
+import { writeLine, clearLine } from '../lib/index.js';
+
+// since we are in a spinner,
+// we have to silence all the cancellation errors when using prompts
+// .catch(() => {process.exit(1);})
+import { confirm, input, password } from '@inquirer/prompts';
+
+
+const bullet = chalk.yellow('-');
+const info = chalk.cyan('i');
+
+/**
+ * Prompt for General Site Information
+ * 
+ * - Site Title
+ * 
+ * @param {string} title Site title default.
+ * @returns {object}
+ */
+async function promptForDivi(){
+    writeLine('CAWebPublishing requires that Divi be installed in order to function properly', { char: '#', borderColor: 'blue'});
+    writeLine('Divi Credentials', {color: 'magenta', char: '#', borderColor: 'magenta'});
+    writeLine('The following credentials are required to download and install Divi.', {color: 'cyan', prefix: 'i'});
+    writeLine('By not providing appropriate credentials, you may encounter issues.', {color: 'cyan', prefix: 'i'});
+    let info = {
+        ET_USERNAME: await input({
+                message: 'Elegant Themes Username:',
+            },
+            {
+                clearPromptOnDone: true,
+            },
+        ).catch(() => {
+            // clear lines.
+            clearLine(8);
+            process.exit(1);
+        }),
+        ET_API_KEY: await password({
+                message: 'Elegant Themes API Key:',
+            },
+            {
+                clearPromptOnDone: true,
+            },
+        ).catch(() => {
+            // clear lines.
+            clearLine(8);
+            process.exit(1);
+        })
+   };
+
+    // clear lines.
+    clearLine(8);
+    return info;
+}
+
+export {
+    bullet,
+    info,
+    promptForDivi,
+}

package/configs/wp-env.js

@@ -8,58 +8,55 @@ import fs from 'fs';
  * Internal Dependencies
  */
 import {
+    appPath,
     projectPath
 } from '../lib/helpers.js';
+import { promptForDivi } from './prompts.js';
+import { config, env } from 'process';
 
 const localFile = path.join(projectPath, 'package.json');
 const pkg = JSON.parse( fs.readFileSync(localFile) );
 
+const cawebJson = fs.existsSync( path.join(appPath, 'caweb.json') ) ? 
+  JSON.parse(fs.readFileSync(path.join(appPath, 'caweb.json'))) 
+  : {};
+
 /**
  * Build .wp-env.json
  * 
  * @param {boolean} bare   True if excluding any CAWeb Configurations.
  * @param {boolean} multisite   True if converting to multisite.
+ * @param {boolean} subdomain   True if converting to multisite subdomain.
  * @param {boolean} plugin   True if root directory is a plugin.
  * @param {boolean} theme   True if root directory is a theme.
  * 
  * @returns object
  */
-export default function wpEnvConfig ( bare, multisite, plugin, theme ) {
+function wpEnvConfig ( bare, multisite, subdomain, plugin, theme ) {
     let themes = [];
     let plugins = [];
-
-    let config = {
+    
+    let envConfig = {
         core: `WordPress/WordPress#${pkg.config.WP_VER}`,
         phpVersion: `${pkg.config.PHP_VER}`,
-        config: {
-            ...pkg.config.DEFAULTS
+        multisite,
+        env: {
+            development: { port: 8888, config: {} },
+            tests: { port: 8889, config: {} }
         }
     }
 
-    // if not bare.
-    if( ! bare ){
-        // include our theme
-        themes.push('CAWebPublishing/CAWeb')
-
-        // include our dev plugin
-        plugins.push('CAWebPublishing/caweb-dev')
+    if( multisite && subdomain ){
+        pkg.config.DEFAULTS.SUBDOMAIN_INSTALL= true;
     }
 
+    envConfig.config = pkg.config.DEFAULTS
+
     // 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( '.' );
@@ -67,14 +64,106 @@ export default function wpEnvConfig ( bare, multisite, plugin, theme ) {
 
     // add plugins if sources were added
     if( plugins.length ){
-        config['plugins'] = plugins;
+        envConfig['plugins'] = plugins;
     }
 
     // add themes if sources were added
     if( themes.length ){
-        config['themes'] = themes;
+        envConfig['themes'] = themes;
     }
 
-    return config;
+    // lets add some configurations from the caweb.json file
+    if( cawebJson ){
+        let siteDomain = new URL('http://localhost');
+        let currentDate = new Date();
+        let uploadDir = path.join(
+                'wp-content', 'uploads',
+                currentDate.getFullYear().toString(), (currentDate.getMonth() + 1).toString().padStart(2, '0')
+            );
+
+
+        // add siteurl and home
+        if( cawebJson?.site?.domain ){
+            siteDomain = new URL(cawebJson.site.domain);
+            
+            if( 'localhost' !== siteDomain.host ){
+                // Global configurations
+                envConfig.config['WP_SITEURL'] = `${cawebJson.site.domain}`;
+                envConfig.config['WP_HOME'] = `${cawebJson.site.domain}`; 
+                
+                // dev configurations
+                envConfig.env.development.port = '' !== siteDomain.port ? siteDomain.port : envConfig.env.development.port;
+
+                // tests configurations
+            }
+        }
+
+        // add caweb logo
+        if( cawebJson?.logo ){
+            // dev configurations
+            envConfig.env.development.config['CAWEB_ORG_LOGO'] = `${envConfig.config['WP_SITEURL']}/` + path.join(
+                uploadDir,
+                path.basename(cawebJson.logo) + // add the port
+                ('80' !== envConfig.env.development.port ? `:${envConfig.env.development.port}` : '')
+            ).replace(/\\/g, '/');
+                
+            // tests configurations
+            envConfig.env.tests.config['CAWEB_ORG_LOGO'] = `${envConfig.config['WP_SITEURL']}/` + path.join(
+                uploadDir,
+                path.basename(cawebJson.logo) + // add the port
+                ('80' !== envConfig.env.tests.port ? `:${envConfig.env.tests.port}` : '')
+            ).replace(/\\/g, '/');
+        }
+
+        // add caweb favicon
+        if( cawebJson?.favicon ){
+            // dev configurations
+            envConfig.env.development.config['CAWEB_FAV_ICON'] = `${envConfig.config['WP_SITEURL']}/` + path.join(
+                uploadDir,
+                path.basename(cawebJson.favicon) + // add the port
+                ('80' !== envConfig.env.development.port ? `:${envConfig.env.development.port}` : '')
+            ).replace(/\\/g, '/');
+                
+            // tests configurations
+            envConfig.env.tests.config['CAWEB_FAV_ICON'] = `${envConfig.config['WP_SITEURL']}/` + path.join(
+                uploadDir,
+                path.basename(cawebJson.favicon) + // add the port
+                ('80' !== envConfig.env.tests.port ? `:${envConfig.env.tests.port}` : '')
+            ).replace(/\\/g, '/');
+
+        }
+
+    }
+
+    return envConfig;
     
+}
+
+
+/**
+ * Build .wp-env.override.json
+ * 
+ * @param {boolean} bare   True if excluding any CAWeb Configurations.
+ * @param {boolean} multisite   True if converting to multisite.
+ * @param {boolean} subdomain   True if converting to multisite subdomain.
+ * @param {boolean} plugin   True if root directory is a plugin.
+ * @param {boolean} theme   True if root directory is a theme.
+ * 
+ * @returns object
+ */
+async function wpEnvOverrideConfig(){
+    let divi = await promptForDivi();
+     
+    let config = {
+        config: {
+            ...divi
+        }
+    }
+
+    return config;
+}
+
+export {
+    wpEnvConfig,
+    wpEnvOverrideConfig
 }

package/lib/cli.js

@@ -52,13 +52,13 @@ function addWebpackCmds(){
 	.allowUnknownOption(true)
 	.allowExcessArguments(true)
 	.action(env.webpack)
-      
-    
+	  
+	
   // Serve Command.
   program.command('serve')
-    .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([
+	.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',
 		'eureka',
 		'mono', 
@@ -73,74 +73,74 @@ function addWebpackCmds(){
 		'trinity',
 		'false'
 	]).default('oceanside'))
-    .option( '--no-audit', 'Skips WordPress CSS-Audit.', false )
-    .option( '--no-a11y', 'Skips IBM Accessibility Checker.', false )
-    .option( '--no-jshint', 'Skips JSHint.', false )
-    .allowUnknownOption(true)
+	.option( '--no-audit', 'Skips WordPress CSS-Audit.', false )
+	.option( '--no-a11y', 'Skips IBM Accessibility Checker.', false )
+	.option( '--no-jshint', 'Skips JSHint.', false )
+	.allowUnknownOption(true)
 	.allowExcessArguments(true)
-    .action(env.webpack)
+	.action(env.webpack)
 
   // a11y Command.
   program.command('a11y')
-    .description('Runs accessibility checks.')
-    .addArgument(new Argument('<url>', 'URL to scan for accessibility checks.'))
-    .option( '--rule-archive <rule>', 'Specify the rule archive.', 'latest')
-    .option( '--policies <policy...>', 'Specify one or many policies to scan.', ['WCAG_2_1'])
-    .option( '--fail-levels <levels...>', 'Specify one or many violation levels on which to fail the test.', [
-      'violation',
-      'potentialviolation'
-    ])
-    .option( '--report-levels <levels...>', 'Specify one or many violation levels that should be reported.', [
-      'violation', 
-      'potentialviolation',
-      'recommendation',
-      'potentialrecommendation',
-      'manual',
-      'pass'
-    ])
-    .option( '--labels <label...>', 'Specify labels that you would like associated to your scan.', [])
-    .option( '--output-format <format>', 'In which formats should the results be output.', ['html'])
-    .option( '--output-filename <name>', 'Filename for the scan results.', 'a11y')
-    .option( '--output-folder <folder>', 'Where the scan results should be saved.', 'a11y')
-    .option( '--output-filename-timestamp', 'Should the timestamp be included in the filename of the reports?', false)
-    .allowUnknownOption(true)
+	.description('Runs accessibility checks.')
+	.addArgument(new Argument('<url>', 'URL to scan for accessibility checks.'))
+	.option( '--rule-archive <rule>', 'Specify the rule archive.', 'latest')
+	.option( '--policies <policy...>', 'Specify one or many policies to scan.', ['WCAG_2_1'])
+	.option( '--fail-levels <levels...>', 'Specify one or many violation levels on which to fail the test.', [
+	  'violation',
+	  'potentialviolation'
+	])
+	.option( '--report-levels <levels...>', 'Specify one or many violation levels that should be reported.', [
+	  'violation', 
+	  'potentialviolation',
+	  'recommendation',
+	  'potentialrecommendation',
+	  'manual',
+	  'pass'
+	])
+	.option( '--labels <label...>', 'Specify labels that you would like associated to your scan.', [])
+	.option( '--output-format <format>', 'In which formats should the results be output.', ['html'])
+	.option( '--output-filename <name>', 'Filename for the scan results.', 'a11y')
+	.option( '--output-folder <folder>', 'Where the scan results should be saved.', 'a11y')
+	.option( '--output-filename-timestamp', 'Should the timestamp be included in the filename of the reports?', false)
+	.allowUnknownOption(true)
 	.allowExcessArguments(true)
-    .action(env.a11y)
+	.action(env.a11y)
 
-    
+	
   // audit Command.
   program.command('audit')
-    .description('Runs WordPress CSS Audit tool against projects.')
-    .addArgument(new Argument('[files...]', 'Files or directory path to CSS files.').default(['./build']))
-    .option('--format [format]', 'Format to use for displaying report.', 'html' )
-    .option('--filename [name]', 'If using a format that outputs to a file, specify the file name.', 'css-audit' )
-    .option('--colors', 'Runs colors audit.', true )
-    .addOption(new Option('--no-colors', 'Skips colors audit.', false ).hideHelp())
-    .option('--important', 'Runs !important audit.', true )
-    .addOption(new Option('--no-important', 'Skips !important audit.', false ).hideHelp())
-    .option('--display-none', 'Runs display: none audit.', true )
-    .addOption(new Option('--no-display-none', 'Skips display: none audit.', false ).hideHelp())
-    .option('--selectors', 'Runs selectors audit.', true )
-    .addOption(new Option('--no-selectors', 'Skips selectors audit.', false ).hideHelp())
-    .option('--media-queries', 'Runs media queries audit.', true )
-    .addOption(new Option('--no-media-queries', 'Skips media queries audit.', false ).hideHelp())
-    .option('--typography', 'Runs typography audit.', true )
-    .addOption(new Option('--no-typography', 'Skips typography audit.', false ).hideHelp())
-    .option('--property-values <values...>', 'Runs property value audit.', ['font-size', 'padding,padding-top,padding-bottom,padding-right,padding-left', 'margin,margin-top,marin-bottom,marin-right,marin-left'] )
-    .addOption(new Option('--no-property-values', 'Skips property values audit.', false ).hideHelp())
-    .allowUnknownOption(true)
+	.description('Runs WordPress CSS Audit tool against projects.')
+	.addArgument(new Argument('[files...]', 'Files or directory path to CSS files.').default(['./build']))
+	.option('--format [format]', 'Format to use for displaying report.', 'html' )
+	.option('--filename [name]', 'If using a format that outputs to a file, specify the file name.', 'css-audit' )
+	.option('--colors', 'Runs colors audit.', true )
+	.addOption(new Option('--no-colors', 'Skips colors audit.', false ).hideHelp())
+	.option('--important', 'Runs !important audit.', true )
+	.addOption(new Option('--no-important', 'Skips !important audit.', false ).hideHelp())
+	.option('--display-none', 'Runs display: none audit.', true )
+	.addOption(new Option('--no-display-none', 'Skips display: none audit.', false ).hideHelp())
+	.option('--selectors', 'Runs selectors audit.', true )
+	.addOption(new Option('--no-selectors', 'Skips selectors audit.', false ).hideHelp())
+	.option('--media-queries', 'Runs media queries audit.', true )
+	.addOption(new Option('--no-media-queries', 'Skips media queries audit.', false ).hideHelp())
+	.option('--typography', 'Runs typography audit.', true )
+	.addOption(new Option('--no-typography', 'Skips typography audit.', false ).hideHelp())
+	.option('--property-values <values...>', 'Runs property value audit.', ['font-size', 'padding,padding-top,padding-bottom,padding-right,padding-left', 'margin,margin-top,marin-bottom,marin-right,marin-left'] )
+	.addOption(new Option('--no-property-values', 'Skips property values audit.', false ).hideHelp())
+	.allowUnknownOption(true)
 	.allowExcessArguments(true)
-    .action(env.audit)
+	.action(env.audit)
 
   // JSHint Command.
   program.command('jshint')
-    .description('Runs JSHint tool against projects.')
-    .addArgument(new Argument('[files...]', 'Files or directory path to JS files.').default(['./src']))
-    .option( '--output-filename <name>', 'Filename for the scan results.', 'jshint')
-    .option( '--output-folder <folder>', 'Where the hint results should be saved.', 'jshint')
-    .allowUnknownOption(true)
+	.description('Runs JSHint tool against projects.')
+	.addArgument(new Argument('[files...]', 'Files or directory path to JS files.').default(['./src']))
+	.option( '--output-filename <name>', 'Filename for the scan results.', 'jshint')
+	.option( '--output-folder <folder>', 'Where the hint results should be saved.', 'jshint')
+	.allowUnknownOption(true)
 	.allowExcessArguments(true)
-    .action(env.hint)
+	.action(env.hint)
 }
 
 
@@ -170,6 +170,11 @@ function addWPEnvCommands(){
 			'Execute any configured lifecycle scripts.',
 			true
 		)
+		.option( 
+			'--sync',
+			'Will attempt to sync changes from a CAWebPublishing static site to this WordPress instance.',
+			false
+		)
 		.option(
 			'--bare',
 			'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.',
@@ -293,7 +298,7 @@ function addWPEnvCommands(){
  */
 function addWPInstanceCommands(){
 	// Update Plugins Command.
-    program.command('update-plugins')
+	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'))
@@ -416,30 +421,37 @@ export default function cli() {
 		})
 		.helpCommand(false)
 
-    // Add Webpack specific commands.
+	// Add Scripts command.
+	program.command('gen-scripts')
+		.description('Adds some general basic scripts commonly used in most projects to your package.json.')
+		.allowUnknownOption(true)
+		.allowExcessArguments(true)
+		.action( withSpinner(env.genScripts) )
+
+	// Add Webpack specific commands.
 	  addWebpackCmds()
 
-    // Add wp-env specific commands.
-    addWPEnvCommands();
+	// Add wp-env specific commands.
+	addWPEnvCommands();
 
 	// Add wp-env specific commands.
-    addWPInstanceCommands()
+	addWPInstanceCommands()
 
 	// Add block specific commands.
-  	addBlockCommands()
+	addBlockCommands()
 
 	// Add site specific commands.
-    addSiteCommands()
+	addSiteCommands()
   
-    
+	
   // Test Command.
   // Ensure this is commented out.
   /*program.command('test')
-    .description('Test commands on a WordPress environment')
-    //.addArgument(envArg)
-    .allowUnknownOption(true)
+	.description('Test commands on a WordPress environment')
+	//.addArgument(envArg)
+	.allowUnknownOption(true)
 	.allowExcessArguments(true)
-    .action(withSpinner(env.test))
+	.action(withSpinner(env.test))
   */
 
 	return program;

package/lib/wordpress/api.js

@@ -5,6 +5,7 @@ import path from 'path';
 import axios from 'axios';
 import terminalLink from  'terminal-link';
 import axiosRetry from 'axios-retry';
+import { stat } from 'fs';
 
 /**
  * Internal dependencies
@@ -60,6 +61,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 +135,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 +179,6 @@ async function getTaxonomies( request, tax = 'pages', debug = false ){
 
         page++;
     }while( results )
-   
     
     return collection;
 }
@@ -187,12 +188,12 @@ async function createTaxonomies( taxData, request, tax = 'pages', spinner ){
     if( ! request.method ){
         request.method = 'POST'
     }
+    // endpoint url.
+    let url = `${request.url}${endpoint}/${tax}`;
 
     let collection = [];
 
     for( let obj of taxData ){
-        // endpoint url.
-        let url = `${request.url}${endpoint}/${tax}`;
         let existingID = obj.id ? obj.id : false;
 
         // process object properties.
@@ -212,7 +213,7 @@ async function createTaxonomies( taxData, request, tax = 'pages', spinner ){
                 delete obj[prop];
             }
         }
-       
+
         // The REST API doesn't allow passing the id, in order to maintain ID's we make an additional request to our plugin endpoint.
         if( obj.id ){
             // first we check if the ID exist
@@ -269,16 +270,23 @@ async function createTaxonomies( taxData, request, tax = 'pages', spinner ){
                     // return the JSON object.
                     return JSON.parse(res.data.substring(res.data.indexOf('{')))
                 }
-                //console.log( res.data );
                  return res.data; 
             } ).catch( async (error) => { 
                 let { data, status } = error.response;
-                let msg = data.message || 'An unknown error occurred.';
-
-                if( 401 === status ){
-                    msg +=  `\nPlease check your ${terminalLink('Application Password', 'https://make.wordpress.org/core/2020/11/05/application-passwords-integration-guide/')}`;
-                } else if( 403 === status ){
-                    msg =  'Forbidden Request: A potentially unsafe operation has been detected in your request to this site';
+                let msg = '';
+
+                switch( status ){
+                    case 401:
+                        msg = `${data.message}\nPlease check your ${terminalLink('Application Password', 'https://make.wordpress.org/core/2020/11/05/application-passwords-integration-guide/')}`;
+                        break;
+                    case 403:
+                        msg = `Forbidden Request: A potentially unsafe operation has been detected in your request to this site`;
+                        break;
+                    case 404:
+                        msg = `The requested URL was not found on this server.`;
+                        break;
+                    default:
+                        msg = data.message || 'An unknown error occurred.';
                 }
 
                 spinner.fail( msg )
@@ -354,6 +362,7 @@ async function createTaxonomies( taxData, request, tax = 'pages', spinner ){
         
     }
 
+    return collection;
 
 }
 

package/lib/wordpress/caweb.js

@@ -53,19 +53,18 @@ async function activateCAWeb(
  * @param {Object}        spinner     A CLI spinner which indicates progress.
  */
 async function configureCAWeb( environment, config, spinner ) {
-	
 
 	const isThemeActivated = await activateCAWeb( environment, config );
 
-	const {
-		DESIGN_SYSTEM_ENABLED
-	} = config.env[ environment ].config
-
 	// if our theme is active.
 	if( false !== isThemeActivated ){
+		
 		spinner.text = `Configuring CAWebPublishing ${environment} Environment...`;
 
-		let themeOptions = [];
+		// lets set the default theme to CAWeb.
+		let themeOptions = [
+			'wp config set WP_DEFAULT_THEME CAWeb',
+		];
 
 		// iterate over config options.
 		Object.entries(config.env[ environment ].config).forEach(([k,v]) => {
@@ -104,21 +103,8 @@ async function configureCAWeb( environment, config, spinner ) {
 				times: 2,
 			} ),
 		] );
+
 	}
-		
-	// Activate Design System plugin
-	if( undefined !== DESIGN_SYSTEM_ENABLED && DESIGN_SYSTEM_ENABLED ){
-		await runCLICmds(
-			environment,
-			[
-				'wp plugin is-installed design-system-wordpress', 
-				'wp plugin activate design-system-wordpress'
-			],
-			config,
-			spinner
-		)
-	}
-	
 	
 }