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