https://github.com/kufu/textlint-plugin-ruby

Ruby plugin for textlint
https://github.com/kufu/textlint-plugin-ruby

Last synced: about 6 hours ago
JSON representation

Ruby plugin for textlint

• Host: GitHub
• URL: https://github.com/kufu/textlint-plugin-ruby
• Owner: kufu
• License: mit
• Created: 2022-01-17T00:58:20.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-03T01:39:32.000Z (4 months ago)
• Last Synced: 2024-10-18T11:25:41.426Z (21 days ago)
• Language: TypeScript
• Size: 138 KB
• Stars: 1
• Watchers: 65
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# textlint-plugin-ruby

Ruby plugin for [textlint](https://github.com/textlint/textlint)

## Install 

Install with [npm](https://www.npmjs.com/):

```sh

$ npm install --dev textlint-plugin-ruby

```

Install [textlint-ruby](https://github.com/kufu/textlint-ruby) with [gem](https://guides.rubygems.org/command-reference/#gem-install):

```sh

# requires >= 2.0.0

$ gem install textlint-ruby

```

## Usage

Put following config to `.textlintrc`

```json

{

  "plugins": {

    "ruby": true

  }

}

```

### Options

- `extensions`: `string[]`

  - Additional file extensions for markdown

- `execCommand`: `string[]`

  - Default `["textlint-ruby", "--stdio"]`

  - Set [textlint-ruby](https://github.com/kufu/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"]

    }

  }

}

```