https://github.com/tahv/typos-gitlab-code-quality
Generate GitLab Code Quality report from typos output
https://github.com/tahv/typos-gitlab-code-quality
codequality gitlab gitlab-ci typos
Last synced: 20 days ago
JSON representation
Generate GitLab Code Quality report from typos output
- Host: GitHub
- URL: https://github.com/tahv/typos-gitlab-code-quality
- Owner: tahv
- License: mit
- Created: 2025-12-09T19:26:16.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-12-10T12:08:30.000Z (6 months ago)
- Last Synced: 2025-12-10T17:46:49.980Z (6 months ago)
- Topics: codequality, gitlab, gitlab-ci, typos
- Language: Python
- Homepage: https://pypi.org/project/typos-gitlab-code-quality/
- Size: 45.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# typos-gitlab-code-quality
Generate [GitLab Code Quality report](https://docs.gitlab.com/ci/testing/code_quality/)
from [typos](https://github.com/crate-ci/typos)
output.
## Usage
Read from **stdin**:
```console
$ typos --format json | typos-gitlab-code-quality
```
Read from **file**:
```console
$ typos --format json > typos-report.json
$ typos-gitlab-code-quality typos-report.json
```
## Example `.gitlab-ci.yml`
With pip:
```yaml
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](https://docs.astral.sh/uv/guides/integration/gitlab/):
```yaml
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](https://pypi.org/project/mypy-gitlab-code-quality/).