fix(axe.configure): do not remove newline characters from locale doT …

…strings (#3216)
dequelabs · Oct 18, 2021 · ea2ce17 · ea2ce17
1 parent ac7b2b5
commit ea2ce17
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 9 deletions.
diff --git a/build/configure.js b/build/configure.js
@@ -3,12 +3,12 @@
 'use strict';
 
 var clone = require('clone');
-var dot = require('@deque/dot');
+var doT = require('@deque/dot');
 var templates = require('./templates');
 var buildManual = require('./build-manual');
 var entities = new (require('html-entities').AllHtmlEntities)();
 var packageJSON = require('../package.json');
-var dotRegex = /\{\{.+?\}\}/g;
+var doTRegex = /\{\{.+?\}\}/g;
 
 var axeVersion = packageJSON.version.substring(
   0,
@@ -18,7 +18,9 @@ var axeVersion = packageJSON.version.substring(
 var descriptionTableHeader =
   '| Rule ID | Description | Impact | Tags | Issue Type | ACT Rules |\n| :------- | :------- | :------- | :------- | :------- | :------- |\n';
 
-dot.templateSettings.strip = false;
+// prevent striping newline characters from strings (e.g. failure
+// summaries). must be synced with lib/core/imports/index.js
+doT.templateSettings.strip = false;
 
 function getLocale(grunt, options) {
   var localeFile;
@@ -120,17 +122,17 @@ function buildRules(grunt, options, commons, callback) {
           // objects handled later in publish-metadata.js
           if (
             typeof result.messages[key] !== 'object' &&
-            dotRegex.test(result.messages[key])
+            doTRegex.test(result.messages[key])
           ) {
-            result.messages[key] = dot
+            result.messages[key] = doT
               .template(result.messages[key])
               .toString();
           }
         });
       }
       //TODO this is actually failureSummaries, property name should better reflect that
-      if (result.failureMessage && dotRegex.test(result.failureMessage)) {
-        result.failureMessage = dot.template(result.failureMessage).toString();
+      if (result.failureMessage && doTRegex.test(result.failureMessage)) {
+        result.failureMessage = doT.template(result.failureMessage).toString();
       }
       return result;
     }
@@ -150,9 +152,9 @@ function buildRules(grunt, options, commons, callback) {
       summaries.forEach(function(summary) {
         if (
           summary.incompleteFallbackMessage &&
-          dotRegex.test(summary.incompleteFallbackMessage)
+          doTRegex.test(summary.incompleteFallbackMessage)
         ) {
-          result = dot.template(summary.incompleteFallbackMessage).toString();
+          result = doT.template(summary.incompleteFallbackMessage).toString();
         }
       });
       return result;

diff --git a/lib/core/imports/index.js b/lib/core/imports/index.js
@@ -7,6 +7,10 @@ import es6promise from 'es6-promise';
 import { Uint32Array } from 'typedarray';
 import 'weakmap-polyfill';
 
+// prevent striping newline characters from strings (e.g. failure
+// summaries). value must be synced with build/configure.js
+doT.templateSettings.strip = false;
+
 if (!('Promise' in window)) {
   es6promise.polyfill();
 }

diff --git a/test/core/public/configure.js b/test/core/public/configure.js
@@ -573,6 +573,40 @@ describe('axe.configure', function() {
       assert.equal(localeData.incompleteFallbackMessage(), 'failed incomplete');
     });
 
+    it('should not strip newline characters from doT template', function() {
+      axe._load({
+        data: {
+          failureSummaries: {
+            any: {
+              failureMessage: function() {
+                return 'failed any';
+              }
+            }
+          }
+        }
+      });
+
+      axe.configure({
+        locale: {
+          lang: 'lol',
+          failureSummaries: {
+            any: {
+              failureMessage:
+                "Fix any of the following:{{~it:value}}\n  {{=value.split('\\n').join('\\n  ')}}{{~}}"
+            }
+          }
+        }
+      });
+
+      var audit = axe._audit;
+      var localeData = audit.data;
+
+      assert.equal(
+        localeData.failureSummaries.any.failureMessage(['1', '2', '3']),
+        'Fix any of the following:\n  1\n  2\n  3'
+      );
+    });
+
     describe('only given checks', function() {
       it('should not error', function() {
         assert.doesNotThrow(function() {