Refactoring to put shared flags parser in its own module

Author: mpilgrem

package.yaml

@@ -229,6 +229,7 @@ library:
   - Stack.Options.DotParser
   - Stack.Options.EvalParser
   - Stack.Options.ExecParser
+  - Stack.Options.FlagsParser
   - Stack.Options.GhcBuildParser
   - Stack.Options.GhciParser
   - Stack.Options.GhcVariantParser

src/Stack/Options/BuildParser.hs

@@ -8,28 +8,24 @@ License     : BSD-3-Clause
 
 module Stack.Options.BuildParser
   ( buildOptsParser
-  , flagsParser
-  , targetsParser
   ) where
 
 import qualified Data.List as L
-import qualified Data.Map as Map
 import qualified Data.Text as T
 import           Options.Applicative
                    ( Parser, completer, flag, flag', help, internal, long
-                   , metavar, option, strOption, switch, value
+                   , metavar, strOption, switch, value
                    )
 import           Options.Applicative.Args ( cmdOption )
 import           Options.Applicative.Builder.Extra
                    ( firstBoolFlagsNoDefault, textArgument, textOption )
-import           Stack.Options.Completion
-                   ( flagCompleter, ghcOptsCompleter, targetCompleter )
-import           Stack.Options.PackageParser ( readFlag )
+import           Stack.Options.Completion ( ghcOptsCompleter, targetCompleter )
+import           Stack.Options.FlagsParser ( flagsParser )
 import           Stack.Options.Utils ( hideMods )
 import           Stack.Prelude
 import           Stack.Types.BuildOptsCLI
-                   ( ApplyCLIFlag, BuildCommand, BuildOptsCLI (..)
-                   , BuildSubset (..), FileWatchOpts (..)
+                   ( BuildCommand, BuildOptsCLI (..), BuildSubset (..)
+                   , FileWatchOpts (..)
                    )
 
 -- | Parser for CLI-only build arguments
@@ -127,7 +123,7 @@ buildOptsParser cmd = BuildOptsCLI
         <> internal
         )
 
--- | Parser for build targets. Also used by the @stack dot@ command.
+-- | Parser for build targets.
 targetsParser :: Parser [Text]
 targetsParser =
   many (textArgument
@@ -139,21 +135,6 @@ targetsParser =
             \for details."
     ))
 
--- | Parser for the @--flag@ option, for Cabal flags.
-flagsParser :: Parser (Map.Map ApplyCLIFlag (Map.Map FlagName Bool))
-flagsParser = Map.unionsWith Map.union
-  <$> many (option readFlag
-       (  long "flag"
-       <> completer flagCompleter
-       <> metavar "PACKAGE:[-]FLAG"
-       <> help "Set (or unset) the Cabal flag for the package (or use '*' for \
-               \all packages) (can be specified multiple times). Applies to \
-               \project packages, packages included directly in the snapshot, \
-               \and extra-deps. Takes precedence over any Cabal flags \
-               \specified for the package in the snapshot or in the \
-               \project-level configuration file (stack.yaml)."
-       ))
-
 progsOptionsParser :: Parser [(Text, [Text])]
 progsOptionsParser =
      dummyProgOptionsParser

src/Stack/Options/DotParser.hs

@@ -22,8 +22,8 @@ import           Options.Applicative
                    , strOption, switch
                    )
 import           Options.Applicative.Builder.Extra ( boolFlags, textArgument )
-import           Stack.Options.BuildParser ( flagsParser )
 import           Stack.Options.Completion ( targetCompleter )
+import           Stack.Options.FlagsParser ( flagsParser )
 import           Stack.Prelude
 import           Stack.Types.DotOpts ( DotOpts (..) )
 

src/Stack/Options/FlagsParser.hs

@@ -0,0 +1,37 @@
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# LANGUAGE OverloadedStrings #-}
+
+{-|
+Module      : Stack.Options.FlagsParser
+Description : Parser for one or more Cabal flags.
+License     : BSD-3-Clause
+
+Parser for one or more Cabal flags.
+-}
+
+module Stack.Options.FlagsParser
+  ( flagsParser
+  ) where
+
+import qualified Data.Map as Map
+import           Options.Applicative
+                   ( Parser, completer, help, long, metavar, option )
+import           Stack.Options.Completion ( flagCompleter )
+import           Stack.Options.PackageParser ( readFlag )
+import           Stack.Prelude
+import           Stack.Types.BuildOptsCLI ( ApplyCLIFlag )
+
+-- | Parser for one or more @--flag@ options, each for a Cabal flag.
+flagsParser :: Parser (Map.Map ApplyCLIFlag (Map.Map FlagName Bool))
+flagsParser = Map.unionsWith Map.union
+  <$> many (option readFlag
+       (  long "flag"
+       <> completer flagCompleter
+       <> metavar "PACKAGE:[-]FLAG"
+       <> help "Set (or unset) the Cabal flag for the package (or use '*' for \
+               \all packages) (can be specified multiple times). Applies to \
+               \project packages, packages included directly in the snapshot, \
+               \and extra-deps. Takes precedence over any Cabal flags \
+               \specified for the package in the snapshot or in the \
+               \project-level configuration file (stack.yaml)."
+       ))

src/Stack/Options/GhciParser.hs

@@ -21,9 +21,8 @@ import           Options.Applicative.Builder.Extra
                    )
 import           Stack.Config ( packagesParser )
 import           Stack.Ghci ( GhciOpts (..) )
-import           Stack.Options.BuildParser ( flagsParser )
-import           Stack.Options.Completion
-                   ( ghcOptsCompleter, targetCompleter )
+import           Stack.Options.Completion ( ghcOptsCompleter, targetCompleter )
+import           Stack.Options.FlagsParser ( flagsParser )
 import           Stack.Prelude
 
 -- | Parser for GHCI options

stack.cabal

@@ -265,6 +265,7 @@ library
       Stack.Options.DotParser
       Stack.Options.EvalParser
       Stack.Options.ExecParser
+      Stack.Options.FlagsParser
       Stack.Options.GhcBuildParser
       Stack.Options.GhciParser
       Stack.Options.GhcVariantParser