Skip to content

Commit a33196d

Browse files
author
Ed Page
committed
docs: Add debugging steps
1 parent cff8cad commit a33196d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -89,5 +89,21 @@ typos dir/file --diff
8989
typos dir/file --format json
9090
```
9191

92+
### Debugging
93+
94+
You can see what the effective config looks like by running
95+
```bash
96+
typos --dump-config -
97+
```
98+
99+
You can then see how typos is processing your project with
100+
```bash
101+
typos --files
102+
typos --identifiers
103+
typos -- words
104+
```
105+
106+
If you need to dig in more, you can enable debug logging with `-v`
107+
92108
[Crates.io]: https://crates.io/crates/typos-cli
93109
[Documentation]: https://docs.rs/typos

0 commit comments

Comments
 (0)