github
An ESLint formatter that reports lint results as annotations in GitHub pull requests using the Checks API.
What is github?
eslint-formatter-github is a specialized ESLint formatter that posts linting results as inline annotations in GitHub pull requests. It solves the problem of developers needing to switch between terminal output and code reviews by integrating ESLint feedback directly into the GitHub interface. The tool uses the GitHub Checks API to display errors and warnings where they matter most—during code review.
Development teams using ESLint in their JavaScript/TypeScript projects who want to integrate linting results into their GitHub-based code review process. It's particularly useful for teams with CI/CD pipelines on GitHub Actions or other CI platforms.
Developers choose this formatter because it eliminates context switching by bringing lint feedback directly into pull requests, making code reviews more efficient. Its seamless integration with GitHub's native Checks API and support for custom GitHub Apps provide a secure, professional-grade solution compared to basic terminal output.
Overview
See ESLint errors and warnings directly in pull requests.
Use Cases
Best For
- Teams wanting ESLint errors visible directly in GitHub pull requests
- Integrating linting feedback into CI/CD pipelines on GitHub Actions
- Improving code review efficiency with inline annotations
- JavaScript/TypeScript projects using ESLint for code quality
- GitHub Enterprise users needing custom app integration
- Development workflows where terminal lint output is frequently overlooked
Not Ideal For
- Projects not using GitHub for version control or CI/CD pipelines
- Teams that rely on local ESLint runs without automated checks
- Environments with strict policies against creating or integrating GitHub Apps
- Developers needing real-time lint feedback in IDEs during active coding
Pros & Cons
Pros
Transforms ESLint results into inline annotations in pull requests using the GitHub Checks API, making issues visible during code review without context switching, as highlighted in the README's example image.
Runs exclusively in CI environments to prevent annotation spam in local development, ensuring feedback is only posted during automated checks, as stated in the 'Only runs in CI environment' feature.
Allows teams to use their own GitHub App for enhanced security and GitHub Enterprise compatibility, with detailed steps provided in the README for app creation and environment variable setup.
Leverages eslint-formatter-pretty for clear and readable lint result displays in annotations, improving readability over raw ESLint output, as noted in the 'Highlights' section.
Cons
Requires creating a GitHub App with specific permissions and configuring multiple environment variables, which can be time-consuming and error-prone, as detailed in the 'Using your own GitHub App' section.
Designed only for CI, so developers miss inline feedback when running ESLint locally, potentially delaying issue detection until pull request creation, as emphasized by its CI-only execution.
Tightly integrated with GitHub's ecosystem via the Checks API, making it incompatible with other Git hosting services like GitLab or Bitbucket, limiting its use to GitHub-based projects.
The public GitHub app raises security concerns, forcing teams to set up their own app to avoid sharing private keys, as warned in the GitHub Actions example with a strong recommendation against third-party apps.
Frequently Asked Questions
Related Projects
moGood-lookin' ESLint formatter for delightful readability
git-logESLint Formatter featuring Git Author, Date, and Hash
htmleslint-formatter-html
summary-chartA ESLint formatter to summarise errors by rules and files using bar charts
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.