Richtypo-rules-common NPM

Richtypo common typography rules

A convenience package to create Richtypo typography rules for different languages.

It includes definitions, rules and rule factories.

Definitions

Use definitions to improve readability of your rules:

import { definitions } from 'richtypo-common-rules';
const { space, nbsp } = definitions;
export const numberSigns = text =>
  text.replace(new RegExp(`№${space}`, 'g'), `№${nbsp}`);

Definition name	Description
`dash`	hyphen (-) or em dash (—)
`hairspace`	narrow non-breaking space (`\u202f`).
`letter`	any European or Cyrillic letter
`letterOrQuote`	any European or Cyrillic letter with quotes
`nbsp`	non-breaking space
`notInTag`	negative lookbehind to make sure we're not running rules inside an HTML tag. It’s usually added to the beginning of `RegExp` in most rules
`openingQuote`	any opening quote
`punctuation`	punctuation symbols
`quote`	any quotes
`semicolon`	a semicolon
`shortWord`	a word of one or two letters
`space`	any space (except `\n`)
`tag`	matches any HTML tag
`upperLetter`	any uppercase European or Cyrillic letter

Rules

Rules are available as named exports:

import { abbrs } from 'richtypo-common-rules';

Rule name	Description	Input	Output
`abbrs`	wrap abbreviations in `<abbr>` tags	`ONU`	`<abbr>ONU</abbr>`
`amps`	wrap an ampersand (&) in `<span class="amp">` tags	`Cie & Sons`	`Cie <span class="amp">&</span> Sons`
`dashes`	replace the hyphen character with a em dash and add non-breaking spaces when it makes sense.	`- Hello`	`— Hello`²
`degreeSigns`	add a hair space between numbers and degree symbol	`34 ° or 34°`	`34 °`
`ellipses`	replace three consecutive dots with an ellipsis	`oh...`	`oh…`
`numberUnits`	insert non-breaking space between numbers and the following word	`100 km`	`100 km`²
`orphans`	add a non-breaking space to avoid orphans	`We go to the mall`	`We go to the mall`²
`shortWords`	add a non-breaking space after short words	`We go to the mall`	`We go to the mall`²

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

Rule factories

Use factory rules to customize some common rules, like quotes, for your language. For example, quotes in English are written as “” while in French they are written as «».

import { quotesFactory } from 'richtypo-rules-common';
export const quotes = quotesFactory({
  openingQuote: '«',
  closingQuote: '»'
});

Rule	Arguments	Description
`numberOrdinalsFactory`	`{ ordinal }`	format 1st, 2nd, 3rd etc. into 1st, 2nd, 3rd. `ordinal` should be a regex array of strings such as `'(st \| nd \| rd \| th)'`.
`numberSeparatorsFactory`	`{ decimalsSeparator, thousandsSeparator }`	format numbers with thousands separator
`quotesFactory`	`{ openingQuote, closingQuote }`	replace dumb quotes with typography quotes