unified

Project: retextjs/retext-quotes

Package: retext-quotes@4.0.0

  1. Dependencies: 3·Dependents: 7
  2. retext plugin to check quotes and apostrophes
  1. unified 145
  2. plugin 128
  3. retext 33
  4. retext-plugin 21
  5. apostrophe 2

retext-quotes

Build Coverage Downloads Size Sponsors Backers Chat

retext plugin to check quotes and apostrophes, and warn if their style ("straight" or “smart”) or level of nesting is not the preferred style.

Install

npm:

npm install retext-quotes

Use

Say we have the following file, example.txt:

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

…and our script, example.js, looks like this:

var vfile = require('to-vfile')
var report = require('vfile-reporter')
var unified = require('unified')
var english = require('retext-english')
var stringify = require('retext-stringify')
var quotes = require('retext-quotes')

unified()
  .use(english)
  .use(quotes)
  .use(stringify)
  .process(vfile.readSync('example.txt'), function(err, file) {
    console.error(report(err || file))
  })

Now, running node example 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

This plugin can be configured to prefer “straight” quotes instead:

   .use(english)
-  .use(quotes)
+  .use(quotes, {preferred: 'straight'})
   .use(stringify)

Now, running node example again would yield:

no issues found

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

   .use(english)
-  .use(quotes)
+  .use(quotes, {smart: ['«»', '‹›']})
   .use(stringify)

Running node example 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

retext().use(quotes[, 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.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>).

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