highmark-markdown 0.0.428 → 0.0.431

package/src/node/markdown.js

@@ -126,10 +126,10 @@ class MarkdownNode extends NonTerminalNode {
   }
 
   asHTML(indent, context) {
-    const tagName = this.tagName(context);
-
     let html = null;
 
+    const tagName = this.tagName(context);
+
     if (tagName !== null) {
       indent = this.adjustIndent(indent);
 
@@ -157,6 +157,25 @@ ${childNodesHTML}${indent}${closingTag}
     return html;
   }
 
+  asPlainText(context) {
+    let plainText = null;
+
+    const tagName = this.tagName(context);
+
+    if (tagName !== null) {
+      const childNodesPlainText = this.childNodesAsPlainText(context);
+
+      if (childNodesPlainText !== null) {
+        plainText = (plainText === null) ?
+                      childNodesPlainText :
+                       `${plainText}
+${childNodesPlainText};`;
+      }
+    }
+
+    return plainText;
+  }
+
   childNodesAsHTML(indent, context) {
     const childNodes = this.getChildNodes(),
           childNodesHTML = childNodes.reduce((childNodesHTML, childNode) => {
@@ -209,6 +228,29 @@ ${childNodesHTML}${indent}${closingTag}
     return domElement;
   }
 
+  childNodesAsPlainText(context) {
+    const childNodes = this.getChildNodes(),
+          childNodesPlainText = childNodes.reduce((childNodesPlainText, childNode) => {
+        const childNodeMarkdownNode = (childNode instanceof MarkdownNode);
+
+        if (childNodeMarkdownNode) {
+          const markdownNode = childNode, ///
+                markdownNodePlainText = markdownNode.asPlainText(context);
+
+          if (markdownNodePlainText !== null) {
+            childNodesPlainText = (childNodesPlainText === null) ?
+                                    markdownNodePlainText :  ///
+                                     `${childNodesPlainText}
+${markdownNodePlainText}`;
+          }
+        }
+
+        return childNodesPlainText;
+      }, null);
+
+    return childNodesPlainText;
+  }
+
   createChildNodeDOMElements(context) {
     const childNodes = this.getChildNodes();
 

package/src/nodeMap.js

@@ -1,7 +1,7 @@
 "use strict";
 
 import LineMarkdownNode from "./node/markdown/line";
-import LinkMarkdownNode from "./node/markdown/link";
+import CommaMarkdownNode from "./node/markdown/comma";
 import ImageMarkdownNode from "./node/markdown/image";
 import TableMarkdownNode from "./node/markdown/table";
 import ErrorMarkdownNode from "./node/markdown/error";
@@ -11,6 +11,9 @@ import FootnoteMarkdownNode from "./node/markdown/footnote";
 import ReferenceMarkdownNode from "./node/markdown/reference";
 import ParagraphMarkdownNode from "./node/markdown/paragraph";
 import HyperlinkMarkdownNode from "./node/markdown/hyperlink";
+import IndexListMarkdownNode from "./node/markdown/indexList";
+import IndexItemMarkdownNode from "./node/markdown/indexItem";
+import IndexLinkMarkdownNode from "./node/markdown/indexLink";
 import TableCellMarkdownNode from "./node/markdown/tableCell";
 import TableHeadMarkdownNode from "./node/markdown/tableHead";
 import TableBodyMarkdownNode from "./node/markdown/tableBody";
@@ -30,6 +33,7 @@ import TableBodyRowMarkdownNode from "./node/markdown/tableBodyRow";
 import ContentsLinkMarkdownNode from "./node/markdown/contentsLink";
 import ContentsItemMarkdownNode from "./node/markdown/contentsItem";
 import ContentsListMarkdownNode from "./node/markdown/contentsList";
+import FootnoteLinkMarkdownNode from "./node/markdown/footnoteLink";
 import InlineListingMarkdownNode from "./node/markdown/inlineListing";
 import UnorderedListMarkdownNode from "./node/markdown/unorderedList";
 import FootnotesItemMarkdownNode from "./node/markdown/footnotesItem";
@@ -40,6 +44,7 @@ import TableBodyCellMarkdownNode from "./node/markdown/tableBodyCell";
 import EmphasisedTextMarkdownNode from "./node/markdown/emphasisedText";
 import PrimaryHeadingMarkdownNode from "./node/markdown/heading/primary";
 import EmptyTableCellMarkdownNode from "./node/markdown/emptyTableCell";
+import IndexDirectiveMarkdownNode from "./node/markdown/directive/index";
 import EmbedDirectiveMarkdownNode from "./node/markdown/directive/embee";
 import TertiaryHeadingMarkdownNode from "./node/markdown/heading/tertiary";
 import OrderedListItemMarkdownNode from "./node/markdown/listItem/ordered";
@@ -56,7 +61,7 @@ import PageNumberDirectiveMarkdownNode from "./node/markdown/directive/pageNumbe
 import StronglyEmphasisedTextMarkdownNode from "./node/markdown/stronglyEmphasisedText";
 
 import { LINE_RULE_NAME,
-         LINK_RULE_NAME,
+         COMMA_RULE_NAME,
          IMAGE_RULE_NAME,
          TABLE_RULE_NAME,
          ERROR_RULE_NAME,
@@ -66,6 +71,9 @@ import { LINE_RULE_NAME,
          REFERENCE_RULE_NAME,
          PARAGRAPH_RULE_NAME,
          HYPERLINK_RULE_NAME,
+         INDEX_LIST_RULE_NAME,
+         INDEX_ITEM_RULE_NAME,
+         INDEX_LINK_RULE_NAME,
          TABLE_CELL_RULE_NAME,
          TABLE_HEAD_RULE_NAME,
          TABLE_BODY_RULE_NAME,
@@ -79,6 +87,7 @@ import { LINE_RULE_NAME,
          STRONG_TEXT_RULE_NAME,
          SUB_DIVISION_RULE_NAME,
          ORDERED_LIST_RULE_NAME,
+         FOOTNOTE_LINK_RULE_NAME,
          BLOCK_LISTING_RULE_NAME,
          CONTENTS_LINK_RULE_NAME,
          CONTENTS_ITEM_RULE_NAME,
@@ -94,6 +103,7 @@ import { LINE_RULE_NAME,
          TABLE_BODY_CELL_RULE_NAME,
          EMPHASISED_TEXT_RULE_NAME,
          PRIMARY_HEADING_RULE_NAME,
+         INDEX_DIRECTIVE_RULE_NAME,
          EMBED_DIRECTIVE_RULE_NAME,
          EMPTY_TABLE_CELL_RULE_NAME,
          TERTIARY_HEADING_RULE_NAME,
@@ -112,7 +122,7 @@ import { LINE_RULE_NAME,
 
 const nodeMap = {
   [LINE_RULE_NAME]: LineMarkdownNode,
-  [LINK_RULE_NAME]: LinkMarkdownNode,
+  [COMMA_RULE_NAME]: CommaMarkdownNode,
   [IMAGE_RULE_NAME]: ImageMarkdownNode,
   [TABLE_RULE_NAME]: TableMarkdownNode,
   [ERROR_RULE_NAME]: ErrorMarkdownNode,
@@ -122,6 +132,9 @@ const nodeMap = {
   [REFERENCE_RULE_NAME]: ReferenceMarkdownNode,
   [PARAGRAPH_RULE_NAME]: ParagraphMarkdownNode,
   [HYPERLINK_RULE_NAME]: HyperlinkMarkdownNode,
+  [INDEX_LIST_RULE_NAME]: IndexListMarkdownNode,
+  [INDEX_ITEM_RULE_NAME]: IndexItemMarkdownNode,
+  [INDEX_LINK_RULE_NAME]: IndexLinkMarkdownNode,
   [TABLE_CELL_RULE_NAME]: TableCellMarkdownNode,
   [TABLE_HEAD_RULE_NAME]: TableHeadMarkdownNode,
   [TABLE_BODY_RULE_NAME]: TableBodyMarkdownNode,
@@ -139,6 +152,7 @@ const nodeMap = {
   [CONTENTS_LINK_RULE_NAME]: ContentsLinkMarkdownNode,
   [CONTENTS_ITEM_RULE_NAME]: ContentsItemMarkdownNode,
   [CONTENTS_LIST_RULE_NAME]: ContentsListMarkdownNode,
+  [FOOTNOTE_LINK_RULE_NAME]: FootnoteLinkMarkdownNode,
   [TABLE_HEAD_ROW_RULE_NAME]: TableHeadRowMarkdownNode,
   [TABLE_BODY_ROW_RULE_NAME]: TableBodyRowMarkdownNode,
   [INLINE_LISTING_RULE_NAME]: InlineListingMarkdownNode,
@@ -150,6 +164,7 @@ const nodeMap = {
   [TABLE_BODY_CELL_RULE_NAME]: TableBodyCellMarkdownNode,
   [EMPHASISED_TEXT_RULE_NAME]: EmphasisedTextMarkdownNode,
   [PRIMARY_HEADING_RULE_NAME]: PrimaryHeadingMarkdownNode,
+  [INDEX_DIRECTIVE_RULE_NAME]: IndexDirectiveMarkdownNode,
   [EMBED_DIRECTIVE_RULE_NAME]: EmbedDirectiveMarkdownNode,
   [EMPTY_TABLE_CELL_RULE_NAME]: EmptyTableCellMarkdownNode,
   [TERTIARY_HEADING_RULE_NAME]: TertiaryHeadingMarkdownNode,

package/src/prepends.js

@@ -0,0 +1,5 @@
+"use strict";
+
+export const INDEX_PREPEND = "index";
+export const CONTENTS_PREPEND = "contents";
+export const FOOTNOTE_PREPEND = "footnote";

package/src/replacement/contentsList.js

@@ -11,7 +11,7 @@ import { headingMarkdownNodesFromNode } from "../utilities/query";
 
 const { filter } = arrayUtilities;
 
-export default class ContentsListReplacement extends Replacement {
+class ContentsListReplacement extends Replacement {
   replaceContentsDirectiveSubdivisionReplacement(contentsDirectiveSubDivisionReplacement, divisionMarkdownNode, context) {
     const subDivisionMarkdownNode = contentsDirectiveSubDivisionReplacement.getSubDivisionMarkdownNode(),
           replacedNode = subDivisionMarkdownNode, ///
@@ -63,6 +63,8 @@ Object.assign(ContentsItemReplacement, {  ///
   ContentsListReplacement
 });
 
+export default ContentsListReplacement;
+
 function nestedHeadingMarkdownNodesFromHeadingMarkdownNodes(headingMarkdownNodes) {
   const nodes = headingMarkdownNodes, ///
         nestedNode = nestNodes(nodes),

package/src/replacement/footnotesList.js

@@ -4,13 +4,15 @@ import Replacement from "../replacement";
 import FootnotesItemReplacement from "../replacement/footnotesItem";
 import FootnotesListMarkdownNode from "../node/markdown/footnotesList";
 
-import { linkMarkdownNodesFromNode } from "../utilities/query";
+import { footnoteLinkMarkdownNodesFromNode } from "../utilities/query";
 
 export default class FootnotesListReplacement extends Replacement {
-  appendToDivisionMarkdownNode(divisionMarkdownNode, context) {
-    const parentNode = divisionMarkdownNode; ///
+  replaceFootnotesDirectiveSubDivisionReplacement(footnotesDirectiveSubDivisionReplacement, divisionMarkdownNode, context) {
+    const subDivisionMarkdownNode = footnotesDirectiveSubDivisionReplacement.getSubDivisionMarkdownNode(),
+          replacedNode = subDivisionMarkdownNode, ///
+          parentNode = divisionMarkdownNode;  ///
 
-    super.appendTo(parentNode, context);
+    super.replace(replacedNode, parentNode, context)
   }
 
   static fromDivisionMarkdownNodeAndFootnoteReplacementMap(divisionMarkdownNode, footnoteReplacementMap, context) {
@@ -18,13 +20,13 @@ export default class FootnotesListReplacement extends Replacement {
 
     const node = divisionMarkdownNode,  ///
           start = startFromFootnoteReplacementMap(footnoteReplacementMap),
-          linkMarkdownNodes = linkMarkdownNodesFromNode(node),
+          footnoteLinkMarkdownNodes = footnoteLinkMarkdownNodesFromNode(node),
           footnotesItemReplacements = [];
 
     let number = start;
 
-    linkMarkdownNodes.forEach((linkMarkdownNode) => {
-      const identifier = linkMarkdownNode.identifier(context),
+    footnoteLinkMarkdownNodes.forEach((footnoteLinkMarkdownNode) => {
+      const identifier = footnoteLinkMarkdownNode.identifier(context),
             footnoteReplacement = footnoteReplacementMap[identifier] || null;
 
       if (footnoteReplacement !== null) {

package/src/replacement/indexItem.js

@@ -0,0 +1,28 @@
+"use strict";
+
+import Replacement from "../replacement";
+
+import { COMMA } from "../constants";
+import { INDEX_ITEM_RULE_NAME } from "../ruleNames";
+
+export default class IndexItemReplacement extends Replacement {
+  getIndexItemMarkdownNode() {
+    const node = this.getNode(),
+          indexItemMarkdownNode = node; ///
+
+    return indexItemMarkdownNode;
+  }
+
+  static fromEntryAndPageNumbers(entry, pageNumbers, context) {
+    const { tokensFromContent, nodeFromTokensAndStartRuleName } = context,
+          entryContent = entry, ///
+          pageNumbersContent = pageNumbers.join(COMMA),
+          content = `${entryContent} ${pageNumbersContent}`,
+          startRuleName = INDEX_ITEM_RULE_NAME,
+          tokens = tokensFromContent(content),
+          node = nodeFromTokensAndStartRuleName(tokens, startRuleName),
+          indexItemReplacement = Replacement.fromNodeAndTokens(IndexItemReplacement, node, tokens);
+
+    return indexItemReplacement;
+  }
+}

package/src/replacement/indexList.js

@@ -0,0 +1,45 @@
+"use strict";
+
+import Replacement from "../replacement";
+
+import IndexItemReplacement from "../replacement/indexItem";
+import IndexListMarkdownNode from "../node/markdown/indexList";
+
+import { indexMapFromDivisionMarkdownNodes } from "../utilities/index";
+
+export default class IndexListReplacement extends Replacement {
+  replaceIndexDirectiveSubdivisionReplacement(indexDirectiveSubDivisionReplacement, divisionMarkdownNode, context) {
+    const subDivisionMarkdownNode = indexDirectiveSubDivisionReplacement.getSubDivisionMarkdownNode(),
+          replacedNode = subDivisionMarkdownNode, ///
+          parentNode = divisionMarkdownNode;  ///
+
+    super.replace(replacedNode, parentNode, context)
+  }
+
+  static fromDivisionMarkdownNodesAndDivisionMarkdownNode(divisionMarkdownNodes, divisionMarkdownNode, context) {
+    let indexListReplacement = null;
+
+    const indexMap = indexMapFromDivisionMarkdownNodes(divisionMarkdownNodes, context),
+          entries = Object.keys(indexMap), ///
+          indexItemReplacements = entries.map((entry) => {
+            const pageNumbers = indexMap[entry],
+                  indexItemReplacement = IndexItemReplacement.fromEntryAndPageNumbers(entry, pageNumbers, context);
+
+            return indexItemReplacement;
+          }),
+          indexListMarkdownNode = IndexListMarkdownNode.fromIndexItemReplacements(indexItemReplacements);
+
+    if (indexListMarkdownNode !== null) {
+      const node = indexListMarkdownNode, ///
+            tokens = [];
+
+      indexItemReplacements.forEach((indexItemReplacement) => {
+        indexItemReplacement.getTokens(tokens);
+      });
+
+      indexListReplacement = Replacement.fromNodeAndTokens(IndexListReplacement, node, tokens);
+    }
+
+    return indexListReplacement;
+  }
+}

package/src/replacement/subDivision/footnotesDirective.js

@@ -5,12 +5,6 @@ import SubDivisionReplacement from "../../replacement/subDivision";
 import { footnotesDirectiveMarkdownNodeFromNode } from "../../utilities/query";
 
 export default class FootnotesDirectiveSubDivisionReplacement extends SubDivisionReplacement {
-  appendToDivisionMarkdownNode(divisionMarkdownNode, context) {
-    const parentNode = divisionMarkdownNode;  ///
-
-    super.appendTo(parentNode, context);
-  }
-
   static fromSubDivisionMarkdownNode(subDivisionMarkdownNode, context) {
     let footnotesDirectiveSubDivisionReplacement = null;
 

package/src/replacement/subDivision/indexAnchor.js

@@ -0,0 +1,20 @@
+"use strict";
+
+import SubDivisionReplacement from "../../replacement/subDivision";
+
+import AnchorMarkdownNode from "../../node/markdown/anchor";
+import SubDivisionMarkdownNode from "../../node/markdown/subDivision";
+
+import { INDEX_PREPEND } from "../../prepends";
+
+export default class IndexAnchorSubDivisionReplacement extends SubDivisionReplacement {
+  static fromPageNumber(pageNumber, context) {
+    const prepend = INDEX_PREPEND,
+          identifier = pageNumber,  ///
+          anchorMarkdownNode = AnchorMarkdownNode.fromPrependAndIdentifier(prepend, identifier),
+          subDivisionMarkdownNode = SubDivisionMarkdownNode.fromAnchorMarkdownNode(anchorMarkdownNode),
+          indexAnchorSubdivisionReplacement = SubDivisionReplacement.fromSubDivisionMarkdownNode(IndexAnchorSubDivisionReplacement, subDivisionMarkdownNode, context);
+
+    return indexAnchorSubdivisionReplacement;
+  }
+}

package/src/replacement/subDivision/indexDirective.js

@@ -0,0 +1,20 @@
+"use strict";
+
+import SubDivisionReplacement from "../../replacement/subDivision";
+
+import { indexDirectiveMarkdownNodeFromNode } from "../../utilities/query";
+
+export default class IndexDirectiveSubDivisionReplacement extends SubDivisionReplacement {
+  static fromSubDivisionMarkdownNode(subDivisionMarkdownNode, context) {
+    let indexDirectiveSubDivisionReplacement = null;
+
+    const node = subDivisionMarkdownNode, ///
+          indexDirectiveMarkdownNode = indexDirectiveMarkdownNodeFromNode(node);
+
+    if (indexDirectiveMarkdownNode !== null) {
+      indexDirectiveSubDivisionReplacement = SubDivisionReplacement.fromSubDivisionMarkdownNode(IndexDirectiveSubDivisionReplacement, subDivisionMarkdownNode, context);
+    }
+
+    return indexDirectiveSubDivisionReplacement;
+  }
+}

package/src/replacement/subDivision/pageNumberDirective.js

@@ -5,12 +5,6 @@ import SubDivisionReplacement from "../../replacement/subDivision";
 import { pageNumberDirectiveMarkdownNodeFromNode } from "../../utilities/query";
 
 export default class PageNumberDirectiveSubDivisionReplacement extends SubDivisionReplacement {
-  appendToDivisionMarkdownNode(divisionMarkdownNode, context) {
-    const parentNode = divisionMarkdownNode;  ///
-
-    super.appendTo(parentNode, context);
-  }
-
   static fromSubDivisionMarkdownNode(subDivisionMarkdownNode, context) {
     let pageNumberDirectiveSubDivisionReplacement = null;
 

package/src/replacement/subDivision.js

@@ -13,6 +13,18 @@ export default class SubDivisionReplacement extends Replacement {
     return this.subDivisionMarkdownNode;
   }
 
+  appendToDivisionMarkdownNode(divisionMarkdownNode, context) {
+    const parentNode = divisionMarkdownNode;  ///
+
+    super.appendTo(parentNode, context);
+  }
+
+  prependToDivisionMarkdownNode(divisionMarkdownNode, context) {
+    const parentNode = divisionMarkdownNode;  ///
+
+    super.prependTo(parentNode, context);
+  }
+
   removeFromDivisionMarkdownNode(divisionMarkdownNode, context) {
     const removedNode = this.subDivisionMarkdownNode, ///
           parentNode = divisionMarkdownNode;

package/src/replacement.js

@@ -2,7 +2,19 @@
 
 import { arrayUtilities } from "necessary";
 
-import { removeNode, appendNode, removeTokens, appendTokens, replaceNode, replaceNodes, replaceTokens, addNodesAfter, addTokensAfter } from "./utilities/replacement";
+import { appendNode,
+         prependNode,
+         removeNode,
+         replaceNode,
+         replaceNodes,
+         addNodesAfter,
+         appendTokens,
+         prependTokens,
+         removeTokens,
+         replaceTokens,
+         addTokensAfter,
+         overwriteClonedNodeTokens,
+         clonedTokensFromNodeAndTokens, } from "./utilities/replacement";
 
 const { push } = arrayUtilities;
 
@@ -68,6 +80,16 @@ export default class Replacement {
     appendTokens(appendedTokens, parentNode, tokens);
   }
 
+  prependTo(parentNode, context) {
+    const { tokens } = context,
+          prependedNode = this.node,  ///
+          prependedTokens = this.tokens;  ///
+
+    prependNode(prependedNode, parentNode);
+
+    prependTokens(prependedTokens, parentNode, tokens);
+  }
+
   addAfter(existingNode, parentNode, context) {
     const { tokens } = context,
           addedNodes = this.getChildNodes(), ///
@@ -108,12 +130,13 @@ export default class Replacement {
   }
 
   clone(...remainingArguments) {
-    const node = this.node.clone(),
-          clonedTokens = clonedTokensFromNodeAndTokens(node, this.tokens);
+    const clonedNode = this.node.clone(),
+          clonedTokens = clonedTokensFromNodeAndTokens(this.node, this.tokens);
 
-    overwriteNodeTokens(node, clonedTokens, this.tokens);
+    overwriteClonedNodeTokens(clonedNode, clonedTokens, this.tokens);
 
     const Class = this.constructor, ///
+          node = clonedNode,  ///
           tokens = clonedTokens, ///
           replacement = new Class(node, tokens, ...remainingArguments);
 
@@ -133,13 +156,22 @@ export default class Replacement {
 
     let { tokens } = context;
 
-    const clonedTokens = clonedTokensFromNodeAndTokens(node, tokens),
-          firstSignificantTokenIndex = node.getFirstSignificantTokenIndex(tokens),
-          offset = firstSignificantTokenIndex;  ///
+    const firstSignificantTokenIndex = node.getFirstSignificantTokenIndex(tokens),
+          clonedNode = node.clone();
 
-    node = node.clone();  ///
+    let clonedTokens;
+
+    if (firstSignificantTokenIndex === null) {
+      clonedTokens = [];
+    } else {
+      const offset = firstSignificantTokenIndex;  ///
+
+      clonedTokens = clonedTokensFromNodeAndTokens(node, tokens);
+
+      overwriteClonedNodeTokens(clonedNode, clonedTokens, tokens, offset);
+    }
 
-    overwriteNodeTokens(node, clonedTokens, tokens, offset);
+    node = clonedNode;  ///
 
     tokens = clonedTokens; ///
 
@@ -163,62 +195,3 @@ export default class Replacement {
   }
 }
 
-function overwriteNodeTokens(node, clonedTokens, tokens, offset = 0) {
-  const nodeTerminalNode = node.isTerminalNode();
-
-  if (nodeTerminalNode) {
-    const terminalNode = node;  ///
-
-    overwriteTerminalNodeTokens(terminalNode, clonedTokens, tokens, offset);
-  } else {
-    const nonTerminalNode = node;  ///
-
-    overwriteNonTerminalNodeTokens(nonTerminalNode, clonedTokens, tokens, offset);
-  }
-}
-
-function overwriteTerminalNodeTokens(terminalNode, clonedTokens, tokens, offset) {
-  let index,
-      significantToken;
-
-  significantToken = terminalNode.getSignificantToken();
-
-  if (significantToken !== null) {
-    index = tokens.indexOf(significantToken);
-
-    index -= offset;
-
-    const clonedToken = clonedTokens[index];
-
-    significantToken = clonedToken;  ///
-
-    terminalNode.setSignificantToken(significantToken);
-  }
-}
-
-function overwriteNonTerminalNodeTokens(nonTerminalNode, clonedTokens, tokens, offset) {
-  const childNodes = nonTerminalNode.getChildNodes();
-
-  childNodes.forEach((childNode) => {
-    const node = childNode; ///
-
-    overwriteNodeTokens(node, clonedTokens, tokens, offset);
-  });
-}
-
-function clonedTokensFromNodeAndTokens(node, tokens) {
-  const firstSignificantTokenIndex = node.getFirstSignificantTokenIndex(tokens),
-        lastSignificantTokenIndex = node.getLastSignificantTokenIndex(tokens),
-        start = firstSignificantTokenIndex,  ///
-        end = lastSignificantTokenIndex + 1;
-
-  tokens = tokens.slice(start, end);  ///
-
-  const clonedTokens = tokens.map((token) => {  ///
-    const clonedToken = token.clone();
-
-    return clonedToken;
-  });
-
-  return clonedTokens;
-}

package/src/ruleNames.js

@@ -1,7 +1,7 @@
 "use strict";
 
 export const LINE_RULE_NAME = "line";
-export const LINK_RULE_NAME = "link";
+export const COMMA_RULE_NAME = "comma";
 export const IMAGE_RULE_NAME = "image";
 export const TABLE_RULE_NAME = "table";
 export const ERROR_RULE_NAME = "error";
@@ -11,6 +11,9 @@ export const FOOTNOTE_RULE_NAME = "footnote";
 export const REFERENCE_RULE_NAME = "reference";
 export const PARAGRAPH_RULE_NAME = "paragraph";
 export const HYPERLINK_RULE_NAME = "hyperlink";
+export const INDEX_LIST_RULE_NAME = "indexList";
+export const INDEX_ITEM_RULE_NAME = "indexItem";
+export const INDEX_LINK_RULE_NAME = "indexLink";
 export const TABLE_CELL_RULE_NAME = "tableCell";
 export const TABLE_HEAD_RULE_NAME = "tableHead";
 export const TABLE_BODY_RULE_NAME = "tableBody";
@@ -28,6 +31,7 @@ export const BLOCK_LISTING_RULE_NAME = "blockListing";
 export const CONTENTS_LINK_RULE_NAME = "contentsLink";
 export const CONTENTS_ITEM_RULE_NAME = "contentsItem";
 export const CONTENTS_LIST_RULE_NAME = "contentsList";
+export const FOOTNOTE_LINK_RULE_NAME = "footnoteLink";
 export const FOOTNOTES_ITEM_RULE_NAME = "footnotesItem";
 export const TABLE_HEAD_ROW_RULE_NAME = "tableHeadRow";
 export const TABLE_BODY_ROW_RULE_NAME = "tableBodyRow";
@@ -39,6 +43,7 @@ export const TABLE_HEAD_CELL_RULE_NAME = "tableHeadCell";
 export const TABLE_BODY_CELL_RULE_NAME = "tableBodyCell";
 export const EMPHASISED_TEXT_RULE_NAME = "emphasisedText";
 export const PRIMARY_HEADING_RULE_NAME = "primaryHeading";
+export const INDEX_DIRECTIVE_RULE_NAME = "indexDirective";
 export const EMBED_DIRECTIVE_RULE_NAME = "embedDirective";
 export const EMPTY_TABLE_CELL_RULE_NAME = "emptyTableCell";
 export const TERTIARY_HEADING_RULE_NAME = "tertiaryHeading";
@@ -57,7 +62,7 @@ export const STRONGLY_EMPHASISED_TEXT_RULE_NAME = "stronglyEmphasisedText";
 
 const ruleNames = {
   LINE_RULE_NAME,
-  LINK_RULE_NAME,
+  COMMA_RULE_NAME,
   IMAGE_RULE_NAME,
   TABLE_RULE_NAME,
   ERROR_RULE_NAME,
@@ -67,6 +72,9 @@ const ruleNames = {
   REFERENCE_RULE_NAME,
   PARAGRAPH_RULE_NAME,
   HYPERLINK_RULE_NAME,
+  INDEX_LIST_RULE_NAME,
+  INDEX_ITEM_RULE_NAME,
+  INDEX_LINK_RULE_NAME,
   TABLE_CELL_RULE_NAME,
   TABLE_HEAD_RULE_NAME,
   TABLE_BODY_RULE_NAME,
@@ -84,6 +92,7 @@ const ruleNames = {
   CONTENTS_LINK_RULE_NAME,
   CONTENTS_ITEM_RULE_NAME,
   CONTENTS_LIST_RULE_NAME,
+  FOOTNOTE_LINK_RULE_NAME,
   FOOTNOTES_ITEM_RULE_NAME,
   TABLE_HEAD_ROW_RULE_NAME,
   TABLE_BODY_ROW_RULE_NAME,
@@ -95,6 +104,7 @@ const ruleNames = {
   TABLE_BODY_CELL_RULE_NAME,
   EMPHASISED_TEXT_RULE_NAME,
   PRIMARY_HEADING_RULE_NAME,
+  INDEX_DIRECTIVE_RULE_NAME,
   EMBED_DIRECTIVE_RULE_NAME,
   EMPTY_TABLE_CELL_RULE_NAME,
   TERTIARY_HEADING_RULE_NAME,

package/src/utilities/footnotes.js

@@ -1,25 +1,25 @@
 "use strict";
 
-import { linkMarkdownNodesFromNode } from "../utilities/query";
+import { footnoteLinkMarkdownNodesFromNode } from "../utilities/query";
 
-export function renumberLinkMarkdownNodes(divisionMarkdownNode, footnoteReplacementMap, callback, context) {
+export function renumberFootnoteLinkMarkdownNodes(divisionMarkdownNode, footnoteReplacementMap, callback, context) {
   const node = divisionMarkdownNode,  ///
-        linkMarkdownNodes = linkMarkdownNodesFromNode(node);
+        footnoteLinkMarkdownNodes = footnoteLinkMarkdownNodesFromNode(node);
 
-  linkMarkdownNodes.forEach((linkMarkdownNode) => {
-    const identifier = linkMarkdownNode.identifier(context),
+  footnoteLinkMarkdownNodes.forEach((footnoteLinkMarkdownNode) => {
+    const identifier = footnoteLinkMarkdownNode.identifier(context),
           footnoteReplacement = footnoteReplacementMap[identifier] || null;
 
     if (footnoteReplacement !== null) {
       const number = footnoteReplacement.getNumber();
 
-      linkMarkdownNode.setNumber(number);
+      footnoteLinkMarkdownNode.setNumber(number);
 
-      callback(linkMarkdownNode);
+      callback(footnoteLinkMarkdownNode);
     }
   });
 }
 
 export default {
-  renumberLinkMarkdownNodes
+  renumberFootnoteLinkMarkdownNodes
 };