smartquotes-ts v0.0.2

smartquotes-ts

TypeScript version of smartquotes.js.

Smart quotes are smart typography, and now it’s just a ’script away.

Installation

smartquotes-ts is available in npm.

npm install smartquotes-ts

Usage

Import the script and pass it a string, or use the string method. Both are equivalent.

import smartquotes from 'smartquotes-ts';

const myString = smartquotes('This is my "smart-quoted" string.');
const myString2 = smartquotes.string('This is the "same" thing.');

What are smart quotes?

“Smart quotes,” or “curly quotes,” are the proper typographical way to represent quotation marks. Unfortunately, in order to save space on the keyboard, the dumb quote was created. Smartquotes.js is here to convert all your dumb quotes back to smart ones.

Why should I use smart quotes?

Smart quotes are the correct way. They increase legibility and professionalism. Dumb quotes are for the lazy person. Dumb quotes are unprofessional. And now you have no excuse not to use smart quotes.

What about measurements? What quotes do I use?

Measurements use what are called “primes.” smartquotes-ts handles those too.

Okay, so what about a backwards apostrophe?

Technically, words that are shortened at the beginning require a backwards apostrophe. There’s only so much a script can do by itself, though. Smartquotes.js tries to catch what it can, namely abbreviated years like ’13 and places like the ’burbs, but in the cases that it can’t—there’s not much ’splainin’ to do—just use ’ or try wrapping the word in a tag.

What do I need to change in my code?

smartquotes-ts doesn’t have any dependencies and can be used by itself.

Contributing

If you find bugs or additions to the code, the best way to contribute is to fork this repo, make the changes (without updating version numbers), and make a pull request back to this repo to be merged in.

Be sure to add any necessary tests and run npm test before opening a PR.