commercialhaskell/stack

Default html charset for `stack test --coverage` reports on windows should not be cp437

Open

#3,414 opened on Sep 4, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (4,060 stars) (848 forks)batch import
awaiting pull requestcomponent: Windowshelp wantedtype: bug

Description

The charset of of html files produced by stack test --coverage depends on the OS/locale. E.g. on Ubuntu 16 all files will be marked with charset=UTF-8, while on a Win10 machine they will be charset=CP437 (which mangles any character outside this charset; editing manually the charset to utf8 fixes the problem). I did not find any settings that would override the charset/provide custom css/etc.

Steps to reproduce

  1. Take any project with a non-empty test suite
  2. Cover in that test suite a file with non-ascii characters inside
  3. Use Win10
  4. Run stack test --coverage
  5. Open the produced html report for that file
  6. The charset would be set to CP437, making non-ascii part of the source code non-readable

Expected

A setting in a config file/cli option that would put the charset of my choice; or at least charset=UTF-8 everywhere regardless of the OS.

Actual

charset=CP437 where there is no reason to put this charset

Stack version

1.5.1 (latest after stack upgrade); OS=Win10

Method of installation

  • Official binary, downloaded from stackage.org or fpcomplete's package repository

Contributor guide

Tech stack
None
Domain
build systemtoolingtesting
Issue type
bug
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-2 days
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
Haskell basicsHTML charset encodingWindows locale handlingstack build tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate how stack generates HTML coverage reports, particularly the logic that sets the charset meta tag. Look for locale dependent behavior on Windows. Consider adding a config option or forcing UTF 8. The relevant code is likely in the stack package's coverage module, possibly in src/Stack/Coverage.hs or similar. Review the hpc library usage for HTML generation and charset handling.