{"id":13429118,"url":"https://github.com/crate-ci/typos","last_synced_at":"2026-02-05T23:08:14.645Z","repository":{"id":39227835,"uuid":"181782286","full_name":"crate-ci/typos","owner":"crate-ci","description":"Source code spell checker","archived":false,"fork":false,"pushed_at":"2025-05-07T12:59:18.000Z","size":57430,"stargazers_count":3152,"open_issues_count":112,"forks_count":128,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-05-14T22:02:25.595Z","etag":null,"topics":["cli","code-quality","rust","spell-checker"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crate-ci.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-04-16T23:28:35.000Z","updated_at":"2025-05-14T15:05:54.000Z","dependencies_parsed_at":"2024-01-01T02:37:22.999Z","dependency_job_id":"111427c2-efcd-40e8-b0a4-d5abab72301e","html_url":"https://github.com/crate-ci/typos","commit_stats":{"total_commits":1625,"total_committers":66,"mean_commits":24.62121212121212,"dds":0.3329230769230769,"last_synced_commit":"6802cc60d4e7f78b9d5454f6cf3935c042d5e1e3"},"previous_names":[],"tags_count":552,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crate-ci%2Ftypos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crate-ci%2Ftypos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crate-ci%2Ftypos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crate-ci%2Ftypos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crate-ci","download_url":"https://codeload.github.com/crate-ci/typos/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254235686,"owners_count":22036962,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","code-quality","rust","spell-checker"],"created_at":"2024-07-31T02:00:26.597Z","updated_at":"2025-12-29T17:33:41.185Z","avatar_url":"https://github.com/crate-ci.png","language":"Rust","funding_links":[],"categories":["PGO Showcases","HarmonyOS","Rust","Development tools","Static Checks","Catalog","cli","Spelling \u0026 Linting","Table of Contents"],"sub_categories":["Developer tooling","Windows Manager","Workflow Automation","Web Servers","lint","Dev Tools"],"readme":"# typos\n\n\u003e **Source code spell checker**\n\nFinds and corrects spelling mistakes among source code:\n- Fast enough to run on monorepos\n- Low false positives so you can run on PRs\n\n![Screenshot](./docs/screenshot.png)\n\n\n[![Downloads](https://img.shields.io/github/downloads/crate-ci/typos/total.svg)](https://github.com/crate-ci/typos/releases)\n[![codecov](https://codecov.io/gh/crate-ci/typos/branch/master/graph/badge.svg)](https://codecov.io/gh/crate-ci/typos)\n[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]\n![License](https://img.shields.io/crates/l/typos.svg)\n[![Crates Status](https://img.shields.io/crates/v/typos.svg)][Crates.io]\n\nDual-licensed under [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE)\n\n## Documentation\n\n- [Installation](#install)\n- [Getting Started](#getting-started)\n  - [False Positives](#false-positives)\n  - [Integrations](#integrations)\n    - [GitHub Action](docs/github-action.md)\n    - [pre-commit](docs/pre-commit.md)\n    - [Custom](#custom)\n  - [Debugging](#debugging)\n- [Reference](docs/reference.md)\n- [FAQ](#faq)\n- [Comparison with other spell checkers](docs/comparison.md)\n- [Projects using typos](https://github.com/crate-ci/typos/wiki)\n- [Benchmarks](benchsuite/runs)\n- [Design](docs/design.md)\n- [Contribute](CONTRIBUTING.md)\n- [CHANGELOG](CHANGELOG.md)\n\n## Install\n\n[Download](https://github.com/crate-ci/typos/releases) a pre-built binary\n(installable via [gh-install](https://github.com/crate-ci/gh-install)).\n\nOr use rust to install:\n```console\n$ cargo install typos-cli --locked\n```\n\nOr use [Homebrew](https://brew.sh/) to install:\n```console\n$ brew install typos-cli\n```\n\nOr use [Conda](https://conda.io/) to install:\n```console\n$ conda install typos\n```\n\nOr use [Pacman](https://wiki.archlinux.org/title/pacman) to install:\n```console\n$ sudo pacman -S typos\n```\n\n## Getting Started\n\nMost commonly, you'll either want to see what typos are available with\n```console\n$ typos\n```\n\nOr have them fixed\n```console\n$ typos --write-changes\n$ typos -w\n```\nIf there is any ambiguity (multiple possible corrections), `typos` will just report it to the user and move on.\n\n### False Positives\n\nSometimes, what looks like a typo is intentional, like with people's names, acronyms, or localized content.\n\nTo mark a word or an identifier (grouping of words) as valid, add it to your [`_typos.toml`](docs/reference.md) by declaring itself as the valid spelling:\n```toml\n[default]\nextend-ignore-identifiers-re = [\n    # *sigh* this just isn't worth the cost of fixing\n    \"AttributeID.*Supress.*\",\n]\n\n[default.extend-identifiers]\n# *sigh* this just isn't worth the cost of fixing\nAttributeIDSupressMenu = \"AttributeIDSupressMenu\"\n\n[default.extend-words]\n# Don't correct the surname \"Teh\"\nteh = \"teh\"\n```\nFor more ways to ignore or extend the dictionary with examples, see the [config reference](docs/reference.md).\n\nFor cases like localized content, you can disable spell checking of file contents while still checking the file name:\n```toml\n[type.po]\nextend-glob = [\"*.po\"]\ncheck-file = false\n```\n(run `typos --type-list` to see configured file types)\n\nIf you need some more flexibility, you can completely exclude some files from consideration:\n```toml\n[files]\nextend-exclude = [\"localized/*.po\"]\n```\n\n### Integrations\n\n- [GitHub Actions](docs/github-action.md)\n- [pre-commit](docs/pre-commit.md)\n- [🐊Putout Processor](https://github.com/putoutjs/putout-processor-typos)\n- [Visual Studio Code](https://github.com/tekumara/typos-vscode)\n- [typos-lsp (Language Server Protocol server)](https://github.com/tekumara/typos-vscode)\n- [GitLab Code Quality](https://github.com/tahv/typos-gitlab-code-quality)\n\n#### Custom\n\n`typos` provides several building blocks for custom native integrations\n- `-` reads from `stdin`, `--write-changes` will be written to `stdout`\n- `--diff` to provide a diff\n- `--format json` to get jsonlines with exit code 0 on no errors, code 2 on typos, anything else is an error.\n\nExamples:\n```console\n$ # Read file from stdin, write corrected version to stdout\n$ typos - --write-changes\n$ # Creates a diff of what would change\n$ typos dir/file --diff\n$ # Fully programmatic control\n$ typos dir/file --format json\n```\n\n### Debugging\n\nYou can see what the effective config looks like by running\n```console\n$ typos --dump-config -\n```\n\nYou can then see how typos is processing your project with\n```console\n$ typos --files\n$ typos --identifiers\n$ typos --words\n```\n\nIf you need to dig in more, you can enable debug logging with `-v`\n\n## FAQ\n\n### Why was ... not corrected?\n\n**Does the file show up in `typos --files`?**\nIf not, check your config with `typos --dump-config -`.\nThe `[files]` table controls how we walk files.\nIf you are using `files.extend-exclude`,\nare you running into [#593](https://github.com/crate-ci/typos/issues/593)?\nIf you are using `files.ignore-vcs = true`,\nis the file in your `.gitignore` but git tracks it anyways?\nPrefer allowing the file explicitly (see [#909](https://github.com/crate-ci/typos/issues/909)).\n\n**Does the identifier show up in `typos --identifiers` or the word show up in `typos --words`?**\nIf not, it might be subject to one of typos' heuristics for\ndetecting non-words (like hashes) or\nunambiguous words (like words after a `\\` escape).\n\nIf it is showing up, likely `typos` doesn't know about it yet.\n\n`typos` maintains a list of known typo corrections to keep the false positive\ncount low so it can safely run unassisted.\n\nThis is in contrast to most spell checking UIs people use where there is a\nknown list of valid words.  In this case, the spell checker tries to guess your\nintent by finding the closest-looking word.  It then has a gauge for when a\nword isn't close enough and assumes you know best.  The user has the\nopportunity to verify these corrections and explicitly allow or reject them.\n\nFor more on the trade offs of these approaches, see [Design](docs/design.md).\n\n- To correct it locally, see also our [False Positives documentation](#false-positives).\n- To contribute your correction, see [Contribute](CONTRIBUTING.md)\n\n[Crates.io]: https://crates.io/crates/typos-cli\n[Documentation]: https://docs.rs/typos\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrate-ci%2Ftypos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrate-ci%2Ftypos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrate-ci%2Ftypos/lists"}