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

docs: Add debugging steps

Browse source
This commit is contained in:
Ed Page 2021-05-28 18:37:01 -05:00
parent cff8cadc6e
commit a33196d0d8
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -89,5 +89,21 @@ typos dir/file --diff
typos dir/file --format json typos dir/file --format json
``` ```
### Debugging
You can see what the effective config looks like by running
```bash
typos --dump-config -
```
You can then see how typos is processing your project with
```bash
typos --files
typos --identifiers
typos -- words
```
If you need to dig in more, you can enable debug logging with `-v`
[Crates.io]: https://crates.io/crates/typos-cli [Crates.io]: https://crates.io/crates/typos-cli
[Documentation]: https://docs.rs/typos [Documentation]: https://docs.rs/typos