richtypo-rules-en v6.1.2

Richtypo English Rule Package

Converts this:

The quick brown FOX - weighting 47 kg - jumps over "the lazy dog" on
sunny morning...

to this:

The quick brown <abbr>FOX</abbr>&#x202f;=&#x202f;weighting
47&nbsp;kg&#x202f;=&#x202f; jumps over “the lazy dog”
on&nbsp;sunny&nbsp;morning…

Note:   is and HTML entity for a hair space.

Installation

npm install --save richtypo richtypo-rules-en

Basic usage

import richtypo from 'richtypo';
import rules from 'richtypo-rules-en';

const text =
  'The quick brown FOX - weighting 47 kg -' +
  'jumps over "the lazy dog" on sunny morning...';

richtypo(rules, text);

// -> The quick brown <abbr>FOX</abbr>&#x202f;=&#x202f;weighting 47&nbsp;kg&#x202f;=&#x202f;
//    jumps over “the lazy dog” on&nbsp;sunny&nbsp;morning…

The default export of richtypo-rules-en contains recommended rules (marked with ¹ in a table below), but you can import each rule separately:

import richtypo from 'richtypo';
import { quotes, numberSeparators } from 'richtypo-rules-en';
richtypo([quotes, numberSeparators], 'Text "in quotes" - 123456.78');
// -> Text “in quotes” - 123,456.78

See more examples in Richtypo docs.

The rules

¹ Recommended rules (see code examples above)

²   is actually rendered as a symbol (\xA0), not an HTML entity. We use   only in the docs for readability.