Skip to content

Fix: Filter out private internal libraries from package pages #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 10, 2025
Merged

Fix: Filter out private internal libraries from package pages #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81058e6
Initial plan
Copilot Oct 10, 2025
73a1143
Filter private internal libraries from package rendering
Copilot Oct 10, 2025
6d37540
Also filter private libraries from dependency listing
Copilot Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/Distribution/Server/Packages/Render.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ import Distribution.Types.VersionInterval.Legacy
-- I criticized this unfortunate development at length at:
-- https://github.com/haskell/cabal/issues/7916
import Distribution.ModuleName as ModuleName
import Distribution.Types.LibraryVisibility (LibraryVisibility(LibraryVisibilityPublic))

-- hackage-server
import Distribution.Server.Framework.CacheControl (ETag)
Expand Down Expand Up @@ -148,14 +149,18 @@ doPackageRender users info = PackageRender
else NotBuildable

renderModules :: Maybe TarIndex -> [(LibraryName, ModSigIndex)]
renderModules docindex = flip fmap (allLibraries flatDesc) $ \lib ->
renderModules docindex = flip fmap (filter isPublicLibrary $ allLibraries flatDesc) $ \lib ->
let mod_ix = mkForest $ exposedModules lib
-- Assumes that there is an HTML per reexport
++ map moduleReexportName (reexportedModules lib)
++ virtualModules (libBuildInfo lib)
sig_ix = mkForest $ signatures lib
mkForest = moduleForest . map (\m -> (m, moduleHasDocs docindex m))
in (libName lib, ModSigIndex { modIndex = mod_ix, sigIndex = sig_ix })
where
-- Only show main library or internal libraries with public visibility
isPublicLibrary lib = libName lib == LMainLibName
|| libVisibility lib == LibraryVisibilityPublic

moduleHasDocs :: Maybe TarIndex -> ModuleName -> Bool
moduleHasDocs Nothing = const False
Expand Down Expand Up @@ -189,8 +194,15 @@ doPackageRender users info = PackageRender
renderComponentName name@(CNotLibName _) = componentNameRaw name

allCondLibs :: GenericPackageDescription -> [(LibraryName, CondTree ConfVar [Dependency] Library)]
allCondLibs desc = maybeToList ((LMainLibName,) <$> condLibrary desc)
allCondLibs desc = filter (isPublicCondLib . snd) $
maybeToList ((LMainLibName,) <$> condLibrary desc)
++ (first LSubLibName <$> condSubLibraries desc)
where
-- Check if a conditional library tree contains a public library
-- We check the root node since visibility is a property of the library itself
isPublicCondLib condTree =
let lib = condTreeData condTree
in libName lib == LMainLibName || libVisibility lib == LibraryVisibilityPublic

type DependencyTree = CondTree ConfVar [Dependency] IsBuildable

Expand Down