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

GitHub Action

ESLint changed files

v9.1

ESLint changed files

check-square

ESLint changed files

Run ESLint on all changed files

Installation

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

 
              
- name: ESLint changed files

              
  uses: tj-actions/[email protected]
Learn more about this action in tj-actions/eslint-changed-files

Choose a version

Codacy Badge Test Update release version. Public workflows that use this action.

Ubuntu Mac OS Windows

All Contributors

eslint-changed-files

Run ESLint on either all files which performs slow in most cases or selectively run ESLint on only changed files in a pull request with support for error reporting via GitHub checks.

Screen Shot 2022-03-04 at 5 01 35 AM

Features

  • Easy to debug
  • Fast execution
  • Glob pattern extension filtering
  • Excludes ignored files from change detection to prevent errors.
  • Github checks error reporting.
  • Github annotations with a possible resolution that can be applied to the Pull Request.

Example

Screen Shot 2021-09-06 at 1 15 22 PM

Usage

...:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - uses: actions/setup-node@v2
        with:
          node-version: 14

      - name: Install dependencies
        run: npm ci  # OR: yarn 

      - name: Run eslint on changed files
        uses: tj-actions/eslint-changed-files@v9
        with:
          config_path: "/path/to/.eslintrc"
          ignore_path: "/path/to/.eslintignore"
          extra_args: "--max-warnings=0"
          file_extensions: |
            **/*.ts
            **/*.tsx

If you feel generous and want to show some extra appreciation:

Support this project with a ⭐

Buy me a coffee

Inputs

INPUT TYPE REQUIRED DEFAULT DESCRIPTION
all_files string false "false" Run ESlint on all matching
files
config_path string false ".eslintrc" ESlint configuration file
extra_args string false Extra arguments passed to ESlint
file_extensions string false "**/*.ts\n**/*.tsx\n**/*.js\n**/*.jsx\n" List of file extensions to
watch for changes and run
ESlint against
filter_mode string false "added" reviewdog filtering mode.
ignore_path string false ESlint ignore file
reporter string false "github-pr-review" reviewdog reporter.
skip_annotations string false "false" Skip running reviewdog i.e don't
add any annotations.
token string true "${{ github.token }}" GITHUB_TOKEN or a repo scoped
Personal Access Token

Credits

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Clinton Blackburn
💻

This project follows the all-contributors specification. Contributions of any kind welcome!