typos-gitlab-code-quality 1.0.0

Generate GitLab Code Quality report from typos output

typos-gitlab-code-quality

Generate GitLab Code Quality report from typos output.

Usage

Read from stdin:

$ typos --format json | typos-gitlab-code-quality

Read from file:

$ typos --format json > typos-report.json
$ typos-gitlab-code-quality typos-report.json

Example .gitlab-ci.yml

With pip:

typos:
  image: python:alpine
  script:
    - pip install typos typos-gitlab-code-quality
    # "|| true" is used for preventing job fail when typos find errors
    - typos --format json > typos-report.json || true
    - typos-gitlab-code-quality < typos-report.json > codequality.json
  artifacts:
    when: always
    reports:
      codequality: codequality.json

With uv:

typos:
  image: ghcr.io/astral-sh/uv:python3.14-alpine
  script:
    # "|| true" is used for preventing job fail when typos find errors
    - uvx typos --format json > typos-report.json || true
    - uvx typos-gitlab-code-quality < typos-report.json > codequality.json
  artifacts:
    when: always
    reports:
      codequality: codequality.json

Acknowledgements

This project is inspired by mypy-gitlab-code-quality.