AnnAngela/eslint-formatter-gha

A better ESLint formatter used in GitHub Actions. It can help you to get more human-readable annotation from ESLint. See screenshoots below:

Thess secreenshoots are taken with configuration ESLINT_FORMATTER_GHA_DEPRECATED_RULES_SEVERITY as notice, so you can see the deprecated rules infomation in Annotation and Summary.

Installation

Run this command:

npm install --save-dev @AnnAngela/eslint-formatter-gha

Usage

Add -f @AnnAngela/eslint-formatter-gha or --format @AnnAngela/eslint-formatter-gha to your eslint command, like this:

npx eslint -f @AnnAngela/eslint-formatter-gha src

Configuration

You can use these environment variables to configure the formatter:

• ESLINT_FORMATTER_GHA_DEPRECATED_RULES_SEVERITY:

  Valid value is debug (default in v1), notice, warning, error.

  If the value is debug, the report of the deprecated rules will be only logged as debug log, which you have to enable debug logging to see it.

Upcoming v2

According to the blog "Deprecation of formatting rules" and the release note of ESLint v8.53, a batch of formatting rules have been marked as deprecated in documents.

But:

• In the cli, the deprecation of the rules is only visible after v9;
• There are still some deprecated rules being used in the recommended config from @eslint/js@8.

So the default value of environment variable ESLINT_FORMATTER_GHA_DEPRECATED_RULES_SEVERITY will remain as debug until ESLint v9 is released, to prevent unexpected large amounts of log output.

After that, the default value will be changed to notice with the v2 major release of this package.