@caweb/a11y-webpack-plugin 2.0.4 → 2.1.1

package/index.js

@@ -13,8 +13,6 @@ import chalk from 'chalk';
 import { fileURLToPath, URL, pathToFileURL } from 'url';
 import { createRequire } from 'module';
 
-const require = createRequire(import.meta.url);
-
 /**
  * Internal dependencies
  */
@@ -23,10 +21,12 @@ import { landingPage } from './reporter.js';
 // default configuration
 import {default as DefaultConfig} from './aceconfig.js';
 
-const pluginName = 'CAWebA11yWebpackPlugin';
+const require = createRequire(import.meta.url);
+
+const pluginName = 'CAWebA11yPlugin';
 
 // IBM Accessibility Checker Plugin
-class CAWebA11yWebpackPlugin {
+class CAWebA11yPlugin {
     config = {}
 
     constructor(opts = {}) {
@@ -133,16 +133,9 @@ class CAWebA11yWebpackPlugin {
             console.log('<i> \x1b[32m[webpack-dev-middleware] Running IBM Accessibility scan...\x1b[0m');
             /**
              * We run the accessibility checker
-             * 
-             * we scan the output.publicPath if its set and not set to 'auto'
-             * otherwise we scan the output.path
              */
-            let scanDir = compiler.options.output.publicPath && 'auto' !== compiler.options.output.publicPath ?
-              compiler.options.output.publicPath :
-              compiler.options.output.path;
-
             this.a11yCheck(
-              scanDir,
+              compiler.options.output.path,
               this.config 
             );
 
@@ -286,4 +279,4 @@ class CAWebA11yWebpackPlugin {
 } // end of class
   
 
-export default CAWebA11yWebpackPlugin;
+export default CAWebA11yPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/a11y-webpack-plugin",
-  "version": "2.0.4",
+  "version": "2.1.1",
   "description": "CAWebPublishing Webpack Plugin to run Accessibility Scans",
   "type": "module",
   "main": "index.js",
@@ -35,13 +35,13 @@
     "webpack"
   ],
   "dependencies": {
-    "@caweb/webpack": "^1.6.3",
-    "accessibility-checker": "^4.0.10",
+    "@caweb/webpack": "^1.6.6",
+    "accessibility-checker": "^4.0.12",
     "check-valid-url": "^0.1.0"
   },
   "devDependencies": {
-    "@caweb/html-webpack-plugin": "^2.0.2",
-    "webpack": "^5.104.1",
+    "@caweb/html-webpack-plugin": "^2.1.5",
+    "webpack": "^5.105.1",
     "webpack-cli": "^6.0.1"
   }
 }

package/reporter.js

@@ -3,26 +3,11 @@
  */
 import path from 'path';
 import fs from 'fs';
-import HandleBars from 'handlebars';
 import htmlFormat from 'html-format';
-
-import endsWith from '@caweb/webpack/helpers/logic/endsWith.js';
-
+import HandleBars from '@caweb/webpack/lib/handlebars.js';
 
 const templateDir = path.resolve( 'node_modules', '@caweb', 'template' );
 
-let templatePartials = {
-  'header': 'semantics/header.html',
-  'footer': 'semantics/footer.html',
-  'utilityHeader': 'semantics/utility-header.html',
-  'branding': 'semantics/branding.html',
-  'mobileControls': 'semantics/mobile-controls.html',
-  'navHeader': 'semantics/nav-header.html',
-  'navFooter': 'semantics/nav-footer.html',
-  'alert': 'components/alert/alert.html',
-  'searchForm': 'forms/search.html'
-}
-
 let sortedReport = {
   errors: [],
   warnings: [],
@@ -165,18 +150,6 @@ function addBreakdown({
     </section>`;
 }
 
-function initHandleBars(){
-  // Register partials.
-  Object.entries(templatePartials).forEach(([p, f]) => HandleBars.registerPartial(p, fs.readFileSync(path.resolve(templateDir, f )).toString() ) );
-
-  
-  // Register custom helpers.
-  HandleBars.registerHelper('endsWith', endsWith )
-
-  return HandleBars.compile(fs.readFileSync(path.resolve(templateDir, 'patterns', 'default.html')).toString() )
-
-}
-
 /**
  * JSHint Reporter
  * 
@@ -348,17 +321,16 @@ function landingPage(data, opts ){
     '<table class="table"><thead><tr><th>Page Auditted</th><th>Audit</th></thead><tbody>',
     ...data.sort().map(file => {
       // remove the .json extension from the file name
-      file = file.replace(/\.json$/, '');
+      // we also replace backslashes with forward slashes for better readability
+      file = file.replace(/\.json$/, '').replace(/\\/g, '/'); 
 
-      return `<tr><td><a href="/${file}" target="_blank">/${file}</a></td><td><a href="${file}" target="_blank">${file}</a></td></tr>`
+      return `<tr><td><a href="${file}" target="_blank">${file}</a></td><td><a href="${file}" target="_blank">${file}</a></td></tr>`
     }),
     '</tbody></table>',
     '</div></div></div>'
   )
 
-  HandleBars.registerPartial('index', output.join('\n') );
-
-  let template = initHandleBars();
+  let template = HandleBars.compile(fs.readFileSync(path.resolve(templateDir, 'patterns', 'default.html')).toString() )
 
   fs.mkdirSync( outputFolder, {recursive: true} );
   
@@ -369,10 +341,7 @@ function landingPage(data, opts ){
       template({
         title: `${title} for ${process.cwd().split('\\').pop()}`,
         scheme: 'oceanside',
-        assets: [ 
-        fs.existsSync( path.join(outputFolder, 'a11y.update.js' ) ) ? 
-          'a11y.update.js' : '' // if the hot module update file exists, add it
-        ].filter(Boolean)
+        partial: output.join('\n'),
       }),
       "  ".repeat(4), 250
     )
@@ -380,10 +349,6 @@ function landingPage(data, opts ){
 
 }
 
-function capitalCase(str){
-  return str.charAt(0).toUpperCase() + str.slice(1)
-}
-
 export {
   reporter,
   landingPage