@studiometa/prettier-formatter-gitlab v2.1.1

@studiometa/prettier-formatter-gitlab

Send Prettier errors to Gitlab's Code Quality reports.

Installation

Install the package with NPM:

npm install -D @studiometa/prettier-formatter-gitlab

Usage

Prettier does not have an option for custom reporter, this package will run a prettier CLI command for you and parse its result to generate the Code Quality report.

prettier-formatter-gitlab 'prettier -l src/'

The report file path will be read from the PRETTIER_CODE_QUALITY_REPORT environment variable or from the .gitlab-ci.yml configuration file when using the code quality report artifacts:

# .gitlab-ci.yml
prettier:
  image: node:20
  script:
    - npm ci
    - npx prettier-formatter-gitlab 'prettier -l src/'
  artifacts:
    reports:
      codequality: gl-codequality.json

Notes

This project is heavily inspired and borrows some function to the eslint-formatter-gitlab package.