textlint-plugin-ruby

Ruby plugin for textlint

Install

Install with npm:

``sh
$ npm install --dev textlint-plugin-ruby
`

Install textlint-ruby with gem:

`sh


requires >= 2.0.0


$ gem install textlint-ruby
`

Usage

Put following config to .textlintrc

`json
{
"plugins": {
"ruby": true
}
}
`

$3

- 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

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

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

`json


Use gem installed with Gemfile.


{
"plugins": {
"ruby": {
"execCommand": ["bundle", "exec", "textlint-ruby", "--stdio"]
}
}
}
``