Merge pull request #6294 from commercialhaskell/fix6293

Fix #6293 Allow warnings about untested GHC/Cabal to be muted

ChangeLog.md

@@ -39,6 +39,11 @@ Other enhancements:
   command to allow uploading of documentation for packages to Hackage.
 * `stack new` no longer rejects project templates that specify a `package.yaml`
   in a subdirectory of the project directory.
+* Stack will notify the user if Stack has not been tested with the version of
+  GHC that is being user or a version of Cabal (the library) that has been
+  found. In YAML configuration files, the `notify-if-ghc-untested` and
+  `notify-if-cabal-untested` keys are introduced, to allow the notification to
+  be muted if unwanted.
 
 Bug fixes:
 

doc/yaml_configuration.md

@@ -1154,6 +1154,24 @@ for details).
 For further information, see the
 [Nix integration](nix_integration.md#configuration) documentation.
 
+### notify-if-cabal-untested
+
+:octicons-tag-24: UNRELEASED
+
+Default: `true`
+
+If Stack has not been tested with the version of Cabal (the library) that has
+been found, should Stack notify the user of that?
+
+### notify-if-ghc-untested
+
+:octicons-tag-24: UNRELEASED
+
+Default: `true`
+
+If Stack has not been tested with the version of GHC that is being used, should
+Stack notify the user of that?
+
 ### notify-if-nix-on-path
 
 :octicons-tag-24: UNRELEASED

src/Stack/Config.hs

@@ -424,6 +424,8 @@ configFromConfigMonoid
         configHideSourcePaths = fromFirstTrue configMonoidHideSourcePaths
         configRecommendUpgrade = fromFirstTrue configMonoidRecommendUpgrade
         configNotifyIfNixOnPath = fromFirstTrue configMonoidNotifyIfNixOnPath
+        configNotifyIfGhcUntested = fromFirstTrue configMonoidNotifyIfGhcUntested
+        configNotifyIfCabalUntested = fromFirstTrue configMonoidNotifyIfCabalUntested
         configNoRunCompile = fromFirstFalse configMonoidNoRunCompile
     configAllowDifferentUser <-
       case getFirst configMonoidAllowDifferentUser of

src/Stack/Setup.hs

@@ -992,8 +992,12 @@ ensureCompilerAndMsys sopts = do
   pure (cp, paths)
 
 -- | See <https://github.com/commercialhaskell/stack/issues/4246>
-warnUnsupportedCompiler :: HasTerm env => Version -> RIO env Bool
-warnUnsupportedCompiler ghcVersion =
+warnUnsupportedCompiler ::
+     (HasConfig env, HasTerm env)
+  => Version
+  -> RIO env Bool
+warnUnsupportedCompiler ghcVersion = do
+  notifyIfGhcUntested <- view $ configL.to configNotifyIfGhcUntested
   if
     | ghcVersion < mkVersion [7, 8] -> do
         prettyWarnL
@@ -1006,10 +1010,10 @@ warnUnsupportedCompiler ghcVersion =
           , style Url "https://github.com/commercialhaskell/stack/issues/648" <> "."
           ]
         pure True
-    | ghcVersion >= mkVersion [9, 7] -> do
+    | ghcVersion >= mkVersion [9, 7] && notifyIfGhcUntested -> do
         prettyWarnL
-          [ flow "Stack has not been tested with GHC versions 9.8 and above, and \
-                 \using"
+          [ flow "Stack has not been tested with GHC versions 9.8 and above, \
+                 \and using"
           , fromString (versionString ghcVersion) <> ","
           , flow "this may fail."
           ]
@@ -1020,15 +1024,15 @@ warnUnsupportedCompiler ghcVersion =
 
 -- | See <https://github.com/commercialhaskell/stack/issues/4246>
 warnUnsupportedCompilerCabal ::
-     HasTerm env
+     (HasConfig env, HasTerm env)
   => CompilerPaths
   -> Bool -- ^ already warned about GHC?
   -> RIO env ()
 warnUnsupportedCompilerCabal cp didWarn = do
   unless didWarn $
     void $ warnUnsupportedCompiler $ getGhcVersion $ cpCompilerVersion cp
   let cabalVersion = cpCabalVersion cp
-
+  notifyIfCabalUntested <- view $ configL.to configNotifyIfCabalUntested
   if
     | cabalVersion < mkVersion [1, 24, 0] -> do
         prettyWarnL
@@ -1040,10 +1044,10 @@ warnUnsupportedCompilerCabal cp didWarn = do
                  \resolver. Acceptable resolvers: lts-7.0/nightly-2016-05-26 \
                  \or later."
           ]
-    | cabalVersion >= mkVersion [3, 11] ->
+    | cabalVersion >= mkVersion [3, 11] && notifyIfCabalUntested ->
         prettyWarnL
-          [ flow "Stack has not been tested with Cabal versions 3.12 and above, \
-                 \but version"
+          [ flow "Stack has not been tested with Cabal versions 3.12 and \
+                 \above, but version"
           , fromString (versionString cabalVersion)
           , flow "was found, this may fail."
           ]

src/Stack/Types/Config.hs

@@ -182,6 +182,10 @@ data Config = Config
   , configNotifyIfNixOnPath   :: !Bool
     -- ^ Notify if the Nix package manager (nix) is on the PATH, but
     -- Stack's Nix integration is not enabled?
+  , configNotifyIfGhcUntested :: !Bool
+    -- ^ Notify if Stack has not been tested with the GHC version?
+  , configNotifyIfCabalUntested :: !Bool
+    -- ^ Notify if Stack has not been tested with the Cabal version?
   , configNoRunCompile   :: !Bool
     -- ^ Use --no-run and --compile options when using `stack script`
   , configStackDeveloperMode  :: !Bool

src/Stack/Types/ConfigMonoid.hs

@@ -170,6 +170,10 @@ data ConfigMonoid = ConfigMonoid
     -- ^ See 'configRecommendUpgrade'
   , configMonoidNotifyIfNixOnPath  :: !FirstTrue
     -- ^ See 'configNotifyIfNixOnPath'
+  , configMonoidNotifyIfGhcUntested  :: !FirstTrue
+    -- ^ See 'configNotifyIfGhcUntested'
+  , configMonoidNotifyIfCabalUntested  :: !FirstTrue
+    -- ^ See 'configNotifyIfCabalUntested'
   , configMonoidCasaOpts :: !CasaOptsMonoid
     -- ^ Casa configuration options.
   , configMonoidCasaRepoPrefix     :: !(First CasaRepoPrefix)
@@ -342,6 +346,10 @@ parseConfigMonoidObject rootDir obj = do
     FirstTrue <$> obj ..:? configMonoidRecommendUpgradeName
   configMonoidNotifyIfNixOnPath <-
     FirstTrue <$> obj ..:? configMonoidNotifyIfNixOnPathName
+  configMonoidNotifyIfGhcUntested <-
+    FirstTrue <$> obj ..:? configMonoidNotifyIfGhcUntestedName
+  configMonoidNotifyIfCabalUntested <-
+    FirstTrue <$> obj ..:? configMonoidNotifyIfCabalUntestedName
   configMonoidCasaOpts <-
     jsonSubWarnings (obj ..:? configMonoidCasaOptsName ..!= mempty)
   configMonoidCasaRepoPrefix <-
@@ -522,6 +530,12 @@ configMonoidRecommendUpgradeName = "recommend-stack-upgrade"
 configMonoidNotifyIfNixOnPathName :: Text
 configMonoidNotifyIfNixOnPathName = "notify-if-nix-on-path"
 
+configMonoidNotifyIfGhcUntestedName :: Text
+configMonoidNotifyIfGhcUntestedName = "notify-if-ghc-untested"
+
+configMonoidNotifyIfCabalUntestedName :: Text
+configMonoidNotifyIfCabalUntestedName = "notify-if-cabal-untested"
+
 configMonoidCasaOptsName :: Text
 configMonoidCasaOptsName = "casa"