https://github.com/remcohaszing/eslint-formatter-codeclimate
Format ESLint results as a Code Climate report
https://github.com/remcohaszing/eslint-formatter-codeclimate
codeclimate eslint eslint-formatter eslintformatter
Last synced: 6 days ago
JSON representation
Format ESLint results as a Code Climate report
- Host: GitHub
- URL: https://github.com/remcohaszing/eslint-formatter-codeclimate
- Owner: remcohaszing
- License: mit
- Created: 2025-06-08T08:34:48.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-11-28T10:00:53.000Z (3 months ago)
- Last Synced: 2026-01-24T13:19:59.916Z (about 1 month ago)
- Topics: codeclimate, eslint, eslint-formatter, eslintformatter
- Language: JavaScript
- Homepage:
- Size: 326 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# eslint-formatter-codeclimate
[](https://github.com/remcohaszing/eslint-formatter-codeclimate/actions/workflows/ci.yaml)
[](https://codecov.io/gh/remcohaszing/eslint-formatter-codeclimate)
[](https://www.npmjs.com/package/eslint-formatter-codeclimate)
[](https://www.npmjs.com/package/eslint-formatter-codeclimate)
Format [ESLint](https://eslint.org) results as a
[Code Climate](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md) report.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Command Line](#command-line)
- [API](#api)
- [`toCodeClimate(results, rulesMeta, cwd)`](#tocodeclimateresults-rulesmeta-cwd)
- [`formatter()`](#formatter)
- [Compatibility](#compatibility)
- [License](#license)
## Installation
```sh
npm install eslint-formatter-codeclimate
```
## Usage
### Command Line
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
### `toCodeClimate(results, rulesMeta, cwd)`
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.
### `formatter()`
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](LICENSE.md) © [Remco Haszing](https://github.com/remcohaszing)