resultMode --> failWithIssues

Author: mxmason

manifest.yml

@@ -3,13 +3,13 @@ inputs:
   - name: checkPaths
     default: ['/']
     required: false
+  - name: debugMode
+    default: false
+  - name: failWithIssues
+    default: true
   - name: ignoreDirectories
     required: false
-  - name: resultMode
-    default: error
   - name: runners
     default: ['axe']
-  - name: debugMode
-    default: false
   - name: testMode
     default: false

netlify.toml

@@ -10,7 +10,7 @@
     checkPaths = ['/']
 
     # # optional config
-    resultMode = "warn" # is "error" by default
+    failWithIssues = false # true by default
 
     # # Developer only
     # debugMode = true # extra logging for plugin developers

plugin/config.js

@@ -4,7 +4,7 @@ const INSTALLED_RUNNERS = [AXE, HTMLCS];
 
 const DEFAULT_RUNNERS = [AXE];
 const DEFAULT_CHECK_PATHS = ['/'];
-const DEFAULT_RESULT_MODE = 'error';
+const DEFAULT_FAIL_WITH_ISSUES = true;
 const DEFAULT_IGNORE_DIRECTORIES = [];
 
 const PA11Y_USER_AGENT = 'netlify-plugin-a11y';
@@ -15,7 +15,7 @@ const isInvalidRunner = runners => (
 
 const getConfiguration = ({
   constants: { PUBLISH_DIR },
-  inputs: { checkPaths, debugMode, ignoreDirectories, resultMode, runners }
+  inputs: { checkPaths, debugMode, ignoreDirectories, failWithIssues, runners }
 }) => {
 
   runners = runners || DEFAULT_RUNNERS;
@@ -28,7 +28,7 @@ const getConfiguration = ({
     checkPaths: checkPaths || DEFAULT_CHECK_PATHS,
     debugMode: debugMode || false,
     ignoreDirectories: ignoreDirectories || DEFAULT_IGNORE_DIRECTORIES,
-    resultMode: resultMode || DEFAULT_RESULT_MODE,
+    failWithIssues: failWithIssues !== undefined ? failWithIssues : DEFAULT_FAIL_WITH_ISSUES,
     pa11yOpts: {
       runners,
       userAgent: PA11Y_USER_AGENT,

plugin/index.js

@@ -15,7 +15,7 @@ module.exports = {
       debugMode,
       ignoreDirectories,
       pa11yOpts,
-      resultMode,
+      failWithIssues,
     } = getConfiguration({ constants, inputs })
     const htmlFilePaths = await pluginCore.generateFilePaths({
       absolutePublishDir,
@@ -35,7 +35,7 @@ module.exports = {
     if (issueCount > 0) {
       const postRunMsg = `Pa11y found ${issueCount} accessibility issues with your site! Check the logs above for more information.`
       console.log(results);
-      if (resultMode === 'error') {
+      if (failWithIssues) {
         build.failBuild(postRunMsg)
       } else {
         console.warn(postRunMsg)