https://github.com/prontolabs/pronto-spell

Pronto runner that uses Aspell for spell checking
https://github.com/prontolabs/pronto-spell

analyzer aspell pronto pronto-runner spell-check spellchecker

Last synced: 4 months ago
JSON representation

Pronto runner that uses Aspell for spell checking

• Host: GitHub
• URL: https://github.com/prontolabs/pronto-spell
• Owner: prontolabs
• License: mit
• Created: 2013-12-17T19:32:49.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2022-12-31T14:25:17.000Z (almost 3 years ago)
• Last Synced: 2025-06-09T14:17:00.520Z (4 months ago)
• Topics: analyzer, aspell, pronto, pronto-runner, spell-check, spellchecker
• Language: Ruby
• Size: 37.1 KB
• Stars: 5
• Watchers: 3
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Pronto runner that uses Aspell for spell checking

[![Code Climate](https://codeclimate.com/github/prontolabs/pronto-spell.png)](https://codeclimate.com/github/prontolabs/pronto-spell)

[![Build Status](https://github.com/prontolabs/pronto-spell/actions/workflows/checks.yml/badge.svg)](https://github.com/prontolabs/pronto-spell/actions/workflows/checks.yml)

[![Gem Version](https://badge.fury.io/rb/pronto-spell.png)](http://badge.fury.io/rb/pronto-spell)

Pronto runner that uses [Aspell](https://github.com/YorickPeterse/ffi-aspell) for spell checking. [What is Pronto?](https://github.com/prontolabs/pronto)

## Prerequisites

You'll need to install Aspell:

* Arch Linux: `sudo pacman -S aspell`

* OS X: (`brew install aspell --lang=en`)

## Configuration

In order to change configuration, you need to create `.pronto_spell.yml` file in your project root directory. Awailable options are:

```YAML

suggestion_mode: 'fast' # default

language: 'en_US' # default

min_word_length: 5 # default

max_word_length: 999 # default is Infinity

max_suggestions_number: 3 # default

ignored_words: # words in this list won't be marked as misspelled

  - aspell

  - boolean

  - datetime

only_lines_matching: # spell checker will run only if the diff contains a word in this list

  - context

  - describe

```

It's also handy to have `.pronto.yml`. Here is configuration, designed for rails project:

```YAML

spell:

  exclude:

    - 'yarn.lock'

    - 'Gemfile.lock'

    - 'Gemfile'

    - 'package.json'

    - '.*.yml'

    - '*.json'

```