retext

What is retext?

Retext is a natural language processing (NLP) framework for analyzing and manipulating text. It provides a variety of plugins to perform tasks such as spell checking, sentiment analysis, and readability scoring.

What are retext's main functionalities?

Spell Checking

This feature allows you to check the spelling of text. The code sample demonstrates how to use the `retext-spell` plugin with an English dictionary to identify spelling errors in a given text.

const retext = require('retext');
const retextSpell = require('retext-spell');
const dictionary = require('dictionary-en');
const report = require('vfile-reporter');

retext()
  .use(retextSpell, dictionary)
  .process('speling errror', function (err, file) {
    console.error(report(err || file));
  });

Sentiment Analysis

This feature allows you to analyze the sentiment of text. The code sample demonstrates how to use the `retext-sentiment` plugin to determine the sentiment polarity and valence of a given text.

const retext = require('retext');
const retextSentiment = require('retext-sentiment');
const report = require('vfile-reporter');

retext()
  .use(retextSentiment)
  .process('I love programming!', function (err, file) {
    console.error(report(err || file));
    console.log(file.data); // { polarity: 3, valence: 1 }
  });

Readability Scoring

This feature allows you to score the readability of text. The code sample demonstrates how to use the `retext-readability` plugin to determine the readability age of a given text.

const retext = require('retext');
const retextReadability = require('retext-readability');
const report = require('vfile-reporter');

retext()
  .use(retextReadability, { age: 18 })
  .process('The cat sat on the mat.', function (err, file) {
    console.error(report(err || file));
    console.log(file.data); // { readability: { age: 6 } }
  });

Other packages similar to retext

natural

Natural is a general natural language processing (NLP) library for Node.js. It provides functionalities such as tokenization, stemming, classification, and phonetics. Compared to retext, Natural offers a broader range of NLP tools but may not be as specialized in text analysis and manipulation.

compromise

Compromise is a lightweight NLP library for Node.js that focuses on fast and easy text processing. It provides features like part-of-speech tagging, named entity recognition, and text normalization. While it offers some similar functionalities to retext, it is designed to be more user-friendly and performant for common NLP tasks.

README

retext

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

• API by unified
• Parses natural language to the tree with retext-latin
• nlcst syntax tree
• Plugins transform the tree
• Compiles the tree to markdown using retext-stringify

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

Sponsors

🥇 ZEIT

🥇 Gatsby

🥉 Compositor

Holloway

You?

Read more about the unified collective on Medium »

Install

npm:

npm install retext

Use

var retext = require('retext')
var profanities = require('retext-profanities')
var emoji = require('retext-emoji')
var report = require('vfile-reporter')

retext()
  .use(profanities)
  .use(emoji, {convert: 'encode'})
  .process('He’s set on beating your butt for sheriff! :cop:', function(err, file) {
    console.log(String(file))
    console.error(report(err || 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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer