frankrausch / Typographizer

Typographizer · Smart Quotes for Swift Apps

Typographizer turns those pesky dumb quotes (""/'') and apostrophes (') into their beautiful, curly, localized counterparts. Because good typography uses smart quotes, not dumb quotes and we should not let the internet kill smart quotes. Speaking of smartness: Typographizer is smart enough to skip HTML tags and everything between certain tags (like <code> and <pre>).

Typographizer has a small footprint, was written in pure Swift, and has been tested on macOS, iOS, watchOS, and tvOS.

I started building Typographizer to typographize Wikipedia articles in my V for Wiki app.

Installation

Put the .swift files into your app’s Xcode project.

How to Use

The easiest way to use Typographizer is the String extension (String+Typographizer.swift):

var s = "This is a string with \"dumb\" quotes."

s = s.typographized(language: "en")

print(s) // This is a string with “dumb” quotes.

Ignoring HTML Tags

If your string may contain HTML, set the isHTML parameter to true. Typographizer will then ignore the quotes inside tags and anything between <pre>, <code>, <var>, <samp>, <kbd>, <math>, <script>, and <style> tags:

var s = "This is a \"string\" with HTML. <code class="">print(\"hello world\")</code>"

s = s.typographized(language: "en", isHTML: true)

print(s) // This is a “string” with HTML. <code class="">print("hello world")</code>

Debug Mode

Activate the debug mode to highlight the characters that have been changed—Typographizer will add this tag around them: <span class="typographizer-debug typographizer-debug--XXX"> </span>

var s = "This is a string with \"dumb\" quotes."

s = s.typographized(language: "en", isHTML: true, debug: true)

print(s) // This is a string with <span class="typographizer-debug typographizer-debug--opening-double">“</span>dumb<span class="typographizer-debug typographizer-debug--closing-double">”</span> quotes.

(Yes, the class names are a little wordy, but that’s on purpose.)

Use CSS to visualize the changes:

.typographizer-debug {
  font-weight: bold;
}

.typographizer-debug--apostrophe {
  color: red;
}

/* … */

Measuring Performance

Pass measurePerformance: true to log performance stats:

s = s.typographized(language: "en", isHTML: true, debug: false, measurePerformance: true)

You’ll see something like this in the Xcode console:

Typographizing took 0.00582303 seconds

Features

• [x] Fixes double quotes: "" → “” (localized)
• [x] Fixes single quotes: '' → ‘’ (localized)
• [x] Fixes apostrophes: ' → ’
• [x] Fixes hyphens that are used as en dashes: … - … → … – …
• [x] Demo app project for macOS

Supported Languages

Demo App

To get started, try the included demo app for macOS.

To Do

• [ ] Handle special cases like ’80s, ’Twas, Rock ’n’ Roll, etc.
• [ ] Handle primes in coordinates properly:
  52° 27' 20" N, 13° 19' 11" E → 52° 27′ 20″ N, 13° 19′ 11″ E
• [ ] Add support for Hebrew
• [ ] If there is only one dumb single quote in a string, it’s probably an apostrophe
• [ ] Analyze HTML tags to verify correct quotes (opening and closing <p> tags make a good indicator for opening and closing quotation marks)
• [ ] Track open/closed state while iterating over the text to make more informed decisions
• [ ] Add more typographic refinements (e.g. prime symbols, thin spaces)

Credits

Typographizer was created by Frank Rausch (@frankrausch).

Thanks to Tony Allevato for the great article on Strings, characters, and performance in Swift—a deep dive.

Contribution Guidelines

Please always use self when accessing methods and properties.

Preferred:

self.coolMethod()

Not preferred:

coolMethod()

License

The Typographizer source code is released under the MIT License. Please view the LICENSE file for details.

The Typographizer logo is © 2017 Frank Rausch; all rights reserved.