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.
retext
unified processor to add support for parsing and serializing
Latin-script natural language.
Contents
What is this?
This package is a unified processor with support for parsing Latin-script
natural language as input and serializing it as output by using unified with
retext-latin
and retext-stringify
.
See the monorepo readme for info on what the retext ecosystem is.
When should I use this?
You can use this package when you want to use unified, have Latin-script as
input, and as output.
This package is a shortcut for
unified().use(retextLatin).use(retextStringify)
.
When the input isn’t Latin-script or is English or Dutch (meaning you don’t
need retext-latin
), it’s recommended to use unified
directly.
Install
This package is ESM only.
In Node.js (version 16+), install with npm:
npm install retext
In Deno with esm.sh
:
import {retext} from 'https://esm.sh/retext@9'
In browsers with esm.sh
:
<script type="module">
import {retext} from 'https://esm.sh/retext@9?bundle'
</script>
Use
import {retext} from 'retext'
import retextEmoji from 'retext-emoji'
import retextProfanities from 'retext-profanities'
import {reporter} from 'vfile-reporter'
const file = await retext()
.use(retextEmoji, {convert: 'encode'})
.use(retextProfanities)
.process('He’s set on beating your butt for sheriff! :cop:')
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
API
This package exports the identifier retext
.
There is no default export.
retext()
Create a new unified processor that already uses
retext-latin
and retext-stringify
.
You can add more plugins with use
.
See unified
for more information.
Syntax tree
The syntax tree used in retext is nlcst.
Types
This package is fully typed with TypeScript.
It exports no additional types.
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@^9
, compatible
with Node.js 16.
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.
Support this effort and give back by sponsoring on OpenCollective!
License
MIT © Titus Wormer