highmark-markdown 0.0.279 → 0.0.280

package/src/markdown/bnf.js

@@ -5,126 +5,135 @@ const bnf = `
     division                ::=  ( subDivision | endOfLine | error )+ ;
     
     
-    subDivision..           ::=  ( verticalSpace | <START_OF_CONTENT> ) ( directives 
-    
-                                                                        | primaryHeading 
-                                 
-                                                                        | secondaryHeading 
-                                                                           
-                                                                        | tertiaryHeading 
-                                                                           
-                                                                        | quaternaryHeading 
-                                                                           
-                                                                        | lineBreak 
-                                                                           
-                                                                        | footnote 
-                                                                           
-                                                                        | orderedList 
-                                                                           
-                                                                        | unorderedList 
-                                                                           
-                                                                        | blockListing 
-                                              
-                                                                        | table 
-                                                                           
-                                                                        | paragraph ) ;
-
-    
-    verticalSpace.          ::=  endOfLine+ ;
-
+    subDivision             ::=  verticalSpace ( directives 
+    
+                                               | primaryHeading 
+         
+                                               | secondaryHeading 
+                                                   
+                                               | tertiaryHeading 
+                                                   
+                                               | quaternaryHeading 
+                                                   
+                                               | table 
+                                                   
+                                               | footnote 
+                                                   
+                                               | orderedList 
+                                                   
+                                               | unorderedList 
+                                                   
+                                               | blockListing 
+                      
+                                               | paragraph ) ;
 
+    
     endOfLine.              ::=  <END_OF_LINE> ;
 
 
     error.                  ::=  . ;
 
 
-    primaryHeading          ::=  [single-hash] line ;
-
-
-    secondaryHeading        ::=  [double-hash] line ;
+    verticalSpace           ::=  <END_OF_LINE> <END_OF_LINE>+ 
+    
+                              |  <START_OF_CONTENT> <END_OF_LINE>*
+                              
+                              ;
 
 
-    tertiaryHeading         ::=  [triple-hash] line ;
+    directives              ::=  ( embedDirective 
     
+                                 | ignoreDirective 
     
-    quaternaryHeading       ::=  [quadruple-hash] line ;
+                                 | includeDirective 
+    
+                                 | contentsDirective 
+    
+                                 | footnotesDirective ) ( endOfLine ( embedDirective 
+    
+                                                                    | ignoreDirective 
+                                        
+                                                                    | includeDirective 
+                                        
+                                                                    | contentsDirective 
+                                        
+                                                                    | footnotesDirective ) )* ;
 
 
-    lineBreak               ::=  [two-dashes] endOfLine ;
+    primaryHeading          ::=  "#" markedText ;
 
 
-    footnotesList           ::=  footnoteItem+ ;
+    secondaryHeading        ::=  "##" markedText ;
 
 
-    footnoteItem            ::=  anchor paragraph ;
+    tertiaryHeading         ::=  "###" markedText ;
+    
+    
+    quaternaryHeading       ::=  "####" markedText ;
 
 
-    footnote                ::=  reference paragraph ;
+    table                   ::=  tableHead <END_OF_LINE> [dashes] <END_OF_LINE> tableBody ;
 
 
-    table                   ::=  tableHead tableSeparator tableBody ;
+    footnote                ::=  [reference] paragraph ;
 
 
-    paragraph               ::=  line+ ;
-    
+    orderedList             ::=  orderedListItem ( <END_OF_LINE> orderedListItem )* ;
 
-    orderedList             ::=  orderedListItem+ ;
 
+    unorderedList           ::=  unorderedListItem ( <END_OF_LINE> unorderedListItem )* ;
 
-    unorderedList           ::=  unorderedListItem+ ;
 
+    blockListing            ::=  blockListingStart <END_OF_LINE> blockText <END_OF_LINE> blockListingEnd ;
 
-    blockListing            ::=  blockListingStart blockText blockListingEnd ;
 
+    paragraph               ::=  markedText ( <END_OF_LINE> markedText )* ;
+    
 
-    directives              ::=  ( embed | ignore | include | contents | footnotes )+ ;
+    embedDirective          ::=  "@"<NO_WHITESPACE>"embed" [path] ;
 
 
-    embed                   ::=  "@"<NO_WHITESPACE>"embed" [path] endOfLine ;
+    ignoreDirective         ::=  "@"<NO_WHITESPACE>"ignore" ;
 
 
-    ignore                  ::=  "@"<NO_WHITESPACE>"ignore" ;
+    includeDirective        ::=  "@"<NO_WHITESPACE>"include" [path] ;
 
 
-    include                 ::=  "@"<NO_WHITESPACE>"include" [path] endOfLine ;
+    contentsDirective       ::=  "@"<NO_WHITESPACE>"contents" [number]? ;
 
 
-    contents                ::=  "@"<NO_WHITESPACE>"contents" [number]? endOfLine ;
+    footnotesDirective      ::=  "@"<NO_WHITESPACE>"footnotes" ;
 
 
-    footnotes               ::=  "@"<NO_WHITESPACE>"footnotes" endOfLine ;
+    footnotesList           ::=  footnoteItem+ ;
 
 
-    tableHead               ::=  tableHeadRow ;
+    footnoteItem            ::=  anchor paragraph ;
 
-    
-    tableBody               ::=  tableBodyRow+ ;
+
+    tableHead               ::=  tableHeadRow ;
 
     
-    tableSeparator          ::=  [many-dashes] endOfLine ;
+    tableBody               ::=  tableBodyRow ;
 
     
-    orderedListItem.        ::=  marker line ;
+    orderedListItem         ::=  [marker] markedText ( <END_OF_LINE> markedText )* ;
     
     
-    unorderedListItem       ::=  bullet line ;
+    unorderedListItem       ::=  [bullet] markedText ( <END_OF_LINE> markedText )* ;
 
 
-    blockListingStart       ::=  [backticks] className? endOfLine ;
+    blockListingStart       ::=  [backticks] className? ;
 
 
-    blockListingEnd         ::=  [backticks] endOfLine ;
+    blockListingEnd         ::=  [backticks] ;
 
 
-    tableHeadRow            ::=  [vertical-bar] tableHeadCell+ endOfLine ;
+    tableHeadRow            ::=  [vertical-bar] tableHeadCell+ ;
 
     
-    tableBodyRow            ::=  [vertical-bar] tableBodyCell+ endOfLine ;
-
+    tableBodyRow            ::=  [vertical-bar] tableBodyCell+ ;
 
-    blockText.              ::=  ( plainText | endOfLine )+ ;
-    
 
     tableHeadCell           ::=  emptyTableCell | tableCell ;
 
@@ -138,17 +147,14 @@ const bnf = `
     tableCell.              ::=  markedText... [vertical-bar] ;
     
     
-    line.                   ::=  markedText endOfLine ;
-
-
     markedText              ::=  ( link 
     
-                                 | image 
-                                 
                                  | emailLink 
                                  
                                  | hyperlink 
                                  
+                                 | image 
+                                 
                                  | inlineListing 
                                  
                                  | stronglyEmphasisedText 
@@ -163,9 +169,6 @@ const bnf = `
     link.                   ::=  "[^" [identifier] "]" ;
     
 
-    image.                  ::=  "![" inlineText... "]"<NO_WHITESPACE>"(" [path] ")" ;
-
-
     emailLink.              ::=  "[" inlineText... "]"<NO_WHITESPACE>"(" [email-address] ")" 
     
                               |  [email-address] 
@@ -180,53 +183,49 @@ const bnf = `
                               ;
 
 
+    image.                  ::=  "![" inlineText... "]"<NO_WHITESPACE>"(" [path] ")" ;
+
+
     inlineListing           ::=  [backticked-literal] ;
     
 
-    stronglyEmphasisedText  ::=  [triple-asterisk] inlineText... [triple-asterisk] ;
+    stronglyEmphasisedText  ::=  "****" inlineText "****" ;
     
 
-    emphasisedText          ::=  [single-asterisk] inlineText... [single-asterisk] ;
+    emphasisedText          ::=  "**" inlineText "**" ;
 
 
-    strongText              ::=  [double-asterisk] inlineText... [double-asterisk] ;
+    strongText              ::=  "***" inlineText "***" ;
 
 
+    blockText.              ::=  ( plainText 
+                                
+                                 | [url] 
+
+                                 | [dashes] 
+    
+                                 | [vertical-bar] 
+    
+                                 | [email-address] )+ ( <END_OF_LINE> ( plainText 
+                                                                    
+                                                                      | [url] 
+
+                                                                      | [dashes] 
+
+                                                                      | [vertical-bar] 
+
+                                                                      | [email-address] )+ )* ;
+    
+
     inlineText              ::=  plainText+ ;
     
     
     plainText               ::=  [escaped] 
                               
-                              |  [triple-asterisk] 
-                              
-                              |  [double-asterisk] 
-                              
-                              |  [single-asterisk] 
-                              
-                              |  [quadruple-hash]
-                              
-                              |  [triple-hash]
-                              
-                              |  [double-hash]
-                              
-                              |  [single-hash]
-
-                              |  [single-dash] 
-                              
-                              |  [vertical-bar] 
-                              
-                              |  [many-dashes] 
-                              
-                              |  [two-dashes] 
-                              
                               |  [number] 
                               
                               |  [path] 
                               
-                              |  [domain] 
-                              
-                              |  [scheme] 
-                              
                               |  [identifier] 
                               
                               |  [word] 
@@ -238,21 +237,11 @@ const bnf = `
                               ;
     
 
-    reference.              ::=  "[^" [identifier] "]:" ;
-    
-
     anchor.                 ::=  [identifier] ;
     
 
-    marker.                 ::=  [number]<NO_WHITESPACE>"." ;
-
-
-    bullet.                 ::=  [single-dash] | [single-asterisk] ;
-
-
     className               ::=  <NO_WHITESPACE>[identifier] ;
       
 `;
 
 export default bnf;
-

package/src/markdown/entries.js

@@ -5,47 +5,32 @@ const entries = [
     "escaped": "^\\\\[^\\s]"
   },
   {
-    "triple-asterisk": "^\\*\\*\\*"
+    "asterisks": "^\\*{2,4}"
   },
   {
-    "double-asterisk": "^\\*\\*"
+    "hashes": "^#{1,4}"
   },
   {
-    "single-asterisk": "^\\*"
+    "dashes": "^-{3,}"
   },
   {
-    "quadruple-hash": "^####"
+    "bullet": "^(?:-|\\*)"
   },
   {
-    "triple-hash": "^###"
+    "marker": "^[1-9][0-9]*\\."
   },
   {
-    "double-hash": "^##"
-  },
-  {
-    "single-hash": "^#"
-  },
-  {
-    "many-dashes": "^-{3,}"
-  },
-  {
-    "two-dashes": "^--"
+    "number": "^[1-9][0-9]*"
   },
   {
-    "single-dash": "^-"
+    "backticks": "^```"
   },
   {
     "vertical-bar": "^\\|"
   },
-  {
-    "backticks": "^```"
-  },
   {
     "backticked-literal": "^`(?:\\\\[^\\s]|[^`\\\\\\r\\n])*`"
   },
-  {
-    "number": "^[1-9][0-9]*"
-  },
   {
     "email-address": "^[a-z0-9\\-_]+(?:\\.[a-z0-9\\-_]+)*@[a-z0-9\\-_]+(?:\\.[a-z0-9\\-_]+)+"
   },
@@ -55,6 +40,9 @@ const entries = [
   {
     "path": "^[a-z0-9\\-_]+(?:\\/[a-z0-9\\-_]+)*\\.[a-z0-9\\-_]+"
   },
+  {
+    "reference": "\\[\\^[a-z]+(?:-[a-z]+)*\\]:"
+  },
   {
     "identifier": "[a-z]+(?:-[a-z]+)*"
   },

package/src/node/markdown/{contents.js → directive/contents.js}

@@ -2,11 +2,11 @@
 
 import { arrayUtilities } from "necessary";
 
-import MarkdownNode from "../../node/markdown";
+import MarkdownNode from "../../../node/markdown";
 
 const { fourth } = arrayUtilities;
 
-export default class ContentsMarkdownNode extends MarkdownNode {
+export default class ContentsDirectiveMarkdownNode extends MarkdownNode {
   asHTML(indent, context) {
     const html = null;
 
@@ -45,5 +45,5 @@ export default class ContentsMarkdownNode extends MarkdownNode {
     return minimumPosition;
   }
 
-  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(ContentsMarkdownNode, ruleName, childNodes, opacity); }
+  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(ContentsDirectiveMarkdownNode, ruleName, childNodes, opacity); }
 }

package/src/node/markdown/{embee.js → directive/embee.js}

@@ -2,12 +2,12 @@
 
 import { arrayUtilities } from "necessary";
 
-import MarkdownNode from "../../node/markdown";
-import ReplacementNodeAndTokens from "../../replacementNodeAndTokens";
+import MarkdownNode from "../../../node/markdown";
+import ReplacementNodeAndTokens from "../../../replacementNodeAndTokens";
 
 const { fourth } = arrayUtilities;
 
-export default class EmbedMarkdownNode extends MarkdownNode {
+export default class EmbedDirectiveMarkdownNode extends MarkdownNode {
   replacementNodeAndTokens(context) {
     let replacementNodeAndTokens = null;
 
@@ -46,5 +46,5 @@ export default class EmbedMarkdownNode extends MarkdownNode {
     return filePath;
   }
 
-  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(EmbedMarkdownNode, ruleName, childNodes, opacity); }
+  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(EmbedDirectiveMarkdownNode, ruleName, childNodes, opacity); }
 }

package/src/node/markdown/{footnotes.js → directive/footnotes.js}

@@ -1,8 +1,8 @@
 "use strict";
 
-import MarkdownNode from "../../node/markdown";
+import MarkdownNode from "../../../node/markdown";
 
-export default class FootnotesMarkdownNode extends MarkdownNode {
+export default class FootnotesDirectiveMarkdownNode extends MarkdownNode {
   asHTML(indent, context) {
     const html = null;
 
@@ -15,5 +15,5 @@ export default class FootnotesMarkdownNode extends MarkdownNode {
     return domElement;
   }
 
-  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(FootnotesMarkdownNode, ruleName, childNodes, opacity); }
+  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(FootnotesDirectiveMarkdownNode, ruleName, childNodes, opacity); }
 }

package/src/node/markdown/directive/ignore.js

@@ -0,0 +1,7 @@
+"use strict";
+
+import MarkdownNode from "../../../node/markdown";
+
+export default class IgnoreDirectiveMarkdownNode extends MarkdownNode {
+  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(IgnoreDirectiveMarkdownNode, ruleName, childNodes, opacity); }
+}

package/src/node/markdown/{include.js → directive/include.js}

@@ -2,11 +2,11 @@
 
 import { arrayUtilities } from "necessary";
 
-import MarkdownNode from "../../node/markdown";
+import MarkdownNode from "../../../node/markdown";
 
 const { push, fourth } = arrayUtilities;
 
-export default class IncludeMarkdownNode extends MarkdownNode {
+export default class IncludeDirectiveMarkdownNode extends MarkdownNode {
   resolveIncludes(context) {
     let html = null;
 
@@ -56,5 +56,5 @@ export default class IncludeMarkdownNode extends MarkdownNode {
     return filePath;
   }
 
-  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(IncludeMarkdownNode, ruleName, childNodes, opacity); }
+  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(IncludeDirectiveMarkdownNode, ruleName, childNodes, opacity); }
 }

package/src/node/markdown/directives.js

@@ -4,8 +4,7 @@ import MarkdownNode from "../../node/markdown";
 
 export default class DirectivesMarkdownNode extends MarkdownNode {
   asHTML(indent, context) {
-    const childNodesHTML = this.childNodesAsHTML(indent, context),
-          html = childNodesHTML;  ///
+    const html = null;
 
     return html;
   }

package/src/node/markdown/division.js

@@ -6,14 +6,14 @@ import MarkdownNode from "../../node/markdown";
 import ContentsListMarkdownNode from "../../node/markdown/contentsList";
 import FootnotesListMarkdownNode from "../../node/markdown/footnotesList";
 
+import { EMPTY_STRING } from "../../constants";
 import { renumberLinkMarkdownNodes } from "../../utilities/footnotes";
 import { replaceNode, replaceNodes, replaceTokens } from "../../utilities/replace";
-import { embedMarkdownNodesFromNode,
-         ignoreMarkdownNodeFromNode,
-         headingMarkdownNodesFromNode,
-         contentsMarkdownNodeFromNode,
-         footnotesMarkdownNodesFromNode } from "../../utilities/query";
-import {EMPTY_STRING} from "../../constants";
+import { headingMarkdownNodesFromNode,
+         embedDirectiveMarkdownNodesFromNode,
+         ignoreDirectiveMarkdownNodeFromNode,
+         contentsDirectiveMarkdownNodeFromNode,
+         footnotesDirectiveMarkdownNodeFromNode } from "../../utilities/query";
 
 const { filter } = arrayUtilities;
 
@@ -40,8 +40,8 @@ export default class DivisionMarkdownNode extends MarkdownNode {
 
   isIgnored() {
     const node = this,
-          ignoreMarkdownNode = ignoreMarkdownNodeFromNode(node),
-          ignored = (ignoreMarkdownNode !== null);
+          ignoreDirectiveMarkdownNode = ignoreDirectiveMarkdownNodeFromNode(node),
+          ignored = (ignoreDirectiveMarkdownNode !== null);
 
     return ignored;
   }
@@ -78,11 +78,11 @@ export default class DivisionMarkdownNode extends MarkdownNode {
     let contentsCreated = false;
 
     const node = this,  ///
-          contentsMarkdownNode = contentsMarkdownNodeFromNode(node);
+          contentsDirectiveMarkdownNode = contentsDirectiveMarkdownNodeFromNode(node);
 
-    if (contentsMarkdownNode !== null) {
+    if (contentsDirectiveMarkdownNode !== null) {
       const divisionMarkdownNode = this,  ///
-            headingMarkdownNodes = headingMarkdownNodesFromDivisionMarkdownNodeAndContentsMarkdownNode(divisionMarkdownNode, contentsMarkdownNode, context),
+            headingMarkdownNodes = headingMarkdownNodesFromDivisionMarkdownNodeAndContentsDirectiveMarkdownNode(divisionMarkdownNode, contentsDirectiveMarkdownNode, context),
             headingMarkdownNodesLength = headingMarkdownNodes.length;
 
       if (headingMarkdownNodesLength === 0) {
@@ -92,9 +92,9 @@ export default class DivisionMarkdownNode extends MarkdownNode {
       const { tokens } = context,
             contentsListMarkdownNode = ContentsListMarkdownNode.fromHeadingMarkdownNodes(headingMarkdownNodes, context),
             contentsListMarkdownNodeTokens = contentsListMarkdownNode.getTokens(),
-            childNode = contentsMarkdownNode,  ///
+            childNode = contentsDirectiveMarkdownNode,  ///
             parentNode = this.findParentNode(childNode),
-            replacedNode = contentsMarkdownNode, ///
+            replacedNode = contentsDirectiveMarkdownNode, ///
             replacementNode = contentsListMarkdownNode,  ///
             replacementTokens = contentsListMarkdownNodeTokens; ///
 
@@ -110,10 +110,9 @@ export default class DivisionMarkdownNode extends MarkdownNode {
 
   createFootnotes(context) {
     const node = this,  ///
-          footnotesMarkdownNodes = footnotesMarkdownNodesFromNode(node),
-          footnotesMarkdownNodesLength = footnotesMarkdownNodes.length;
+          footnotesDirectiveMarkdownNode = footnotesDirectiveMarkdownNodeFromNode(node);
 
-    if (footnotesMarkdownNodesLength > 0) {
+    if (footnotesDirectiveMarkdownNode !== null) {
       const divisionMarkdownNode = this,  ///
             footnotesListMarkdownNode = FootnotesListMarkdownNode.fromDivisionMarkdownNode(divisionMarkdownNode, context);
 
@@ -129,10 +128,10 @@ export default class DivisionMarkdownNode extends MarkdownNode {
 
   resolveEmbeddings(context) {
     const node = this,  ///
-          embedMarkdownNodes = embedMarkdownNodesFromNode(node);
+          embedDirectiveMarkdownNodes = embedDirectiveMarkdownNodesFromNode(node);
 
-    embedMarkdownNodes.map((embedMarkdownNode) => {
-      const replacementNodeAndTokens = embedMarkdownNode.replacementNodeAndTokens(context);
+    embedDirectiveMarkdownNodes.map((embedDirectiveMarkdownNode) => {
+      const replacementNodeAndTokens = embedDirectiveMarkdownNode.replacementNodeAndTokens(context);
 
       if (replacementNodeAndTokens !== null) {
         let tokens;
@@ -145,9 +144,9 @@ export default class DivisionMarkdownNode extends MarkdownNode {
 
         ({ tokens } = context);
 
-        const childNode = embedMarkdownNode,  ///
+        const childNode = embedDirectiveMarkdownNode,  ///
               parentNode = this.findParentNode(childNode),
-              replacedNode = embedMarkdownNode; ///
+              replacedNode = embedDirectiveMarkdownNode; ///
 
         replaceNodes(replacementNodes, replacedNode, parentNode);
 
@@ -197,10 +196,10 @@ ${childNodesHTML}${indent}${closingTag}
   }
 }
 
-function headingMarkdownNodesFromDivisionMarkdownNodeAndContentsMarkdownNode(divisionMarkdownNode, contentsMarkdownNode, context) {
+function headingMarkdownNodesFromDivisionMarkdownNodeAndContentsDirectiveMarkdownNode(divisionMarkdownNode, contentsDirectiveMarkdownNode, context) {
   const headingMarkdownNodes = [],
-        minimumPosition = contentsMarkdownNode.minimumPosition(context),
-        maximumLevel = contentsMarkdownNode.maximumLevel(context),
+        minimumPosition = contentsDirectiveMarkdownNode.minimumPosition(context),
+        maximumLevel = contentsDirectiveMarkdownNode.maximumLevel(context),
         node = divisionMarkdownNode;  ///
 
   headingMarkdownNodesFromNode(node, headingMarkdownNodes);

package/src/node/markdown/error.js

@@ -4,9 +4,37 @@ import MarkdownNode from "../../node/markdown";
 import contentMixins from "../../mixins/content";
 
 class ErrorMarkdownNode extends MarkdownNode {
+  asHTML(indent, context) {
+    indent = this.adjustIndent(indent);
+
+    const childNodesHTML = this.childNodesAsHTML(indent, context),
+          startingTag = this.startingTag(context),
+          closingTag = this.closingTag(context),
+          html = `${indent}${startingTag}${childNodesHTML}${closingTag}
+`;
+
+    return html;
+  }
+
+  createDOMElement(context) {
+    const tagName = this.tagName(context),
+        className = this.className(context),
+        domElement = document.createElement(tagName);
+
+    Object.assign(domElement, {
+      className
+    });
+
+    this.setDOMElement(domElement);
+
+    this.createChildNodeDOMElements(context);
+
+    return domElement;
+  }
+
   childNodesAsHTML(indent, context) {
     const content = this.content(context),
-          childNodesHTML = content;  ///
+          childNodesHTML = content;
 
     return childNodesHTML;
   }