https://github.com/sjinks/eslint-gha-formatter

ESLint Formatter for GitHub Actions
https://github.com/sjinks/eslint-gha-formatter

eslint eslint-formatter formatter github-actions problem-matcher

Last synced: about 2 months ago
JSON representation

ESLint Formatter for GitHub Actions

• Host: GitHub
• URL: https://github.com/sjinks/eslint-gha-formatter
• Owner: sjinks
• License: mit
• Created: 2021-04-10T12:14:09.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T18:35:08.000Z (2 months ago)
• Last Synced: 2024-10-29T20:38:20.696Z (2 months ago)
• Topics: eslint, eslint-formatter, formatter, github-actions, problem-matcher
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/eslint-formatter-gha
• Size: 1.42 MB
• Stars: 4
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# ESLint Formatter for GitHub Actions

[![Build and Test](https://github.com/sjinks/eslint-gha-formatter/actions/workflows/build.yml/badge.svg)](https://github.com/sjinks/eslint-gha-formatter/actions/workflows/build.yml)

[![CodeQL](https://github.com/sjinks/eslint-gha-formatter/actions/workflows/codeql.yml/badge.svg)](https://github.com/sjinks/eslint-gha-formatter/actions/workflows/codeql.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=sjinks_eslint-gha-formatter&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=sjinks_eslint-gha-formatter)

A custom formatter for ESLint that creates annotations for GitHub Actions.

## Installation

```bash

npm install --save-dev eslint-formatter-gha

```

## Usage

```bash

eslint . -f gha

```

If `eslint-formatter-gha` detects that ESLint runs in a GitHub runner (`GITHUB_ACTIONS` environment variable has the value of `true`), it creates annotations for GitHub Actions.

Otherwise, it invokes ESLint's `stylish` formatter.

**Since 1.1.0:** If the `SONARSCANNER` environment variable equals `true`, the formatter produces the result in the JSON format. Additionally, if the [`GITHUB_WORKSPACE` environment variable](https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables) has a non-empty value, `eslint-formatter-gha` writes the generated JSON into `${GITHUB_WORKSPACE}/eslint-report.json` file.

## Sample Output

![Inline Annotations](https://github.com/sjinks/eslint-gha-formatter/assets/7810770/2909a88f-4a87-4606-b8f0-9fdbdd14e0d6)