ESLint PR review

A simple workflow, that creates pull request reviews for ESLint problems

Inputs

project-root

The path to the directory, which includes files like package.json or .eslintrc.json.

Default: .

src

What you want to lint. Relative to project-root.

Default: .

Example: src (Lints every lintable file in the source folder)

github-token

The GitHub Token of the repository. It is needed for reviewing the Pull Requests.

Required

Example: ${{ secrets.GITHUB_TOKEN }}

eslint-format

The ESLint Format to print the linting result to the GitHub Actions log

Default: stylish

Examples: codeframe, compact, table, tap, unix, visualstudio

approve-mode

0 for dismissing change-requests, 1 for approving after change-requests, 2 for approving always if ESLint doesn't fail

Default: 0

extensions

Comma separated list of file the fileendings, ESLint should lint.

Default: js,jsx,ts,tsx

Example usage:

name: ESLint PR review

on:
  push:

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: rpkak/ESLint-PR-review@latest
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          src: src
          eslint-format: table

Example output:

Infos

Use rpkak/ESLint-PR-review@latest to get the latest none development version ESLint PR review.

Please report everything like bugs by creating an issue.

Version: v1.2.1

by rpkak