Add a test for the id generation

Author: mixu

lib/convert-md.js

@@ -0,0 +1,42 @@
+var md = require('markdown-stream-utils');
+
+// A wrapper around md.convertMd that includes the custom heading generation and id
+// generation code.
+module.exports = function(argv) {
+  if (!argv) {
+    // default to true to match bin/generate-md
+    argv = { 'header-links': true };
+  }
+
+  // header ids already seen in the current render
+  var idCount = {};
+  // custom rendered for headings
+  var renderer = new md.marked.Renderer();
+  renderer.heading = function(text, level, raw) {
+    var id = this.options.headerPrefix + raw.trim().toLowerCase().replace(/[^\w]+/g, '-');
+    // do nothing the first time a heading is seen
+    if (!idCount.hasOwnProperty(id)) {
+      idCount[id] = 0;
+    } else {
+      // when duplicate headings are seen, append a dash-number starting with 1
+      idCount[id]++;
+      id += '-' + idCount[id];
+    }
+    return '<h' +
+      level +
+      ' id="' +
+      id +
+      '">' +
+      // if we want to generate header links, add the <a> link
+      (argv['header-links'] ?
+        '<a class="header-link" href="#' + id + '"></a>' : '') +
+      text +
+      '</h' +
+      level +
+      '>\n';
+  };
+
+  return md.convertMd({
+    renderer: renderer
+  });
+};

lib/index.js

@@ -1,5 +1,6 @@
 module.exports = {
   resolveArgs: require('./resolve-args'),
   render: require('./render'),
-  pipeline: require('./pipeline')
+  pipeline: require('./pipeline'),
+  convertMd: require('./convert-md')
 };

lib/pipeline.js

@@ -3,33 +3,10 @@ var fs = require('fs'),
     md = require('markdown-stream-utils'),
     setOutputPath = require('./set-output-path'),
     applyTemplate = require('./apply-template'),
-    mergeMeta = require('./merge-meta');
-
-var idCount = {};
+    mergeMeta = require('./merge-meta'),
+    convertMd = require('./convert-md');
 
 module.exports = function(argv) {
-  // custom rendered for headings
-  var renderer = new md.marked.Renderer();
-  // if we want to generate header links, override the default header renderer
-  if (argv['header-links']) {
-    renderer.heading = function(text, level, raw) {
-      var id = this.options.headerPrefix + raw.trim().toLowerCase().replace(/[^\w]+/g, '-');
-      idCount[id] = idCount.hasOwnProperty(id) && idCount[id] + 1 || 0;
-      id += idCount[id] > 0 && '-' + idCount[id] || '';
-      return '<h' +
-        level +
-        ' id="' +
-        id +
-        '">' +
-        '<a class="header-link" href="#' +
-        id +
-        '"></a>' +
-        text +
-        '</h' +
-        level +
-        '>\n';
-    };
-  }
   return pi.pipeline([
       md.parseHeader(),
       md.parseMd(),
@@ -40,8 +17,8 @@ module.exports = function(argv) {
         }
         return false;
       }),
-      md.convertMd({
-        renderer: renderer
+      convertMd({
+        'header-links': argv['header-links']
       }),
 
       // map paths

test/integration.test.js

@@ -118,7 +118,7 @@ describe('integration tests', function() {
           md.parseMd(),
           md.annotateMdHeadings(),
           md.highlight(),
-          md.convertMd(),
+          mds.convertMd(),
 
           setOutputPath({
             input: '/fake/input',
@@ -229,12 +229,34 @@ describe('integration tests', function() {
       }, function(html) {
         assert.equal(html, [
           'a<p>a</p>',
-          '<h1 id="foo">foo</h1>',
+          '<h1 id="foo"><a class="header-link" href="#foo"></a>foo</h1>',
           '<pre class="hljs"><code>' +
           '<span class="hljs-keyword">var</span> foo = bar;</code></pre>b'
         ].join('\n'));
         done();
       });
     });
+
+    it('when the same header text is repeated, it produces ids with a number appended to them', function(done) {
+      render( { contents: [
+        '# some heading',
+        'hello',
+        '# some heading',
+        'world',
+        '# some heading',
+      ].join('\n') }, {
+        template: '{{> content}}'
+      }, function(html) {
+        assert.equal(html, [
+          '<h1 id="some-heading"><a class="header-link" href="#some-heading"></a>some heading</h1>',
+          '<p>hello</p>',
+          '<h1 id="some-heading-1"><a class="header-link" href="#some-heading-1"></a>some heading</h1>',
+          '<p>world</p>',
+          '<h1 id="some-heading-2"><a class="header-link" href="#some-heading-2"></a>some heading</h1>',
+          ''
+        ].join('\n'));
+        done();
+      });
+    });
   });
 });