rST section headers can be marked with a bizarre array of characters

There could be more tests ...
gitterHQ · Jan 29, 2015 · fcd723d · fcd723d
1 parent 21e6826
commit fcd723d
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 10 deletions.
diff --git a/lib/rst.js b/lib/rst.js
@@ -1,6 +1,9 @@
 /* jshint node:true */
 "use strict";
 
+// http://docutils.sourceforge.net/docs/user/rst/quickref.html#section-structure
+var ACCEPTED_CHARS = ['=', '-', '`', ':', "'", '"', '~', '^', '_', '*', '+', '#', '<', '>'];
+
 function badger(content, imgUrl, linkUrl, altText) {
   var lines = content.split('\n');
   var idealLine = findIdealLineForInsert(lines);
@@ -13,19 +16,28 @@ function badger(content, imgUrl, linkUrl, altText) {
 }
 
 function findIdealLineForInsert(lines) {
-  var i = 0;
+  var lineIdx = 1;
+  var chrIdx = 0;
   var seenHeader = false;
 
-  for(; i < lines.length; i++) {
-    // the top line is *never* the header
-    if(/^\s*(={3,}|-{3,})/.test(lines[i]) && i > 0) {
-      seenHeader = true;
+  for(; lineIdx < lines.length; lineIdx++) {
+    var line = lines[lineIdx];
+    var lineAbove = lines[lineIdx - 1];
+    var chrSeen = {};
+    for(; chrIdx < line.length; chrIdx++) {
+      chrSeen[line[chrIdx]] = null;
+    }
+    var uniqChars = Object.keys(chrSeen);
+    if(uniqChars.length === 1
+       && ACCEPTED_CHARS.indexOf(uniqChars[0]) !== -1
+       && line.length >= lineAbove.length) {
+        seenHeader = true;
     } else {
       if(seenHeader) break;
     }
   }
 
-  return i;
+  return lineIdx;
 }
 
 module.exports = badger;
diff --git a/test/examples/rst-after.rst b/test/examples/rst-after.rst
@@ -1,6 +1,6 @@
-====================
+####################
  My Amazing Library
-====================
+####################
 
 .. image:: https://badges.gitter.im/Join%20Chat.svg
    :alt: Join the chat at https://gitter.im/myorg/myrepo

diff --git a/test/examples/rst-before.rst b/test/examples/rst-before.rst
@@ -1,6 +1,6 @@
-====================
+####################
  My Amazing Library
-====================
+####################
 
 Features
 --------