The "Fossies" Software Archive
... Fresh Open Source Software mainly for Internet, Engineering and Science ...

Some small "codespell" usage hints

1) Just an untested hint: An alternative solution may be to use the tool "codespell" locally and use e.g. the option
 --write-changes
     ("write changes in place if possible")
together with the option
 --interactive 3
     ("ask for confirmation and ask user to choose one fix when more than one is available").
In such a case, the Fossies configuration may be usable as a helpful starting point for an appropriate list of words and files to be ignored (although some of the FPs that Fossies eliminated by post-filtering of the original codespell results must be so refused manually).

But anyway, do it very carefully!

Probably it's meaningful to use always codespell's latest main dictionary.txt.

The Fossies server itself uses additionally codespell's dictionary_rare.txt, a by Fossies generated extract of the orbitcowboy dictionary_all.txt and a small own Fossies extra dictionary (containing some misspellings not found in the other dictionaries or with further suggested spelling fixes).

2) And another hint for GitHub users: After the correction of the existing errors - maybe with Fossies help - you may use the GitHub Actions feature to detect possible spelling errors and typos in newly added or changed source code or documentation. Some nice approaches and suggestions you may find in the codespell issue #1499 and the corresponding actions-codespell repository.

3) There exists also an interactive Perl script correct.pl written by G. Finch for the LiVES project that generates patch files from the codespell output under the control of the user. The Fossies codespell list of found spelling errors and typos in the original text format (linked on the respective main project specific codespell page) can also be used.


Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  Codespell  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)