Refactor: Separate Stack.Options.IdeParser and Stack.Types.IdeOpts

Author: mpilgrem

package.yaml

@@ -238,6 +238,7 @@ library:
   - Stack.Options.GlobalParser
   - Stack.Options.HaddockParser
   - Stack.Options.HpcReportParser
+  - Stack.Options.IdeParser
   - Stack.Options.InitParser
   - Stack.Options.LogLevelParser
   - Stack.Options.LsParser
@@ -323,6 +324,7 @@ library:
   - Stack.Types.GlobalOpts
   - Stack.Types.GlobalOptsMonoid
   - Stack.Types.HpcReportOpts
+  - Stack.Types.IdeOpts
   - Stack.Types.Installed
   - Stack.Types.InterfaceOpt
   - Stack.Types.IsMutable

src/Stack/CLI.hs

@@ -15,9 +15,10 @@ import           Data.Char ( toLower )
 import qualified Data.List as L
 import           Data.List.NonEmpty ( prependList )
 import           Options.Applicative
-                   ( Parser, ParserFailure, ParserHelp, ParserResult (..), flag, switch
+                   ( Parser, ParserFailure, ParserHelp, ParserResult (..)
                    , handleParseResult, help, helpError, idm, long, metavar
-                   , overFailure, renderFailure, strArgument, switch )
+                   , overFailure, renderFailure, strArgument, switch
+                   )
 import           Options.Applicative.Help ( errorHelp, stringChunk, vcatChunks )
 import           Options.Applicative.Builder.Extra
                    ( boolFlags, extraHelpOption )
@@ -48,10 +49,7 @@ import           Stack.Exec ( SpecialExecCmd (..), execCmd )
 import           Stack.Eval ( evalCmd )
 import           Stack.Ghci ( ghciCmd )
 import           Stack.Hoogle ( hoogleCmd )
-import           Stack.IDE
-                   ( ListPackagesCmd (..), OutputStream (..), idePackagesCmd
-                   , ideTargetsCmd
-                   )
+import           Stack.IDE ( idePackagesCmd, ideTargetsCmd )
 import           Stack.Init ( initCmd )
 import           Stack.List ( listCmd )
 import           Stack.Ls ( lsCmd )
@@ -67,6 +65,7 @@ import           Stack.Options.ExecParser ( execOptsParser )
 import           Stack.Options.GhciParser ( ghciOptsParser )
 import           Stack.Options.GlobalParser ( globalOptsParser )
 import           Stack.Options.HpcReportParser ( hpcReportOptsParser )
+import           Stack.Options.IdeParser ( idePackagesParser, ideTargetsParser )
 import           Stack.Options.InitParser ( initOptsParser )
 import           Stack.Options.LsParser ( lsOptsParser )
 import           Stack.Options.NewParser ( newOptsParser )
@@ -358,46 +357,17 @@ commandLineHandler currentDir progName mExecutablePath isInterpreter =
   ide = addSubCommands'
     "ide"
     "IDE-specific commands."
-    ( let outputFlag = flag
-            OutputLogInfo
-            OutputStdout
-            (  long "stdout"
-            <> help "Send output to the standard output stream instead of the \
-                    \default, the standard error stream."
-            )
-          cabalFileFlag = flag
-            ListPackageNames
-            ListPackageCabalFiles
-            (  long "cabal-files"
-            <> help "Print paths to package Cabal files instead of package \
-                    \names."
-            )
-          exeFlag = switch
-            (  long "exes"
-            <> help "Include executables."
-            )
-          testFlag = switch
-            (  long "tests"
-            <> help "Include test suites."
-            )
-          benchFlag = switch
-            (  long "benchmarks"
-            <> help "Include benchmarks."
-            )
-       in  do
-             addCommand'
-               "packages"
-               "List all available local loadable packages."
-               idePackagesCmd
-               ((,) <$> outputFlag <*> cabalFileFlag)
-             addCommand'
-               "targets"
-               "List all targets or pick component types to list."
-               ideTargetsCmd
-                 (   (,)
-                 <$> ((,,) <$> exeFlag <*> testFlag <*> benchFlag)
-                 <*> outputFlag
-                 )
+    ( do
+        addCommand'
+          "packages"
+          "List all available local loadable packages."
+          idePackagesCmd
+          idePackagesParser
+        addCommand'
+          "targets"
+          "List all targets or pick component types to list."
+          ideTargetsCmd
+          ideTargetsParser
     )
 
   init = addCommand'

src/Stack/IDE.hs

@@ -28,6 +28,7 @@ import           Stack.Runners
                    ( ShouldReexec (..), withBuildConfig, withConfig )
 import           Stack.Types.BuildConfig
                    ( BuildConfig (..), HasBuildConfig (..) )
+import           Stack.Types.IdeOpts ( ListPackagesCmd (..), OutputStream (..) )
 import           Stack.Types.NamedComponent
                    ( NamedComponent, isCBench, isCExe, isCTest
                    , renderPkgComponent
@@ -37,21 +38,6 @@ import           Stack.Types.SourceMap
                    ( ProjectPackage (..), SMWanted (..), ppComponentsMaybe )
 import           System.IO ( putStrLn )
 
--- | Type representing output stream choices for the @stack ide packages@ and
--- @stack ide targets@ commands.
-data OutputStream
-  = OutputLogInfo
-    -- ^ To the same output stream as other log information.
-  | OutputStdout
-    -- ^ To the standard output stream.
-
--- | Type representing output choices for the @stack ide packages@ command.
-data ListPackagesCmd
-  = ListPackageNames
-    -- ^ Package names.
-  | ListPackageCabalFiles
-    -- ^ Paths to Cabal files.
-
 -- | Function underlying the @stack ide packages@ command. List packages in the
 -- project.
 idePackagesCmd :: (OutputStream, ListPackagesCmd) -> RIO Runner ()

src/Stack/Options/IdeParser.hs

@@ -0,0 +1,64 @@
+{-# LANGUAGE NoImplicitPrelude   #-}
+{-# LANGUAGE OverloadedStrings   #-}
+
+{-|
+Module      : Stack.Options.IdeParser
+Description : Parse arguments for Stack's @ide@ commands.
+License     : BSD-3-Clause
+
+Functions to parse command line arguments for Stack's @ide@ commands.
+-}
+
+module Stack.Options.IdeParser
+  ( idePackagesParser
+  , ideTargetsParser
+  ) where
+
+import           Options.Applicative ( Parser, flag, help, long, switch )
+import           Stack.Prelude
+import           Stack.Types.IdeOpts ( ListPackagesCmd (..), OutputStream (..) )
+
+-- | Parse command line arguments for Stack's @ide packages@ command.
+idePackagesParser :: Parser (OutputStream, ListPackagesCmd)
+idePackagesParser = (,) <$> outputFlag <*> cabalFileFlag
+
+-- | Parse command line arguments for Stack's @ide targets@ command.
+ideTargetsParser :: Parser ((Bool, Bool, Bool), OutputStream)
+ideTargetsParser =
+  (,) <$> ((,,) <$> exeFlag <*> testFlag <*> benchFlag) <*> outputFlag
+
+outputFlag :: Parser OutputStream
+outputFlag = flag
+  OutputLogInfo
+  OutputStdout
+  (  long "stdout"
+  <> help "Send output to the standard output stream instead of the \
+          \default, the standard error stream."
+  )
+
+cabalFileFlag :: Parser ListPackagesCmd
+cabalFileFlag = flag
+  ListPackageNames
+  ListPackageCabalFiles
+  (  long "cabal-files"
+  <> help "Print paths to package Cabal files instead of package \
+          \names."
+  )
+
+exeFlag :: Parser Bool
+exeFlag = switch
+  (  long "exes"
+  <> help "Include executables."
+  )
+
+testFlag :: Parser Bool
+testFlag = switch
+  (  long "tests"
+  <> help "Include test suites."
+  )
+
+benchFlag :: Parser Bool
+benchFlag = switch
+  (  long "benchmarks"
+  <> help "Include benchmarks."
+  )

src/Stack/Types/IdeOpts.hs

@@ -0,0 +1,30 @@
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# LANGUAGE NoFieldSelectors  #-}
+
+{-|
+Module      : Stack.Types.IdeOpts
+Description : Types for command line options for Stack's @ide@ commands.
+License     : BSD-3-Clause
+
+Types for command line options for Stack's @ide@ commands.
+-}
+
+module Stack.Types.IdeOpts
+  ( OutputStream (..)
+  , ListPackagesCmd (..)
+  ) where
+
+-- | Type representing output stream choices for the @stack ide packages@ and
+-- @stack ide targets@ commands.
+data OutputStream
+  = OutputLogInfo
+    -- ^ To the same output stream as other log information.
+  | OutputStdout
+    -- ^ To the standard output stream.
+
+-- | Type representing output choices for the @stack ide packages@ command.
+data ListPackagesCmd
+  = ListPackageNames
+    -- ^ Package names.
+  | ListPackageCabalFiles
+    -- ^ Paths to Cabal files.

stack.cabal

@@ -274,6 +274,7 @@ library
       Stack.Options.GlobalParser
       Stack.Options.HaddockParser
       Stack.Options.HpcReportParser
+      Stack.Options.IdeParser
       Stack.Options.InitParser
       Stack.Options.LogLevelParser
       Stack.Options.LsParser
@@ -359,6 +360,7 @@ library
       Stack.Types.GlobalOpts
       Stack.Types.GlobalOptsMonoid
       Stack.Types.HpcReportOpts
+      Stack.Types.IdeOpts
       Stack.Types.Installed
       Stack.Types.InterfaceOpt
       Stack.Types.IsMutable