Reviewdog
Automated code review tool that integrates with any linter and posts results as comments on pull requests.
What is Reviewdog?
reviewdog is an automated code review tool that runs any linter or static analysis tool and posts the results as comments on pull requests or merge requests. It solves the problem of manually reviewing linter outputs by integrating directly with code hosting platforms like GitHub, GitLab, and Bitbucket, ensuring only new issues introduced in changes are highlighted.
Development teams and individual developers who use CI/CD pipelines and want to automate code quality checks in their review process, especially those working with multiple programming languages and linters.
Developers choose reviewdog because it is language-agnostic, supports virtually any linter, and seamlessly integrates with popular CI services and code hosting platforms, reducing manual review overhead and improving code consistency.
Overview
🐶 Automated code review tool integrated with any code analysis tools regardless of programming language
Use Cases
Best For
- Automating linting feedback in GitHub Pull Requests
- Integrating multiple linters into a single CI workflow
- Enforcing code quality in GitLab Merge Requests
- Adding static analysis to Bitbucket Pipelines
- Filtering linter results to show only new issues in a diff
- Suggesting code fixes automatically via pull request comments
Not Ideal For
- Projects exclusively using IDE-based linting without CI/CD pipelines for code reviews
- Teams already invested in all-in-one code quality platforms like SonarQube with built-in pull request analysis
- Organizations with strict security policies that prohibit third-party API access for posting PR comments
- Repositories that do not use pull requests or merge requests as part of their development workflow
Pros & Cons
Pros
Supports any linter output using Vim's errorformat or pre-defined parsers for tools like ESLint and golint, as highlighted in the 'Input Format' section, making it language-agnostic.
Posts comments to GitHub PRs, GitLab MRs, Bitbucket Code Insights, and more via dedicated reporters, detailed in the 'Reporters' section, ensuring wide compatibility.
Offers multiple filter modes like added, diff_context, and nofilter to control which issues are reported, as explained in the 'Filter mode' section, allowing precise review focus.
Enables automated fixes via diff or RDFormat input, as shown in the 'Code Suggestions' section, helping teams implement changes directly from reviews.
Cons
For github-pr-check reporter, it relies on the reviewdog GitHub App server, which is a single point of failure and may not be available 24/7, as cautioned in the README.
Configuring errorformat for linters without pre-defined parsers requires understanding Vim's errorformat syntax, which can be challenging for non-standard tools.
Code suggestions are not supported by all reporters, such as github-check and bitbucket-code-report, as indicated in the 'Code Suggestions Support Table', reducing functionality in some setups.
Requires setting up and securing API tokens for GitHub, GitLab, etc., adding administrative overhead and potential security risks, especially in multi-environment deployments.
Frequently Asked Questions
Related Projects
GitleaksFind secrets with Gitleaks 🔑
PHP ParserA PHP parser written in PHP
TypeScript ESLint:sparkles: Monorepo for all the tooling which enables ESLint to support TypeScript
pyrightStatic Type Checker for Python
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.