Add support for passing a single preset or matter

remarkjs · Aug 1, 2017 · 9db1f5c · 9db1f5c
1 parent 3fc848b
commit 9db1f5c
Show file tree

Hide file tree

Showing 8 changed files with 166 additions and 3 deletions.
diff --git a/lib/matters.js b/lib/matters.js
@@ -13,8 +13,15 @@ var markers = {
 
 function matters(options) {
   var results = [];
-  var length = options.length;
   var index = -1;
+  var length;
+
+  /* One preset or matter. */
+  if (typeof options === 'string' || !('length' in options)) {
+    options = [options];
+  }
+
+  length = options.length;
 
   while (++index < length) {
     results[index] = matter(options[index]);

diff --git a/readme.md b/readme.md
@@ -84,8 +84,8 @@ If you are parsing from a different syntax, or compiling to a different syntax
 
 ###### `options`
 
-An optional configuration array defining all the supported frontmatters
-(`Array.<preset|Matter>?`, default: `['yaml']`).
+One [`preset`][preset] or [`Matter`][matter], or an array of them, defining all
+the supported frontmatters (default: `'yaml'`).
 
 ###### `preset`
 
@@ -148,6 +148,8 @@ An object with a `type` and a `marker`:
 
 [mdast]: https://github.com/syntax-tree/mdast
 
+[preset]: #preset
+
 [matter]: #matter
 
 [man]: https://github.com/wooorm/remark-man
diff --git a/test/fixtures/config-options-as-matter/config.json b/test/fixtures/config-options-as-matter/config.json
@@ -0,0 +1 @@
+{"type": "jsonml", "marker": "*"}
diff --git a/test/fixtures/config-options-as-matter/input.md b/test/fixtures/config-options-as-matter/input.md
@@ -0,0 +1,4 @@
+***
+***
+
+# Empty
diff --git a/test/fixtures/config-options-as-matter/tree.json b/test/fixtures/config-options-as-matter/tree.json
@@ -0,0 +1,72 @@
+{
+  "type": "root",
+  "children": [
+    {
+      "type": "jsonml",
+      "value": "",
+      "position": {
+        "start": {
+          "line": 1,
+          "column": 1,
+          "offset": 0
+        },
+        "end": {
+          "line": 2,
+          "column": 4,
+          "offset": 7
+        },
+        "indent": [
+          1
+        ]
+      }
+    },
+    {
+      "type": "heading",
+      "depth": 1,
+      "children": [
+        {
+          "type": "text",
+          "value": "Empty",
+          "position": {
+            "start": {
+              "line": 4,
+              "column": 3,
+              "offset": 11
+            },
+            "end": {
+              "line": 4,
+              "column": 8,
+              "offset": 16
+            },
+            "indent": []
+          }
+        }
+      ],
+      "position": {
+        "start": {
+          "line": 4,
+          "column": 1,
+          "offset": 9
+        },
+        "end": {
+          "line": 4,
+          "column": 8,
+          "offset": 16
+        },
+        "indent": []
+      }
+    }
+  ],
+  "position": {
+    "start": {
+      "line": 1,
+      "column": 1,
+      "offset": 0
+    },
+    "end": {
+      "line": 5,
+      "column": 1,
+      "offset": 17
+    }
+  }
+}
diff --git a/test/fixtures/config-options-as-string/config.json b/test/fixtures/config-options-as-string/config.json
@@ -0,0 +1 @@
+"yaml"
diff --git a/test/fixtures/config-options-as-string/input.md b/test/fixtures/config-options-as-string/input.md
@@ -0,0 +1,4 @@
+---
+---
+
+# Empty
diff --git a/test/fixtures/config-options-as-string/tree.json b/test/fixtures/config-options-as-string/tree.json
@@ -0,0 +1,72 @@
+{
+  "type": "root",
+  "children": [
+    {
+      "type": "yaml",
+      "value": "",
+      "position": {
+        "start": {
+          "line": 1,
+          "column": 1,
+          "offset": 0
+        },
+        "end": {
+          "line": 2,
+          "column": 4,
+          "offset": 7
+        },
+        "indent": [
+          1
+        ]
+      }
+    },
+    {
+      "type": "heading",
+      "depth": 1,
+      "children": [
+        {
+          "type": "text",
+          "value": "Empty",
+          "position": {
+            "start": {
+              "line": 4,
+              "column": 3,
+              "offset": 11
+            },
+            "end": {
+              "line": 4,
+              "column": 8,
+              "offset": 16
+            },
+            "indent": []
+          }
+        }
+      ],
+      "position": {
+        "start": {
+          "line": 4,
+          "column": 1,
+          "offset": 9
+        },
+        "end": {
+          "line": 4,
+          "column": 8,
+          "offset": 16
+        },
+        "indent": []
+      }
+    }
+  ],
+  "position": {
+    "start": {
+      "line": 1,
+      "column": 1,
+      "offset": 0
+    },
+    "end": {
+      "line": 5,
+      "column": 1,
+      "offset": 17
+    }
+  }
+}
-Original file line number
+Diff line change
@@ -0,0 +1,4 @@
+    ***
+    ***
+    # Empty