@caweb/cli 1.15.11 → 1.15.12

package/commands/webpack/webpack.js

@@ -3,6 +3,7 @@
  */
 import path from 'path';
 import fs from 'fs';
+import { fileURLToPath } from 'url';
 
 /**
  * Internal dependencies
@@ -13,6 +14,8 @@ import {
 
 import { buildFlags, serveFlags } from './webpack-flags.js';
 
+const currentPath = path.dirname(fileURLToPath(import.meta.url));
+
 /**
  * Build the current project
  * 
@@ -33,13 +36,17 @@ export default async function webpack({
     const webpackAllowedFlags = 'build' === webpackCommand ? buildFlags : serveFlags ;
 
     // we use our default config from the @caweb/webpack
-    const defaultConfigPath = path.resolve('node_modules', '@caweb', 'webpack', 'webpack.config.js' );
+    const defaultConfigFile = path.resolve('node_modules', '@caweb', 'webpack', 'webpack.config.js' );
+    
+    // we use the cli webpack plugins config
+    const webpackPluginsFile = 'serve' === webpackCommand ? ['--config', path.resolve( currentPath, '..', '..', 'configs','webpack.plugins.js')] : [];
     
     // prepend our default config to the arguments.
     // users can overwrite any values by creating a webconfig of their own.
     let webPackArgs = [
         '--config',
-        defaultConfigPath,
+        defaultConfigFile,
+        ...webpackPluginsFile,
         ...process.argv.splice(3),
     ];
     

package/configs/webpack.plugins.js

@@ -0,0 +1,29 @@
+// this file is used to add any custom webpack plugins to the serve process.
+/**
+ * External dependencies
+ */
+import CAWebHTMLPlugin from "@caweb/html-webpack-plugin";
+import CAWebA11yPlugin from '@caweb/a11y-webpack-plugin';
+import CAWebCSSAuditPlugin from '@caweb/css-audit-webpack-plugin';
+import CAWebJSHintPlugin from '@caweb/jshint-webpack-plugin';
+
+import { flagExists } from '@caweb/webpack/lib/args.js';
+
+export default {
+
+    plugins: [
+        // add custom plugins here
+        // Used for Site Generation
+        new CAWebHTMLPlugin(),
+
+        // // IBM Accessibility
+        ! flagExists('no-a11y') && new CAWebA11yPlugin(),
+
+        // // WP CSS Auditor
+        ! flagExists( 'no-audit' ) && new CAWebCSSAuditPlugin(),
+
+        // // JSHint
+        ! flagExists( 'no-jshint' ) && new CAWebJSHintPlugin(),
+        
+    ].filter( Boolean ),
+}

package/lib/wordpress/setup/index.js

@@ -1,9 +1,8 @@
 /**
  * External dependencies
  */
-import fs from 'fs';
-import path from 'path';
 import { format } from 'util';
+import { getArgVal } from '@caweb/webpack/lib/args.js';
 
 /**
  * Internal dependencies
@@ -13,34 +12,7 @@ import { configureWordPress } from '../wordpress.js';
 import { isCAWeb, configureCAWeb } from './caweb.js';
 import { isDivi, configureDivi } from './divi.js';
 
-
-function processArgs( arr ){
-  let tmp = [];
-
-  arr.filter(Boolean).map((o) => {
-    return o.replaceAll("'", '').split('=').forEach((e => tmp.push(e)))
-  });
-
-  return tmp
-}
-
-function flagExists(flag){
-  return flags.includes(flag)
-}
-
-function getArgVal(flag){
-  return flagExists(flag) ? flags[flags.indexOf(flag) + 1] : false;
-}
-
-let flags = [].concat(
-    processArgs(process.argv),
-    // the following can be uncommented if ever needed to process those args.
-    // processArgs(process.argv0.split(' ')),
-    // processArgs(process.env)
-    // processArgs(process.env.NODE_OPTIONS ? process.env.NODE_OPTIONS.split(' ') : []),
-)
-
-const workingDirectoryPath = getArgVal('--cwd') ? getArgVal('--cwd') : process.cwd();
+const workingDirectoryPath = getArgVal('--cwd', process.cwd() );
 
 // Collect existing wp-config.php values.
 process.stdout.write('Collecting CAWeb configuration data...');
@@ -68,7 +40,7 @@ let diviInstalled = await isDivi({
         is: 'installed'
     });
 
-let multisite = flagExists('--multisite') ? getArgVal('--multisite') : false;
+let multisite = getArgVal('--multisite', false );
 
 process.stdout.write(`\nConfiguring WordPress...\n`);
 await configureWordPress({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.15.11",
+  "version": "1.15.12",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -64,24 +64,28 @@
     }
   },
   "dependencies": {
-    "@caweb/webpack": "^1.5.18",
+    "@caweb/a11y-webpack-plugin": "^2.1.0",
+    "@caweb/css-audit-webpack-plugin": "^2.1.0",
+    "@caweb/html-webpack-plugin": "^2.1.0",
+    "@caweb/jshint-webpack-plugin": "^2.1.0",
+    "@caweb/webpack": "^1.6.3",
     "@inquirer/prompts": "^8.2.0",
-    "@wordpress/create-block": "^4.81.0",
-    "@wordpress/env": "^10.38.0",
-    "axios": "^1.13.2",
+    "@wordpress/create-block": "^4.82.0",
+    "@wordpress/env": "^10.39.0",
+    "axios": "^1.13.4",
     "axios-retry": "^4.5.0",
     "chalk": "^5.6.2",
     "commander": "^14.0.2",
     "cross-spawn": "^7.0.6",
     "crypto": "^1.0.1",
     "deepmerge": "^4.3.1",
-    "docker-compose": "^1.3.0",
+    "docker-compose": "^1.3.1",
     "fs-extra": "^11.3.3",
     "html-to-json-parser": "^2.0.1",
     "inquirer-select-pro": "^1.0.0-alpha.9",
     "jsdom": "^27.4.0",
     "node-html-parser": "^7.0.2",
-    "ora": "^9.0.0",
+    "ora": "^9.1.0",
     "resolve-bin": "^1.0.1",
     "rimraf": "^6.1.2",
     "terminal-link": "^5.0.0"

package/lib/webpack/plugins/a11y/aceconfig.js

@@ -1,44 +0,0 @@
-/**
- * Configuration for Accessibility Checker
- * @link https://www.npmjs.com/package/accessibility-checker
- */
-
-let levels = [
-    'violation', 
-    'potentialviolation',
-    'recommendation',
-    'potentialrecommendation',
-    'manual',
-    'pass'
-];
-let reportLevels = levels;
-let failLevels = levels;
-
-// process args
-process.argv.forEach((arg) => {
-    // remove any report levels
-    if( arg.includes('--no-report-levels-') ){  
-      let r = arg.replace('--no-report-levels-', '')
-      delete reportLevels[reportLevels.indexOf(r)]
-    }
-    // remove any fails levels
-    if( arg.includes('--no-fail-levels-') ){  
-      let f = arg.replace('--no-fail-levels-', '')
-      delete failLevels[failLevels.indexOf(f)]
-    }
-  })
-
-export default {
-    ruleArchive: "latest",
-    policies: [
-        'WCAG_2_1'
-    ],
-    failLevels: failLevels.filter(e=>e),
-    reportLevels: reportLevels.filter(e=>e),
-    outputFilename: 'a11y',
-    outputFolder: "public",
-    outputFormat: [
-        'html'
-    ],
-    outputFilenameTimestamp: false
-}

package/lib/webpack/plugins/a11y/index.js

@@ -1,272 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * External dependencies
- */
-import { sync as resolveBin } from 'resolve-bin';
-import spawn from 'cross-spawn';
-import { getAllFilesSync } from 'get-all-files'
-import EntryDependency from "webpack/lib/dependencies/EntryDependency.js";
-import path from 'path';
-import { isUrl, isValidUrl } from 'check-valid-url';
-import fs from 'fs';
-import deepmerge from 'deepmerge';
-import chalk from 'chalk';
-import { fileURLToPath, URL } from 'url';
-
-// default configuration
-import {default as DefaultConfig} from './aceconfig.js';
-
-const boldWhite = chalk.bold.white;
-const boldGreen = chalk.bold.green;
-const boldBlue = chalk.bold.hex('#03a7fc');
-const currentPath = path.dirname(fileURLToPath(import.meta.url));
-
-// IBM Accessibility Checker Plugin
-class A11yPlugin {
-    config = {}
-
-    constructor(opts = {}) {
-      // outputFolder must be resolved
-      if( opts.outputFolder ){
-        opts.outputFolder = path.join(process.cwd(), opts.outputFolder);
-      }
-      this.config = deepmerge(
-        DefaultConfig, 
-        {
-          outputFolder: path.join(currentPath, DefaultConfig.outputFolder)
-        },
-        opts
-      );
-    }
-
-    apply(compiler) {
-      const staticDir = {
-        directory: this.config.outputFolder,
-        watch: true
-      }
-      let { devServer, output } = compiler.options;
-      let hostUrl = 'localhost' === devServer.host ? `http://${devServer.host}`: devServer.host;
-      let hostPort = devServer.port;
-
-      if( hostPort && 80 !== hostPort )
-      {
-          hostUrl = `${hostUrl}:${hostPort}`;
-      }
-
-      // if dev server allows for multiple pages to be opened
-      // add outputFilename.html to open property.
-      if( Array.isArray(devServer.open) ){
-        devServer.open.push(`${hostUrl}/${this.config.outputFilename}.html`)
-      }else if( 'object' === typeof devServer.open && Array.isArray(devServer.open.target) ){
-        devServer.open.target.push(`${hostUrl}/${this.config.outputFilename}.html`)
-      }
-
-      // add our static directory 
-      if( Array.isArray(devServer.static) ){
-        devServer.static.push(staticDir)
-      }else{
-        devServer.static = [].concat(devServer.static, staticDir );
-      }
-      
-      // Wait for configuration preset plugins to apply all configure webpack defaults
-      compiler.hooks.initialize.tap('IBM Accessibility Plugin', () => {
-        compiler.hooks.compilation.tap(
-          "IBM Accessibility Plugin",
-          (compilation, { normalModuleFactory }) => {
-            compilation.dependencyFactories.set(
-              EntryDependency,
-              normalModuleFactory
-            );
-          }
-        );
-
-        const { entry, options, context } = {
-          entry: path.join( this.config.outputFolder, 'a11y.update.js'),
-          options: {
-            name: 'a11y'
-          },
-          context: 'a11y'
-        };
-
-        const dep = new EntryDependency(entry);
-        dep.loc = {
-          name: options.name
-        };
-        if( ! fs.existsSync(path.resolve(this.config.outputFolder))){
-          fs.mkdirSync( path.resolve(this.config.outputFolder), {recursive: true} );
-        }
-        
-        fs.writeFileSync(
-          path.join(this.config.outputFolder, `a11y.update.js`),
-          `` // required for hot-update to compile on our page, blank script for now
-        );
-
-
-        compiler.hooks.thisCompilation.tap('IBM Accessibility Plugin',
-          /**
-           * Hook into the webpack compilation
-           * @param {Compilation} compilation
-           */
-          (compilation) => {
-            
-            compiler.hooks.make.tapAsync("IBM Accessibility Plugin", (compilation, callback) => {
-              
-              compilation.addEntry(
-              context,
-              dep, 
-              options, 
-              err => {
-                callback(err);
-              });
-            });
-
-            compiler.hooks.done.tapAsync(
-              'IBM Accessibility Plugin',
-              /**
-               * Hook into the process assets hook
-               * @param {any} _
-               * @param {(err?: Error) => void} callback
-               */
-              ({compilation}, callback) => {
-                  
-                console.log(`<i> ${boldGreen('[webpack-dev-middleware] Running IBM Accessibility scan...')}`);
-
-                this.a11yCheck(path.join(process.cwd(), output.publicPath ?? '/' ), this.config );
-
-                console.log(`<i> ${boldGreen('[webpack-dev-middleware] IBM Accessibilty Report can be viewed at')} ${ boldBlue(new URL(`${hostUrl}/${this.config.outputFilename}.html`).toString())  }`);
-
-                callback();
-            });
-
-            compiler.hooks.watchClose.tap( 'IBM Accessibility Plugin', () => {
-              getAllFilesSync(compiler.options.output.path).toArray().forEach(f => {
-                if( 
-                  f.includes('a11y') || // delete any a11y files
-                  f.includes('.hot-update.js') // delete any HMR files
-                ){
-                  fs.rmSync(f)
-                }
-              })
-            });
-            
-        });
-
-    });
-    
-    }
-
-    /**
-     * Run accessibility checks
-     * 
-     * @param {Object}  options
-     * @param {boolean} options.debug            True if debug mode is enabled.
-     * @param {boolean} options.ruleArchive   Specify the rule archive.
-     * @param {boolean} options.policies   Specify one or many policies to scan.
-     * @param {boolean} options.failLevels   Specify one or many violation levels on which to fail the test.
-     * @param {boolean} options.reportLevels   Specify one or many violation levels that should be reported.
-     * @param {boolean} options.labels   Specify labels that you would like associated to your scan.
-     * @param {boolean} options.outputFormat   In which formats should the results be output.
-     * @param {boolean} options.outputFilename   Filename for the scan results.
-     * @param {boolean} options.outputFolder   Where the scan results should be saved.
-     * @param {boolean} options.outputFilenameTimestamp   Should the timestamp be included in the filename of the reports?
-     */
-    a11yCheck(url, {
-      debug, 
-      ruleArchive,
-      policies,
-      failLevels,
-      reportLevels,
-      labels,
-      outputFormat,
-      outputFilename, 
-      outputFolder,
-      outputFilenameTimestamp
-    }){
-
-      let acheckerArgs = [
-        '--ruleArchive',
-        ruleArchive,
-        '--policies',
-        Array.isArray(policies) ? policies.filter(e => e).join(',') : policies,
-        '--failLevels',
-        Array.isArray(failLevels) ? failLevels.filter(e => e).join(',') : failLevels,
-        '--reportLevels',
-        Array.isArray(reportLevels) ? reportLevels.filter(e => e).join(',') : reportLevels,
-        '--outputFolder',
-        outputFolder,
-        '--outputFormat',
-        outputFormat,
-        '---outputFilenameTimestamp',
-        outputFilenameTimestamp,
-        url
-      ];
-    
-      let isValid = false;
-
-      if( fs.existsSync( url ) ){
-          if( fs.statSync(url).isDirectory() &&  path.join( url, 'index.html') ){
-              url = path.join( url, 'index.html')
-          }
-          isValid = true;
-      }else{
-          isValid = 'localhost' === new URL(url).hostname || isUrl( url )
-      }
-
-      if( isValid ){
-        let originalFileName =  `${fs.existsSync( url ) ?
-          path.resolve(url).replace(':', '_') :
-          url.replace(/http[s]+:\/\//, '')}.html`;
-        let originalJsonFileName =  `${fs.existsSync( url ) ?
-            path.resolve(url).replace(':', '_') :
-            url.replace(/http[s]+:\/\//, '')}.json`;
-
-        let outputDir = path.resolve('.',  outputFolder );
-
-        let {stderr, stdout}  = spawn.sync( 
-          resolveBin('accessibility-checker', {executable: 'achecker'}),
-          acheckerArgs,
-          {
-            stdio: 'pipe',
-            timeout: 30000 // stop after 30 seconds
-          }
-        )
-
-        if( stderr && stderr.toString() ){
-            console.log( stderr.toString() );
-        }
-        
-        if( stdout && stdout.toString()){
-          let reportedFile =  path.join(outputDir, originalFileName );
-          let reportedJSon =  path.join(outputDir, originalJsonFileName );
-
-          // if output file name option was passed
-          if( outputFilename ){
-
-              reportedFile =  path.join( outputDir, `${outputFilename}.html` );
-              reportedJSon =  path.join( outputDir, `${outputFilename}.json` );
-
-              // rename the output files
-              fs.renameSync(path.join(outputDir, originalFileName), reportedFile );
-              fs.renameSync(path.join(outputDir, originalJsonFileName), reportedJSon );
-
-              // delete any empty directories.
-              fs.rmSync( path.join(outputDir, originalFileName.split(path.sep).shift()), {recursive: true} )
-          }
-
-          if( 'a11y' === process.argv[2] ){
-              console.log( reportedFile )
-          }else{
-              return reportedFile;
-          }
-        }
-      }else{
-        console.log( `${url} is not a valid url.` )
-      }
-
-    } // end of a11yCheck
-
-} // end of class
-  
-
-export default A11yPlugin;

package/lib/webpack/plugins/a11y/package.json

@@ -1,12 +0,0 @@
-{
-  "name": "@caweb/a11y-webpack-plugin",
-  "version": "1.0.0",
-  "description": "Webpack Plugin to run Accessibility Scans",
-  "type": "module",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 0"
-  },
-  "author": "Danny Guzman",
-  "license": "ISC"
-}