Rename horizontalRule to thematicBreak

Closes GH-143.
Closes GH-148.
Related to syntax-tree/mdast#3.
Related to http://spec.commonmark.org/0.23/.

Author: wooorm

doc/remarksetting.7.md

@@ -185,7 +185,7 @@ The following constructs are not allowed:
     brackets, `<` and `>`);
 
 *   Lazy **Blockquote** continuation—lines not preceded by a closing angle
-    bracket (`>`)—for **List**s, **Code**, and **HorizontalRule**.
+    bracket (`>`)—for **List**s, **Code**, and **ThematicBreak**.
 
 The following document:
 

lib/parse.js

@@ -49,7 +49,7 @@ var CODE_INDENT_LENGTH = 4;
 var MIN_FENCE_COUNT = 3;
 var MAX_ATX_COUNT = 6;
 var MAX_LINE_HEADING_INDENT = 3;
-var HORIZONTAL_RULE_MARKER_COUNT = 3;
+var THEMATIC_BREAK_MARKER_COUNT = 3;
 var MIN_CLOSING_HTML_NEWLINE_COUNT = 2;
 var MIN_BREAK_LENGTH = 2;
 var MIN_TABLE_COLUMNS = 2;
@@ -186,7 +186,7 @@ var CDATA_END_LENGTH = CDATA_END.length;
  * Node types.
  */
 
-var T_HORIZONTAL_RULE = 'horizontalRule';
+var T_THEMATIC_BREAK = 'thematicBreak';
 var T_HTML = 'html';
 var T_YAML = 'yaml';
 var T_TABLE = 'table';
@@ -1388,14 +1388,14 @@ function tokenizeLineHeading(eat, value, silent) {
  * Tokenise a horizontal rule.
  *
  * @example
- *   tokenizeHorizontalRule(eat, '***');
+ *   tokenizeThematicBreak(eat, '***');
  *
  * @param {function(string)} eat - Eater.
  * @param {string} value - Rest of content.
  * @param {boolean?} [silent] - Whether this is a dry run.
- * @return {Node?|boolean} - `horizontalRule` node.
+ * @return {Node?|boolean} - `thematicBreak` node.
  */
-function tokenizeHorizontalRule(eat, value, silent) {
+function tokenizeThematicBreak(eat, value, silent) {
     var self = this;
     var index = -1;
     var length = value.length + 1;
@@ -1434,7 +1434,7 @@ function tokenizeHorizontalRule(eat, value, silent) {
         } else if (character === C_SPACE) {
             queue += character;
         } else if (
-            markerCount >= HORIZONTAL_RULE_MARKER_COUNT &&
+            markerCount >= THEMATIC_BREAK_MARKER_COUNT &&
             (!character || character === C_NEWLINE)
         ) {
             subvalue += queue;
@@ -1443,7 +1443,7 @@ function tokenizeHorizontalRule(eat, value, silent) {
                 return true;
             }
 
-            return eat(subvalue)(self.renderVoid(T_HORIZONTAL_RULE));
+            return eat(subvalue)(self.renderVoid(T_THEMATIC_BREAK));
         } else {
             return;
         }
@@ -1549,7 +1549,7 @@ function tokenizeBlockquote(eat, value, silent) {
                     tokenizers.fences.call(self, eat, rest, true) ||
                     tokenizers.heading.call(self, eat, rest, true) ||
                     tokenizers.lineHeading.call(self, eat, rest, true) ||
-                    tokenizers.horizontalRule.call(self, eat, rest, true) ||
+                    tokenizers.thematicBreak.call(self, eat, rest, true) ||
                     tokenizers.html.call(self, eat, rest, true) ||
                     tokenizers.list.call(self, eat, rest, true)
                 )
@@ -1820,7 +1820,7 @@ function tokenizeList(eat, value, silent) {
 
         if (currentMarker && RULE_MARKERS[currentMarker] === true) {
             if (
-                tokenizers.horizontalRule.call(self, eat, line, true)
+                tokenizers.thematicBreak.call(self, eat, line, true)
             ) {
                 break;
             }
@@ -1863,7 +1863,7 @@ function tokenizeList(eat, value, silent) {
 
             if (
                 !pedantic &&
-                tokenizers.horizontalRule.call(self, eat, line, true)
+                tokenizers.thematicBreak.call(self, eat, line, true)
             ) {
                 break;
             }
@@ -3322,7 +3322,7 @@ function tokenizeParagraph(eat, value, silent) {
         subvalue = value.slice(index + 1);
 
         if (
-            tokenizers.horizontalRule.call(self, eat, subvalue, true) ||
+            tokenizers.thematicBreak.call(self, eat, subvalue, true) ||
             tokenizers.heading.call(self, eat, subvalue, true) ||
             tokenizers.fences.call(self, eat, subvalue, true) ||
             tokenizers.blockquote.call(self, eat, subvalue, true) ||
@@ -3686,7 +3686,7 @@ function renderBlockquote(value, now) {
  * Create a void node.
  *
  * @example
- *   renderVoid('horizontalRule');
+ *   renderVoid('thematicBreak');
  *
  * @param {string} type - Node type.
  * @return {Object} - Node of type `type`.
@@ -6080,7 +6080,7 @@ Parser.prototype.blockTokenizers = {
     'fences': tokenizeFences,
     'heading': tokenizeHeading,
     'lineHeading': tokenizeLineHeading,
-    'horizontalRule': tokenizeHorizontalRule,
+    'thematicBreak': tokenizeThematicBreak,
     'blockquote': tokenizeBlockquote,
     'list': tokenizeList,
     'html': tokenizeHTML,
@@ -6101,7 +6101,7 @@ Parser.prototype.blockMethods = [
     'fences',
     'blockquote',
     'heading',
-    'horizontalRule',
+    'thematicBreak',
     'list',
     'lineHeading',
     'html',

lib/stringify.js

@@ -151,11 +151,11 @@ LIST_BULLETS[PLUS] = true;
  * Allowed horizontal-rule bullet characters.
  */
 
-var HORIZONTAL_RULE_BULLETS = {};
+var THEMATIC_BREAK_BULLETS = {};
 
-HORIZONTAL_RULE_BULLETS[ASTERISK] = true;
-HORIZONTAL_RULE_BULLETS[DASH] = true;
-HORIZONTAL_RULE_BULLETS[UNDERSCORE] = true;
+THEMATIC_BREAK_BULLETS[ASTERISK] = true;
+THEMATIC_BREAK_BULLETS[DASH] = true;
+THEMATIC_BREAK_BULLETS[UNDERSCORE] = true;
 
 /*
  * Allowed emphasis characters.
@@ -752,7 +752,7 @@ compilerPrototype.options = defaultOptions;
 var maps = {
     'entities': ENTITY_OPTIONS,
     'bullet': LIST_BULLETS,
-    'rule': HORIZONTAL_RULE_BULLETS,
+    'rule': THEMATIC_BREAK_BULLETS,
     'listItemIndent': LIST_ITEM_INDENTS,
     'emphasis': EMPHASIS_MARKERS,
     'strong': EMPHASIS_MARKERS,
@@ -1564,14 +1564,14 @@ compilerPrototype.html = function (node) {
  * @example
  *   var compiler = new Compiler();
  *
- *   compiler.horizontalRule({
- *     type: 'horizontalRule'
+ *   compiler.thematicBreak({
+ *     type: 'thematicBreak'
  *   });
  *   // '***'
  *
  * @return {string} - Markdown rule.
  */
-compilerPrototype.horizontalRule = function () {
+compilerPrototype.thematicBreak = function () {
     var options = this.options;
     var rule = repeat(options.rule, options.ruleRepetition);
 

man/remarksetting.7

@@ -210,7 +210,7 @@ Newlines in \fBLink\fR and \fBImage\fR titles;
 .IP \(bu 4
 White space in \fBLink\fR and \fBImage\fR URLs in auto-links (links in brackets, \fB<\fR and \fB>\fR);
 .IP \(bu 4
-Lazy \fBBlockquote\fR continuation\[em]lines not preceded by a closing angle bracket (\fB>\fR)\[em]for \fBList\fRs, \fBCode\fR, and \fBHorizontalRule\fR.
+Lazy \fBBlockquote\fR continuation\[em]lines not preceded by a closing angle bracket (\fB>\fR)\[em]for \fBList\fRs, \fBCode\fR, and \fBThematicBreak\fR.
 .RE 0
 
 .P

script/setting/parse-commonmark/description.md

@@ -29,4 +29,4 @@ The following constructs are not allowed:
     brackets, `<` and `>`);
 
 *   Lazy **Blockquote** continuation—lines not preceded by a closing angle
-    bracket (`>`)—for **List**s, **Code**, and **HorizontalRule**.
+    bracket (`>`)—for **List**s, **Code**, and **ThematicBreak**.

test/index.js

@@ -998,7 +998,7 @@ validateToken = function (context) {
         return;
     }
 
-    if (type === 'horizontalRule' || type === 'break') {
+    if (type === 'thematicBreak' || type === 'break') {
         assert(keys === 1);
 
         return;

test/tree/blockquote-lazy-rule.commonmark.json

@@ -55,7 +55,7 @@
       }
     },
     {
-      "type": "horizontalRule",
+      "type": "thematicBreak",
       "position": {
         "start": {
           "line": 2,

test/tree/blockquote-lazy-rule.json

@@ -40,7 +40,7 @@
           }
         },
         {
-          "type": "horizontalRule",
+          "type": "thematicBreak",
           "position": {
             "start": {
               "line": 2,

test/tree/def-blocks.commonmark.json

@@ -115,7 +115,7 @@
       }
     },
     {
-      "type": "horizontalRule",
+      "type": "thematicBreak",
       "position": {
         "start": {
           "line": 4,

test/tree/def-blocks.json

@@ -129,7 +129,7 @@
       }
     },
     {
-      "type": "horizontalRule",
+      "type": "thematicBreak",
       "position": {
         "start": {
           "line": 4,