Merge pull request #5827 from mpilgrem/envHelp

Fix help for `stack config`

Author: mpilgrem

src/Stack/ConfigCmd.hs

@@ -31,7 +31,8 @@ import           Pantry (loadSnapshot)
 import           Path
 import qualified RIO.Map as Map
 import           RIO.Process (envVarsL)
-import           Stack.Config (makeConcreteResolver, getProjectConfig, getImplicitGlobalProjectDir)
+import           Stack.Config (makeConcreteResolver, getProjectConfig,
+                              getImplicitGlobalProjectDir)
 import           Stack.Constants
 import           Stack.Types.Config
 import           Stack.Types.Resolver
@@ -82,7 +83,8 @@ cfgCmdSet cmd = do
     if config' == config
         then logInfo
                  (fromString (toFilePath configFilePath) <>
-                  " already contained the intended configuration and remains unchanged.")
+                  " already contained the intended configuration and remains \
+                  \unchanged.")
         else do
             let configLines = yamlLines rawConfig
             either
@@ -125,60 +127,67 @@ cfgCmdEnvName :: String
 cfgCmdEnvName = "env"
 
 configCmdSetParser :: OA.Parser ConfigCmdSet
-configCmdSetParser =
-    OA.hsubparser $
-    mconcat
-        [ OA.command
-              "resolver"
-              (OA.info
-                   (ConfigCmdSetResolver <$>
-                    OA.argument
-                        readAbstractResolver
-                        (OA.metavar "RESOLVER" <>
-                         OA.help "E.g. \"nightly\" or \"lts-7.2\""))
-                   (OA.progDesc
-                        "Change the resolver of the current project. See https://docs.haskellstack.org/en/stable/yaml_configuration/#resolver for more info."))
-        , OA.command
-              (T.unpack configMonoidSystemGHCName)
-              (OA.info
-                   (ConfigCmdSetSystemGhc <$> scopeFlag <*> boolArgument)
-                   (OA.progDesc
-                        "Configure whether stack should use a system GHC installation or not."))
-        , OA.command
-              (T.unpack configMonoidInstallGHCName)
-              (OA.info
-                   (ConfigCmdSetInstallGhc <$> scopeFlag <*> boolArgument)
-                   (OA.progDesc
-                        "Configure whether stack should automatically install GHC when necessary."))
-        ]
+configCmdSetParser = OA.hsubparser $
+  mconcat
+    [ OA.command "resolver"
+        ( OA.info
+            (ConfigCmdSetResolver <$>
+             OA.argument
+                 readAbstractResolver
+                 (OA.metavar "SNAPSHOT" <>
+                  OA.help "E.g. \"nightly\" or \"lts-7.2\""))
+            (OA.progDesc
+               "Change the resolver of the current project."))
+    , OA.command (T.unpack configMonoidSystemGHCName)
+        ( OA.info
+            (ConfigCmdSetSystemGhc <$> scopeFlag <*> boolArgument)
+            (OA.progDesc
+               "Configure whether Stack should use a system GHC installation \
+               \or not."))
+    , OA.command (T.unpack configMonoidInstallGHCName)
+        ( OA.info
+            (ConfigCmdSetInstallGhc <$> scopeFlag <*> boolArgument)
+            (OA.progDesc
+               "Configure whether Stack should automatically install GHC when \
+               \necessary."))
+    ]
 
 scopeFlag :: OA.Parser CommandScope
-scopeFlag =
-    OA.flag
-        CommandScopeProject
-        CommandScopeGlobal
-        (OA.long "global" <>
-         OA.help
-             "Modify the global configuration (typically at \"~/.stack/config.yaml\") instead of the project stack.yaml.")
+scopeFlag = OA.flag
+  CommandScopeProject
+  CommandScopeGlobal
+  (  OA.long "global"
+  <> OA.help
+       "Modify the user-specific global configuration file ('config.yaml') \
+       \instead of the project-level configuration file ('stack.yaml')."
+  )
 
 readBool :: OA.ReadM Bool
 readBool = do
-    s <- OA.readerAsk
-    case s of
-        "true" -> return True
-        "false" -> return False
-        _ -> OA.readerError ("Invalid value " ++ show s ++ ": Expected \"true\" or \"false\"")
+  s <- OA.readerAsk
+  case s of
+    "true" -> return True
+    "false" -> return False
+    _ -> OA.readerError ("Invalid value " ++ show s ++
+           ": Expected \"true\" or \"false\"")
 
 boolArgument :: OA.Parser Bool
-boolArgument = OA.argument readBool (OA.metavar "true|false" <> OA.completeWith ["true", "false"])
+boolArgument = OA.argument
+  readBool
+  (  OA.metavar "true|false"
+  <> OA.completeWith ["true", "false"]
+  )
 
 configCmdEnvParser :: OA.Parser EnvSettings
 configCmdEnvParser = EnvSettings
   <$> boolFlags True "locals" "include local package information" mempty
-  <*> boolFlags True "ghc-package-path" "set GHC_PACKAGE_PATH variable" mempty
+  <*> boolFlags True
+        "ghc-package-path" "set GHC_PACKAGE_PATH environment variable" mempty
   <*> boolFlags True "stack-exe" "set STACK_EXE environment variable" mempty
-  <*> boolFlags False "locale-utf8" "set the GHC_CHARENC environment variable to UTF8" mempty
-  <*> boolFlags False "keep-ghc-rts" "keep any GHC_RTS environment variables" mempty
+  <*> boolFlags False
+        "locale-utf8" "set the GHC_CHARENC environment variable to UTF-8" mempty
+  <*> boolFlags False
+        "keep-ghc-rts" "keep any GHCRTS environment variable" mempty
 
 data EnvVarAction = EVASet !Text | EVAUnset
   deriving Show

src/main/Main.hs

@@ -397,7 +397,7 @@ commandLineHandler currentDir progName isInterpreter = complicatedOptions
             "Subcommands for accessing and modifying configuration values"
             (do
                addCommand' ConfigCmd.cfgCmdSetName
-                          "Sets a field in the project's stack.yaml to value"
+                          "Sets a key in YAML configuration file to value"
                           (withConfig NoReexec . cfgCmdSet)
                           configCmdSetParser
                addCommand' ConfigCmd.cfgCmdEnvName