pylint-dev/pylint

Add pylint-junit reporter class

Open

#9,143 opened on Oct 12, 2023

View on GitHub
 (2 comments) (6 reactions) (0 assignees)Python (4,978 stars) (1,059 forks)batch import
Enhancement ✨Good first issueHacktoberfestHelp wanted 🙏Needs PR

Description

Current problem

I'm a user of pylint. I used to use pylint2junit. I found out it has not been working since pylint 2.15. I then found pylint-junit which seems to fix some issues in pylint2junit. But it also have had issues since pylint 2.15. pylint2junit does not seem maintained. pylint-junit seems more active.

I would really like to continue to use pylint and I need junit reporting for my (Azure DevOps) pipelines.

Desired solution

Add pylint-junit reporter class to pylint to make the junit support more robust.

Additional context

Proposed by @Pierre-Sassoulas in https://github.com/pylint-dev/pylint/issues/8368#issuecomment-1759674966

Contributor guide

Tech stack
python
Domain
testingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythonunderstanding pylint reporter interface
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Refer to the proposal by @Pierre Sassoulas in the linked comment. Examine the existing reporter implementations in pylint's codebase, particularly in the 'pylint/reporters' directory. The goal is to create a new reporter class that outputs JUnit XML format, similar to the external pylint junit package. Look at the base reporter class and existing JSON or text reporters for guidance. Implement the new class and register it in pylint's reporter registry.