blob: 299755ead10865d26af0668a00e8ec20625d02ee (
plain)
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
|
# What's this
This script is a spell checker for GoBGP's source codes.
## Requirements
- [scspell3k](https://pypi.python.org/pypi/scspell3k): Spell checker for
source code written in Python.
```bash
pip install scspell3k
```
## How to use
Just run `scspell.sh`.
```bash
bash tools/spell-check/scspell.sh
```
Example of output:
```bash
# Format:
# path/to/file.go: <messages>
xxx/xxx.go: 'mispeld' not found in dictionary (from token 'Mispeld')
```
## Adding new words to dictionary
If you want to add new words to the dictionary for this spell checker, please
insert words into `tools/spell-check/dictionary.txt` or
`tools/spell-check/ignore.txt`.
|
