README.md

ivuorinen/actions/eslint-check

ESLint Check

Description

Run ESLint check on the repository with advanced configuration and reporting

Inputs

name	description	required	default
working-directory	Directory containing files to lint	false	.
eslint-version	ESLint version to use	false	latest
config-file	Path to ESLint config file	false	.eslintrc
ignore-file	Path to ESLint ignore file	false	.eslintignore
file-extensions	File extensions to lint (comma-separated)	false	.js,.jsx,.ts,.tsx
cache	Enable ESLint caching	false	true
max-warnings	Maximum number of warnings allowed	false	0
fail-on-error	Fail workflow if issues are found	false	true
report-format	Output format (stylish, json, sarif)	false	sarif
max-retries	Maximum number of retry attempts	false	3

Outputs

name	description
error-count	Number of errors found
warning-count	Number of warnings found
sarif-file	Path to SARIF report file
files-checked	Number of files checked

Runs

This action is a composite action.

Usage

- uses: ivuorinen/actions/eslint-check@main
  with:
    working-directory:
    # Directory containing files to lint
    #
    # Required: false
    # Default: .

    eslint-version:
    # ESLint version to use
    #
    # Required: false
    # Default: latest

    config-file:
    # Path to ESLint config file
    #
    # Required: false
    # Default: .eslintrc

    ignore-file:
    # Path to ESLint ignore file
    #
    # Required: false
    # Default: .eslintignore

    file-extensions:
    # File extensions to lint (comma-separated)
    #
    # Required: false
    # Default: .js,.jsx,.ts,.tsx

    cache:
    # Enable ESLint caching
    #
    # Required: false
    # Default: true

    max-warnings:
    # Maximum number of warnings allowed
    #
    # Required: false
    # Default: 0

    fail-on-error:
    # Fail workflow if issues are found
    #
    # Required: false
    # Default: true

    report-format:
    # Output format (stylish, json, sarif)
    #
    # Required: false
    # Default: sarif

    max-retries:
    # Maximum number of retry attempts
    #
    # Required: false
    # Default: 3