retext-sentence-spacing

retext plugin to check spacing between sentences.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(retextSentenceSpacing[, options])
• Messages
• Types
• Compatibility
• Related
• Contribute
• License

What is this?

This package is a unified (retext) plugin to check spacing between sentences. For example, it can check for one or two spaces sentences.

When should I use this?

You can opt-into this plugin when you’re dealing with content that might contain 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-sentence-spacing

In Deno with esm.sh:

import retextSentenceSpacing from 'https://esm.sh/retext-sentence-spacing@5'

In browsers with esm.sh:

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

Use

Say our document example.txt contains:

One sentence. Two sentences.

One sentence.  Two sentences.

…and our module example.js looks as follows:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {retext} from 'retext'
import retextSentenceSpacing from 'retext-sentence-spacing'

const file = await retext()
  .use(retextSentenceSpacing)
  .process(await read('example.txt'))

console.error(reporter(file))

…now running node example.js yields:

example.txt
  3:14-3:16  warning  Expected `1` space between sentences, not `2`  space  retext-sentence-spacing

⚠ 1 warning

The default is to check for 1 space, which can be changed. For example, to 2 spaces:

 const file = await retext()
-  .use(retextSentenceSpacing)
+  .use(retextSentenceSpacing, {preferred: 2})
   .process(await read('example.txt'))

…now running node example.js once again yields:

example.txt
  1:14-1:15  warning  Expected `2` spaces between sentences, not `1`  double-space  retext-sentence-spacing

⚠ 1 warning

API

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

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

Check spacing between sentences. Emit warnings when the spacing does not adhere to the preferred style.

options.preferred

• 0 (or 'newline') — disallow spaces between sentences
• 1 (or 'space', default) — allow only one space between sentences
• 2 (or 'double-space') — allow only two spaces between sentences

Messages

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

message.source

Name of this plugin ('retext-sentence-spacing').

message.ruleId

Preferred style ('newline', 'space', or 'double-space').

message.actual

Current not ok spacing (string, such as ' ').

message.expected

List of suggestions of spacing to use (Array<string>, such as ['\n']).

Types

This package is fully typed with TypeScript. It exports the additional type Options.

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.

Related

• retext-contractions — check apostrophe use in contractions
• retext-diacritics — check for proper use of diacritics
• retext-quotes — check quote and apostrophe usage

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