textlint-plugin-ruby

textlint-plugin-ruby

Ruby plugin for textlint

Install

Install with npm:

$ npm install --dev textlint-plugin-ruby

Install textlint-ruby with gem:

# requires >= 2.0.0
$ gem install textlint-ruby

Usage

Put following config to .textlintrc

{
  "plugins": {
    "ruby": true
  }
}

Options

• extensions: string[]
  • Additional file extensions for markdown
• execCommand: string[]
  • Default ["textlint-ruby", "--stdio"]
  • Set textlint-ruby executable command

For example, if you want to treat custom extensions as ruby, put following config to .textlintrc

{
  "plugins": {
    "ruby": {
      "extensions": [".rbx"]
    }
  }
}

For example, if you want to set specific textlint-ruby executable path, put following config to .textlintrc

# Use gem installed with Gemfile.
{
  "plugins": {
    "ruby": {
      "execCommand": ["bundle", "exec", "textlint-ruby", "--stdio"]
    }
  }
}