commercialhaskell/stack

Pass options to HPC (like --xml-output)

Open

#4,307 opened on Sep 11, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Haskell (4,060 stars) (848 forks)batch import
component: benchmarkcomponent: coveragecomponent: options parsingcomponent: profilinghelp wantedtype: enhancement

Description

I could not find a way to pass options to HPC (as documented in https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/profiling.html#hpc-report).

The one I am particularly interested in is --xml-output to be able to parse coverage (and hopefully convert it into SonarQube-compatible code coverage later). I could not find an equivalent in stack, stack hpc or stack hpc report documentation/help.

Contributor guide

Tech stack
None
Domain
build systemtooling
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Haskell knowledgeFamiliarity with Stack codebaseUnderstanding of HPC tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate how Stack currently calls HPC (likely in src/Stack/HPC.hs). Extend the 'hpc report' command to accept options like xml output and pass them through to the HPC executable. Check existing command parsing in src/Stack/Options/HPC.hs for guidance.