Added mailto: handling of links

lib/index.js

@@ -10,6 +10,9 @@ function externalLinksPlugin(md, options) {
   let externalClassName = (typeof options.externalClassName === "string" || options.externalClassName === null)
       ? options.externalClassName
       : "external-link";
+  let mailtoClassName = (typeof options.mailtoClassName === "string" || options.mailtoClassName === null)
+      ? options.mailtoClassName
+      : "mailto-link";
   let internalClassName = (typeof options.internalClassName === "string" || options.internalClassName === null)
       ? options.internalClassName
       : null;
@@ -18,9 +21,11 @@ function externalLinksPlugin(md, options) {
       : [];
 
   let externalTarget = options.externalTarget || "_self";
+  let mailtoTarget = options.mailtoTarget || "_blank";
   let internalTarget = options.internalTarget || "_self";
 
   let externalRel = options.externalRel || null;
+  let mailtoRel = options.mailtoRel || null;
   let internalRel = options.internalRel || null;
 
   if (externalClassName === null && internalClassName === null
@@ -39,8 +44,24 @@ function externalLinksPlugin(md, options) {
       if (token.type === "link_open") {
         let href = token.attrGet("href");
         let internal = isInternalLink(href);
+        let mailto = isMailtoLink(href);
+
+        let newClasses, target, rel;
+
+        if (internal) {
+          newClasses = internalClassName;
+          target = internalTarget;
+          rel = internalRel;
+        } else if (mailto) {
+          newClasses = mailtoClassName;
+          target = mailtoTarget;
+          rel = mailtoRel;
+        } else {
+          newClasses = externalClassName;
+          target = externalTarget;
+          rel = externalRel;
+        }
 
-        let newClasses = internal ? internalClassName : externalClassName;
         if (newClasses) {
           let existingClasses = token.attrGet("class") || "";
           if (existingClasses !== "") {
@@ -49,12 +70,10 @@ function externalLinksPlugin(md, options) {
           token.attrSet("class", newClasses);
         }
 
-        let target = internal ? internalTarget : externalTarget;
         if (target !== "_self") {
           token.attrSet("target", target);
         }
 
-        let rel = internal ? internalRel : externalRel;
         if (rel) {
           let existingRel = token.attrGet("rel") || "";
           if (existingRel !== "") {
@@ -69,6 +88,9 @@ function externalLinksPlugin(md, options) {
   }
 
   function isInternalLink(href) {
+    if (isMailtoLink(href)) {
+      return false;
+    }
     let domain = getDomain(href);
     return domain === null || internalDomains.indexOf(domain) !== -1;
   }
@@ -82,6 +104,13 @@ function externalLinksPlugin(md, options) {
     return null;
   }
 
+  function isMailtoLink(href) {
+    // regex taken from https://stackoverflow.com/questions/46155/how-to-validate-email-address-in-javascript
+    let regex = /^(([^<>()\[\]\.,;:\s@\"]+(\.[^<>()\[\]\.,;:\s@\"]+)*)|(\".+\"))@(([^<>()[\]\.,;:\s@\"]+\.)+[^<>()[\]\.,;:\s@\"]{2,})$/i; // eslint-disable-line
+    let emailAddress = href.indexOf("mailto:") !== -1 ? href.split(":")[1] : href;
+    return regex.test(emailAddress);
+  }
+
   md.core.ruler.push("external_links", externalLinks);
 }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-it-external-links",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Plugin for markdown-it that adds CSS classes to links that fall outside of the specified internal domain(s).",
   "repository": {
     "type": "git",

test/spec/plugin-spec.js

@@ -171,4 +171,18 @@ describe("markdown-it-external-links", function () {
       .should.be.eql(expected);
   });
 
+  given(
+    "mailto:[email protected]"
+  ).it("adds custom class to external links", function (href) {
+    let source = `Text with [link](${href}).`;
+    let expected = `<p>Text with <a href="${href}" class="custom-mailto-class" target="_blank">link</a>.</p>`;
+
+    let markdownProcessor = markdownIt().use(externalLinks, {
+      mailtoClassName: "custom-mailto-class"
+    });
+
+    markdownProcessor.render(source)
+      .trim()
+      .should.be.eql(expected);
+  });
 });