Merge pull request commercialhaskell#6624 from commercialhaskell/fix6501

Fix commercialhaskell#6501 Add `stack build --[no-]allow-newer`

Author: mpilgrem

ChangeLog.md

@@ -12,6 +12,9 @@ Behavior changes:
 
 Other enhancements:
 
+* Add flag `--[no-]allow-newer` to Stack's `build` command, which takes
+  precedence over the existing `allow-newer` configuration option.
+
 Bug fixes:
 
 * Fix a regression, introduced in Stack 2.15.7, that caused GHC 8.10.7 or

doc/build_command.md

@@ -216,6 +216,21 @@ of the Cabal build process (for further information, see the documentation for
 the [configure-options](yaml_configuration.md#configure-options) configuration
 option).
 
+### `--[no-]allow-newer` flag
+
+:octicons-tag-24: UNRELEASED
+
+Overrides: [`allow-newer`](yaml_configuration.md#allow-newer) non-project
+specific configuration option
+
+Pass the flag to enable or disable the ignoring of lower and upper version
+bounds in Cabal files.
+
+!!! info
+
+    The name `allow-newer` was chosen to match a commonly-used Cabal option
+    which ignored only upper version bounds.
+
 ### `--bench` flag
 
 Pass the flag to add benchmark components to the targets, if specific components

doc/yaml_configuration.md

@@ -498,9 +498,15 @@ process.
 
 Default: `false`
 
-Whether to ignore version bounds in Cabal files. This also ignores lower bounds.
-The name `allow-newer` is chosen to match the commonly-used Cabal option.
+Command line equivalent (takes precedence):
+[`stack build --[no-]allow-newer`](build_command.md#-allow-newer-flag) flag
+
+Whether to ignore lower and upper version bounds in Cabal files.
+
+!!! info
 
+    The name `allow-newer` was chosen to match a commonly-used Cabal option
+    which ignored only upper bounds.
 
 ~~~yaml
 allow-newer: true

src/Stack/Build/ConstructPlan.hs

@@ -896,8 +896,11 @@ adrInRange ::
 adrInRange pkgId name range adr = if adrVersion adr `withinRange` range
   then pure True
   else do
-    allowNewer <- view $ configL . to (.allowNewer)
-    allowNewerDeps <- view $ configL . to (.allowNewerDeps)
+    config <- view configL
+    allowNewerCLI <- view $ envConfigL . to (.buildOptsCLI) . to (.allowNewer)
+    let allowNewerConfig = config.allowNewer
+        allowNewer = fromFirst False $ allowNewerCLI <> allowNewerConfig
+        allowNewerDeps = config.allowNewerDeps
     if allowNewer
       then case allowNewerDeps of
         Nothing -> do

src/Stack/Config.hs

@@ -420,7 +420,7 @@ configFromConfigMonoid
           fromFirst AGOLocals configMonoid.applyGhcOptions
         applyProgOptions =
           fromFirst APOLocals configMonoid.applyProgOptions
-        allowNewer = fromFirst False configMonoid.allowNewer
+        allowNewer = configMonoid.allowNewer
         allowNewerDeps = coerce configMonoid.allowNewerDeps
     defaultInitSnapshot <- do
       root <- getCurrentDir

src/Stack/Options/BuildParser.hs

@@ -15,10 +15,12 @@ import           Options.Applicative
                    , metavar, option, strOption, switch, value
                    )
 import           Options.Applicative.Args ( cmdOption )
-import           Options.Applicative.Builder.Extra ( textArgument, textOption )
+import           Options.Applicative.Builder.Extra
+                   ( firstBoolFlagsNoDefault, textArgument, textOption )
 import           Stack.Options.Completion
                    ( flagCompleter, ghcOptsCompleter, targetCompleter )
 import           Stack.Options.PackageParser ( readFlag )
+import           Stack.Options.Utils ( hideMods )
 import           Stack.Prelude
 import           Stack.Types.BuildOptsCLI
                    ( ApplyCLIFlag, BuildCommand, BuildOptsCLI (..)
@@ -61,6 +63,10 @@ buildOptsParser cmd = BuildOptsCLI
       )
   <*> progsOptionsParser
   <*> flagsParser
+  <*> firstBoolFlagsNoDefault
+        "allow-newer"
+        "ignoring of lower and upper version bounds in Cabal files."
+        (hideMods False)
   <*> (   flag' BSOnlyDependencies
             (  long "dependencies-only"
             <> help "A synonym for --only-dependencies."

src/Stack/Types/Build/Exception.hs

@@ -541,7 +541,9 @@ pprintExceptions exceptions configFile stackRoot isImplicitGlobal parentMap want
           then ["also"]
           else
             [ fillSep
-                $  [ "in"
+                $  [ "pass"
+                   , style Shell "--allow-newer" <> ","
+                   , flow "or, in"
                    , pretty (defaultUserConfigPath stackRoot)
                    , flow
                        (  "(global configuration)"

src/Stack/Types/BuildOptsCLI.hs

@@ -19,13 +19,15 @@ import qualified Data.Map.Strict as Map
 import qualified Data.Text as T
 import           Stack.Prelude
 
--- | Build options that may only be specified from the CLI
+-- | Build options that are specified from the CLI and not specified as
+-- non-project specific configuration options under the build key.
 data BuildOptsCLI = BuildOptsCLI
   { targetsCLI :: ![Text]
   , dryrun :: !Bool
   , ghcOptions :: ![Text]
   , progsOptions :: ![(Text, [Text])]
   , flags :: !(Map ApplyCLIFlag (Map FlagName Bool))
+  , allowNewer :: !(First Bool)
   , buildSubset :: !BuildSubset
   , fileWatch :: !FileWatchOpts
   , watchAll :: !Bool
@@ -41,6 +43,7 @@ defaultBuildOptsCLI = BuildOptsCLI
   { targetsCLI = []
   , dryrun = False
   , flags = Map.empty
+  , allowNewer = mempty
   , ghcOptions = []
   , progsOptions = []
   , buildSubset = BSAll

src/Stack/Types/BuildOptsMonoid.hs

@@ -33,11 +33,15 @@ import           Generics.Deriving.Monoid ( mappenddefault, memptydefault )
 import           Stack.Prelude hiding ( trace )
 import           Stack.Types.ComponentUtils ( StackUnqualCompName )
 
--- | Build options that may be specified in the stack.yaml or from the CLI
+-- | Build options that may be specified as non-project specific configuration
+-- options under the build key (with certain exceptions) or from the CLI.
 data BuildOptsMonoid = BuildOptsMonoid
   { trace :: !Any
+    -- ^ Cannot be specified under the build key
   , profile :: !Any
+    -- ^ Cannot be specified under the build key
   , noStrip :: !Any
+    -- ^ Cannot be specified under the build key
   , libProfile :: !FirstFalse
   , exeProfile :: !FirstFalse
   , libStrip :: !FirstTrue

src/Stack/Types/Config.hs

@@ -153,7 +153,7 @@ data Config = Config
   , applyProgOptions       :: !ApplyProgOptions
     -- ^ Which packages do all and any --PROG-option options on the command line
     -- apply to?
-  , allowNewer             :: !Bool
+  , allowNewer             :: !(First Bool)
     -- ^ Ignore version ranges in .cabal files. Funny naming chosen to
     -- match cabal.
   , allowNewerDeps         :: !(Maybe [PackageName])