Registry / devops / eslint-formatter-gitlab

eslint-formatter-gitlab

library7.1.0jsnpmunverified

ESLint formatter that outputs results as GitLab Code Quality reports (gl-codequality.json) and prints issues to the console with merge request links. Version 7.1.0, released under MIT, requires Node.js 20+ and ESLint 9+. Integrates seamlessly with GitLab CI/CD using predefined environment variables, auto-detecting project configuration. Unlike generic formatters, it directly produces the artifact format expected by GitLab's Code Quality feature, enabling inline annotations in merge requests. Maintained by Remco Haszing, with TypeScript type definitions included.

devops testing

npm install eslint-formatter-gitlab

package ↗homepage ↗

INSTALL

IMPORT

SIG · ESLINT-FORMATTER-G

eslint-formatter-gitlab

devopsjavascriptv7.1.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default (formatter function)

✓ import formatter from 'eslint-formatter-gitlab'

✗ const formatter = require('eslint-formatter-gitlab')

ESM-only since v7; CommonJS require fails. Use dynamic import() if needed.

ESLint formatter name

✓ eslint.loadFormatter('gitlab')

✗ eslint.loadFormatter('eslint-formatter-gitlab')

Use 'gitlab' as the formatter name, not the full package name.

TypeScript types

✓ import type { LintResult } from 'eslint' import formatter from 'eslint-formatter-gitlab'

Package ships TypeScript declarations; no separate type import needed.

Shows both GitLab CI job configuration and programmatic usage for generating Code Quality reports.

// .gitlab-ci.yml eslint: image: node:22-alpine script: - npm ci - npx eslint --format gitlab . artifacts: reports: codequality: gl-codequality.json // Programmatic use: import { ESLint } from 'eslint'; import formatter from 'eslint-formatter-gitlab'; const eslint = new ESLint(); const results = await eslint.lintFiles(['src/']); const output = await formatter(results); // output contains Code Quality JSON and console text

Debug

Known issues

breakingv7 dropped CommonJS support; requires ESM.

fix

Use ESM imports or upgrade to Node >= 20. For CJS, pin to v6.

affects: >=7.0.0

breakingv7 requires ESLint 9. Not compatible with ESLint 8.

fix

Upgrade to ESLint 9 or use eslint-formatter-gitlab@6.

affects: >=7.0.0

breakingv7 requires Node.js 20. Older Node versions break.

fix

Use Node.js >= 20.

affects: >=7.0.0

gotchaEnvironment variable CI_CONFIG_PATH must point to the correct .gitlab-ci.yml path; defaults to '.gitlab-ci.yml'.

fix

Set CI_CONFIG_PATH if your CI config is at a non-default location.

affects: >=1.0.0

gotchaOutput file location is read from the 'codequality:report' artifact path inside the job definition; if misconfigured, the artifact may be missing.

fix

Ensure the job in .gitlab-ci.yml has 'artifacts: reports: codequality: ...' set.

affects: >=1.0.0

gotchaThe formatter uses process.cwd() if CI_PROJECT_DIR is not set; may cause relative path mismatches in CI.

fix

Set CI_PROJECT_DIR environment variable in CI jobs to the project root.

affects: >=1.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module not supported

Using require() on an ESM-only package (v7+).

fix

Switch to import or dynamic import(). If using CJS, use eslint-formatter-gitlab@6.

Cannot find module 'eslint-formatter-gitlab'

Using the full package name in eslint --format (should be just 'gitlab').

fix

Use 'npx eslint --format gitlab' instead of '--format eslint-formatter-gitlab'.

Failed to load formatter 'gitlab': Could not find a declaration file for module 'eslint-formatter-gitlab'.

TypeScript not finding types; missing @types/eslint or incorrect tsconfig.

fix

Install eslint types: npm i -D @types/eslint. Ensure tsconfig has 'moduleResolution': 'node16' or 'bundler'.

Warning: Code Quality report not generated because CI_JOB_NAME environment variable is not set.

Running outside GitLab CI or missing predefined environment variables.

fix

Run inside a GitLab CI job, or set CI_JOB_NAME manually for local testing (not recommended).

Upgrade

Version history

7.1.0latest on npm

Audit

Dependencies

eslintrequiredPeer dependency for ESLint formatter API (>=9)

Agent activity

2 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/eslint-formatter-gitlab ↗

homepagehttps://gitlab.com/remcohaszing/eslint-formatter-gitlab#readme ↗