@caweb/cli 1.4.5 → 1.5.0

package/commands/index.js

@@ -1,9 +1,7 @@
 /**
  * External dependencies
  */
-/**
- * These are default wp-env commands. No need to overwrite these commands
- */
+// 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';
@@ -14,16 +12,15 @@ import installPath from '@wordpress/env/lib/commands/install-path.js';
  */
 import webpack from './webpack/webpack.js';
 
+import CSSAuditPlugin from '@caweb/css-audit-webpack-plugin';
+const audit = new CSSAuditPlugin().audit;
 
-import A11yPlugin from '../lib/webpack/plugins/a11y/index.js';
-const a11y = new A11yPlugin().a11yCheck;
-
-import CSSAuditPlugin from '../lib/webpack/plugins/css-audit/index.js';
-const audit = new CSSAuditPlugin({}).audit;
-
-import JSHintPlugin from '../lib/webpack/plugins/jshint/index.js';
+import JSHintPlugin from '@caweb/jshint-webpack-plugin';
 const hint = new JSHintPlugin().hint;
 
+import A11yPlugin from '@caweb/a11y-webpack-plugin';
+const a11y = new A11yPlugin().a11yCheck;
+
 import shell from './tasks/shell.js';
 
 import sync from './sync.js';
@@ -34,14 +31,16 @@ 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.
- */
+// 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 {
+    a11y,
+    audit,
+    hint,
+    webpack,
     clean,
 	logs,
 	run,
@@ -49,14 +48,9 @@ export {
     start,
 	stop,
     destroy,
-    webpack,
-    a11y,
-    audit,
-    hint,
     sync,
     updatePlugins,
     shell,
     createBlock,
-    updateBlock,
-    test
+    updateBlock
 }

package/commands/webpack/webpack.js

@@ -1,24 +1,16 @@
-#!/usr/bin/env node
-
 /**
  * External dependencies
  */
 import path from 'path';
-import fs, { watch } from 'fs';
-import deepmerge from 'deepmerge';
-import Webpack from 'webpack';
-import webpackServer from 'webpack-dev-server';
+import fs from 'fs';
 
 /**
  * Internal dependencies
  */
 import { 
-    runCmd, 
-    projectPath,
     appPath,
-    wpPrimary,
-    wpGreen,
-    wpRed
+    projectPath,
+    runCmd
 } from '../../lib/index.js';
 
 
@@ -32,13 +24,11 @@ import {
 export default async function webpack({
     spinner,
 	debug, 
-    audit,
-    a11y,
-    selectors
 } ) {
     const webpackCommand = 'build' === process.argv[2] ? 'build' : 'serve' ;
 
-    const defaultConfigPath = path.join( projectPath, 'configs', 'webpack.config.js' );
+    // we use our default config from the @caweb/html-webpack-plugin
+    const defaultConfigPath = path.resolve(projectPath, '..', 'webpack', 'webpack.config.js' );
     let webpackConfig = await import('file://' + defaultConfigPath);
     let customConfig = {};
 
@@ -46,16 +36,15 @@ export default async function webpack({
     // the environment variables as well.
     process.env.WP_COPY_PHP_FILES_TO_DIST  = true;
 
-    // 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 = [
         '--config',
-        defaultConfigPath,
-    ];
-    
+        defaultConfigPath
+    ].filter(e => e);
+
     // CommonJS
-    if( fs.existsSync( path.join(appPath, 'webpack.config.cjs' ))){
+    if( fs.existsSync( path.join(appPath, 'webpack.config.cjs' ) ) ){
         webPackArgs.push(
             '--config',
             path.join(appPath, 'webpack.config.cjs' ),
@@ -78,89 +67,17 @@ export default async function webpack({
     if( customConfig.length ){
         webpackConfig = deepmerge(webpackConfig.default, customConfig.default);
     }
-    
-    // we always run the build command.
-    let result = await runCmd(
-		'webpack', 
-		['build', ...webPackArgs],
-        {stdio:'pipe'}
-	).then(({stdout, stderr}) => {
-        // we hide the punycode deprecation warning.
-        // this is caused by the wp-scripts package
-        // if an error was thrown
-        if( stderr ){
-            //console.log( stderr.toString().replace(/.*`punycode`.*\n.*/, '') )
-        }
         
-        if(stdout){
-            return stdout.toString().replace(/.*`punycode`.*\n.*/, '');
-        }
-
-    });
-
-    // if serving.
-    if( 'serve' === webpackCommand ){
-        let hostUrl = 'localhost' === webpackConfig.default.devServer.host ? `http://${webpackConfig.default.devServer.host}`: webpackConfig.default.devServer.host;
-        let hostPort = webpackConfig.default.devServer.port;
-
-        if( hostPort && 80 !== hostPort )
+    // run the webpackCommand command.
+    await runCmd(
+		'webpack', 
+		[
+            webpackCommand, 
+            ...webPackArgs
+        ],
         {
-            hostUrl = `${hostUrl}:${hostPort}`;
-        }        
-        
-        console.log( `Webpack Server is preparing to launch ${ wpGreen(hostUrl) }` );
-        console.log( `Press ${ wpRed('Ctrl + C') } to shutdown the server.\n` );
-
-        // add a11y plugin
-        if( a11y ){
-            /*webpackConfig.default.plugins.push(new A11yPlugin({
-                outputFilename: 'a11y'
-              }) )
-
-            webpackConfig.default.devServer.static.push({
-                directory: path.join(appPath, 'a11y')
-            })*/
+            stdio: 'inherit',
+            argv0: process.argv.join(' ')
         }
-        
-         // add css-auditor plugin
-         if( audit ){
-        }
-        
-        const compiler = Webpack(webpackConfig.default);
-        const server = new webpackServer({...webpackConfig.default.devServer}, compiler);
-    
-        await server.start();
-
-        //process.stdin.resume();
-
-        // run webpack serve command
-        /*await runCmd(
-            'webpack', 
-            ['serve', ...webPackArgs],
-            {
-                stdio: 'inherit'
-            }
-        ).then(({stdout, stderr}) => {
-            // if an error was thrown, and no output
-            if( stderr && ! stdout){
-                console.log( stderr.toString() )
-            }
-            
-            if( stdout ){
-                spinner.text = "Webpack Server was closed.";
-            }
-    
-        });*/
-
-        /*
-        const compiler = Webpack(webpackConfig.default);
-        const server = new webpackServer({...webpackConfig.default.devServer}, compiler);
-       */
-       
-    // only build was ran.
-    }else{
-        //spinner.prefixText = result;
-        //spinner.text = "Done!";
-    }
-
+	);
 };

package/lib/cli.js

@@ -1,7 +1,6 @@
 /**
  * External dependencies
  */
-//const wpenv_cli = require('@wordpress/env/lib/cli');
 
 import path from 'path';
 import fs from 'fs';
@@ -11,9 +10,10 @@ import { Command, Argument, Option  } from 'commander';
  * Internal dependencies
  */
 import * as env from '../commands/index.js';
+
 import {
-	withSpinner,
 	projectPath,
+	withSpinner
 } from './index.js';
 
 const localFile = path.join(projectPath, 'package.json');
@@ -39,6 +39,85 @@ const envArg = new Argument('[environment]', 'Which environment to use.')
 	])
 	.default('development');
 
+function addWebpackCmds(){
+  
+	// Build Command.
+	program.command('build')
+  .description('Builds the current project.')
+  .allowUnknownOption(true)
+  .action(env.webpack)
+      
+    
+  // Serve Command.
+  program.command('serve')
+    .description('Serve the current project')
+    .option( '--audit', 'Performs WordPress CSS-Audit.', true )
+    .option( '--no-audit', 'Skips WordPress CSS-Audit.', false )
+    .option( '--a11y', 'Performs IBM Accessibility Checker.', true )
+    .option( '--no-a11y', 'Skips IBM Accessibility Checker.', false )
+    .allowUnknownOption(true)
+    .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)
+    .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)
+    .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)
+    .action(env.hint)
+}
+
 
 /**
  * Adds commands for wp-env 
@@ -190,132 +269,59 @@ export default function cli() {
 		})
 		.helpCommand(false)
 
-		
-	// Build Command.
-	program.command('build')
-		.description('Builds the current project.')
-		.allowUnknownOption(true)
-		.action(env.webpack)
-			
-		
-	// Serve Command.
-	program.command('serve')
-		.description('Serve the current project')
-		.option( '--audit', 'Performs WordPress CSS-Audit.', true )
-		.option( '--no-audit', 'Skips WordPress CSS-Audit.', false )
-		.option( '--a11y', 'Performs IBM Accessibility Checker.', true )
-		.option( '--no-a11y', 'Skips IBM Accessibility Checker.', false )
-		.allowUnknownOption(true)
-		//.action(withSpinner(env.webpack))
-		.action(env.webpack)
+    // Add Webpack specific commands.
+	  addWebpackCmds()
 
-	// 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.')
-		.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)
-		.action(env.a11y)
+    // Add wp-env specific commands.
+    addWPEnvCommands();
 
-		
-	// 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)
-		.action(env.audit)
+    // 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)
+    .action( withSpinner(env.updatePlugins) )
 
-	// 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.')
-		.option( '--output-folder <folder>', 'Where the hint results should be saved.')
-		.allowUnknownOption(true)
-		.action(env.hint)
+  // 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 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)
-		.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('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 WordPress instance to another.')
-		.argument('<from>', 'Target Site URL.')
-		.argument('<to>', 'Destination Site URL.')
-		.addOption(new Option(
-			'-t,--tax [tax...]',
-			'Taxonomy that should be synced. Omitting this option will sync the full site.'
-		).choices(['pages', 'posts', 'media', 'menus', 'settings']))
-		.addOption(new Option(
-			'-i,--include [include...]',
-			'IDs to of taxonomies to include. Omitting this option will sync all items for given taxonomy.'
-		))
-		.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)
-		.allowUnknownOption(true)
-		.action(withSpinner(env.test))
-	*/
-	addWPEnvCommands();
+    
+  // Update a Design System Block Command.
+  program.command('sync')
+    .description('Sync changes from one WordPress instance to another.')
+    .argument('<from>', 'Target Site URL.')
+    .argument('<to>', 'Destination Site URL.')
+    .addOption(new Option(
+      '-t,--tax [tax...]',
+      'Taxonomy that should be synced. Omitting this option will sync the full site.'
+    ).choices(['pages', 'posts', 'media', 'menus', 'settings']))
+    .addOption(new Option(
+      '-i,--include [include...]',
+      'IDs to of taxonomies to include. Omitting this option will sync all items for given taxonomy.'
+    ))
+    .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)
+    .allowUnknownOption(true)
+    .action(withSpinner(env.test))
+  */
 
 	return program;
-};
+};

package/lib/helpers.js

@@ -30,7 +30,7 @@ const appPath = path.resolve( projectPath, '../../../' );
  * 
  * @returns {Promise}
  */
-async function runCmd(cmd, args,opts = { stdio: ['inherit', 'pipe'] }){
+async function runCmd(cmd, args,opts = { stdio: 'pipe' }){
 	// fix various commands.
 	switch (cmd) {
 		case 'npm':
@@ -103,12 +103,10 @@ async function runCLICmds(
 	);
 }
 
-
-
 export {
 	currentPath,
 	projectPath,
 	appPath,
-	runCLICmds,
-	runCmd
+	runCmd,
+	runCLICmds
 };

package/lib/index.js

@@ -1,19 +1,17 @@
 import {
-    wpPrimary,
-    wpGreen,
-    wpRed,
-    wpYellow,
-    withSpinner,
-} from './spinner.js';
-
-import {
-	runCmd,
-    runCLICmds,
-	currentPath,
+    appPath,
+    currentPath,
     projectPath,
-    appPath
+    runCmd,
+    runCLICmds
 } from './helpers.js';
 
+// Spinner
+import {
+    withSpinner,
+} from './spinner.js';
+
+// WordPress
 import {
     activateCAWeb,
     configureCAWeb,
@@ -31,15 +29,11 @@ import {
 } from './wordpress/index.js';
 
 export {
+    appPath,
     currentPath,
     projectPath,
-    appPath,
-    wpPrimary,
-    wpGreen,
-    wpRed,
-    wpYellow,
+    runCmd,
     withSpinner,
-	runCmd,
     runCLICmds,
     activateCAWeb,
     configureCAWeb,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.4.5",
+  "version": "1.5.0",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -9,8 +9,7 @@
   "author": "CAWebPublishing",
   "license": "ISC",
   "bin": {
-    "caweb": "bin/caweb.js",
-    "auditor": "bin/css-audit/index.js"
+    "caweb": "bin/caweb.js"
   },
   "files": [
     "bin",
@@ -21,8 +20,7 @@
   ],
   "scripts": {
     "doc": "node ./docs/tool/index.js",
-    "test": "echo \"Error: run tests from root\" && exit 0",
-    "postinstall": "cd bin/css-audit && npm ci"
+    "test": "echo \"Error: run tests from root\" && exit 0"
   },
   "homepage": "https://github.com/CAWebPublishing/cli#readme",
   "repository": {
@@ -58,39 +56,17 @@
     }
   },
   "dependencies": {
+    "@caweb/webpack": "^1.0.0",
     "@wordpress/create-block": "^4.45.0",
     "@wordpress/env": "^10.2.0",
-    "@wordpress/scripts": "^28.2.0",
-    "accessibility-checker": "^3.1.73",
-    "autoprefixer": "^10.4.19",
     "axios": "^1.7.2",
     "axios-retry": "^4.4.1",
     "chalk": "^5.3.0",
-    "check-valid-url": "^0.1.0",
     "commander": "^12.1.0",
     "cross-spawn": "^7.0.3",
-    "css-audit": "file:css-audit",
-    "css-loader": "^7.1.2",
-    "deepmerge": "^4.3.1",
     "docker-compose": "^0.24.8",
-    "fs-extra": "^11.2.0",
-    "get-all-files": "^5.0.0",
-    "got": "^14.4.1",
-    "handlebars-loader": "^1.7.3",
-    "html-format": "^1.1.7",
-    "html-to-json-parser": "^2.0.1",
-    "html-webpack-plugin": "^5.6.0",
-    "html-webpack-skip-assets-plugin": "^1.0.4",
-    "jshint": "^2.13.6",
-    "mini-css-extract-plugin": "^2.9.0",
     "ora": "^8.0.1",
-    "postcss-loader": "^8.1.1",
     "resolve-bin": "^1.0.1",
-    "sass-loader": "^14.2.1",
-    "snyk": "^1.1292.1",
-    "terminal-link": "^3.0.0",
-    "url": "^0.11.3",
-    "webpack": "^5.92.1",
-    "webpack-dev-server": "^5.0.4"
+    "terminal-link": "^3.0.0"
   }
 }