Improvements to HTML reports
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 1.6k
- Forks
- 210
- PR merge metrics
- No merged PRs in 30d
Description
Split off from https://github.com/ndmitchell/hlint/pull/513. For info, I thought of two further improvements, which might be valuable if you are doing work and using the report (I tend not to use it myself):
- Use hash on the name to derive an id (with a backup of what you have now if there are clashes). Advantage is that given a link it's likely to remain stable even if it's regenerated.
- Use folder structure for files, so everything below src is one level, then src/Model. Would also let you see all errors/warnings in a folder at a time.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the HTML report implementation and the split-off pull request #513. Investigate how report names currently become IDs and how files are presented. Done would mean stable hash-derived IDs with a collision fallback and folder-based grouping for files, if both improvements are pursued.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100