Add changelog entry and help message for --public-only

Author: Kleidukos

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.2.0
+
+* Add support for module-level Haddock attribute `Visibility: Public` in order to filter modules.
+  The command-line argument `--public-only` can be combined with `--modules-ignore-list`.
 ## 0.1.1.0
 
 * Add support for user-supplied ignore lists of modules ([#18](https://github.com/Kleidukos/print-api/pull/18))

README.md

@@ -12,7 +12,7 @@ Binaries for the following operating systems and GHC are provided:
 | GHC / OS | Ubuntu 22.04 (glibc) | Alpine 3.20 (musl) | macOS 14  |
 |---|---|---|---|
 | 9.10.1 | ✅ | ✅ | ✅ |
-| 9.8.2 | ✅ | ✅ | ✅ |
+| 9.8.4 | ✅ | ✅ | ✅ |
 | 9.6.6 | ✅ | ✅ | ✅ |
 
 ### Releases

src/PrintApi/CLI/Cmd/Dump.hs

@@ -179,13 +179,16 @@ extractModuleDeclarations moduleName mod_info = do
   let contents =
         vcat $
           [ pprTyThing ss thing $$ extras
-          | thing <- things
-          , let ss = mkShowSub mod_info
-          , let extras = case thing of
-                  ATyCon tycon
-                    | Just cls <- tyConClass_maybe tycon ->
-                        nest 2 (text "{-# MINIMAL" <+> ppr (classMinimalDef cls) <+> text "#-}")
-                  _ -> empty
+          | let ss = mkShowSub mod_info
+          , thing <- things
+          , let extras =
+                  case thing of
+                    ATyCon tycon
+                      | Just cls <- tyConClass_maybe tycon ->
+                          nest
+                            2
+                            (text "{-# MINIMAL" <+> ppr (classMinimalDef cls) <+> text "#-}")
+                    _ -> empty
           ]
   pure $ withUserStyle name_ppr_ctx AllTheWay $ hang (modHeader moduleName) 2 contents <> text ""
 

src/PrintApi/CLI/Types.hs

@@ -40,7 +40,7 @@ parseOptions =
       (long "package-name" <> short 'p' <> metavar "PACKAGE NAME" <> help "Name of the package")
     <*> optional
       (option osPathOption (long "modules-ignore-list" <> metavar "FILE" <> help "Read the file for a list of ignored modules (one per line)"))
-    <*> switch (long "public-only")
+    <*> switch (long "public-only" <> help "Process modules with `Visibility: Public` set in their Haddock attributes.")
 
 withInfo :: Parser a -> String -> ParserInfo a
 withInfo opts desc =