Check only visible text

[walseb]

Currently, commands like jinx-correct-all, and jinx-correct-nearest tries to correct words that aren't visible (for instance those folded with folding tools, or outline-mode).

While thorough, sometimes, this isn't useful. For instance today, I folded headings containing massive amounts of text in an attempt to exclude them from being spell checked when checking other text.

I could have achieved the same thing by narrowing a bunch of times and spell checking those individual buffers, but that would have taken a long time and be error prone. I ended up just patching Jinx to only check visible text.

Would you be open to a patch that adds a variable jinx-check-only-visible to change this behavior?

[minad]

Yes, please submit the patch. Jinx usually only updates unfolded regions lazily, but jinx-correct-all and jinx-correct-nearest enforce spell checking in the whole region, and does not take folded regions into account. We should also change that. Do you have the FSF papers signed, see https://github.com/minad/jinx?tab=readme-ov-file#contributions?

[walseb]

I see. This is a bug in your code. Your overlay should provide means for unfolding, e.g., via the Isearch unfolding API.

Thanks, I didn't know that! Is there any way to indicate that the overlay shouldn't be unfolded?

[walseb]

I suppose I could add a face to it and put that face in jinx-exclude-faces.

[walseb]

The reason I don't want it unfolded and checked is because the overlay often contains many non-words which shouldn't be corrected.

[minad]

The correct approach seems then to exclude this region from checking in the first place via jinx-exclude-faces or a custom predicate function in jinx--predicates. You could for example attach a custom property jinx-exclude=t which is then be checked by a predicate function.

[walseb]

I see, thank you so much for the help! Attaching a face and putting it in jinx-exclude-faces seems good for now. I think this can be closed.

[walseb]

I think this should also apply to jinx-next

[minad]

Yes, all commands jumping to misspellings will be affected.