Skip to content

:octocat: Github action to run ESLint on changed pull request files with support for reporting errors via Github checks.

License

Notifications You must be signed in to change notification settings

nomad-bank/eslint-changed-files

 
 

Repository files navigation

Ubuntu Mac OS Windows Public workflows that use this action.

Test Update release version.

All Contributors

eslint-changed-files

Run ESLint on either all files or selectively run ESLint on only changed files in a pull request with support for inline annotations of ESLint Warnings & Errors.

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

Features

  • Easy to debug
  • Fast execution
  • Fix ESlint errors
  • Glob pattern extension filtering
  • Excludes ignored files from change detection.
  • Inline annotations of ESLint Warnings & Errors.
  • Inline annotations with possible resolutions that can be applied to the Pull Request.
  • Monorepo support.

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@v20
        with:
          config_path: "/path/to/.eslintrc"
          ignore_path: "/path/to/.eslintignore"
          extra_args: "--max-warnings=0"
          file_extensions: |
            **/*.ts
            **/*.tsx

For more working examples view the test.yml

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 ESlint configuration file. Optionally omit this
input for Mono repositories.
extra_args string false Extra arguments passed to ESlint
fail_on_error string false "true" Exit code for reviewdog when
errors are found.
file_extensions string false "**/*.{ts,tsx,js,jsx}"
List of file extensions to
watch for changes and run
ESlint against
filter_mode string false "added" Filter mode for the reviewdog command
(added, diff_context, file, nofilter).
ignore_path string false ESlint ignore file
level string false "error" Report level for reviewdog (info,warning,error)
path string false "." Relative path under GITHUB_WORKSPACE to
the repository
reporter string false "github-pr-review" Reporter of reviewdog command (github-check, github-pr-review).
github-pr-review can use Markdown and
add a link to rule
page in reviewdog reports.
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

💻

Sava Vidakovic

💻 ⚠️ 📖

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

About

:octocat: Github action to run ESLint on changed pull request files with support for reporting errors via Github checks.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 40.9%
  • TypeScript 23.6%
  • HTML 18.8%
  • CSS 10.7%
  • JavaScript 6.0%