Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace dependency on Ink with swift-markdown. #149

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 45 additions & 9 deletions Package.resolved
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,6 @@
"version": "4.2.0"
}
},
{
"package": "Ink",
"repositoryURL": "https://github.com/johnsundell/ink.git",
"state": {
"branch": null,
"revision": "77c3d8953374a9cf5418ef0bd7108524999de85a",
"version": "0.5.1"
}
},
{
"package": "Plot",
"repositoryURL": "https://github.com/johnsundell/plot.git",
Expand All @@ -63,6 +54,51 @@
"revision": "801c2878e4c6c5baf32fe132e1f3f3af6f9fd1b0",
"version": "0.4.0"
}
},
{
"package": "swift-case-paths",
"repositoryURL": "https://github.com/pointfreeco/swift-case-paths",
"state": {
"branch": null,
"revision": "fc45e7b2cfece9dd80b5a45e6469ffe67fe67984",
"version": "0.14.1"
}
},
{
"package": "cmark-gfm",
"repositoryURL": "https://github.com/apple/swift-cmark.git",
"state": {
"branch": "gfm",
"revision": "b1c49eb0752d727fda5dfa63c8bb23670592d7c9",
"version": null
}
},
{
"package": "swift-markdown",
"repositoryURL": "https://github.com/apple/swift-markdown.git",
"state": {
"branch": "main",
"revision": "cb80ea4151e5860a3b344d46e14cbcb52c5daeb3",
"version": null
}
},
{
"package": "swift-parsing",
"repositoryURL": "https://github.com/pointfreeco/swift-parsing.git",
"state": {
"branch": null,
"revision": "27c941bbd22a4bbc53005a15a0440443fd892f70",
"version": "0.12.1"
}
},
{
"package": "xctest-dynamic-overlay",
"repositoryURL": "https://github.com/pointfreeco/xctest-dynamic-overlay",
"state": {
"branch": null,
"revision": "4af50b38daf0037cfbab15514a241224c3f62f98",
"version": "0.8.5"
}
}
]
},
Expand Down
27 changes: 19 additions & 8 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,10 @@ let package = Package(
platforms: [.macOS(.v12)],
products: [
.library(name: "Publish", targets: ["Publish"]),
.library(name: "MarkdownParser", targets: ["MarkdownParser"]),
.executable(name: "publish-cli", targets: ["PublishCLI"])
],
dependencies: [
.package(
name: "Ink",
url: "https://github.com/johnsundell/ink.git",
from: "0.2.0"
),
.package(
name: "Plot",
url: "https://github.com/johnsundell/plot.git",
Expand Down Expand Up @@ -50,14 +46,24 @@ let package = Package(
name: "CollectionConcurrencyKit",
url: "https://github.com/johnsundell/collectionConcurrencyKit.git",
from: "0.1.0"
)
),
.package(url: "https://github.com/apple/swift-markdown.git", .branch("main")),
.package(url: "https://github.com/pointfreeco/swift-parsing.git", from: "0.12.0"),
],
targets: [
.target(
name: "Publish",
dependencies: [
"Ink", "Plot", "Files", "Codextended",
"ShellOut", "Sweep", "CollectionConcurrencyKit"
"MarkdownParser", "Plot", "Files", "Codextended",
"ShellOut", "Sweep", "CollectionConcurrencyKit",
]
),
.target(
name: "MarkdownParser",
dependencies: [
"Plot",
.product(name: "Markdown", package: "swift-markdown"),
.product(name: "Parsing", package: "swift-parsing")
]
),
.executableTarget(
Expand All @@ -71,6 +77,11 @@ let package = Package(
.testTarget(
name: "PublishTests",
dependencies: ["Publish", "PublishCLICore"]
),
.testTarget(
name: "MarkdownParserTests",
dependencies: ["MarkdownParser", "Publish"]
)

]
)
24 changes: 24 additions & 0 deletions Sources/MarkdownParser/MarkdownDocument.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import Foundation
import Plot

public struct MarkdownDocument: Identifiable {
public var id: UUID
public var body: Node<HTML.BodyContext> = .empty
public var title: String? = nil
public var description: Node<HTML.BodyContext>? = nil
public var metadata: [String: String] = .init()

public init(
id: UUID = .init(),
body: Node<HTML.BodyContext> = .empty,
title: String? = nil,
description: Node<HTML.BodyContext>? = nil,
metadata: [String : String] = [:]
) {
self.id = id
self.body = body
self.title = title
self.description = description
self.metadata = metadata
}
}
122 changes: 122 additions & 0 deletions Sources/MarkdownParser/MarkdownParser.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
import Foundation
import Markdown
import Parsing

public struct MarkdownParser {
private var modifiers: ModifierCollection

public init() {
self.modifiers = .init(modifiers: [])
}

public mutating func addModifier(
for target: Modifier.Target,
modifier: @escaping Modifier.Closure,
file: StaticString = #file,
line: Int = #line
) {
modifiers.insert(.init(target: target, closure: modifier, file: file, line: line))
}

public func html(from markdown: String) -> String {
parse(markdown).body.render()
}

public func parse(_ markdown: String) -> MarkdownDocument {
var visitor = Visitor(modifiers: modifiers)
var markdown = markdown

do {
(visitor.document.metadata, markdown) = try markdownMetadata.parse(markdown)
} catch let error {
print(error)
}

visitor.parse(
markdown: Markdown.Document(
parsing: markdown,
options: [.parseBlockDirectives]
)
)

return visitor.document
}

private var identifier: some Parser<Substring, String> {
Parse {
"\($0)\($1)"
} with: {
CharacterSet.letters
Prefix {
$0.unicodeScalars.allSatisfy { CharacterSet.alphanumerics.contains($0) }
}
}
}

private var dottedIdentifier: some Parser<Substring, String> {
Many(into: "") { (s: inout String, e: String) in
if !s.isEmpty { s.append(".") }
s.append(e)
} element: {
identifier
} separator: {
"."
}
}

private var keyAndValue: some Parser<Substring, (String, String)> {
Parse {
Whitespace(.horizontal)

dottedIdentifier

Whitespace(.horizontal)
":"
Whitespace(.horizontal)

Prefix {
$0 != "\r" && $0 != "\n"
}
.map(.string)
.map { $0.trimmingCharacters(in: .whitespaces) }
}
}

private var metadataDictionary: some Parser<Substring, [String: String]> {
Many(into: [:]) {
$0[$1.0] = $1.1
} element: {
keyAndValue
} separator: {
Whitespace(.vertical)
}
}

private var separator: some Parser<Substring, Void> {
Skip {
Whitespace(.vertical)
"---"
OneOf {
Whitespace(.vertical)
End()
}
}
}

private var markdownMetadata: some Parser<Substring, ([String: String], String)> {
Parse {
Optionally {
separator
metadataDictionary
separator
}.map {
$0 ?? [:] as [String: String]
}

OneOf {
End().map { "" }
Rest().map(.string)
}
}
}
}
Loading