Merge branch 'master' of https://github.com/younho9/json2md into new-version

Author: IonicaBizau

DOCUMENTATION.md

@@ -20,6 +20,7 @@ Converts a JSON input to markdown.
 | `img`        | Image              | An object or an array of objects containing the `title`, `source` and `alt`  fields.                                     | `{ img: { title: "My image title", source: "http://example.com/image.png", alt: "My image alt" } }`                                              |
 | `ul`         | Unordered list     | An array of strings or lists representing the items.                                                                     | `{ ul: ["item 1", "item 2"] }`                                                                                                                   |
 | `ol`         | Ordered list       | An array of strings or lists representing the items.                                                                     | `{ ol: ["item 1", "item 2"] }`                                                                                                                   |
+| `taskLists`  | Task list          | An array of strings or array of task objects or lists representing the items.                                            | `{ taskLists: [{ title: "item 1" }, { title: "item 2", isDone: true }, "item 3"]`                                                                |
 | `hr`         | Separator          | None                                                                                                                     | `{ hr: "" }`                                                                                                                                     |
 | `code`       | Code block element | An object containing the `language` (`String`) and `content` (`Array` or `String`)  fields.                              | `{ code: { "language": "html", "content": "<script src='dummy.js'></script>" } }`                                                                |
 | `table`      | Table              | An object containing the `headers` (`Array` of `String`s) and `rows` (`Array` of `Array`s or `Object`s).                 | `{ table: { headers: ["a", "b"], rows: [{ a: "col1", b: "col2" }] } }` or `{ table: { headers: ["a", "b"], rows: [["col1", "col2"]] } }`         |

README.md

@@ -195,6 +195,7 @@ Converts a JSON input to markdown.
 | `img`        | Image              | An object or an array of objects containing the `title`, `source` and `alt`  fields.                                     | `{ img: { title: "My image title", source: "http://example.com/image.png", alt: "My image alt" } }`                                              |
 | `ul`         | Unordered list     | An array of strings or lists representing the items.                                                                     | `{ ul: ["item 1", "item 2"] }`                                                                                                                   |
 | `ol`         | Ordered list       | An array of strings or lists representing the items.                                                                     | `{ ol: ["item 1", "item 2"] }`                                                                                                                   |
+| `taskLists`  | Task list          | An array of strings or array of task objects or lists representing the items.                                            | `{ taskLists: [{ title: "item 1" }, { title: "item 2", isDone: true }, "item 3"]`                                                                |
 | `hr`         | Separator          | None                                                                                                                     | `{ hr: "" }`                                                                                                                                     |
 | `code`       | Code block element | An object containing the `language` (`String`) and `content` (`Array` or `String`)  fields.                              | `{ code: { "language": "html", "content": "<script src='dummy.js'></script>" } }`                                                                |
 | `table`      | Table              | An object containing the `headers` (`Array` of `String`s) and `rows` (`Array` of `Array`s or `Object`s).                 | `{ table: { headers: ["a", "b"], rows: [{ a: "col1", b: "col2" }] } }` or `{ table: { headers: ["a", "b"], rows: [["col1", "col2"]] } }`         |

lib/converters.js

@@ -74,7 +74,7 @@ converters.ul = (input, json2md) => {
         let marker = ""
 
         let type = Object.keys(input[i])[0]
-        if(type !== "ul" && type !== "ol"){
+        if(type !== "ul" && type !== "ol" && type !== 'taskLists'){
           marker += "\n - "
         }
 
@@ -89,7 +89,7 @@ converters.ol = (input, json2md) => {
     for (let i = 0; i < input.length; ++i) {
         let marker = ""
         let type = Object.keys(input[i])[0]
-        if(type !== "ul" && type !== "ol"){
+        if(type !== "ul" && type !== "ol" && type !== 'taskLists'){
           marker = "\n " + (i + 1 - jumpCount) + ". "
         } else {
           jumpCount++
@@ -100,6 +100,21 @@ converters.ol = (input, json2md) => {
     return c
 }
 
+converters.taskLists = (input, json2md) => {
+    let c = ""
+    for (let i = 0; i < input.length; ++i) {
+        let marker = ""
+
+        let type = Object.keys(input[i])[0]
+        if(type !== "ul" && type !== "ol" && type !== 'taskLists'){
+            marker += input[i].isDone ? "\n - [x] " : "\n - [ ] "
+        }
+
+        c += marker + parseTextFormat(indent(json2md(input[i].title || input[i]), 4, true))
+    }
+    return c
+}
+
 converters.code = (input, json2md) => {
     let c = "```" + (input.language || "") + "\n"
     if (Array.isArray(input.content)) {

test/index.js

@@ -94,6 +94,16 @@ tester.describe("json2md", test => {
         cb();
     });
 
+    // task lists
+    test.it("should support task lists", function(cb) {
+        test.expect(json2md({
+            taskLists: [
+                { title: "item 1" }, { title: "item 2", isDone: true }, "item 3"
+            ]
+        })).toBe("\n - [ ] item 1\n - [x] item 2\n - [ ] item 3\n");
+        cb();
+    });
+
     // Code blocks
     test.it("should support code blocks", function(cb) {
         test.expect(json2md({