View on GitHub

check-spelling-docs

Documentation for check-spelling

Only check changed hunks

Some workflows would like to be able to only send feedback to contributors about the changes they're making as opposed to preexisting unrecognized content.

Background

As of v0.0.21, you can use only_check_changed_files: true to limit spell checking to changed files.

Considerations

Offhand, I think no is the right answer for all three.

Implementation

It should be fairly easy to use the equivalent of git blame BASE..HEAD -- file to identify which line numbers should be checked and only check them.

(It's possible the implementation will use porcelain output as opposed to actually using the naive git blame BASE..HEAD, but that's a minor implementation detail.)

Fancier

Run check-spelling on before/after for the file, diff the report items, and only report new items.

Tradeoff: this is, obviously, slower than the naive implementation, but the results would be quieter, which is probably more valuable for the average user.


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