Skip to content

Commit

Permalink
adding docs bout using pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
Borda committed Sep 26, 2023
1 parent 1f96324 commit 1ce39c8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,22 @@ If you need some more flexibility, you can completely exclude some files from co
extend-exclude = ["localized/*.po"]
```

### Supported config files

The default option is setting the configuration in `typos.toml`, `_typos.toml` or `.typos.toml`.

In addition, you can set the same configuration with standard python's config file `pyproject.toml` by adding `[tool.typos.xyz]` where the `xyz` is the same as in default `_typos.toml` so the sample configuration above will be:
```toml
[tool.typos.default]
extend-ignore-identifiers-re = ["AttributeID.*Supress.*"]

[tool.typos.default.extend-identifiers]
AttributeIDSupressMenu = "AttributeIDSupressMenu"

[tool.typos.default.extend-words]
teh = "teh"
```

### Integrations

- [GitHub Actions](docs/github-action.md)
Expand Down

0 comments on commit 1ce39c8

Please sign in to comment.