support for unordered lists.

NiftyTreeStudios · Aug 9, 2021 · f9b9a27 · f9b9a27
1 parent 3765c1d
commit f9b9a27
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 2 deletions.
diff --git a/Sources/NiftyMarkdownFormatter/NiftyMarkdownFormatter.swift b/Sources/NiftyMarkdownFormatter/NiftyMarkdownFormatter.swift
@@ -38,6 +38,8 @@ public func formattedMarkdownArray(markdown: String) -> [Text] {
         if string.starts(with: "#") {
             let heading = formatHeading(convertMarkdownHeading(string))
             formattedTextViews.append(heading)
+        } else if string.starts(with: "* ") {
+            formattedTextViews.append(Text(formatUnorderedListItem(string)))
         } else if string.range(of: "^[0-9].") != nil {
             formattedTextViews.append(Text(formatOrderedListItem(string)))
         } else if string.count == 0 {
@@ -60,7 +62,7 @@ public func formattedMarkdownArray(markdown: String) -> [Text] {
 
 // MARK: Private
 
-// MARK: Heading
+// MARK: Headings
 /// Heading struct used to represent headings.
 internal struct Heading: Identifiable, Equatable {
     let id = UUID()
@@ -116,6 +118,8 @@ internal func formatHeading(_ formattedText: Heading) -> Text {
     }
 }
 
+// MARK: Lists
+
 /**
  Formats ordered lists.
 
@@ -125,7 +129,7 @@ internal func formatHeading(_ formattedText: Heading) -> Text {
  */
 internal func formatOrderedListItem(_ string: String) -> String {
     let regex = "^[0-9]."
-    if string.range(of: regex, options: .regularExpression) != nil  {
+    if string.range(of: regex, options: .regularExpression) != nil {
         var orderedItem = string
         var orderedPrefix = string
         orderedPrefix.removeSubrange(
@@ -142,6 +146,31 @@ internal func formatOrderedListItem(_ string: String) -> String {
     }
 }
 
+/**
+ Formats unordered lists.
+
+ - Parameter string: the markdown string to be formatted into an unordered list item.
+
+ - Returns: a `Text` view formatted into an ordered list item.
+ */
+internal func formatUnorderedListItem(_ string: String) -> String {
+    if string.starts(with: "* ") {
+        var orderedItem = string
+        var orderedPrefix = string
+        orderedPrefix.removeSubrange(
+            (orderedItem.firstIndex(of: " ") ?? orderedItem.startIndex)..<orderedItem.endIndex
+        )
+        orderedItem.replaceSubrange(
+            orderedItem.startIndex...(
+                orderedItem.firstIndex(of: "*") ?? orderedItem.startIndex
+            ),
+            with: "**\(orderedPrefix)**")
+        return orderedItem
+    } else {
+        return string
+    }
+}
+
 extension NSRegularExpression {
     convenience init(_ pattern: String) {
         do {

diff --git a/Tests/NiftyMarkdownFormatterTests/NiftyMarkdownFormatterTests.swift b/Tests/NiftyMarkdownFormatterTests/NiftyMarkdownFormatterTests.swift
@@ -42,4 +42,26 @@ final class NiftyMarkdownFormatterTests: XCTestCase {
         let actual = formatOrderedListItem(testString)
         XCTAssertEqual(expected, actual)
     }
+
+    // MARK: Unordered list
+    func testUnorderedList() throws {
+        let testString = "* List item"
+        let excepted = "***** List item"
+        let actual = formatUnorderedListItem(testString)
+        XCTAssertEqual(excepted, actual)
+    }
+
+    func testUnorderedList2() throws {
+        let testString = "* List item"
+        let excepted = "***** List item"
+        let actual = formatUnorderedListItem(testString)
+        XCTAssertEqual(excepted, actual)
+    }
+
+    func testUnorderedListWithWrongInput() throws {
+        let testString = "No correct prefix."
+        let expected = testString
+        let actual = formatUnorderedListItem(testString)
+        XCTAssertEqual(expected, actual)
+    }
 }