commercialhaskell/stack

Add `--all-packages`

Open

#1,479 opened on Dec 8, 2015

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (848 forks)batch import
component: haddockhelp wantedtype: enhancement

Repository metrics

Stars
 (4,060 stars)
PR merge metrics
 (Avg merge 17d 10h) (6 merged PRs in 30d)

Description

The stack haddock command currently generates documentation for the current build plan (which can include dependencies or not).

It would be good to have a flag like --all-packages so that haddocks would be generated for everything in the complete available package set.

Contributor guide

Research direction
Add a new flag ' all packages' to the 'stack haddock' command. The flag should generate haddock documentation for all packages in the complete available package set, rather than just the current build plan. Locate the command definition in the source code (likely in src/Stack/Build/Haddock.hs or similar). Add the flag to the command options, and modify the logic to iterate over all packages when the flag is set. Test the implementation.
Tech stack
haskell
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HaskellGitStack
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75