https://github.com/reviewdog/action-eclint

Run eclint with reviewdog
https://github.com/reviewdog/action-eclint

eclint github-action reviewdog

Last synced: 3 months ago
JSON representation

Run eclint with reviewdog

• Host: GitHub
• URL: https://github.com/reviewdog/action-eclint
• Owner: reviewdog
• License: mit
• Archived: true
• Created: 2020-01-02T16:45:06.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-23T13:07:24.000Z (4 months ago)
• Last Synced: 2024-07-24T09:11:42.396Z (3 months ago)
• Topics: eclint, github-action, reviewdog
• Language: Shell
• Homepage: https://github.com/marketplace?type=actions&query=reviewdog
• Size: 48.8 KB
• Stars: 5
• Watchers: 28
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WARNING

reviewdog/action-eclint is no longer maintained.

Please use another action. See https://github.com/reviewdog/action-eclint/issues/29

# GitHub Action: Run eclint with reviewdog

[![Docker Image CI](https://github.com/reviewdog/action-eclint/workflows/Docker%20Image%20CI/badge.svg)](https://github.com/reviewdog/action-eclint/actions)

[![Release](https://img.shields.io/github/release/reviewdog/action-eclint?sort=semver)](https://github.com/reviewdog/action-eclint/releases)

This action runs [eclint](https://github.com/jedmao/eclint) with

[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve

code review experience.

[![github-pr-check sample](https://user-images.githubusercontent.com/3797062/65439130-a6043b80-de61-11e9-98b5-bd9567e184b0.png)](https://github.com/reviewdog/action-eclint/pull/1)

[![github-pr-review sample](https://user-images.githubusercontent.com/3797062/65439073-91c03e80-de61-11e9-9077-39d480fbad0d.png)](https://github.com/reviewdog/action-eclint/pull/1)

## Inputs

### `github_token`

**Required**. The default value is `github_token: ${{ github.token }}`'.

### `level`

Optional. Report level for reviewdog [info,warning,error].

It's same as `-level` flag of reviewdog.

### `reporter`

Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].

Default is github-pr-check.

It's same as `-reporter` flag of reviewdog.

github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

### `eclint_flags`

Optional. Flags and args of eclint command. Default: '.'

## Example usage

You can create [eclint config](https://editorconfig.org/) and this action uses that config too.

### [.github/workflows/reviewdog.yml](.github/workflows/reviewdog.yml)

```yml

name: reviewdog

on: [pull_request]

jobs:

  eclint:

    name: runner / eclint

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - name: eclint

        uses: reviewdog/action-eclint@v1

        with:

          github_token: ${{ secrets.github_token }}

          reporter: github-pr-review # Change reporter.

          eclint_flags: 'src/'

```