Skip to content

jamesacarr/eslint-formatter-github-actions

Repository files navigation

ESLint Reporter for GitHub Actions

Test status NPM badge

A custom formatter for ESLint that creates annotations when run via GitHub Actions

Installation

npm install -D @jamesacarr/eslint-formatter-github-actions

Or, even better:

yarn add -D @jamesacarr/eslint-formatter-github-actions

Usage

To get annotations working in your GitHub Actions runs, you need to run ESLint with the --format or -f flag. For example:

eslint -f @jamesacarr/github-actions

You can also use this formatter if you're using XO:

xo --reporter @jamesacarr/github-actions