Skip to content

Commit 432f65c

Browse files
committed
DOC?MINOR: update .aspell.yml with configuration examples and comments
Expand the configuration file `.aspell.yml` to include detailed comments explaining the available settings such as mode, min_length, and ignoring identifiers. Also added commented-out examples for advanced features like fetching allowed words from a remote API and downloading dictionaries from GitHub/GitLab repositories or direct URLs. This makes it easier to understand and configure advanced spell-checking options.
1 parent 7fdaad4 commit 432f65c

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

.aspell.yml

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,49 @@
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
14
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)
313
ignore_files:
414
- '*test.go'
15+
16+
## Extra words to accept as correctly spelled (one per line, case-insensitive)
517
allowed:
618
- mri
719
- 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

Comments
 (0)