Release 0.2.0.0

Author: TravisCardwell

CHANGELOG.md

@@ -24,6 +24,16 @@ following conventions:
 
 [KaC]: <https://keepachangelog.com/en/1.0.0/>
 
+## 0.2.0.0 (2023-05-28)
+
+### Breaking
+
+* Add support for `optparse-applicative` `0.18`
+
+### Non-Breaking
+
+* Bump `ansi-wl-pprint` dependency version upper bound
+
 ## 0.1.1.0 (2023-04-23)
 
 ### Non-Breaking

Makefile

@@ -124,7 +124,6 @@ endif
 
 clean-all: clean
 clean-all: # clean package and remove artifacts
-> @rm -rf .hie
 > @rm -rf .stack-work
 > @rm -rf build
 > @rm -rf dist-newstyle
@@ -370,17 +369,6 @@ source-tar: # create source tarball using tar
 > @rm -f build/.gitignore
 .PHONY: source-tar
 
-stan: hr
-stan: export STAN_USE_DEFAULT_CONFIG=True
-stan: # run stan static analysis
-ifeq ($(MODE), cabal)
-> @cabal v2-build -f write-hie
-else
-> @stack build --flag $(PACKAGE):write-hie
-endif
-> @stan
-.PHONY: stan
-
 test: hr
 test: # run tests, optionally for pattern P *
 > $(eval P := "")
@@ -396,7 +384,7 @@ else
 endif
 .PHONY: test
 
-test-all: # run all configured tests and build examples using MODE
+test-all: # run all configured tests using MODE
 > @./test-all.sh "$(MODE)"
 .PHONY: test-all
 

app/LibOA.hs

@@ -9,15 +9,21 @@
 -- @optparse-applicative@.  I do not feel that it is worth maintaining yet
 -- another helper package on Hackage, so I just copy the code to different
 -- projects as required.  If the library grows to a substantial size or others
--- with to use it, I will reconsider.
+-- want to use it, I will reconsider.
 --
--- Revision: 2022-01-02
+-- Revision: 2023-05-26
 ------------------------------------------------------------------------------
 
 {-# LANGUAGE CPP #-}
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE TupleSections #-}
 
+#if defined(MIN_VERSION_ansi_wl_pprint)
+#if MIN_VERSION_ansi_wl_pprint (1,0,2)
+{-# OPTIONS_GHC -Wno-warnings-deprecations #-}
+#endif
+#endif
+
 module LibOA
   ( -- * Options
     -- $Options
@@ -28,14 +34,23 @@ module LibOA
     -- * Help
   , (<||>)
   , section
+  , section'
   , table
   , table_
   , vspace
+    -- ** Compatibility
+  , Doc
+  , (<$$>)
+  , empty
+  , string
+  , vcat
   ) where
 
 -- https://hackage.haskell.org/package/ansi-wl-pprint
+#if !MIN_VERSION_optparse_applicative (0,18,0)
 import qualified Text.PrettyPrint.ANSI.Leijen as Doc
 import Text.PrettyPrint.ANSI.Leijen (Doc)
+#endif
 
 -- https://hackage.haskell.org/package/base
 import Data.List (intersperse, transpose)
@@ -50,8 +65,16 @@ import qualified Options.Applicative as OA
 import qualified Options.Applicative.Builder.Internal as OABI
 #endif
 import qualified Options.Applicative.Common as OAC
+#if MIN_VERSION_optparse_applicative (0,18,0)
+import Options.Applicative.Help.Pretty (Doc)
+#endif
 import qualified Options.Applicative.Types as OAT
 
+-- https://hackage.haskell.org/package/prettyprinter
+#if MIN_VERSION_optparse_applicative (0,18,0)
+import qualified Prettyprinter as Doc
+#endif
+
 ------------------------------------------------------------------------------
 -- $Options
 --
@@ -103,8 +126,12 @@ versioner verStr = OA.infoOption verStr $ mconcat
 commands :: OA.Parser a -> [String]
 commands =
     let go _ opt = case OAT.optMain opt of
+#if MIN_VERSION_optparse_applicative (0,18,0)
+           OAT.CmdReader _ cmdPs -> reverse $ fst <$> cmdPs
+#else
            OAT.CmdReader _ cmds _ -> reverse cmds
-           _otherReader           -> []
+#endif
+           _otherReader -> []
     in  concat . OAC.mapParser go
 
 ------------------------------------------------------------------------------
@@ -115,22 +142,26 @@ commands =
 d1 <||> d2 = d1 <> Doc.line <> Doc.line <> d2
 infixr 5 <||>
 
--- | Create a section with a title and indented body
+-- | Create a section with a title and body indented by 2 spaces
 section :: String -> Doc -> Doc
-section title = (Doc.text title Doc.<$$>) . Doc.indent 2
+section = section' 2
+
+-- | Create a section with a title and body indented by specified spaces
+section' :: Int -> String -> Doc -> Doc
+section' numSpaces title = (string title <$$>) . Doc.indent numSpaces
 
 -- | Create a table, with formatting
 table :: Int -> [[(String, Doc -> Doc)]] -> Doc
 table sep rows = Doc.vcat $
-    map (fromMaybe Doc.empty . foldr go Nothing . zip lengths) rows
+    map (fromMaybe empty . foldr go Nothing . zip lengths) rows
   where
     lengths :: [Int]
     lengths = map ((+) sep . maximum . map (length . fst)) $ transpose rows
 
     go :: (Int, (String, Doc -> Doc)) -> Maybe Doc -> Maybe Doc
     go (len, (s, f)) = Just . \case
-      Just doc -> Doc.fill len (f $ Doc.string s) <> doc
-      Nothing  -> f $ Doc.string s
+      Just doc -> Doc.fill len (f $ string s) <> doc
+      Nothing  -> f $ string s
 
 -- | Create a table, without formatting
 table_ :: Int -> [[String]] -> Doc
@@ -139,3 +170,30 @@ table_ sep = table sep . (map . map) (, id)
 -- | Vertically space documents with blank lines between them
 vspace :: [Doc] -> Doc
 vspace = mconcat . intersperse (Doc.line <> Doc.line)
+
+------------------------------------------------------------------------------
+-- $Compatibility
+
+(<$$>) :: Doc -> Doc -> Doc
+#if MIN_VERSION_optparse_applicative (0,18,0)
+l <$$> r = l <> Doc.line <> r
+#else
+(<$$>) = (Doc.<$$>)
+#endif
+
+empty :: Doc
+#if MIN_VERSION_optparse_applicative (0,18,0)
+empty = Doc.emptyDoc
+#else
+empty = Doc.empty
+#endif
+
+string :: String -> Doc
+#if MIN_VERSION_optparse_applicative (0,18,0)
+string = Doc.pretty
+#else
+string = Doc.string
+#endif
+
+vcat :: [Doc] -> Doc
+vcat = Doc.vcat

bm.cabal

@@ -1,5 +1,5 @@
 name:           bm
-version:        0.1.1.0
+version:        0.2.0.0
 category:       Utils
 synopsis:       open bookmarks and queries from the command line
 description:
@@ -22,9 +22,9 @@ tested-with:
    || ==8.8.4
    || ==8.10.7
    || ==9.0.2
-   || ==9.2.7
+   || ==9.2.8
    || ==9.4.5
-   || ==9.6.1
+   || ==9.6.2
 
 extra-source-files:
   CHANGELOG.md
@@ -34,9 +34,11 @@ source-repository head
   type: git
   location: https://github.com/ExtremaIS/bm-haskell.git
 
-flag write-hie
-  description: write .hie files
+-- This flag is referenced in the Stack build-constraints.yaml configuration.
+flag optparse-applicative_ge_0_18
+  description: Use optparse-applicative 0.18 or newer
   default: False
+  manual: False
 
 library
   hs-source-dirs: src
@@ -56,25 +58,28 @@ library
   default-language: Haskell2010
   default-extensions:
       OverloadedStrings
-  if flag(write-hie)
-    ghc-options: -Wall -fwrite-ide-info -hiedir=.hie
-  else
-    ghc-options: -Wall
+  ghc-options: -Wall
 
 executable bm
   hs-source-dirs: app
   main-is: Main.hs
   other-modules:
       LibOA
   build-depends:
-      ansi-wl-pprint >=0.6.8 && <0.7
-    , base
+      base
     , bm
     , directory >=1.3.3 && <1.4
     , filepath >=1.4.2.1 && <1.5
-    , optparse-applicative >=0.14 && <0.18
     , typed-process >=0.2.6 && <0.3
     , yaml >=0.11.2 && <0.12
+  if flag(optparse-applicative_ge_0_18)
+    build-depends:
+        optparse-applicative >=0.18 && <0.19
+      , prettyprinter >=1.7.1 && <1.8
+  else
+    build-depends:
+        ansi-wl-pprint >=0.6.8 && <1.1
+      , optparse-applicative >=0.14 && <0.18
   default-language: Haskell2010
   ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N
 

cabal-bounds-upper.project

@@ -1,14 +1,11 @@
 packages: ./bm.cabal
 
-with-compiler: ghc-9.6.1
+with-compiler: ghc-9.6.2
 
 constraints:
     -- https://hackage.haskell.org/package/aeson
   , aeson == 2.1.2.1
 
-    -- https://hackage.haskell.org/package/ansi-wl-pprint
-  , ansi-wl-pprint == 0.6.9
-
     -- https://hackage.haskell.org/package/base
     -- GHC boot library
   , base == 4.18.0.0
@@ -28,7 +25,10 @@ constraints:
   , network-uri == 2.6.4.2
 
     -- https://hackage.haskell.org/package/optparse-applicative
-  , optparse-applicative == 0.17.0.0
+  , optparse-applicative == 0.18.0.0
+
+    -- https://hackage.haskell.org/package/prettyprinter
+  , prettyprinter == 1.7.1
 
     -- https://hackage.haskell.org/package/scientific
   , scientific == 0.3.7.0

doc/bm.1

@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "BM" "1" "" "bm-haskell 0.1.1.0 (2023-04-23)" "bm Manual"
+.TH "BM" "1" "" "bm-haskell 0.2.0.0 (2023-05-28)" "bm Manual"
 .nh
 .SH NAME
 .PP

project/release/bm-haskell-0.2.0.0.md

@@ -0,0 +1,36 @@
+# `bm-haskell` `0.2.0.0` Release Notes
+
+Date
+: 2023-05-28
+
+## Overview
+
+`bm` is a utility for opening bookmarks and queries from the command line.
+The bookmarks and queries are configured hierarchically in YAML, and they are
+referenced using keyword prefixes.  It allows you to quickly open bookmarks
+and perform search queries in your browser using only your keyboard.
+
+See the [README][] for details.
+
+[README]: <https://github.com/ExtremaIS/bm-haskell#readme>
+
+## This Release
+
+This release adds compatibility with the latest version of the
+`optparse-applicative` library.
+
+There are no changes to the API or CLI.
+
+### Compatibility
+
+To use this release with a Stackage snapshot that does not include it, add
+the following to your `stack.yaml` configuration:
+
+```yaml
+extra-deps:
+  - bm-0.2.0.0
+```
+
+### Issues
+
+There are no known issues at this time.

stack-9.2.7.yaml

@@ -1,4 +1,4 @@
-resolver: lts-20.18
+resolver: lts-20.23
 
 packages:
   - .