{"id":15470438,"url":"https://github.com/vkatsuba/rebar3_sheldon","last_synced_at":"2026-03-10T06:33:29.395Z","repository":{"id":45652272,"uuid":"423850281","full_name":"vkatsuba/rebar3_sheldon","owner":"vkatsuba","description":"A rebar plugin for spellchecking","archived":false,"fork":false,"pushed_at":"2023-08-21T09:50:58.000Z","size":40,"stargazers_count":6,"open_issues_count":12,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-12-13T01:57:09.914Z","etag":null,"topics":["erlang","rebar3","rebar3-plugin","spellcheck","spellchecker"],"latest_commit_sha":null,"homepage":"","language":"Erlang","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vkatsuba.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-02T13:15:40.000Z","updated_at":"2025-07-27T22:13:36.000Z","dependencies_parsed_at":"2025-03-03T16:47:16.000Z","dependency_job_id":null,"html_url":"https://github.com/vkatsuba/rebar3_sheldon","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":"vkatsuba/rebar3_plugin","purl":"pkg:github/vkatsuba/rebar3_sheldon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_sheldon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_sheldon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_sheldon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_sheldon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vkatsuba","download_url":"https://codeload.github.com/vkatsuba/rebar3_sheldon/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_sheldon/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30326891,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T05:25:20.737Z","status":"ssl_error","status_checked_at":"2026-03-10T05:25:17.430Z","response_time":106,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["erlang","rebar3","rebar3-plugin","spellcheck","spellchecker"],"created_at":"2024-10-02T02:04:41.618Z","updated_at":"2026-03-10T06:33:29.360Z","avatar_url":"https://github.com/vkatsuba.png","language":"Erlang","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rebar3_sheldon\n[![Hex.pm Version][hexpm version]][hexpm]\n[![Hex.pm Downloads][hexpm downloads]][hexpm]\n[![Build Status][gh badge]][gh]\n[![Erlang Versions][erlang version badge]][gh]\n\nA rebar plugin for spellchecking code with [Sheldon](https://github.com/inaka/sheldon).\n\n## Build\n\n```sh\n$ rebar3 compile\n```\n\n## Use\n\nAdd the plugin to your rebar config:\n\n```erlang\n{project_plugins, [{rebar3_sheldon, \"~\u003e 0.3.1\"}]}.\n```\n\nThen just call your plugin directly in an existing application:\n```sh\n$ rebar3 spellcheck\n===\u003e Fetching rebar3_sheldon\n===\u003e Compiling rebar3_sheldon\n===\u003e Youre welcome. And if he has twins, we can do all kinds of neat experiments on them.:\ntest/test_SUITE.erl:1: The word \"Speling\" in string is unknown. Maybe you wanted to use \"speeling\" or \"speiling\" or ....?\ntest/test_SUITE.erl:2: The word \"fdfdf\" in string is unknown.\ntest/test_SUITE.erl:3: The word \"Unicode\" in comment is unknown. Maybe you wanted to use \"uncoded\"?\n```\n\n## Command line\n### Arguments List\n```sh\n$ rebar3 -h spellcheck\nPlugin for spellcheck by sheldon\nUsage: rebar3 spellcheck [-f \u003cfiles\u003e] [-i \u003cignore\u003e] [-r \u003cignore_regex\u003e]\n                         [-d \u003cdefault_dictionary\u003e]\n                         [-a \u003cadditional_dictionaries\u003e]\n\n  -f, --files                    List of files for spellchecker\n  -i, --ignore                   List of ignore files for spellchecker\n  -r, --ignore_regex             Regular exemptions for ignore lines\n  -d, --default_dictionary       Set default dictionary\n  -a, --additional_dictionaries  List of additional dictionaries\n```\n### Short full example\n```sh\n$ rebar3 spellcheck -f 'src/*.erl, test/*erl' -i 'include/*.hrl' -r '[_@./#\u0026+-=%*]' -d 'path/to/dict.txt' -a 'path/to.txt, additional_dict_1.txt'`\n```\n\n## Config\n### Description\nBy default, the dictionary used is the one provided by [sheldon](https://github.com/inaka/sheldon).\nIf you need to use a custom list of files for spellchecking, use the config option `files`.\nIf you need to ignore some files for spellchecking, use the config option `ignore`.\nIf 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.\nIf you want to directly replace Sheldon's dictionary with your own one, you can replace using the config option `default_dictionary`.\nIf 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.\n\n### Options\nCurrently supported options for `spellcheck` configuration through `rebar.config`:\n| Name                       | Type              | Description                           |\n| -------------------------- | ----------------- | --------------------------------------|\n| `files`                    | `[string(), ...]` | List of files for spellchecker        |\n|  `ignore`                  | `[string(), ...]` | List of ignore files for spellchecker |\n|  `ignore_regex`            | `string()`        | Regular exemptions for ignore lines   |\n|  `default_dictionary`      | `string()`        | Set default dictionary                |\n|  `additional_dictionaries` | `[string(), ...]` | List of additional dictionaries       |\n\n### Default\n```erlang\n{spellcheck, [\n    {files, [\"include/**/*.[he]rl\",\n             \"include/**/*.app.src\",\n             \"src/**/*.[he]rl\",\n             \"src/**/*.app.src\",\n             \"test/**/*.[he]rl\",\n             \"test/**/*.app.src\",\n             \"{rebar,elvis,sys}.config\"]}\n]}.\n```\n\n### Example\n```erlang\n{spellcheck, [\n    {files, [\"src/*.erl\", \"src/*/*.erl\", \"include/*.hrl\"]},\n    {ignore, [\"src/*_ignore.erl\"]},\n    {ignore_regex, \"[_@./#\u0026+-=%*]\"},\n    {default_dictionary, \"path/to/default_dictionary.txt\"},\n    {additional_dictionaries, [\"path/to/custom_dictionary_1.txt\", \"path/to/custom_dictionary_2.txt\"]}\n]}.\n```\n\n## Dependencies\n\n**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.\n\n\u003c!-- Badges --\u003e\n[hexpm]: https://hex.pm/packages/rebar3_sheldon\n[hexpm version]: https://img.shields.io/hexpm/v/rebar3_sheldon.svg?style=flat-square\n[hexpm downloads]: https://img.shields.io/hexpm/dt/rebar3_sheldon.svg?style=flat-square\n[gh]: https://github.com/vkatsuba/rebar3_sheldon/actions/workflows/ci.yml\n[gh badge]: https://img.shields.io/github/workflow/status/vkatsuba/rebar3_sheldon/CI?style=flat-square\n[erlang version badge]: https://img.shields.io/badge/erlang-23.0%20to%2024.1-blue.svg?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvkatsuba%2Frebar3_sheldon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvkatsuba%2Frebar3_sheldon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvkatsuba%2Frebar3_sheldon/lists"}