Fix doctest with Cabal-2.0 by requiring c-i>=1.24

.gitlab-ci.yml

@@ -5,9 +5,10 @@ stages:
   before_script:
     - ls -l ..
     - apt-get update && apt-get install alex happy
+    - ghc-pkg list
+    - cabal update && cabal install --only-dependencies -j2 --enable-tests --enable-documentation
     - mkdir -p ../ghc-mod.sdist-$CI_PIPELINE_ID
     - touch ChangeLog
-    - cabal update
     - cabal sdist --output-directory=../ghc-mod.sdist-$CI_PIPELINE_ID
     - cd ../ghc-mod.sdist-$CI_PIPELINE_ID
 
@@ -19,8 +20,6 @@ after_script:
 .script_template: &common_script
   script:
     - echo $PWD
-    - ghc-pkg list
-    - cabal install --user --only-dependencies -j2 --force-reinstalls --upgrade-dependencies --enable-tests --enable-documentation
     - which cabal
     - cabal --version
     - cabal configure --enable-tests

Setup.hs

@@ -1,9 +1,23 @@
 #!/usr/bin/env runhaskell
 
+{-# LANGUAGE CPP #-}
+
+#ifndef MIN_VERSION_cabal_doctest
+#error \
+    Your version of cabal-install does not seem to support the 'custom-setup' section. \
+    Please see https://github.com/DanielG/ghc-mod/wiki/Installing#checking-and-installing-prerequisites for instrutions on how to upgrade. \
+    It is also possible that you forgot to install cabal-doctest before running Setup.hs
+#endif
+
 import Distribution.Simple
 import Distribution.Simple.Program
 
+import Distribution.Extra.Doctest
+
 main :: IO ()
-main = defaultMainWithHooks $ simpleUserHooks {
+main =
+    defaultMainWithHooks $
+    addDoctestsUserHook "doctest" $
+    simpleUserHooks {
         hookedPrograms = [ simpleProgram "shelltest" ]
     }

ghc-mod.cabal

@@ -24,7 +24,7 @@ Description:
 
 
 Category:               GHC, Development
-Cabal-Version:          >= 1.18
+Cabal-Version:          >= 1.24
 Build-Type:             Custom
 Data-Files:             elisp/Makefile
                         elisp/*.el
@@ -92,7 +92,8 @@ Extra-Source-Files:     ChangeLog
 
 Custom-Setup
   Setup-Depends:         base
-                       , Cabal >= 1.18 && < 2.1
+                       , Cabal               < 2.1  && >= 1.24
+                       , cabal-doctest       < 1.1  && >= 1
                        , containers
                        , filepath
                        , directory
@@ -273,7 +274,10 @@ Test-Suite doctest
   Main-Is:              doctests.hs
   Build-Depends:        base                 < 4.11 && >= 4.6.0.1
                       , doctest              < 0.12 && >= 0.9.3
-
+                      , directory
+                      , ghc
+                      , mtl
+                      , transformers
 
 Test-Suite spec
   Default-Language:     Haskell2010

test/doctests.hs

@@ -1,23 +1,12 @@
-{-# LANGUAGE CPP #-}
 module Main where
 
-import Test.DocTest
+import Build_doctests (flags, pkgs, module_sources)
-import System.Environment
+import Data.Foldable (traverse_)
-import Data.Maybe
+import Test.DocTest (doctest)
 
 main :: IO ()
 main = do
-  distdir <- (fromMaybe "dist" . lookup "DOCTEST_DIST_DIR") `fmap` getEnvironment
+    traverse_ putStrLn args -- optionally print arguments
-  doctest
+    doctest args
-     [ "-package", "ghc-" ++ VERSION_ghc
+  where
-     , "-package", "transformers-" ++ VERSION_transformers
+    args = flags ++ pkgs ++ module_sources
-     , "-package", "mtl-" ++ VERSION_mtl
-     , "-package", "directory-" ++ VERSION_directory
-     , "-XScopedTypeVariables", "-XRecordWildCards", "-XNamedFieldPuns", "-XConstraintKinds", "-XFlexibleContexts", "-XDataKinds", "-XKindSignatures", "-XTypeOperators", "-XViewPatterns"
-     , "-i" ++ distdir ++ "/build/autogen/"
-     , "-icore/"
-     , "-ishared"
---     , "-optP-include"
---     , "-optP" ++ distdir ++ "/build/autogen/cabal_macros.h"
-     , "GhcMod.hs"
-     ]