# textlint-plugin-ruby

> Ruby plugin for textlint

Latest version **3.0.3** (published 2022-02-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install textlint-plugin-ruby
pnpm add textlint-plugin-ruby
yarn add textlint-plugin-ruby
bun add textlint-plugin-ruby
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2022-02-24 |
| First published | 2021-11-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 34.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | SmartHR textlint Team |
| Maintainers | alpaca-tc, nabeliwo, atsushim, koba04, im36.123, smarthr-dev, ykarakita, cidermitaina, meganemura, wata727, wmoai, diescake, moshisora, tokky0425, hawaiiman, smarthr-admin, yamamoto-yuta, kgsi, otapo, kuny |
| Keywords | textlint, textlintplugin, ruby |

## Links

- npm: https://www.npmjs.com/package/textlint-plugin-ruby
- Repository: https://github.com/kufu/textlint-plugin-ruby
- Homepage: https://github.com/kufu/textlint-plugin-ruby#readme
- Issues: https://github.com/kufu/textlint-plugin-ruby/issues
- npm.io page: https://npm.io/package/textlint-plugin-ruby

## Dependencies (2)

- [tmp](https://npm.io/package/tmp.md) ^0.2.1
- [@textlint/ast-node-types](https://npm.io/package/@textlint/ast-node-types.md) ^12.1.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 3.0.3 (latest) — 2022-02-24
- 3.0.2 — 2022-01-27
- 3.0.1 — 2022-01-06
- 3.0.0 — 2021-12-02
- 2.0.0 — 2021-12-02
- 1.0.0 — 2021-11-29

## 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"]
    }
  }
}
```

---
_Source: https://npm.io/package/textlint-plugin-ruby · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._