vfile-reporter-codeclimate

Format VFile messages as a Code Climate report.

Table of Contents

• Installation
• Usage
  • CLI
  • GitLab
  • Programmatic
• API
  • toCodeClimate(files)
  • default
• Compatibility
• License

Installation

npm install vfile-reporter-codeclimate

Usage

This VFile reporter formats VFile messages to Code Climate issues.

CLI

You can use this with a unified-engine based CLI. For example, with remark-cli.

remark --report codeclimate .

You may also pass options:

remark --report 'codeclimate=pretty:2' .

GitLab

You can use the report in GitLab.

eslint:
  image: node:26-alpine
  script:
    - npm ci
    - npx remark --report codeclimate . 2> codequality.json
  artifacts:
    reports:
      codequality: codequality.json

Programmatic

You can use this package programmatically in Node.js.

import { VFile } from 'vfile'
import { toCodeClimate } from 'vfile-reporter-codeclimate'

const file = new VFile()

file.message('This is a VFile message')

const issues = toCodeClimate([file])

API

toCodeClimate(files)

Convert VFile messages to a Code Climate issues.

Parameters

• files (Iterable<VFile>): The files whose messages to convert to Code Climate issues.

Returns

An array of Code Climate issues to represent the VFile messages.

default

Convert VFile messages to a Code Climate report.

This API exists for compatibility with unified-engine. For programmatic use, you want to use toCodeClimate instead.

Parameters

• files (Iterable<VFile>): The files whose messages to convert to Code Climate issues.
• options (Options, optional): Additional reporter options.

Returns

The Code Climate report as a string.

Compatibility

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

License

MIT © Remco Haszing