What is retext-smartypants?
The retext-smartypants package is a plugin for the retext ecosystem that transforms plain ASCII punctuation into typographically correct punctuation. It is useful for converting straight quotes to curly quotes, double hyphens to em dashes, and other similar transformations to improve the readability and appearance of text.
What are retext-smartypants's main functionalities?
Convert straight quotes to curly quotes
This feature converts straight quotes (" and ') to their curly counterparts (“ and ’).
const retext = require('retext');
const smartypants = require('retext-smartypants');
const report = require('vfile-reporter');
retext()
.use(smartypants)
.process('"Hello, world!" she said.', function (err, file) {
if (err) throw err;
console.log(String(file));
console.error(report(file));
});
Convert double hyphens to em dashes
This feature converts double hyphens (--) to em dashes (—).
const retext = require('retext');
const smartypants = require('retext-smartypants');
const report = require('vfile-reporter');
retext()
.use(smartypants)
.process('This is an example--with an em dash.', function (err, file) {
if (err) throw err;
console.log(String(file));
console.error(report(file));
});
Convert triple dots to ellipses
This feature converts triple dots (...) to ellipses (…).
const retext = require('retext');
const smartypants = require('retext-smartypants');
const report = require('vfile-reporter');
retext()
.use(smartypants)
.process('Wait... what?', function (err, file) {
if (err) throw err;
console.log(String(file));
console.error(report(file));
});
Other packages similar to retext-smartypants
typogr
The typogr package provides similar functionality to retext-smartypants by improving the typography of text. It converts straight quotes to curly quotes, double hyphens to em dashes, and more. It is a standalone library and does not require the retext ecosystem.
smartypants
The smartypants package is a JavaScript port of the original SmartyPants Perl library. It provides similar transformations for typographic punctuation, such as converting straight quotes to curly quotes and double hyphens to em dashes. It is a standalone library and can be used independently of retext.
retext-smartypants
retext plugin to implement SmartyPants.
Install
This package is ESM only:
Node 12+ is needed to use it and it must be import
ed instead of require
d.
npm:
npm install retext-smartypants
Use
import {retext} from 'retext'
import retextSmartypants from 'retext-smartypants'
const file = retext()
.use(retextSmartypants)
.processSync('He said, "A \'simple\' english sentence. . ."')
console.log(String(file))
Yields:
He said, “A ‘simple’ english sentence…”
API
This package exports no identifiers.
The default export is retextSmartypants
.
unified().use(retextSmartypants[, options])
Replaces dumb/straight/typewriter punctuation marks with smart/curly punctuation
marks.
options
options.quotes
Create smart quotes (boolean
, default: true
).
Converts straight double and single quotes to smart double or single quotes.
options.ellipses
Create smart ellipses (boolean
, default: true
).
Converts triple dot characters (with or without spaces between) into a single
Unicode ellipsis character
options.backticks
Create smart quotes from backticks (boolean
or 'all'
, default: true
).
When true
, converts double back-ticks into an opening double quote, and
double straight single quotes into a closing double quote.
When 'all'
: does the preceding and converts single back-ticks into an
opening single quote, and a straight single quote into a closing single
smart quote.
Note: Quotes can not be true
when backticks
is 'all'
;
options.dashes
Create smart dashes (boolean
or 'oldschool'
, 'inverted'
, default: true
).
When true
, converts two dashes into an em-dash character.
When 'oldschool'
, converts two dashes into an en-dash, and three dashes into
an em-dash.
When 'inverted'
, converts two dashes into an em-dash, and three dashes into
an en-dash.
Contribute
See contributing.md
in retextjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct.
By interacting with this repository, organization, or community you agree to
abide by its terms.
License
MIT © Titus Wormer