Initial commit

JohnSundell · Dec 30, 2019 · 5c37a2e · 5c37a2e
commit 5c37a2e
Show file tree

Hide file tree

Showing 8 changed files with 170 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+.DS_Store
+/.build
+Package.resolved
+.swiftpm
+/*.xcodeproj
+xcuserdata/
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 John Sundell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Package.swift b/Package.swift
@@ -0,0 +1,33 @@
+// swift-tools-version:5.1
+
+/**
+*  Splash-plugin for Publish
+*  Copyright (c) John Sundell 2019
+*  MIT license, see LICENSE file for details
+*/
+
+import PackageDescription
+
+let package = Package(
+    name: "SplashPublishPlugin",
+    products: [
+        .library(
+            name: "SplashPublishPlugin",
+            targets: ["SplashPublishPlugin"]
+        )
+    ],
+    dependencies: [
+        .package(url: "git@github.com:johnsundell/publish.git", .branch("master")),
+        .package(url: "https://github.com/johnsundell/splash.git", from: "0.9.0")
+    ],
+    targets: [
+        .target(
+            name: "SplashPublishPlugin",
+            dependencies: ["Splash", "Publish"]
+        ),
+        .testTarget(
+            name: "SplashPublishPluginTests",
+            dependencies: ["SplashPublishPlugin"]
+        ),
+    ]
+)
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# Splash plugin for Publish
+
+A [Publish](https://github.com/johnsundell/publish) plugin that makes it easy to integrate the [Splash](https://github.com/johnsundell/splash) Swift syntax highlighter into any Publish website.
diff --git a/Sources/SplashPublishPlugin/SplashPublishPlugin.swift b/Sources/SplashPublishPlugin/SplashPublishPlugin.swift
@@ -0,0 +1,44 @@
+/**
+*  Splash-plugin for Publish
+*  Copyright (c) John Sundell 2019
+*  MIT license, see LICENSE file for details
+*/
+
+import Publish
+import Splash
+import Ink
+
+public extension Plugin {
+    static func splash(withClassPrefix classPrefix: String) -> Self {
+        Plugin(name: "Splash") { context in
+            context.markdownParser.addModifier(
+                .splashCodeBlocks(withFormat: HTMLOutputFormat(
+                    classPrefix: classPrefix
+                ))
+            )
+        }
+    }
+}
+
+public extension Modifier {
+    static func splashCodeBlocks(withFormat format: HTMLOutputFormat = .init()) -> Self {
+        let highlighter = SyntaxHighlighter(format: format)
+
+        return Modifier(target: .codeBlocks) { html, markdown in
+            var markdown = markdown.dropFirst("```".count)
+
+            guard !markdown.hasPrefix("no-highlight") else {
+                return html
+            }
+
+            markdown = markdown
+                .drop(while: { !$0.isNewline })
+                .dropFirst()
+                .dropLast("\n```".count)
+
+            let highlighted = highlighter.highlight(String(markdown))
+            return "<pre><code>" + highlighted + "\n</code></pre>"
+        }
+    }
+}
+
diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
@@ -0,0 +1,13 @@
+/**
+*  Splash-plugin for Publish
+*  Copyright (c) John Sundell 2019
+*  MIT license, see LICENSE file for details
+*/
+
+import XCTest
+
+import SplashPublishPluginTests
+
+var tests = [XCTestCaseEntry]()
+tests += SplashPublishPluginTests.allTests()
+XCTMain(tests)
diff --git a/Tests/SplashPublishPluginTests/SplashPublishPluginTests.swift b/Tests/SplashPublishPluginTests/SplashPublishPluginTests.swift
@@ -0,0 +1,35 @@
+/**
+*  Splash-plugin for Publish
+*  Copyright (c) John Sundell 2019
+*  MIT license, see LICENSE file for details
+*/
+
+import XCTest
+import SplashPublishPlugin
+import Ink
+
+final class SplashPublishPluginTests: XCTestCase {
+    func testHighlightingMarkdown() {
+        let parser = MarkdownParser(modifiers: [.splashCodeBlocks()])
+        let html = parser.html(from: """
+        Some text
+        ```
+        let int = 7
+        ```
+        More text
+        ```no-highlight
+        not.highlighted()
+        ```
+        """)
+
+        XCTAssertEqual(html, """
+        <p>Some text</p><pre><code><span class="keyword">let</span> int = <span class="number">7</span>
+        </code></pre><p>More text</p><pre><code class="language-no-highlight">not.highlighted()
+        </code></pre>
+        """)
+    }
+
+    static var allTests = [
+        ("testHighlightingMarkdown", testHighlightingMarkdown)
+    ]
+}
diff --git a/Tests/SplashPublishPluginTests/XCTestManifests.swift b/Tests/SplashPublishPluginTests/XCTestManifests.swift
@@ -0,0 +1,15 @@
+/**
+*  Splash-plugin for Publish
+*  Copyright (c) John Sundell 2019
+*  MIT license, see LICENSE file for details
+*/
+
+import XCTest
+
+#if !canImport(ObjectiveC)
+public func allTests() -> [XCTestCaseEntry] {
+    return [
+        testCase(SplashPublishPluginTests.allTests),
+    ]
+}
+#endif
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Splash plugin for Publish

		A [Publish](https://github.com/johnsundell/publish) plugin that makes it easy to integrate the [Splash](https://github.com/johnsundell/splash) Swift syntax highlighter into any Publish website.