reviewdog/reviewdog
Reviewdog
Reviewdog is a linter result posting tool and a diff-aware static analysis filter. It parses the output of various linters and posts findings as comments on pull requests within code hosting platforms. It also functions as a quality gate for CI pipelines, failing builds when findings exceed specified severity thresholds.
The project distinguishes itself by isolating static analysis issues to only those introduced within the current git code diff, preventing the reporting of legacy errors. It unifies tool findings by processing industry-standard SARIF and XML diagnostic formats alongside custom regular expression patterns.
The system covers linter output standardization, automated code review, and CI/CD quality gates. It supports suggesting code changes and managing execution settings through YAML configuration files.
Features
- Diff-Aware Result Filtering - Compares diagnostic line numbers against the git patch diff to report only errors introduced in the current change.
- Static Analysis Filtering - Isolates static analysis issues to only those introduced in the current git diff to avoid reporting legacy errors.
- Linter Output Parsing - Convert raw compiler or linter text into a structured format using custom patterns or pre-defined templates.
- Diagnostic - Processes Static Analysis Results Interchange Format files to normalize findings from multiple tools into a single internal representation.
- Linter Result Posters - Parses linter output and posts findings as automated review comments on pull requests in code hosting platforms.
- Automated PR Commenting - Sends tool diagnostics to code hosting services as review comments by filtering output to report only issues within the patch diff.
- Hosting Provider API Integrations - Integrates with code hosting platforms via APIs to post findings as pull request comments and commit annotations.
- Regex-Based Output Parsing - Transforms unstructured tool text into structured diagnostics using custom regular expression patterns and pre-defined templates.
- Quality Controls - Implements quality gates by failing CI pipeline builds when linter findings exceed defined severity thresholds.
- Quality Gates - Acts as an automated validation mechanism that enforces linter severity thresholds during the build process.
- Diagnostic Reporting Formats - Processes industry-standard data formats like SARIF and XML to ingest tool findings into a unified data structure.
- Assertion Diff Visualizers - Restrict reported issues to only those found in changed lines, modified files, or a specified context around the diff.
- Automated Code Review - Integrates linters into pull requests to post automated feedback and suggestions directly on changed lines of code.
- Automated Code Fix Suggestions - Provides specific code replacement suggestions by integrating with formatters or automated fixing tools alongside diagnostic results.
- Exit Status Signaling - Fails a build pipeline by returning a non-zero exit code when findings meet or exceed a specified severity level.
- Code Hosting API Integrations - Transmits processed diagnostics to remote code hosting platforms using their respective REST APIs for pull request annotations.
- Linter Exit Code Thresholds - Translates the count and level of detected findings into a process exit code to signal build pipeline failure.
- SARIF Integrations - Processes industry-standard SARIF and XML files to unify tool findings for automated reporting in code reviews.
- Code Analysis and Quality - Automated code review bot.
