Run mispell, with reviewdog output on the PR
A GitHub Action that runs the misspell spell checker with reviewdog to catch typos in pull requests.
What is Run mispell, with reviewdog output on the PR?
reviewdog/action-misspell is a GitHub Action that runs the misspell spell checker integrated with reviewdog to automatically detect and report spelling errors in pull requests. It scans code and documentation changes for common typos and provides inline feedback during code reviews. This helps developers catch mistakes early and maintain consistent spelling across the codebase.
Development teams using GitHub for version control who want to automate spell checking in their CI/CD pipelines, particularly those focused on code quality and review efficiency.
It combines the accuracy of the misspell tool with the seamless GitHub integration of reviewdog, offering a lightweight, configurable solution for automated spell checking without requiring manual intervention during reviews.
Overview
Run misspell with reviewdog
Use Cases
Best For
- Automating spell checks in GitHub pull request workflows
- Catching typos in code comments and documentation
- Enforcing consistent spelling (US/UK English) across repositories
- Integrating lightweight spell checking into CI/CD pipelines
- Reducing manual proofreading during code reviews
- Improving code quality with automated feedback tools
Not Ideal For
- Projects using GitLab, Bitbucket, or other version control systems outside GitHub
- Teams needing spell checking for languages other than English (US/UK)
- Codebases with specialized terminology requiring advanced custom dictionaries or context-aware corrections
- Workflows requiring real-time, offline spell checking without CI/CD integration
Pros & Cons
Pros
Leverages reviewdog to post inline comments and checks directly on GitHub pull requests, as demonstrated by the sample annotation screenshot in the README, streamlining code reviews.
Supports US and UK English locales and allows ignoring specific words with the 'ignore' input, providing flexibility for different project standards and reducing false positives.
Automatically scans pull request changes for misspellings and reports them based on severity levels (info, warning, error), enhancing code quality with minimal manual effort.
Offers inputs like path, pattern, and exclude to control which files are checked, preventing unnecessary scans on irrelevant directories or file types, as shown in the example YAML.
Cons
Only supports US and UK English locales, making it ineffective for multilingual projects or codebases with non-English text, which the README does not address.
Relies on the misspell tool and reviewdog, introducing dependency risks and potential breaking changes, as seen with the deprecated 'fail_on_error' input noted in the README.
Designed exclusively for GitHub Actions, so it cannot be easily adapted to other CI/CD platforms or local development environments without significant customization.
Frequently Asked Questions
Related Projects
wemake-python-styleguideThe strictest and most opinionated python linter ever!
Show and auto-fix linting errors for many programming languages✨ GitHub Action for detecting and auto-fixing lint errors
Lint Pull Request commits with commitlintLints Pull Request commits with commitlint
Run dotenv-linter - Lints your .env files like a charm, with optional reviewdog output on the PR:relaxed: Linting dotenv files like a charm!
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.