This project contains tools to check Espeak NG spelling changes for improvements and/or regressions.
1. Prepare file xx-words.txt
with list of checked files1.
2. Run ./espeak-ng-spellcheck.sh [lang]
where [lang]
is optional two letter language code (default is lv
)2:
xx_spelling_YYYY-MM-DD_HH-mm.txt
shows how words are spelledxx_spelling-diff.txt
shows differences from previousespeak-ng
run
-
xx_rule-results.txt
trace of rule decisions for all words -
xx_winning-rule-lines.txt
only winning lines filtered out fromrule-results.txt
-
xx_winning-lines.txt
full unsorted list of line numbers of winning rules -
xx_winning-lines-count.txt
count how many times each rule line has win for all words -
xx_unused-lines.txt
list of lines, which have never used (won) for spelling decisions
3. Make changes in xx_list
or xx_rules
file of espeak-ng
project.
5. Compare differences in produced log files and check for regressions.
6. Continue with step 3 etc.
1. There are already prepared files for several languages. You can get list of words in your language from e.g. from LibreOffice dictionary. Note, that words should finish with dot at the end, to make sure spelling output is in separate line for each word. If necessary you can put phrases in the line.
2. Script assumes espeak-ng poroject is located in ~/code/espeak-ng/
folder. Change settings (or project location) if necessary.