|
| 1 | +## Spell check scope: disabled (off), subject (first line only), |
| 2 | +## commit (full commit message), all (commit + file content) |
| 3 | +# mode: disabled | subject | commit | all |
1 | 4 | mode: all |
2 | | -min_length: 3 |
| 5 | + |
| 6 | +## Minimum word length to spell-check (words shorter than this are skipped, default: 3) |
| 7 | +# min_length: 3 |
| 8 | + |
| 9 | +## If true, code identifiers found in the diff will NOT be excluded from spell check |
| 10 | +# no_ignore_identifiers: false |
| 11 | + |
| 12 | +## File patterns to skip when mode is "all" (glob syntax) |
3 | 13 | ignore_files: |
4 | 14 | - '*test.go' |
| 15 | + |
| 16 | +## Extra words to accept as correctly spelled (one per line, case-insensitive) |
5 | 17 | allowed: |
6 | 18 | - mri |
7 | 19 | - iid |
| 20 | + |
| 21 | +## Fetch an additional allowed-word list from a JSON API endpoint |
| 22 | +# remote_file: |
| 23 | +# ## Direct URL to fetch |
| 24 | +# url: "https://example.com/api/words" |
| 25 | +# ## Or read the URL from this environment variable instead |
| 26 | +# url_env: ALLOWED_WORDS_URL |
| 27 | +# ## Set a custom HTTP header whose value is read from the named env var |
| 28 | +# header_from_env: X-Custom-Header |
| 29 | +# ## Set PRIVATE-TOKEN header from this env var (GitLab/GitHub auth) |
| 30 | +# private_token_env: PRIVATE_TOKEN |
| 31 | +# ## JSON key that contains the word list in the response |
| 32 | +# allowed_items_key: words |
| 33 | + |
| 34 | +## Fetch dictionary files (.txt word lists or .rws aspell compiled dicts) from remote sources |
| 35 | +# dictionaries: |
| 36 | +# ## Fetch every .txt/.rws file from a GitHub repo directory |
| 37 | +# github: |
| 38 | +# - url: "https://github.com/haproxytech/check-commit/tree/main/aspell/dictionaries" |
| 39 | +# ## Optional env var holding a GitHub token (needed for private repos) |
| 40 | +# token_env: GITHUB_TOKEN |
| 41 | +# ## Fetch every .txt/.rws file from a GitLab repo directory (supports self-hosted instances) |
| 42 | +# gitlab: |
| 43 | +# - url: "https://gitlab.com/group/project/-/tree/main/path/to/dictionaries" |
| 44 | +# ## Optional env var holding a GitLab private token (needed for private repos) |
| 45 | +# token_env: GITLAB_TOKEN |
| 46 | +# ## Fetch individual dictionary files by direct URL |
| 47 | +# urls: |
| 48 | +# - "https://raw.githubusercontent.com/haproxytech/check-commit/main/aspell/dictionaries/computing.txt" |
| 49 | +# - "https://example.com/custom-words.txt" |
0 commit comments