View on GitHub


Documentation for check-spelling

Automatically truncate comment

Included in v0.0.20


GitHub comments are limited to 64k.

Typically, as part of the first-run experience, it's possible that there will be a very large number of unrecognized words in a lot of files that shouldn't be checked.

Possible Approaches


I'm currently truncating first the stale items, and then the misspelled items.

Generally during first run, the first thing to do is to tune excludes, and thus the focus should be on either adding excludes or adding dictionaries. Currently these two are not automatically truncated. If I get feedback that someone managed to have too many exclude suggestions, then I may add support for truncating that as well.

The log should include the truncated content.

FAQ | Showcase | Event descriptions | Configuration information | Known Issues | Possible features | Deprecations | Release notes | Helpful scripts