retext-smartypants
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatretext plugin to apply SmartyPants.
Contents
* [`unified().use(retextSmartypants[, options])`](#unifieduseretextsmartypants-options)
* [`Options`](#options)
* [`QuoteCharacterMap`](#quotecharactermap)
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 onlyesm. In Node.js (version 16+), install with npm:npm install retext-smartypants
In Deno with
esm.sh
esmsh:import retextSmartypants from 'https://esm.sh/retext-smartypants@6'
In browsers with
esm.sh
esmsh:<script type="module">
import retextSmartypants from 'https://esm.sh/retext-smartypants@6?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 isretextSmartypants
api-retext-smartypants.unified().use(retextSmartypants[, options])
Replace straight punctuation marks with curly ones.Parameters
options
(Options
api-options, optional)
— configuration
Returns
Transform (Transformer
unified-transformer).Options
Configuration (TypeScript type).Fields
backticks
(boolean
or'all'
, default:true
)
— transform backticks;
when `true`, turns double backticks into an opening double quote and
double straight single quotes into a closing double quote;
when `'all'`, does that and turns single backticks into an opening
single quote and a straight single quotes into a closing single smart
quote;
`quotes: false` must be used with `backticks: 'all'`
closingQuotes
(QuoteCharacterMap
api-quote-character-map, default:
`{double: '”', single: '’'}`)
— closing quotes to use
dashes
('inverted'
or'oldschool'
orboolean
, default:true
)
— transform dashes;
when `true`, turns two dashes into an em dash character;
when `'oldschool'`, turns three dashes into an em dash and two into an en
dash;
when `'inverted'`, turns three dashes into an en dash and two into an em
dash
ellipses
('spaced'
or'unspaced'
orboolean
, default:true
)
— transform triple dots;
when `'spaced'`, turns triple dots with spaces into ellipses;
when `'unspaced'`, turns triple dots without spaces into ellipses;
when `true`, turns triple dots with or without spaces into ellipses
openingQuotes
(QuoteCharacterMap
api-quote-character-map, default:
`{double: '“', single: '‘'}`)
— opening quotes to use
quotes
(boolean
, default:true
)
— transform straight quotes into smart quotes
QuoteCharacterMap
Quote characters (TypeScript type).Fields
double
(string
)
— character to use for double quotes
single
(string
)
— character to use for single quotes
Types
This package is fully typed with TypeScript. It exports the additional typesOptions
api-options and
QuoteCharacterMap
api-quote-character-map.Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,
retext-smartypants@^6
,
compatible with Node.js 16.Contribute
Seecontributing.md
contributing in retextjs/.github
health for ways
to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.