retext-sentence-spacing
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatretext plugin to check spacing between sentences.
Contents
* [`unified().use(retextSentenceSpacing[, options])`](#unifieduseretextsentencespacing-options)
* [`Options`](#options)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 onlyesm. In Node.js (version 16+), install with npm:npm install retext-sentence-spacingIn Deno with
esm.shesmsh:import retextSentenceSpacing from 'https://esm.sh/retext-sentence-spacing@6'In browsers with
esm.shesmsh:<script type="module">
import retextSentenceSpacing from 'https://esm.sh/retext-sentence-spacing@6?bundle'
</script>Use
Say our documentexample.txt contains:One sentence. Two sentences.
One sentence. Two sentences.…and our module
example.js contains:import {retext} from 'retext'
import retextSentenceSpacing from 'retext-sentence-spacing'
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
const file = await retext()
.use(retextSentenceSpacing)
.process(await read('example.txt'))
console.error(reporter(file))…then running
node example.js yields:example.txt
3:14-3:16 warning Unexpected 2 spaces between sentence, expected 1 space space retext-sentence-spacing
⚠ 1 warningThe 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: 'double-space'})
.process(await read('example.txt'))…now running
node example.js once again yields:example.txt
1:14-1:15 warning Unexpected 1 space between sentence, expected 2 spaces double-space retext-sentence-spacing
⚠ 1 warningAPI
This package exports no identifiers. The default export isretextSentenceSpacingapi-retext-sentence-spacing.unified().use(retextSentenceSpacing[, options])
Check spacing between sentences.Parameters
options(Optionsapi-options, optional)
— configurationReturns
Transform (Transformerunified-transformer).Options
Configuration (TypeScript type).Fields
preferred('double-space','newline','space',0,1,2,
default: `'space'`)
— spaces to useMessages
Each message is emitted as aVFileMessagevfile-message on file, with
source set to 'retext-sentence-spacing', ruleId to the preferred style
('newline', 'space', or 'double-space'), actual to the unexpected
value, and expected to the expected value.Types
This package is fully typed with TypeScript. It exports the additional typeOptionsapi-options.Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,
retext-sentence-spacing@^6, compatible with Node.js 16.Related
— check apostrophe use in contractions— check for proper use of diacritics— check quote and apostrophe usageContribute
Seecontributing.mdcontributing in retextjs/.githubhealth for ways
to get started.
See support.mdsupport for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.
