eslint-formatter-codeclimate


Format ESLint results as a
Code Climate report.

Table of Contents

- Installation
- Usage
- Command Line
- API
- toCodeClimate(results, rulesMeta, cwd)
- formatter()
- Compatibility
- License

Installation

``sh
npm install eslint-formatter-codeclimate
`

Usage

$3

Using the ESLint CLI:

`sh
eslint --format codeclimate
`

Programmatically using Node.js:

`js
import { ESLint } from 'eslint'
import { toCodeClimate } from 'eslint-formatter-codeclimate'

const cwd = process.cwd()
const eslint = new ESLint({ cwd })
const results = await eslint.lintFiles([])
const rulesMeta = eslint.getRulesMetaForResults(results)
const issues = toCodeClimate(results, rulesMeta, cwd)

console.log(issues)
`

API

$3

Convert ESLint messages to CodeClimate issues.

#### Arguments

- results (ESLint.LintResult[]) — The ESLint report results.
- rulesMeta (Record) — The ESLint rule meta data.
- cwd (string) — The current work directory to calculate relative paths against.

#### Returns

The ESLint messages in the form of a CodeClimate report.

$3

The default export is an ESLint formatter which represents ESLint results as a CodeClimate report.

#### Arguments

- results (ESLint.LintResult[]) — The ESLint report results.
- data (ESLint.LintResultData`) — The ESLint report result data.

#### Returns

The Code Climate report as a string.

Compatibility

This project is compatible with Node.js 20 or greater.

License

MIT © Remco Haszing