retext-smartypants

retext plugin to apply SmartyPants.

Contents

• retext-smartypants
  • Contents
  • What is this?
  • When should I use this?
  • Install
  • Use
  • API
    • unified().use(retextSmartypants[, options])
      • options
        • options.quotes
        • options.openingQuotes
        • options.closingQuotes
        • options.ellipses
        • options.backticks
        • options.dashes
  • Types
  • Compatibility
  • Contribute
  • License

What is this?

This package is a unified (retext) plugin to apply SmartyPants to the syntax tree. It replaces straight/typewriter punctuation marks and symbols with smart/curly marks and symbols.

When should I use this?

You can use this plugin any time there straight marks and symbols in prose, but you want to use smart ones instead.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:

npm install retext-smartypants

In Deno with esm.sh:

import retextSmartypants from 'https://esm.sh/retext-smartypants@5'

In browsers with esm.sh:

<script type="module">
  import retextSmartypants from 'https://esm.sh/retext-smartypants@5?bundle'
</script>

Use

import {retext} from 'retext'
import retextSmartypants from 'retext-smartypants'

const file = await retext()
  .use(retextSmartypants)
  .process('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])

Apply SmartyPants.

options

Configuration (optional).

options.quotes

Create smart quotes (boolean, default: true).

Converts straight double and single quotes to smart double or single quotes. The options options.openingQuotes and options.closingQuotes affect which quotes are considered smart.

options.openingQuotes

Characters to use for opening quotes {single: '‘', double: '“'}.

options.closingQuotes

Characters to use for closing quotes {single: '’', double: '”'}.

options.ellipses

Create smart ellipses (boolean, default: true).

Converts triple dot characters into a single unicode ellipsis character.

options.backticks

Create smart quotes from backticks (boolean or 'all', default: true).

When true, converts double backticks into an opening double quote, and double straight single quotes into a closing double quote.

When 'all': does the what true does with the addition of converting single backticks into an opening single quote, and a straight single quote into a closing single smart quote.

👉 Note: options.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.

Types

This package is fully typed with TypeScript. It exports the additional types Options and QuoteCharacterMap.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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