/prettier-formatter-gitlab

Send Prettier errors to Gitlab's Code Quality reports.

Primary LanguageJavaScriptMIT LicenseMIT

Prettier formatter for GitLab Code Quality

NPM Version Dependency Status devDependency Status

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
eslint:
  image: node:14
  script:
    - npm ci
    - 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.