Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
code

GitHub Action

ESLint Plus

v1

ESLint Plus

code

ESLint Plus

Runs ESLint against changed files with customization, issue commenting, and more

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: ESLint Plus

              
  uses: bradennapier/eslint-plus-action@v1
Learn more about this action in bradennapier/eslint-plus-action

Choose a version




eslint-plus-action






A Github Action which runs ESLint against the changed files in a PR with customizable options and rich summaries. ESLint issues are annotated inline on your PR diff.







Features

  • Inline Annotations of ESLint Warnings & Errors
  • Customizable ESLint options
  • Optional summary comments on each push to the PR
  • Links to the rule documentation when available
  • Suggestions are printed (not yet provided as change suggestions)
  • More...

This is fairly new some setup is coming but it should be straight forward by viewing the action.yml

The fix property is not yet setup but will come shortly. If fixes are available, it will render an action button to run the fix as well.

Simple Workflow Example

Below is a basic example which should get you going. You can view the action.yml to see what other properties are available for customization.

name: "my-workflow"
on: [pull_request]

jobs:
  test: # make sure the action works on a clean machine without building
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: bradennapier/eslint-plus-action@v1
      with: 
        github-token: ${{secrets.GITHUB_TOKEN}}

At this time it will build your code with the yarn or npm script build.

yarn && yarn build
# or if you use npm it will run
npm install && npm run build