Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
retext-smartypants
Advanced tools
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.
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));
});
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.
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 plugin to apply SmartyPants.
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.
You can use this plugin any time there straight marks and symbols in prose, but you want to use smart ones instead.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install retext-smartypants
In Deno with esm.sh
:
import retextSmartypants from 'https://esm.sh/retext-smartypants@6'
In browsers with esm.sh
:
<script type="module">
import retextSmartypants from 'https://esm.sh/retext-smartypants@6?bundle'
</script>
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…”
This package exports no identifiers.
The default export is retextSmartypants
.
unified().use(retextSmartypants[, options])
Replace straight punctuation marks with curly ones.
options
(Options
, optional)
— configurationTransform (Transformer
).
Options
Configuration (TypeScript type).
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
, default:
{double: '”', single: '’'}
)
— closing quotes to usedashes
('inverted'
or 'oldschool'
or boolean
, 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
dashellipses
('spaced'
or 'unspaced'
or boolean
, 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 ellipsesopeningQuotes
(QuoteCharacterMap
, default:
{double: '“', single: '‘'}
)
— opening quotes to usequotes
(boolean
, default: true
)
— transform straight quotes into smart quotesQuoteCharacterMap
Quote characters (TypeScript type).
double
(string
)
— character to use for double quotessingle
(string
)
— character to use for single quotesThis package is fully typed with TypeScript.
It exports the additional types Options
and
QuoteCharacterMap
.
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.
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.
FAQs
retext plugin to implement SmartyPants
The npm package retext-smartypants receives a total of 266,170 weekly downloads. As such, retext-smartypants popularity was classified as popular.
We found that retext-smartypants demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.