JSPM

  • Created
  • Published
  • Downloads 624208
  • Score
    100M100P100Q184968F
  • License MIT

natural language processor powered by plugins part of the unified collective

Package Exports

  • retext

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (retext) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

retext

Build Coverage Downloads Size Sponsors Backers Chat

retext is a natural language processor powered by plugins part of the unified collective.

Don’t need the parser? Or the compiler? That’s OK.

Sponsors

Support this effort and give back by sponsoring on OpenCollective!

Gatsby 🥇

Vercel 🥇

Netlify

Holloway

ThemeIsle

Boost Hub

Expo


You?

Install

npm:

npm install retext

Use

import {retext} from 'retext'
import retextProfanities from 'retext-profanities'
import retextEmoji from 'retext-emoji'
import {reporter} from 'vfile-reporter'

retext()
  .use(retextProfanities)
  .use(retextEmoji, {convert: 'encode'})
  .process('He’s set on beating your butt for sheriff! 👮')
  .then((file) => {
    console.log(String(file))
    console.error(reporter(file))
  })

Yields:

He’s set on beating your butt for sheriff! 👮
  1:26-1:30  warning  Be careful with “butt”, it’s profane in some cases  butt  retext-profanities

⚠ 1 warning

Contribute

See contributing.md in retextjs/.github for ways to get started. See support.md for ways to get help. Ideas for new plugins and tools can be posted in retextjs/ideas.

A curated list of awesome retext resources can be found in awesome retext.

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