feat: add support for passing custom preAttributes and `codeAttribu…

…tes` options (#10)

src/HighlightPairedShortcode.js

@@ -1,7 +1,11 @@
 const hljs = require("highlight.js");
 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);
+
     let highlightedContent;
     if (language === "text") {
         highlightedContent = content.trim();
@@ -22,7 +26,7 @@ module.exports = function (content, language, highlightNumbers, options = {}) {
     let classString = options.className ? " " + options.className : "";
 
     return (
-        `<pre class="language-${language}${classString}"><code class="language-${language}${classString}">` +
+        `<pre class="language-${language}${classString}"${preAttributes}><code class="language-${language}${classString}"${codeAttributes}>` +
         lines.join("<br>") +
         "</code></pre>"
     );

src/getAttributes.js

@@ -0,0 +1,39 @@
+function attributeEntryToString([key, value]) {
+  if (typeof value !== "string" && typeof value !== "number")
+    throw new Error(
+      `Attribute "${key}" must have a value of type string or number not "${typeof value}".`
+    );
+
+  return `${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 it is falsey, an empty string will be returned.
+ *
+ * ```js
+  getAttributes({
+    tabindex: 0,
+    'data-language': 'JavaScript',
+    'data-otherStuff': 'value'
+  }) // => ' tabindex="0" data-language="JavaScript" data-otherStuff="value"'
+  ```
+ *
+ * @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 === "object") {
+    const formattedAttributes = Object.entries(attributes).map(
+      attributeEntryToString
+    );
+    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));
+  }
+}
+
+module.exports = getAttributes;

src/markdownSyntaxHighlightOptions.js

@@ -1,7 +1,11 @@
 const hljs = require("highlight.js");
 const HighlightLinesGroup = require("./HighlightLinesGroup");
+const getAttributes = require("./getAttributes");
 
 module.exports = function (options = {}) {
+    const preAttributes = getAttributes(options.preAttributes);
+    const codeAttributes = getAttributes(options.codeAttributes);
+
     return function (str, language) {
         if (!language) {
             // empty string means defer to the upstream escaping code built into markdown lib.
@@ -34,7 +38,7 @@ module.exports = function (options = {}) {
 
         let classString = options.className ? " " + options.className : "";
 
-        return `<pre class="language-${language}${classString}"><code class="language-${language}${classString}">${lines.join(
+        return `<pre class="language-${language}${classString}"${preAttributes}><code class="language-${language}${classString}"${codeAttributes}>${lines.join(
             "<br>"
         )}</code></pre>`;
     };