Question 1

How to ignore words in typos?

Accepted Answer

Add them to your `_typos.toml` configuration file using the `extend-words` or `extend-identifiers` sections, as shown in the False Positives documentation. You can also exclude entire files or disable checking for specific file types.

Question 2

typos vs codespell – which is better for code?

Accepted Answer

typos prioritizes low false positives with a curated list, making it safer for automation, while codespell uses a broader dictionary that might catch more typos but with higher false positives. Choose based on your need for precision in CI workflows.

Question 3

How to integrate typos with GitHub Actions?

Accepted Answer

Use the provided GitHub Action from the documentation, which allows you to add a step in your workflow to run typos on pull requests. It outputs results and can fail the check if typos are found.

Question 4

Why isn't typos correcting a specific word in my code?

Accepted Answer

First, check if the word is in typos' curated list by running `typos --words`. If not, you may need to add it to your config or contribute to the project, as typos only corrects known typos to reduce false positives.

Question 5

How to fix all typos in my codebase automatically?

Accepted Answer

Run `typos --write-changes` or `typos -w` to apply corrections. However, review ambiguous cases manually, as typos will skip corrections with multiple possible fixes and report them instead.

Question 6

Can typos check markdown or documentation files?

Accepted Answer

Yes, by default it checks markdown and other file types, but you can customize this via the `[type]` section in `_typos.toml`. For example, you can disable content checking for localized files while still checking filenames.

typos

What is typos?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions