Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding docs about using pyproject.toml #834

Closed
wants to merge 2 commits into from
Closed

adding docs about using pyproject.toml #834

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ce39c8
adding docs bout using `pyproject.toml`
Borda Sep 26, 2023
4462e81
format config
Borda Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
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"
```
Borda marked this conversation as resolved.
Show resolved Hide resolved

### Integrations
Comment on lines +106 to 122
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI this was covered in #826. If we want to expand it, we should probably do it in that area within the context of whats there

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I may suggest to have it readme as it is easy to find and the other location was not discoverable =( so I found it based on issue and merged PR...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README is focused on being a quick start, delegating to this file for the details.

Copy link
Author

@Borda Borda Sep 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but for some cases like us, the need to add a new config in the root could be a deal breaker so in such cases, we cannot use it... so how about making it lighter #834 (comment)?


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