Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vkatsuba/rebar3_sheldon
A rebar plugin for spellchecking
https://github.com/vkatsuba/rebar3_sheldon
erlang rebar3 rebar3-plugin spellcheck spellchecker
Last synced: 1 day ago
JSON representation
A rebar plugin for spellchecking
- Host: GitHub
- URL: https://github.com/vkatsuba/rebar3_sheldon
- Owner: vkatsuba
- License: apache-2.0
- Created: 2021-11-02T13:15:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-21T09:50:58.000Z (about 1 year ago)
- Last Synced: 2024-10-02T02:04:38.887Z (1 day ago)
- Topics: erlang, rebar3, rebar3-plugin, spellcheck, spellchecker
- Language: Erlang
- Homepage:
- Size: 39.1 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rebar3_sheldon
[![Hex.pm Version][hexpm version]][hexpm]
[![Hex.pm Downloads][hexpm downloads]][hexpm]
[![Build Status][gh badge]][gh]
[![Erlang Versions][erlang version badge]][gh]
A rebar plugin for spellchecking code with [Sheldon](https://github.com/inaka/sheldon).
## Build
```sh
$ rebar3 compile
```
## Use
Add the plugin to your rebar config:
```erlang
{project_plugins, [{rebar3_sheldon, "~> 0.3.1"}]}.
```
Then just call your plugin directly in an existing application:
```sh
$ rebar3 spellcheck
===> Fetching rebar3_sheldon
===> Compiling rebar3_sheldon
===> Youre welcome. And if he has twins, we can do all kinds of neat experiments on them.:
test/test_SUITE.erl:1: The word "Speling" in string is unknown. Maybe you wanted to use "speeling" or "speiling" or ....?
test/test_SUITE.erl:2: The word "fdfdf" in string is unknown.
test/test_SUITE.erl:3: The word "Unicode" in comment is unknown. Maybe you wanted to use "uncoded"?
```
## Command line
### Arguments List
```sh
$ rebar3 -h spellcheck
Plugin for spellcheck by sheldon
Usage: rebar3 spellcheck [-f ] [-i ] [-r ]
[-d ]
[-a ]
-f, --files List of files for spellchecker
-i, --ignore List of ignore files for spellchecker
-r, --ignore_regex Regular exemptions for ignore lines
-d, --default_dictionary Set default dictionary
-a, --additional_dictionaries List of additional dictionaries
```
### Short full example
```sh
$ rebar3 spellcheck -f 'src/*.erl, test/*erl' -i 'include/*.hrl' -r '[_@./#&+-=%*]' -d 'path/to/dict.txt' -a 'path/to.txt, additional_dict_1.txt'`
```
## Config
### Description
By default, the dictionary used is the one provided by [sheldon](https://github.com/inaka/sheldon).
If you need to use a custom list of files for spellchecking, use the config option `files`.
If you need to ignore some files for spellchecking, use the config option `ignore`.
If you need to ignore some particular strings or comments in your modules, use `ignore_regex` to set regular expressions and ignore the lines that match them.
If you want to directly replace Sheldon's dictionary with your own one, you can replace using the config option `default_dictionary`.
If you need to _expand_ Sheldon's dictionary with your own words, use the `additional_dictionaries` option pointing to your own dictionaries with which you want to expand Sheldon's.
### Options
Currently supported options for `spellcheck` configuration through `rebar.config`:
| Name | Type | Description |
| -------------------------- | ----------------- | --------------------------------------|
| `files` | `[string(), ...]` | List of files for spellchecker |
| `ignore` | `[string(), ...]` | List of ignore files for spellchecker |
| `ignore_regex` | `string()` | Regular exemptions for ignore lines |
| `default_dictionary` | `string()` | Set default dictionary |
| `additional_dictionaries` | `[string(), ...]` | List of additional dictionaries |
### Default
```erlang
{spellcheck, [
{files, ["include/**/*.[he]rl",
"include/**/*.app.src",
"src/**/*.[he]rl",
"src/**/*.app.src",
"test/**/*.[he]rl",
"test/**/*.app.src",
"{rebar,elvis,sys}.config"]}
]}.
```
### Example
```erlang
{spellcheck, [
{files, ["src/*.erl", "src/*/*.erl", "include/*.hrl"]},
{ignore, ["src/*_ignore.erl"]},
{ignore_regex, "[_@./#&+-=%*]"},
{default_dictionary, "path/to/default_dictionary.txt"},
{additional_dictionaries, ["path/to/custom_dictionary_1.txt", "path/to/custom_dictionary_2.txt"]}
]}.
```
## Dependencies
**Required OTP version 23** or or higher. We only provide guarantees that the system runs on `OTP23+` since that's what we're testing it in, but the `minimum_otp_vsn` is `"21"` because some systems where **rebar3_sheldon** is integrated do require it.
[hexpm]: https://hex.pm/packages/rebar3_sheldon
[hexpm version]: https://img.shields.io/hexpm/v/rebar3_sheldon.svg?style=flat-square
[hexpm downloads]: https://img.shields.io/hexpm/dt/rebar3_sheldon.svg?style=flat-square
[gh]: https://github.com/vkatsuba/rebar3_sheldon/actions/workflows/ci.yml
[gh badge]: https://img.shields.io/github/workflow/status/vkatsuba/rebar3_sheldon/CI?style=flat-square
[erlang version badge]: https://img.shields.io/badge/erlang-23.0%20to%2024.1-blue.svg?style=flat-square