plugins.md

Plugins

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

Table of Contents

• List of Plugins
• List of Utilities
• Using plugins
• Creating plugins

List of Plugins

See awesome retext for the most awesome projects in the ecosystem. More plugins can be found on GitHub tagged with the retext-plugin topic.

Have a good idea for a new plugin? See Creating plugins below.

• retext-cliches — check phrases for cliches
• retext-contractions — check apostrophe use in contractions
• retext-diacritics — check for proper use of diacritics
• retext-dutch — dutch language support
• retext-english — English language support
• retext-emoji — encode or decode gemoji
• retext-equality — warn about possible insensitive, inconsiderate language
• retext-indefinite-article — check if indefinite articles (a, an) are used correctly
• retext-keywords — extract keywords and keyphrases
• retext-latin — Latin-script language support
• retext-overuse — check words for overuse
• retext-passive — check for passive voice
• retext-profanities — check profane and vulgar wording
• retext-readability — check readability
• retext-redundant-acronyms — check redundant acronyms (ATM machine > ATM)
• retext-repeated-words — check for for repeated words
• retext-sentence-spacing — check spacing between sentences
• retext-sentiment — detect sentiment in text
• retext-simplify — check phrases for simpler alternatives
• retext-smartypants — implementation of SmartyPants
• retext-spell — check spelling
• retext-stringify — compile back to text
• retext-syntax-mentions — classify @mentions as syntax
• retext-usage — check incorrect English usage
• retext-quotes — check quote and apostrophe usage

List of Utilities

See nlcst for a list of utilities for working with the syntax tree. See unist for other utilities which work with nlcst nodes, too. Finally, see vfile for a list of utilities working with virtual files.

Using plugins

To use a plugin invoke the use() function.

Creating plugins

Have an idea for a plugin? Post it on spectrum or in ideas and make it happen!

To create a plugin, first read up on the concept of plugins. Then, read the guide on “Creating a plugin with unified”. Finally, take one of existing plugins, which looks similar to what you’re about to make, and work from there. If you get stuck, spectrum, ideas, and issues are good places to get help.

You should pick a name prefixed by 'retext-', such as retext-spell.

Do not use the retext- prefix if the thing you create doesn’t work with retext().use(): it isn’t a “plugin” and will confuse users. If it works with nlcst, use 'nlcst-util-', if it works with any unist tree, use unist-util-, and if it works with virtual files, use vfile-.