actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-22 00:51:11 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(faq): Add more debugging steps

Browse source 
Inspired by #909
This commit is contained in:
Ed Page 2024-01-23 14:31:16 -06:00
parent bdcaedb080
commit 9121fd01fe
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -148,7 +148,21 @@ If you need to dig in more, you can enable debug logging with `-v`
### Why was ... not corrected? ### Why was ... not corrected?
tl;dr `typos` doesn't know about it yet **Does the file show up in `typos --files`?**
If not, check your config with `typos --dump-config -`.
The `[files]` table controls how we walk files.
If you are using `files.extend-exclude`,
are you running into [#593](https://github.com/crate-ci/typos/issues/593)?
If you are using `files.ignore-vcs = true`,
is the file in your `.gitignore` but git tracks it anyways?
Prefer allowing the file explicitly (see [#909](https://github.com/crate-ci/typos/issues/909)).
**Does the identifier show up in `typos --identifers` or the word show up in `typos --words`?**
If not, it might be subject to one of typos' heuristics for
detecting non-words (like hashes) or
unambiguous words (like words after a `\` escape).
If it is showing up, likely `typos` doesn't know about it yet.
`typos` maintains a list of known typo corrections to keep the false positive `typos` maintains a list of known typo corrections to keep the false positive
count low so it can safely run unassisted. count low so it can safely run unassisted.