textlintThe pluggable linting tool for text and markdown

Getting Started

textlint is an open source text linting utility written in JavaScript. It is hard to lint natural language texts, but we try to resolve this issue by pluggable approach.

Rules

To use a rule, simply run npm install textlint-rule-xxx. See the collection of textlint rules.

Markdown & Texts

Markdown and plain text are supported by default. HTML and other formats are offered by custom plugins

Custom Formatters

Formatter is used both by bundled and custom formatters

Getting Started

You can use textlint by following steps:
For more details, see documents.

  1. Create your project:
    npm init --yes
  2. Install textlint into your project:
    npm install --save-dev textlint
  3. Install textlint rule:
    npm install --save-dev textlint-rule-no-todo
  4. Create .textlintrc file:
    npx textlint --init
  5. Run textlint:
    npx textlint README.md
  1. $ npm init --yes Wrote to ~/textlint-demo/package.json: { "name": "textlint-demo", "version": "1.0.0" }
  2. $ npm install --save-dev textlint + textlint@10.0.0 added 239 packages in 10.23s
  3. $ npm install --save-dev textlint-rule-no-todo + textlint@latest added 239 packages in 10.23s
  4. $ npx textlint --init Create .textlintrc
  5. $npx textlint README.md ~/textlint-demo/README.md 1:3 error Found TODO: '- [ ] Write usage' no-todo ✖ 1 problem (1 error, 0 warnings)

Playground

Take textlint for a spin, start typing below.
Want to try more? Go to playground.

Who's Using This?

This project is used by all these people. More textlint users.