How to set up reviewdog action eslint for a TypeScript project?

Ensure your ESLint configuration includes TypeScript plugins and parsers, then run the action with `eslint_flags` pointing to your source directories. The action works with TypeScript out of the box if ESLint is properly configured.

reviewdog action eslint vs super-linter for JavaScript codebases?

Super-linter supports multiple languages and linters but can be slower and less customizable for ESLint. reviewdog/action-eslint is more focused, offering better GitHub PR comment integration and flexible reporting for ESLint-specific needs.

Can I use this action to lint only changed files in a pull request?

Yes, use the `filter_mode` input set to 'added' or 'diff_context' to limit ESLint analysis to files changed in the PR, improving performance by avoiding full codebase scans.

How to configure reviewdog action eslint to fail on warnings?

Set the `fail_level` input to 'warning' instead of the default 'none'. This will cause the CI check to fail if any issues with severity warning or higher are found, enforcing stricter code quality.

What permissions are needed in GitHub for reviewdog action eslint to work?

As shown in the example workflow, you need to set permissions for pull-requests: write to post comments and contents: read to access the code. Adjust these in your GitHub Actions YAML file.

Does reviewdog action eslint support custom ESLint rules or plugins?

Yes, as long as the rules or plugins are installed in your project's dependencies and configured in your .eslintrc file. The action runs ESLint with your setup, so compatibility depends on your ESLint environment.

Open-Awesome

Run ESLint, with reviewdog output on the PR

MITJavaScriptv1.34.0

A GitHub Action that runs ESLint with reviewdog to automatically post code review comments on pull requests.

Visit Website GitHub

260 stars73 forks0 contributors

What is Run ESLint, with reviewdog output on the PR?

reviewdog/action-eslint is a GitHub Action that runs ESLint with reviewdog to automatically analyze code changes in pull requests. It detects JavaScript and TypeScript linting issues and posts them as review comments, helping teams maintain code quality during code reviews. The action integrates directly into GitHub's workflow to provide immediate feedback on proposed changes.

Target Audience

Development teams using GitHub for collaboration who want to automate code quality checks during pull request reviews. It's particularly useful for JavaScript/TypeScript projects that already use ESLint and want to integrate it into their CI/CD pipeline.

Value Proposition

Developers choose this action because it provides a seamless integration between ESLint and GitHub's review system, saving time during code reviews by automatically surfacing linting issues. Unlike basic ESLint CI checks, it offers flexible reporting options and contextual comments that make it easier to address issues directly in the pull request interface.

Overview

Run eslint with reviewdog

Use Cases

Best For

Automating code quality checks in GitHub pull requests
Integrating ESLint into CI/CD pipelines for JavaScript projects
Teams wanting to enforce coding standards during code review
Projects that need flexible reporting of linting issues (warnings vs errors)
Development workflows using matrix testing with different Node.js versions
Maintaining consistent code style across large JavaScript/TypeScript codebases

Not Ideal For

Projects not using GitHub for version control or code review
Teams already using integrated CI/CD platforms with built-in ESLint tasks, like GitLab CI or Azure Pipelines
Development workflows emphasizing pre-commit hooks over pull request feedback
Environments where minimizing CI toolchain dependencies is a priority due to added reviewdog layer

Pros & Cons

Pros

Direct PR Integration

Posts ESLint findings as inline comments on GitHub pull requests using reviewdog, providing immediate contextual feedback during code reviews, as demonstrated in the example workflows.

Flexible Reporting Modes

Supports multiple reviewdog reporters like github-pr-review for markdown comments and github-check for status checks, allowing teams to tailor feedback to their workflow preferences.

Configurable Severity Control

Inputs such as `level` and `fail_level` let you set issue severity and failure thresholds, offering granular control over code quality gates without hard failures.

Matrix and Tool Support

Can run in matrix jobs with unique `tool_name` inputs, enabling distinct checks for different Node.js versions or environments, as shown in the README's matrix example.

Cons

Manual ESLint Setup

Requires separate ESLint installation and configuration, as noted in the README's example usage, adding steps to the setup process compared to all-in-one solutions.

Reviewdog Dependency

Relies on reviewdog for reporting, introducing an extra tool that teams unfamiliar with it must learn and maintain, potentially increasing complexity.

Limited to ESLint

Specifically designed for ESLint, so projects using other linters like stylelint or markdownlint require separate actions or custom integrations.

Frequently Asked Questions

Related Projects

wemake-python-styleguide

The strictest and most opinionated python linter ever!

Stars2,866

Forks423

Last commit6 hours ago

Show and auto-fix linting errors for many programming languages

✨ GitHub Action for detecting and auto-fixing lint errors

Stars609

Forks145

Last commit1 day ago

Lint Pull Request commits with commitlint

Lints Pull Request commits with commitlint

Stars399

Forks65

Last commit5 months ago

Run dotenv-linter - Lints your .env files like a charm, with optional reviewdog output on the PR

:relaxed: Linting dotenv files like a charm!

Stars304

Forks12

Last commit13 hours ago

Community-curated · Updated weekly · 100% open source

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.

Submit a project Star on GitHub