Documentation

textlint – pluggable linting tool for text and markdown

textlint is a pluggable linting tool for text and Markdown. This program is similar to ESLint, but it’s for use with natural language.

A linter is a computer program that, akin to a spell checker, scans through a file and detects issues — like how a real lint roller helps you get unwanted lint off of your shirt.

textlint performs the following steps:

  1. Loads rules, every single rule is a plugin and you can add more at runtime.
  2. Parses texts using Markdown/Text/HTML parser plugin.
  3. Uses an AST(Abstract Syntax Tree) to evaluate patterns in texts.
  4. Reports errors/warning if exist.

This is free and open source software.

Key Features

  • No bundled rules. To use a rule, install a textlint rule via npm.
  • Markdown and plain text are supported by default. Support is available for HTML and other file formats via plugins including reStructuredText, AsciiDoc, Re:VIEW, and Org-mode.
  • Supports the use of custom formatters and formatter bundles.

Website: textlint.org
Support: GitHub Code Repository
Developer: azu
License: MIT License

textlint is written in TypeScript. Learn TypeScript with our recommended free books and free tutorials.


Related Software

Linters
LanguageToolStyle and grammar checker for 30+ languages
ValeWrite with a consistent tone and style
ALEAsynchronous Lint Engine
textlintPluggable linting tool for text and markdown
HarperEnglish grammar checker designed to be just right
proselintAs the name suggests, this is a linter for prose
alexCatch insensitive, inconsiderate writing
write goodLinter for English prose
EloquentWorks fully offline, powered by the LanguageTool standalone server
RedPenProvides both a simple standalone command line tool and a server

Read our verdict in the software roundup.


Best Free and Open Source Software Explore our comprehensive directory of recommended free and open source software. Our carefully curated collection spans every major software category.

This directory is part of our ongoing series of informative articles for Linux enthusiasts. It features hundreds of detailed reviews, along with open source alternatives to proprietary solutions from major corporations such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk.

You’ll also find interesting projects to try, hardware coverage, free programming books and tutorials, and much more.

Discovered a useful open source Linux program that we haven’t covered yet? Let us know by completing this form.
Subscribe
Notify of
guest
0 Comments
Oldest
Newest Most Voted
Inline Feedbacks
View all comments