Skip to content

Warning

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

ESLint Plus

Actions
Runs ESLint against changed files with customization, issue commenting, and more
v2
By bradennapier
Star (39)

Tags

 (2)
code-reviewcode-quality




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

The summary comments have some redundancy when there are suggestions available. This will be improved.

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.

Configuration

You provide configuration properties within your workflow by using the with property. See the Simple Workflow Example for an example of providing your github-token.

array types are expected to be comma-separated values

General Configuration Properties

Property Type Default Required Description
github-token string none true Your Github token. This is provided by default and should be set to `${{secrets.GITHUB_TOKEN}} in most cases.
issueSummary boolean true false Should the bot provide a summary of the results as a comment?
issueSummaryType string compact false Changes the PR comment to be "full" (as shown on actions page) or "compact"
annotateWarnings boolean true false By setting this to "false", only errors will be annotated
reportSuggestions boolean true false Report suggestions when available within the annotations?
reportIgnoredFiles boolean false false Report a list of any ignored files?
reportWarningsAsErrors boolean false false Report any eslint warnings as errors?
extensions array .js,.jsx,.ts,.tsx false An array of extensions to lint
includeGlob array **/* false Optional array of globs to include from the changed files list
ignoreGlob array none false Optional array of globs to ignore from the changed files list
configFile string none false A config file to use if the default config resolution doesn't work.
rulePaths array none false Optional paths to custom rules directories to include.
errorOnUnmatchedPattern boolean false false Throw error if unmatched pattern is seen?
useEslintrc boolean true false Use eslintrc?
useEslintIgnore boolean true false Use eslintignore?
fix boolean false false Commit fixes when possible (UNFINISHED)

The official settings can always be seen by viewing the action.yml schema for the action.

Examples

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:
  eslint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: bradennapier/eslint-plus-action@v2
      with: 
        github-token: ${{secrets.GITHUB_TOKEN}}

Environment Variables

There may be times that you need to provide a NPM_TOKEN so that the action can install your private repos. You do this by adding the secret to your repo Settings -> Secrets then providing it as an environment variable to the action:

jobs:
  eslint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: bradennapier/eslint-plus-action@v2
      env:
        NPM_TOKEN: ${{secrets.NPM_TOKEN}}
      with: 
        github-token: ${{secrets.GITHUB_TOKEN}}

Providing Parameters

jobs:
  eslint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: bradennapier/eslint-plus-action@v2
      env:
        NPM_TOKEN: ${{secrets.NPM_TOKEN}}
      with: 
        github-token: ${{secrets.GITHUB_TOKEN}}
        issueSummaryType: full
        reportIgnoredFiles: true

More Previews

Credits

This action was adapted from other actions which didn't quite work for me but were close. So special thanks to them for helping me get here.

Contributors (5)

@bradennapier@semantic-release-bot@imsteev@luisherranz@github-actions

Resources

ESLint Plus is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

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

Tags

 (2)
code-reviewcode-quality

Contributors (5)

@bradennapier@semantic-release-bot@imsteev@luisherranz@github-actions

Resources

ESLint Plus is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.