crate-ci/typos

Features

• Automated Typo Fixers - Automatically writes corrected spelling changes back to the local checkout to streamline typo fixing.
• Code Spell Checkers - Scans programming language files to identify and correct spelling errors in comments, strings, and identifiers.
• Spell Check Whitelisting - Supports the definition of valid words and patterns to ignore, effectively whitelisting terminology to reduce false positives.
• Spell Checking Rules - Allows users to define specific typo-to-correction mappings and mark certain identifiers as always valid or invalid.
• Dictionary-Based Validation - Validates text against locale-specific dictionaries to identify potential spelling errors in source code.
• Automated Spelling Checkers - Scans repository files for typos during continuous integration workflows to identify errors in pull requests.
• Custom Dictionary Managers - Provides a dictionary engine that integrates project-specific terminology and locale-specific word lists to expand the validation vocabulary.
• Source Code Mutators - Automatically applies spelling corrections directly to source files on disk while preserving original formatting.
• CI Pipeline Integrations - Integrates into CI pipelines to enforce spelling quality by setting failing exit codes when errors are found.
• Continuous Integration Checks - Integrates automated spell checks into CI pipelines to prevent misspelled text from being merged into production.
• Identifier Tokenizers - Decomposes camelCase and snake_case identifiers into individual words to detect spelling mistakes within code symbols.
• Spelling Rule Configurations - Enables detailed customization of the spell-checking engine, including locale definitions and identifier handling rules.
• Technical String Filters - Uses regular expressions to filter out technical strings like UUIDs, URLs, and hex codes to reduce false positives.
• Analysis File Exclusions - Prevents specific files or file types from being scanned for typos based on glob patterns or content types.
• Automated Code Refactoring - Automatically applies spelling corrections across the codebase to maintain professional naming and documentation.
• Automated Fixers - Automatically writes corrected spelling changes directly back to source files within a local checkout.
• Scan Scope Restrictions - Limits the scan scope by excluding hidden directories, version control paths, and specific files.
• File Exclusion Patterns - Filters the scanning scope using glob patterns and gitignore rules to exclude specific files and directories.
• File Exclusion Rules - Defines which files or directories to skip using exclusion lists, negation patterns, and forced-exclude flags.
• Pre-commit Hooks - Executes spell checks as a pre-commit git hook to prevent misspelled text from entering the repository.
• TOML Configuration Support - Uses TOML manifest files to manage tool settings and custom project-specific word lists.
• Technical String Filters - The tool ignores emails, URLs, hex strings, and UUIDs to ensure only human-readable text is checked for errors.
• False Positive Filtering - Filters out technical noise like UUIDs, SHAs, and JWT tokens to reduce false positive spell-check alerts.
• GitHub Actions - Provides native support for GitHub Actions, including code annotations and optimized pull request scanning.
• SARIF Integrations - Generates reports in the Static Analysis Results Interchange Format for seamless integration with security and quality tooling.
• Static Analysis Exporters - Exports detected typos in SARIF and JSON formats for integration with external security and quality tooling.
• Developer Tools - Source code spell checker.
• Development Tools - Fast source code spell checker.

Star history