unified

Project: retextjs/retext-quotes

Package: retext-quotes@5.2.0

  1. Dependents: 0
  2. retext plugin to check quotes and apostrophes
  1. unified 182
  2. plugin 136
  3. retext 41
  4. retext-plugin 26
  5. apostrophe 2

retext-quotes

Build Coverage Downloads Size Sponsors Backers Chat

retext plugin to check quotes and apostrophes.

Contents

What is this?

This package is a unified (retext) plugin to check quotes and apostrophes. It warns if their style ("straight" or “smart”) or level of nesting is not the preferred style.

When should I use this?

You can opt-into this plugin when you’re dealing with content that might contain punctuation mistakes, and have authors that can fix that content.

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-quotes

In Deno with esm.sh:

import retextQuotes from 'https://esm.sh/retext-quotes@5'

In browsers with esm.sh:

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

Use

Say our document example.txt contains:

A sentence "with quotes, 'nested' quotes,
and '80s apostrophes."

…and our module example.js looks as follows:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {unified} from 'unified'
import retextEnglish from 'retext-english'
import retextQuotes from 'retext-quotes'
import retextStringify from 'retext-stringify'

const file = await unified()
  .use(retextEnglish)
  .use(retextQuotes)
  .use(retextStringify)
  .process(file)
  .process(await read('example.txt'))

console.error(reporter(file))

…now running node example.js yields:

example.txt
  1:12-1:13  warning  Expected a smart quote: `“`, not `"`       quote       retext-quotes
  1:26-1:27  warning  Expected a smart quote: `‘`, not `'`       quote       retext-quotes
  1:33-1:34  warning  Expected a smart quote: `’`, not `'`       quote       retext-quotes
    2:5-2:6  warning  Expected a smart apostrophe: `’`, not `'`  apostrophe  retext-quotes
  2:22-2:23  warning  Expected a smart quote: `”`, not `"`       quote       retext-quotes

⚠ 5 warnings

The default is to prefer smart quotes. This can be changed to straight:

   .use(retextEnglish)
-  .use(retextQuotes)
+  .use(retextQuotes, {preferred: 'straight'})
   .use(retextStringify)

…now running node example.js once more yields:

no issues found

You can pass in different markers that count as “smart”:

   .use(retextEnglish)
-  .use(retextQuotes)
+  .use(retextQuotes, {smart: ['«»', '‹›']})
   .use(retextStringify)

…now running node example.js a final time yields:

example.txt
  1:12-1:13  warning  Expected a smart quote: `«`, not `"`       quote       retext-quotes
  1:26-1:27  warning  Expected a smart quote: `‹`, not `'`       quote       retext-quotes
  1:33-1:34  warning  Expected a smart quote: `›`, not `'`       quote       retext-quotes
    2:5-2:6  warning  Expected a smart apostrophe: `’`, not `'`  apostrophe  retext-quotes
  2:22-2:23  warning  Expected a smart quote: `»`, not `"`       quote       retext-quotes

⚠ 5 warnings

API

This package exports no identifiers. The default export is retextQuotes.

unified().use(retextQuotes[, options])

Check quotes and apostrophes. Emit warnings when they don’t match the preferred style.

This plugin knows about apostrophes as well and prefers ' when preferred: 'straight', and otherwise.

The values in straight and smart can be one or two characters. When two, the first character determines the opening quote and the second the closing quote at that level. When one, both the opening and closing quote are that character.

The order in which the preferred quotes appear in their respective list determines which quotes to use at which level of nesting. So, to prefer ‘’ at the first level of nesting, and “” at the second, pass: smart: ['‘’', '“”'].

If quotes are nested deeper than the given amount of quotes, the markers wrap around: a third level of nesting when using smart: ['«»', '‹›'] should have double guillemets, a fourth single, a fifth double again, etc.

options

Configuration (optional).

options.preferred

Style of quotes to prefer ('smart' or 'straight', default: 'smart').

options.straight

List of quotes to see as “straight” (Array<string>, default: ['"', '\'']).

options.smart

List of quotes to see as “smart” (Array<string>, default: ['“”', '‘’']).

Messages

Each message is emitted as a VFileMessage on file, with the following fields:

message.source

Name of this plugin ('retext-quotes').

message.ruleId

Category of message ('apostrophe' or 'quote')

message.actual

Current not ok character (string).

message.expected

Suggested replacement character (Array<string>).

Types

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

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