Swiftpack.co - Package - JohnSundell/Splash

Splash

Swift Package Manager Mac + Linux Twitter: @johnsundell

Welcome to Splash - a fast, lightweight and flexible Swift syntax highlighter. It can be used to generate code sample HTML for a blog post, to turn a string of Swift code into a fully syntax highlighted image, or to build custom developer tools.

It's used to highlight all recent articles on swiftbysundell.com.

Usage

Splash can be used either as a library in your own Swift Package Manager-powered tool or script, or by using one of the four built-in command line tools that act as frontends for the Splash library.

🌍 On the web

Thanks to my good friend Gui Rambo, you can try out Splash directly in your browser! His web tool lets you use Splash to generate either HTML or an image, by simply pasting Swift code into a text box.

πŸ‘‰ splash.rambo.codes

If you're using Jekyll, there's also a custom {% splash %} tag available for the Liquid templating language.

πŸ‘‰ splashtag

πŸ–₯ On the command line

The easiest way to get started building things with Splash is to use one of the four built-in command line tools that each enable you to use Splash in different ways.

SplashHTMLGen

SplashHTMLGen uses Splash's HTML output format to generate an HTML string from Swift code. You simply pass it the code you want to highlight as an argument and HTML is returned as standard output.

For example, if you call it like this:

$ SplashHTMLGen "func hello(world: String) -> Int"

You'll get the following output back:

<span class="keyword">func</span> hello(world: <span class="type">String</span>) -> <span class="type">Int</span>

To be as flexible as possible, Splash doesn't hardcode any colors or other CSS attributes in the HTML it generates. Instead it simply assigns a CSS class to each token. For an example of a CSS file that can be used to style Splash-generated HTML, see Examples/sundellsColors.css.

When rendering your outputted html, make sure to wrap your output code in the <pre> and <code> tags and properly link to your .css file. Like this:

<!DOCTYPE html>
<head>
    <title>Hello World</title>
    <link rel="stylesheet" href="sundellsColors.css">
</head>

<pre>
    <code>
        <span class="keyword">func</span> hello(world: <span class="type">String</span>) -> <span class="type">Int</span>
    </code>
</pre>

For more information about HTML generation with Splash and how to customize it, see HTMLOutputFormat here.

SplashMarkdown

SplashMarkdown builds on top of SplashHTMLGen to enable easy Splash decoration of any Markdown file. Pass it a path to a Markdown file, and it will iterate through all code blocks within that file and convert them into Splash-highlighted HTML.

Just like the HTML generated by SplashHTMLGen itself, a CSS file should also be added to any page serving the processed Markdown, since Splash only adds CSS classes to tokens β€” rather than hardcoding styles inline. See the above SplashHTMLGen documentation for more information.

Here’s an example call to decorate a Markdown file at the path ~/Documents/Article.md:

$ SplashMarkdown ~/Documents/Article.md

The decorated Markdown will be returned as standard output.

Highlighting can be skipped for any code block by adding no-highlight next to the block’s opening row of backticks β€” like this: β€œ```no-highlight”.

SplashImageGen

SplashImageGen uses Splash to generate an NSAttributedString from Swift code, then draws that attributed string into a graphics context to turn it into an image, which is then written to disk.

For example, if you call it like this:

$ SplashImageGen "func hello(world: String) -> Int" "MyImage.png"

The following image will be generated (and written to disk as MyImage.png):

Code sample

SplashImageGen is currently only available on macOS.

SplashTokenizer

The final built-in command line tool, SplashTokenizer, is mostly useful as a debugging tool when working on Splash - but can also be interesting to use in order to see how Splash breaks down code into tokens. Given a string of Swift code, it simply outputs all of its components (excluding whitespaces).

So if you call it like this:

$ SplashTokenizer "func hello(world: String) -> Int"

You'll get the following standard output back:

Keyword token: func
Plain text: hello(world:
Type token: String
Plain text: )
Plain text: ->
Type token: Int

πŸ“¦ As a package

To include Splash in your own script or Swift package, add it as a dependency and use the SyntaxHighlighter class combined with your output format of choice to highlight a string of code:

import Splash

let highlighter = SyntaxHighlighter(format: HTMLOutputFormat())
let html = highlighter.highlight("func hello() -> String")

Splash ships with two built-in output formats - HTML and NSAttributedString, but you can also easily add your own by implementing the OutputFormat protocol.

Installation

Splash is distributed as a Swift package, making it easy to install for use in scripts, developer tools, server-side applications, or to use its built-in command line tools.

Splash supports both macOS and Linux.

Before you begin, make sure that you have a Swift 4.2-compatible toolchain installed (for example Xcode 10 if you're on a Mac).

πŸ“¦ As a package

To install Splash for use in a Swift Package Manager-powered tool or server-side application, add Splash as a dependency to your Package.swift file. For more information, please see the Swift Package Manager documentation.

.package(url: "https://github.com/JohnSundell/Splash", from: "0.1.0")

πŸƒβ€β™‚οΈ As a Marathon dependency

If you want to use Splash in a Marathon script, either add it to your Marathonfile (see the Marathon repo for instructions on how to do that), or point Marathon to Splash using the inline dependency syntax:

import Splash // https://github.com/johnsundell/splash.git

πŸ›  Command line tools

If you want to use Splash through one of its built-in command line tools, start by cloning the repo to your local machine:

$ git clone https://github.com/johnsundell/splash.git
$ cd Splash

To run a tool without installing it, you can use the Swift Package Manager's run command, like this:

$ swift run SplashHTMLGen "func hello(world: String) -> Int"

To install all four command line tools globally on your system, use Make:

$ make install

That will install the following four tools in your /usr/local/bin folder:

SplashHTMLGen
SplashMarkdown
SplashImageGen
SplashTokenizer

If you only wish to install one of these, compile it and then move it to /usr/local/bin, like this:

$ swift build -c release -Xswiftc -static-stdlib
$ install .build/Release/SplashHTMLGen /usr/local/bin/SplashHTMLGen

Contributions and support

Splash is developed completely in the open, and your contributions are more than welcome. It's still a very new project, so I'm sure there are bugs to be found and improvements to be made - and hopefully we can work on those together as a community.

You might notice that this project does not have GitHub issues enabled. That's because with Splash, I'm trying out a new 100% PR-based open source workflow. This is a bit of an experiment, so let's see how it works out.

To read more about suggested workflows when contributing to Splash, how to report bugs and feature requests, as well as technical details and an architectural overview - check out the Contributing Guide.

Hope you enjoy using Splash!

I had a lot of fun building Splash, and I'm looking forward to continue working on it in the open together with you! I hope you'll like it and that you'll find it useful. Let me know what you think on on Twitter 😊

Github

link
Stars: 1016
Help us keep the lights on

Dependencies

Releases

0.6.0 - May 13, 2019

This version of Splash migrates the installation script to the Swift 5 toolchain, and fixes highlighting in the following scenarios:

  • When using closure argument shorthands, such as $0, $1, etc.
  • When using the inout keyword with a closure argument.
  • When returning a generic type from a function.

0.5.0 - Mar 31, 2019

  • Splash is now implemented using Swift 5.
  • Highlighting has been corrected for keywords used as parameter labels for generic functions.
  • Highlighting has been corrected for key paths passed as arguments to functions.

0.4.1 - Mar 24, 2019

Fixed highlighting for nested @escaping closures.

0.4.0 - Mar 16, 2019

  • Support for the rethrows keyword (thanks @marcocapano!)
  • Fixed documentation for TokenType.keyword (thanks @warren-gavin!)
  • Generic parameters (such as Array<T>) within generic functions are now highlighted correctly.
  • The root level of a key path literal (\.property) is now highlighted correctly.

This release also includes a new command line tool - SplashMarkdown, which enables automatic HTML conversion and Splash decoration of all code blocks within a Markdown file.

0.3.0 - Mar 12, 2019

  • Added support for Swift 5 raw strings (both single-line and multi-line).
  • HTML output is now much more compact, and merges <span>s for tokens of the same type.
  • Multi-line comments with two asterisks (documentation-style) are now supported (thanks @MaciejGad, @marcocapano and @warren-gavin).
  • The dynamic and nonmutating keywords are now supported (thanks @marcocapano).