Add support for 'standard' input

Also other cleanup.

Author: mxmason

manifest.yml

@@ -11,5 +11,7 @@ inputs:
     required: false
   - name: runners
     default: ['axe']
+  - name: standard
+    default: 'WCAG2AA'
   - name: testMode
     default: false

netlify.toml

@@ -12,5 +12,6 @@
     # # optional config
     failWithIssues = false # true by default
 
+    standard = 'WCAG2A'
     # # Developer only
     # debugMode = true # extra logging for plugin developers

plugin/config.js

@@ -3,6 +3,7 @@ const HTMLCS = 'htmlcs';
 const INSTALLED_RUNNERS = [AXE, HTMLCS];
 
 const DEFAULT_RUNNERS = [AXE];
+const DEFAULT_STANDARD = 'WCAG2AA';
 const DEFAULT_CHECK_PATHS = ['/'];
 const DEFAULT_FAIL_WITH_ISSUES = true;
 const DEFAULT_IGNORE_DIRECTORIES = [];
@@ -15,7 +16,7 @@ const isInvalidRunner = runners => (
 
 const getConfiguration = ({
   constants: { PUBLISH_DIR },
-  inputs: { checkPaths, debugMode, ignoreDirectories, failWithIssues, runners }
+  inputs: { checkPaths, debugMode, ignoreDirectories, failWithIssues, runners, standard }
 }) => {
 
   runners = runners || DEFAULT_RUNNERS;
@@ -32,6 +33,7 @@ const getConfiguration = ({
     pa11yOpts: {
       runners,
       userAgent: PA11Y_USER_AGENT,
+      standard: standard || DEFAULT_STANDARD,
     }
   }
 }

plugin/index.js

@@ -26,15 +26,15 @@ module.exports = {
       console.log({ htmlFilePaths });
     }
 
-    const { results, issueCount } = await pluginCore.runPa11y({
+    const { report, issueCount } = await pluginCore.runPa11y({
       build,
       debugMode,
       htmlFilePaths,
       pa11yOpts,
     });
     if (issueCount > 0) {
       const postRunMsg = `Pa11y found ${issueCount} accessibility issues with your site! Check the logs above for more information.`
-      console.log(results);
+      console.log(report);
       if (failWithIssues) {
         build.failBuild(postRunMsg)
       } else {

plugin/pluginCore.js

@@ -4,7 +4,7 @@ const { isDirectory, isFile } = require('path-type')
 const { results: cliReporter } = require('pa11y/lib/reporters/cli');
 const readdirp = require('readdirp')
 
-exports.runPa11y = async function ({ htmlFilePaths, pa11yOpts = {}, build }) {
+exports.runPa11y = async function ({ htmlFilePaths, pa11yOpts, build }) {
   let issueCount = 0;
   const results = await Promise.all(htmlFilePaths.map(async path => {
     try {
@@ -20,14 +20,14 @@ exports.runPa11y = async function ({ htmlFilePaths, pa11yOpts = {}, build }) {
 
   return {
     issueCount,
-    results: results.filter(Boolean)
+    report: results.filter(Boolean)
       .join(''),
   };
 };
 
 exports.generateFilePaths = async function({
   fileAndDirPaths, // array, mix of html and directories
-  ignoreDirectories = [],
+  ignoreDirectories,
   absolutePublishDir,
   testMode,
   debugMode