plugins.md

Plugins

retext is a tool that transforms natural language with plugins. See the monorepo readme for info on what the retext ecosystem is. This page lists existing plugins.

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.

The list of plugins:

• retext-assuming — check for unhelpful phrases such as just, simply, obviously
• retext-case-police — check for popular names casing (github → GitHub)
• 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-intensify — check for weak and mitigating wording
• retext-keywords — extract keywords and keyphrases
• retext-latin — Latin-script language support
• retext-lexrank — add Lexrank scores to sentences
• 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 — serialize back to text
• retext-syntax-mentions — classify @mentions as syntax
• retext-syntax-urls — classify url-like values (example.com, example.md, etc) 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 that work with the syntax tree. See unist for other utilities which work with nlcst and other syntax trees too. Finally, see vfile for a list of utilities working with virtual files.

Using plugins

To use a plugin programmatically, call the use() function.

Creating plugins

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, discussions is a good place to get help.

You should pick a name prefixed by 'retext-' (such as retext-emoji). 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-', if it works with any unist tree, use unist-util-, and if it works with virtual files, use vfile-.

Use default exports to expose plugins from your packages, add retext-plugin keywords in package.json, add a retext-plugin topic to your repo on GitHub, and create a pull request to add the plugin here on this page!