textlint

textlint

  • Docs
  • Rules
  • Blog
  • Help
  • GitHub

›User Manual

User Manual

  • Getting Started with textlint
  • Command Line Interface
  • Configuring textlint
  • Ignoring Text
  • Integrating with Editors, Tools, etc..

Developer Guide

  • Creating Rules
  • Creating Filter Rule
  • Creating Fixable Rule
  • Creating Preset
  • Advanced: Paragraph Rule
  • How to implement "after-all" in the rule?
  • Plugin
  • Formatter
  • Use as Node Modules
  • TxtAST Interface

Contributing

  • Contributing Guideline
Edit

Ignoring Text

Use .textlintignore to ignore certain files and folders completely.

Use textlint-filter-rule-comments to ignore parts of files.

Ignoring Files: .textlintignore

To exclude files from linting, create a .textlintignore file in the root of your project.

Example:

# Ignore file:
ignored.md

# Ignore by glob pattern:
vendor/**

:memo: textlint supports glob pattern of node-glob.

You can also specify path to a file containing patterns that describes files to ignore by --ignore-path flag.

Ignoring parts of files

textlint-filter-rule-comments provide filtering function by using comments.

<!-- textlint-disable -->

Disables all rules between comments

<!-- textlint-enable -->`

Allow to short textlint-filter-rule-comments to comments.

Add filter rule name to filters field.

{
  "filters": {
    "comments": true
  }
}
← Configuring textlintIntegrating with Editors, Tools, etc.. →
textlint
Docs
User ManualDeveloper Guide
Community
Project Chat
More
BlogGitHubStar
Copyright © 2023 textlint organization