Minor tweaks to attribute additions to <pre> and <code>. Removes stri…

…ng support. Add tests.
11ty · May 23, 2021 · fa14c60 · fa14c60
1 parent ccd0adb
commit fa14c60
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 15 deletions.
diff --git a/.eleventy.js b/.eleventy.js
@@ -12,6 +12,8 @@ module.exports = {
       alwaysWrapLineHighlights: false,
       // eligible to change the default to \n in a new major version.
       lineSeparator: "<br>",
+      preAttributes: {},
+      codeAttributes: {}
     }, options);
 
     // TODO hbs?

diff --git a/src/CharacterWrap.js b/src/CharacterWrap.js
@@ -137,7 +137,9 @@ class CharacterWrap {
       }
     }
 
-    let highlightedContent = HighlightPairedShortcode(content, codeFormat, "", { trim: false });
+    let highlightedContent = HighlightPairedShortcode(content, codeFormat, "", {
+      trim: false
+    });
     let {document} = parseHTML(`<html><body>${highlightedContent}</body></html>`);
     let counter = new IndexCounter();
     let bodyEl = document.getElementsByTagName("body")[0];

diff --git a/src/HighlightPairedShortcode.js b/src/HighlightPairedShortcode.js
@@ -4,8 +4,8 @@ const HighlightLinesGroup = require("./HighlightLinesGroup");
 const getAttributes = require("./getAttributes");
 
 module.exports = function (content, language, highlightNumbers, options = {}) {
-  const preAttributes = getAttributes(options.preAttributes)
-  const codeAttributes = getAttributes(options.codeAttributes)
+  const preAttributes = getAttributes(options.preAttributes);
+  const codeAttributes = getAttributes(options.codeAttributes);
 
   // default to on
   if(options.trim === undefined || options.trim === true) {

diff --git a/src/getAttributes.js b/src/getAttributes.js
@@ -10,32 +10,29 @@ function attributeEntryToString([key, value]) {
 /**
  * ## Usage
  * The function `getAttributes` is used to convert an object, `attributes`, with HTML attributes as keys and the values as the corresponding HTML attribute's values.
- * If the `attributes` parameter is a string, it will be returned. If it is falsey, an empty string will be returned.
+ * If it is falsey, an empty string will be returned.
  *
  * ```js
-  getAttributes('tabindex="0" data-language="HTML"')
-  // => ' tabindex="0" data-language="HTML"'
-
   getAttributes({
     tabindex: 0,
     'data-language': 'JavaScript',
     'data-otherStuff': 'value'
   }) // => ' tabindex="0" data-language="JavaScript" data-otherStuff="value"'
   ```
  *
- * @param {string | {[s: string]: string | number}} attributes A string containing HTML attributes or an object with key-value pairs that represent attributes.
+ * @param {{[s: string]: string | number}} attributes An object with key-value pairs that represent attributes.
  * @returns {string} A string containing the above HTML attributes preceded by a single space.
  */
 function getAttributes(attributes) {
   if (!attributes) {
     return "";
-  } else if (typeof attributes === "string") {
-    return ` ${attributes}`;
   } else if (typeof attributes === "object") {
     const formattedAttributes = Object.entries(attributes).map(
       attributeEntryToString
     );
-    return ` ${formattedAttributes.join(" ")}`;
+    return formattedAttributes.length ? ` ${formattedAttributes.join(" ")}` : "";
+  } else if (typeof attributes === "string") {
+    throw new Error("Syntax highlighter plugin custom attributes on <pre> and <code> must be an object. Received: " + JSON.stringify(attributes));
   }
 }
 

diff --git a/src/markdownSyntaxHighlightOptions.js b/src/markdownSyntaxHighlightOptions.js
@@ -4,8 +4,8 @@ const HighlightLinesGroup = require("./HighlightLinesGroup");
 const getAttributes = require("./getAttributes");
 
 module.exports = function (options = {}) {
-  const preAttributes = getAttributes(options.preAttributes)
-  const codeAttributes = getAttributes(options.codeAttributes)
+  const preAttributes = getAttributes(options.preAttributes);
+  const codeAttributes = getAttributes(options.codeAttributes);
 
   return function(str, language) {
     if(!language) {

diff --git a/test/CharacterWrapTest.js b/test/CharacterWrapTest.js
diff --git a/test/GetAttributesTest.js b/test/GetAttributesTest.js
@@ -0,0 +1,18 @@
+const test = require("ava");
+const ga = require("../src/getAttributes");
+
+test("Falsy", t => {
+  t.is(ga(false), "");
+  t.is(ga(null), "");
+  t.is(ga(undefined), "");
+  t.is(ga(""), "");
+  t.throws(() => {
+    ga(" test='1'");
+  });
+});
+
+test("Object syntax", t => {
+  t.is(ga({}), "");
+  t.is(ga({ hi: 1 }), ' hi="1"');
+  t.is(ga({ hi: 1, bye: 2 }), ' hi="1" bye="2"');
+});