How to ignore words in typos?

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.

typos vs codespell – which is better for code?

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.

How to integrate typos with GitHub Actions?

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.

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

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.

How to fix all typos in my codebase automatically?

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.

Can typos check markdown or documentation files?

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 — Fast Source Code Spell Checker

What is typos?

typos is a source code spell checker that identifies and corrects spelling mistakes within codebases. It is optimized for speed to handle large monorepos and minimizes false positives, making it safe to run in continuous integration pipelines like PR checks.

Target Audience

Developers and teams working on large codebases, especially those using monorepos, who need to automate spell checking in their CI/CD pipelines. It's also suitable for open-source maintainers who want to enforce spelling consistency in pull requests.

Value Proposition

Developers choose typos over traditional spell checkers because it prioritizes accuracy with a curated list of known typo corrections, drastically reducing false positives. Its high performance and seamless integrations with tools like GitHub Actions and pre-commit hooks make it ideal for automated workflows.

Source code spell checker

Use Cases

Best For

Automating spell checks in continuous integration pipelines, particularly for pull request validation.
Scanning large monorepos quickly due to its high-performance design.
Teams needing low false positives to avoid manual intervention in automated checks.
Projects requiring customizable spell checking via configuration files to ignore acronyms, names, or localized content.
Integrating spell checking into developer tools like VS Code, pre-commit hooks, or custom scripts via JSON output or diff generation.
Enforcing spelling consistency across codebases with minimal configuration overhead.

Not Ideal For

Projects requiring interactive, real-time spell checking within an IDE as you type, since typos is a command-line tool designed for batch processing.
Teams working primarily with natural language documents (e.g., books, articles) who need a general-purpose spell checker with extensive dictionaries and grammar checks.
Situations where you need to automatically correct all possible typos, including those not in its curated list, as typos relies on known corrections to minimize false positives.

Pros & Cons

Pros

Blazing Fast Performance

Optimized to scan entire monorepos efficiently, with benchmarks provided in the README, making it practical for large codebases.

Minimal False Positives

Uses a curated list of known typo corrections, allowing it to run safely in CI pipelines like PR checks without manual intervention, as highlighted in the philosophy.

Highly Configurable

Supports custom ignore lists and rules via a `_typos.toml` file, enabling teams to exclude acronyms, names, or localized content with examples in the documentation.

Seamless Integrations

Offers native support for GitHub Actions, pre-commit hooks, and provides JSON output and diff generation for custom scripts, as detailed in the integrations section.

Cons

Curated List Limitation

Only corrects typos from its maintained list; unknown mistakes require manual configuration or contribution, which can lead to missed corrections in new or niche contexts.

Configuration Overhead

Setting up custom ignore rules and file types involves editing TOML files, which can be complex and time-consuming for teams with diverse codebases.

Limited to Source Code

Primarily designed for code spell checking; it may be less effective for prose-heavy documentation without additional configuration, as noted in the file type settings.

What is typos?

Target Audience

Value Proposition

Use Cases

Best For

Automating spell checks in continuous integration pipelines, particularly for pull request validation.
Scanning large monorepos quickly due to its high-performance design.
Teams needing low false positives to avoid manual intervention in automated checks.
Projects requiring customizable spell checking via configuration files to ignore acronyms, names, or localized content.
Integrating spell checking into developer tools like VS Code, pre-commit hooks, or custom scripts via JSON output or diff generation.
Enforcing spelling consistency across codebases with minimal configuration overhead.

Not Ideal For

Projects requiring interactive, real-time spell checking within an IDE as you type, since typos is a command-line tool designed for batch processing.
Teams working primarily with natural language documents (e.g., books, articles) who need a general-purpose spell checker with extensive dictionaries and grammar checks.
Situations where you need to automatically correct all possible typos, including those not in its curated list, as typos relies on known corrections to minimize false positives.

Pros & Cons

Pros

Blazing Fast Performance

Optimized to scan entire monorepos efficiently, with benchmarks provided in the README, making it practical for large codebases.

Minimal False Positives

Uses a curated list of known typo corrections, allowing it to run safely in CI pipelines like PR checks without manual intervention, as highlighted in the philosophy.

Highly Configurable

Supports custom ignore lists and rules via a `_typos.toml` file, enabling teams to exclude acronyms, names, or localized content with examples in the documentation.

Seamless Integrations

Offers native support for GitHub Actions, pre-commit hooks, and provides JSON output and diff generation for custom scripts, as detailed in the integrations section.

Cons

Curated List Limitation

Only corrects typos from its maintained list; unknown mistakes require manual configuration or contribution, which can lead to missed corrections in new or niche contexts.

Configuration Overhead

Setting up custom ignore rules and file types involves editing TOML files, which can be complex and time-consuming for teams with diverse codebases.

Limited to Source Code

Primarily designed for code spell checking; it may be less effective for prose-heavy documentation without additional configuration, as noted in the file type settings.

typos

What is typos?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

typos

What is typos?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?