npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

retext-spell

v6.1.0

Published

retext plugin to check spelling

Downloads

73,095

Readme

retext-spell

Build Coverage Downloads Size Sponsors Backers Chat

retext plugin to check spelling.

Contents

What is this?

This package is a unified (retext) plugin to check spelling with nspell and a dictionary.

When should I use this?

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

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install retext-spell

In Deno with esm.sh:

import retextSpell from 'https://esm.sh/retext-spell@6'

In browsers with esm.sh:

<script type="module">
  import retextSpell from 'https://esm.sh/retext-spell@6?bundle'
</script>

Use

import dictionaryEn from 'dictionary-en'
import {retext} from 'retext'
import retextSpell from 'retext-spell'
import {reporter} from 'vfile-reporter'

const file = await retext()
  .use(retextSpell, {dictionary: dictionaryEn})
  .process('Some useles documeant.')

console.error(reporter(file))

Yields:

1:6-1:12  warning Unexpected unknown word `useles`, expected for example `useless`     useles    retext-spell
1:13-1:22 warning Unexpected unknown word `documeant`, expected for example `document` documeant retext-spell

⚠ 2 warnings

API

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

unified().use(retextSpell, options)

Check spelling.

Parameters
  • options (Options, required) — configuration
Returns

Transform (Transformer).

Dictionary

Dictionary function (TypeScript type).

Type
type Dictionary = (onload: OnLoad) => undefined | void

type OnLoad = (error: Error | undefined, result?: unknown) => undefined | void

Options

Configuration (TypeScript type).

Fields
  • dictionary (Dictionary, required) — dictionary function; result of importing one of the dictionaries in wooorm/dictionaries
  • ignore (Array<string>, optional) — list of words to ignore
  • ignoreLiteral (boolean, default: true) — whether to ignore literal words
  • ignoreDigits (boolean, default: true) — whether to ignore “words” that contain digits or times such as 123456 or 2:41pm
  • max (number, default: 30) — number of times to suggest; further misspellings do not get suggestions
  • normalizeApostrophes (boolean, default: true) — normalize smart apostrophes () as straight (') apostrophes; dictionaries sometimes don’t support smart apostrophes
  • personal (Buffer in UTF-8 or string, optional) — personal dictionary to use

Messages

Each message is emitted as a VFileMessage on file, with source set to 'retext-spell', ruleId to the normalized unknown word, actual to the unknown word, and expected to an array with suggestions.

Types

This package is fully typed with TypeScript. It exports the additional types Dictionary and 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-spell@^6, compatible with Node.js 16.

Related

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