Merge branch '587-new-job-prettier_check' into 'latest'

# Changelog

All notable changes to this job will be documented in this file.

## [0.1.0] - 2022-06-07

* Initial version

 No newline at end of file

## Objective

This jobs will run a `prettier --check` command. It's an opinionated code formatter with multiple support for JavaScript, TypeScript, JSX and many [others](https://prettier.io/docs/en/index.html). You can customize it to your needs by specifying rules in [specific files](https://prettier.io/docs/en/configuration.html).

## How to use it

1. Copy the job URL located in the `Install` part of the right panel and add it inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

1. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/use-the-hub/#jobs-customization)

1. Well done, your job is ready to work ! 😀

## Job details

* Job name: `prettier_check`

* Docker image:

[`node:18-buster`](https://hub.docker.com/r/_/node)

* Default stage: `tests`

* When: `always`

### Variables

| Name | Description | Default |

| ---- | ----------- | ------- |

| `PROJECT_ROOT` <img width=100/> | Path to the root of project <img width=175/>| `.` <img width=100/>|

| `PRETTIER_SOURCE` <img width=100/> | Relative path to the directory to scan <img width=175/>| `./src` <img width=100/>|

| `PRETTIER_VERSION` <img width=100/> | Version of Prettier <img width=175/>| `2.6.2` <img width=100/>|

| `OUTPUT_DIRECTORY` <img width=100/> | Output directory where to save files checked. None if empty <img width=175/>| `prettier-report` <img width=100/>|

| `ADDITIONAL_OPTIONS` <img width=100/> | Additional options for Prettier <img width=175/>| ` ` <img width=100/>|

stages:

  - tests

prettier_check:

    image: node:18-buster

    stage: tests

    variables:

      PROJECT_ROOT: "."

      PRETTIER_SOURCE: "./src"

      PRETTIER_VERSION: "2.6.2"

      OUTPUT_DIRECTORY: "prettier-report"

      ADDITIONAL_OPTIONS: ""

    script:

      - cd "${PROJECT_ROOT}"

      - npm install --location=global prettier@${PRETTIER_VERSION}

      - if [ ! -z ${OUTPUT_DIRECTORY} ]; then

      -    mkdir -p "${OUTPUT_DIRECTORY}"

      -    if prettier ${ADDITIONAL_OPTIONS} -l ${PRETTIER_SOURCE} > "${OUTPUT_DIRECTORY}/prettier-report.txt"; then

      -       echo "Prettier check passed"

      -    else

      -       echo "Prettier check failed"

      -       prettier ${ADDITIONAL_OPTIONS} -c ${PRETTIER_SOURCE}

      -    fi

      - else

      -    prettier ${ADDITIONAL_OPTIONS} -c ${PRETTIER_SOURCE}

      - fi

    artifacts:

      when: always

      paths:

        - ${PROJECT_ROOT}/${OUTPUT_DIRECTORY}/prettier-report.txt