commercialhaskell/stack

stack haddock ignores the dependencies of test suites and executables

Open

#2,620 建立於 2016年9月22日

在 GitHub 查看
 (4 留言) (2 反應) (0 負責人)Haskell (4,060 star) (848 fork)batch import
component: haddockhelp wantedtype: enhancement

描述

General summary/comments (optional)

stack haddock generates the documentation for the dependencies of the library component, but not of the executable or test components.

Steps to reproduce

  1. Create a cabal package where some packages are required by the executable or test but not the library
  2. Run stack haddock

Expected

If I go to the doc index (.stack-work/install/x86_64-linux/lts-7.0/8.0.1/doc/all/index.html), I expect to see the executables and test suite dependencies docs.

Actual

They're not there.

Stack version

$ stack --version
Version 1.2.1, Git revision f28002bdea51468566fd9370f7f9e801c2b51bc5 (4141 commits) x86_64 hpack-0.14.1

Method of installation

Built from git.

貢獻者指南

技術棧
無
領域
clibuild systemdocumentation
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Haskell build system knowledgeStack internalsCabal file structure
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
35
研究方向
Investigate how `stack haddock` collects dependencies for library vs test and executable components. Look at the stack code for the haddock command, likely in `src/Stack/Build/Haddock.hs` or similar. Examine how the dependency graph is constructed to ensure all component dependencies are included. Consider checking if there is an existing PR or discussion about this behavior.