Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caarmen/pylint-json2checkstyle
A Pylint plugin and command line tool to produce Pylint reports in checkstyle format.
https://github.com/caarmen/pylint-json2checkstyle
pylint-plugin python
Last synced: 11 days ago
JSON representation
A Pylint plugin and command line tool to produce Pylint reports in checkstyle format.
- Host: GitHub
- URL: https://github.com/caarmen/pylint-json2checkstyle
- Owner: caarmen
- License: mit
- Created: 2022-05-21T13:46:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-20T11:49:38.000Z (10 months ago)
- Last Synced: 2024-09-22T10:17:37.532Z (about 2 months ago)
- Topics: pylint-plugin, python
- Language: Python
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pylint-json2checkstyle
A Pylint plugin and command line tool to produce Pylint reports in checkstyle format.
This project is partially inspired from the [pylint-json2html](https://github.com/Exirel/pylint-json2html) project.
[![GitHub license][license-image]][license-url]
[![GitHub-Actions][gh-image]][gh-url]
[![pyversion][pyversion-image]][pyversion-url]
[![pypi][pypi-image]][pypi-url]
[license-image]: https://img.shields.io/badge/license-MIT-lightgrey.svg?maxAge=2592000
[license-url]: https://raw.githubusercontent.com/caarmen/pylint-json2checkstyle/main/LICENSE
[gh-image]: https://img.shields.io/github/actions/workflow/status/caarmen/pylint-json2checkstyle/tests.yml?branch=main
[gh-url]: https://github.com/caarmen/pylint-json2checkstyle/actions/workflows/tests.yml?query=branch%3Amain
[pyversion-image]: https://img.shields.io/pypi/pyversions/pylint-json2checkstyle
[pyversion-url]: https://pypi.org/project/pylint-json2checkstyle/
[pypi-image]: https://img.shields.io/pypi/v/pylint-json2checkstyle.svg?style=flat
[pypi-url]: https://pypi.org/project/pylint-json2checkstyle/
## Usage:
### As a command line tool
```
usage: pylint-json2checkstyle [-h] [-o checkstyle_output_file] [json_input_file]
Convert pylint json report to checkstyle
positional arguments:
json_input_file Pylint JSON report input file (or stdin)
optional arguments:
-h, --help show this help message and exit
-o checkstyle_output_file, --output checkstyle_output_file
Checkstyle report output file (or stdout)
```
### As a Pylint plugin:
```
pylint --load-plugins=pylint_json2checkstyle.checkstyle_reporter --output-format=checkstyle [pylint arguments ... ]
```
## Why?
Checkstyle is a widely supported report format for code issues, with integrations available in CI environments.
For example, the [Checkstyle GitHub Action](https://github.com/jwgmeligmeyling/checkstyle-github-action) reads a checkstyle report and adds
annotations to PRs.