@caweb/cli 1.4.2 → 1.4.4

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

@@ -0,0 +1,272 @@
+#!/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

@@ -0,0 +1,12 @@
+{
+  "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"
+}

package/lib/webpack/plugins/css-audit/css-audit.config.cjs

@@ -0,0 +1,5 @@
+/**
+ * External dependencies
+ */
+
+module.exports = {};

package/lib/webpack/plugins/css-audit/default.config.js

@@ -0,0 +1,19 @@
+/**
+ * External dependencies
+ */
+
+export default {
+	format: 'html',
+	filename: 'css-audit',
+	colors: true,
+      important: true,
+      displayNone: true,
+      selectors: true,
+      mediaQueries: true,
+      typography: true,
+      propertyValues: [
+        'font-size',
+        'padding,padding-top,padding-bottom,padding-right,padding-left' ,
+        'property-values', 'margin,margin-top,marin-bottom,marin-right,marin-left',
+      ]
+};

package/lib/webpack/plugins/css-audit/index.js

@@ -0,0 +1,297 @@
+#!/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 fs, { stat } from 'fs';
+import deepmerge from 'deepmerge';
+import chalk from 'chalk';
+import { fileURLToPath, URL } from 'url';
+
+// default configuration
+import {default as DefaultConfig} from './default.config.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));
+
+// CSS Audit Plugin
+class CSSAuditPlugin {
+    config = {}
+
+    constructor(opts = {}) {
+      this.config = deepmerge(DefaultConfig, opts);
+    }
+
+    apply(compiler) {
+      const staticDir = {
+        directory: path.join(path.resolve(currentPath, '../../../../'), 'bin', 'css-audit', 'public'),
+        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 css-audit.html to open property.
+      if( Array.isArray(devServer.open) ){
+        devServer.open.push(`${hostUrl}/${this.config.rewrite ? this.config.rewrite : this.config.filename}.html`)
+      }else if( 'object' === typeof devServer.open && Array.isArray(devServer.open.target) ){
+        devServer.open.target.push(`${hostUrl}/${this.config.filename}.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('CSS Audit Plugin', () => {
+        compiler.hooks.compilation.tap(
+          "CSS Audit Plugin",
+          (compilation, { normalModuleFactory }) => {
+            compilation.dependencyFactories.set(
+              EntryDependency,
+              normalModuleFactory
+            );
+          }
+        );
+
+        const { entry, options, context } = {
+          entry: path.join(staticDir.directory, 'css-audit.update.js'),
+          options: {
+            name: 'css-audit.update'
+          },
+          context: staticDir.directory
+        };
+
+        const dep = new EntryDependency(entry);
+        dep.loc = {
+          name: options.name
+        };
+        
+        fs.writeFileSync(
+          path.join(staticDir.directory, `css-audit.update.js`),
+          `` // required for hot-update to compile on our page, blank script for now
+        );
+
+        compiler.hooks.thisCompilation.tap('CSS Audit Plugin',
+          /**
+           * Hook into the webpack compilation
+           * @param {Compilation} compilation
+           */
+          (compilation) => {
+            
+            compiler.hooks.make.tapAsync("CSS Audit Plugin", (compilation, callback) => {
+              
+              compilation.addEntry(
+              context,
+              dep, 
+              options, 
+              err => {
+                callback(err);
+              });
+            });
+
+            // process assets and run the css-audit on appropriate assets.
+            compilation.hooks.processAssets.tapAsync(
+              {
+                name: 'CSS Audit Plugin',
+                stage: compiler.webpack.Compilation.PROCESS_ASSETS_STAGE_ADDITIONAL  
+              },
+              /**
+               * Hook into the process assets hook
+               * @param {any} _
+               * @param {(err?: Error) => void} callback
+               */
+              (assets, callback) => {
+                let files = [];
+
+                Object.entries(assets).forEach(([pathname, source]) => {
+                  if( pathname.endsWith('.js') ){
+                    if( source['_source'] && source['_source']['_children'] ){
+                      source['_source']['_children'].forEach((s, i) => {
+                        if( 
+                          'string' === typeof s && // is a string and
+                          0 < s.indexOf('.css') && // has a .css reference and
+                          0 > s.indexOf('node_modules') // not referencing node_modules directory
+                        ){
+                          files.push( path.resolve(s.replace(/[\n\s\S\w]*"(.*)"[\n\s\S\w]*/, '$1')) )
+                        }
+                      })    
+                    }
+                  }
+                })
+                console.log(`<i> ${boldGreen('[webpack-dev-middleware] Running CSS Audit...')}`);
+                
+                this.audit(files, this.config );
+    
+                // we have to inject the css-audit.update.js file into the head in order for the webpack-dev-server scripts to load.
+                let pageContent = fs.readFileSync(path.join(staticDir.directory, `${this.config.filename}.html`))
+                
+                fs.writeFileSync(
+                  path.join(staticDir.directory, `${this.config.filename}.html`),
+                  pageContent.toString().replace('</head>', '<script src="/css-audit.update.js"></script>\n</head>')
+                )
+
+                console.log(`<i> ${boldGreen('[webpack-dev-middleware] CSS Audit can be viewed at')} ${ boldBlue(new URL(`${hostUrl}/${this.config.filename}.html`).toString())  }`);
+    
+                callback();
+            });
+            
+
+            compiler.hooks.watchClose.tap( 'CSS Audit Plugin', () => {
+              getAllFilesSync(compiler.options.output.path).toArray().forEach(f => {
+                if( 
+                  f.includes('css-audit') || // delete any css-audit files
+                  f.includes('.hot-update.js') // delete any HMR files
+                ){
+                  fs.rmSync(f)
+                }
+              })
+            })
+        });
+
+      });
+    
+    }
+
+    /**
+     * Run CSS Auditor
+     *
+     * @param {Array} files
+     * @param {Object}  options
+     * @param {boolean} options.debug
+     * @param {boolean} options.format
+     * @param {boolean} options.filename
+     * @param {boolean} options.colors
+     * @param {boolean} options.important
+     * @param {boolean} options.displayNone
+     * @param {boolean} options.selectors
+     * @param {boolean} options.mediaQueries
+     * @param {boolean} options.typography
+     * @param {Array} options.propertyValues
+     */
+    audit(files, {
+      debug,
+      format,
+      filename,
+      colors,
+      important,
+      displayNone,
+      selectors,
+      mediaQueries,
+      typography,
+      propertyValues
+    }){
+
+
+      let filesToBeAuditted = [];
+      let filesWithIssues = [];
+
+      files.forEach( (paths, i) => {
+        let resolvePath = path.resolve(paths);
+
+        try {
+            // if given path is a directory
+            if( fs.statSync(resolvePath).isDirectory() ){
+
+                // get all .css files
+                getAllFilesSync(resolvePath).toArray().forEach(f => {
+                    if( f.endsWith('.css') ){
+                      filesToBeAuditted.push(f)
+                    }
+                })
+            // if given path is a file and a .css file
+            }else if( fs.statSync(paths).isFile() && paths.endsWith('.css') ){
+              filesToBeAuditted.push(paths)
+            }
+        // invalid path/file
+        } catch (error) {
+          filesWithIssues.push(paths)
+        }
+
+      });
+
+      if( ! filesToBeAuditted.length ){
+        console.log('No file(s) or directory path(s) were given or default directory was not found.')
+        console.log('Auditor did not execute.');
+        return
+      }
+
+      /**
+       * the css audit uses the filename for the title, rather than the project name
+       * we fix that by passing the project name for the file name
+       * then renaming the file to the intended file name.
+       */
+      let auditArgs = [
+        colors ? '--colors' : '',
+        important ? '--important' : '',
+        displayNone ? '--display-none' : '',
+        selectors ? '--selectors' : '',
+        mediaQueries ? '--media-queries' : '',
+        typography ? '--typography' : '',
+        format ? `--format=${format}` : '',
+        filename ? `--filename=${path.basename(process.cwd())}` : ''
+      ].filter( e => e)
+      
+      if( propertyValues ){
+        propertyValues.forEach((p) => {
+          auditArgs.push(`--property-values=${p.replace(' ',',')}`)
+        })
+      }
+
+      
+      let { stdout, stderr } = spawn.sync( 
+        'node ' + resolveBin('@caweb/cli', {executable: 'auditor'}),
+        [
+          ...filesToBeAuditted,
+          ...auditArgs
+        ],
+        {
+          stdio: 'pipe',
+          cwd: fs.existsSync(path.join(process.cwd(), 'css-audit.config.cjs')) ? process.cwd() : currentPath
+        }
+      )
+
+      if( stderr && stderr.toString() ){
+        console.log( stderr.toString())
+      }
+      if( stdout ){
+          // rename the file back to the intended file name instead of the project name
+          fs.renameSync(
+            path.join(path.resolve(currentPath, '../../../../'), 'bin', 'css-audit', 'public', `${path.basename(process.cwd())}.html`),
+            path.join(path.resolve(currentPath, '../../../../'), 'bin', 'css-audit', 'public', `${filename}.html`)
+          )
+          
+          let msg = stdout.toString().replace('undefined', '');
+      
+          if( 'audit' === process.argv[2] ){
+              console.log( msg )
+          }else{
+              return msg;
+          }
+
+      }
+      
+    } // end of audit
+
+} // end of class
+  
+
+export default CSSAuditPlugin;

package/lib/webpack/plugins/css-audit/package.json

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

package/lib/webpack/plugins/jshint/.jshintrc

@@ -0,0 +1,31 @@
+{
+	"boss": true,
+	"curly": true,
+	"eqeqeq": true,
+	"eqnull": true,
+	"esversion": 6,
+	"expr": true,
+	"immed": true,
+	"noarg": true,
+	"nonbsp": true,
+	"quotmark": "single",
+	"undef": true,
+	"unused": true,
+
+	"browser": true,
+
+	"globals": {
+		"_": false,
+		"Backbone": false,
+		"jQuery": false,
+		"JSON": false,
+		"wp": false,
+		"export": false,
+		"module": false,
+		"require": false,
+		"WorkerGlobalScope": false,
+		"self": false,
+		"OffscreenCanvas": false,
+		"Promise": false
+	}
+}