Add JSPOptions test, use 3.14 as min required cabal version

Co-authored-by: Mateusz Goslinowski <mateusz.goslinowski@gmail.com>

Author: zlonast

Cabal-syntax/src/Distribution/CabalSpecVersion.hs

@@ -35,6 +35,7 @@ data CabalSpecVersion
   | -- 3.10: no changes
     CabalSpecV3_12
   | CabalSpecV3_14
+  | CabalSpecV3_16
   deriving (Eq, Ord, Show, Read, Enum, Bounded, Data, Generic)
 
 instance Binary CabalSpecVersion
@@ -45,6 +46,7 @@ instance NFData CabalSpecVersion where rnf = genericRnf
 --
 -- @since 3.0.0.0
 showCabalSpecVersion :: CabalSpecVersion -> String
+showCabalSpecVersion CabalSpecV3_16 = "3.16"
 showCabalSpecVersion CabalSpecV3_14 = "3.14"
 showCabalSpecVersion CabalSpecV3_12 = "3.12"
 showCabalSpecVersion CabalSpecV3_8 = "3.8"
@@ -67,13 +69,14 @@ showCabalSpecVersion CabalSpecV1_2 = "1.2"
 showCabalSpecVersion CabalSpecV1_0 = "1.0"
 
 cabalSpecLatest :: CabalSpecVersion
-cabalSpecLatest = CabalSpecV3_14
+cabalSpecLatest = CabalSpecV3_16
 
 -- | Parse 'CabalSpecVersion' from version digits.
 --
 -- It may fail if for recent versions the version is not exact.
 cabalSpecFromVersionDigits :: [Int] -> Maybe CabalSpecVersion
 cabalSpecFromVersionDigits v
+  | v == [3, 16] = Just CabalSpecV3_16
   | v == [3, 14] = Just CabalSpecV3_14
   | v == [3, 12] = Just CabalSpecV3_12
   | v == [3, 8] = Just CabalSpecV3_8
@@ -98,6 +101,7 @@ cabalSpecFromVersionDigits v
 
 -- | @since 3.4.0.0
 cabalSpecToVersionDigits :: CabalSpecVersion -> [Int]
+cabalSpecToVersionDigits CabalSpecV3_16 = [3, 16]
 cabalSpecToVersionDigits CabalSpecV3_14 = [3, 14]
 cabalSpecToVersionDigits CabalSpecV3_12 = [3, 12]
 cabalSpecToVersionDigits CabalSpecV3_8 = [3, 8]

Cabal-syntax/src/Distribution/PackageDescription/FieldGrammar.hs

@@ -621,8 +621,8 @@ buildInfoFieldGrammar =
     <*> monoidalFieldAla "cc-options" (alaList' NoCommaFSep Token') L.ccOptions
     <*> monoidalFieldAla "cxx-options" (alaList' NoCommaFSep Token') L.cxxOptions
       ^^^ availableSince CabalSpecV2_2 []
-    <*> monoidalFieldAla "jsp-options" (alaList' NoCommaFSep Token') L.jspOptions
-      ^^^ availableSince CabalSpecV3_14 []
+    <*> monoidalFieldAla "jspp-options" (alaList' NoCommaFSep Token') L.jsppOptions
+      ^^^ availableSince CabalSpecV3_16 []
     <*> monoidalFieldAla "ld-options" (alaList' NoCommaFSep Token') L.ldOptions
     <*> monoidalFieldAla "hsc2hs-options" (alaList' NoCommaFSep Token') L.hsc2hsOptions
       ^^^ availableSince CabalSpecV3_6 []

Cabal-syntax/src/Distribution/Types/BuildInfo.hs

@@ -61,8 +61,8 @@ data BuildInfo = BuildInfo
   -- ^ options for C compiler
   , cxxOptions :: [String]
   -- ^ options for C++ compiler
-  , jspOptions :: [String]
-  -- ^ options for pre-processing JavaScript code
+  , jsppOptions :: [String]
+  -- ^ options for pre-processing JavaScript code @since 3.16.0.0
   , ldOptions :: [String]
   -- ^ options for linker
   , hsc2hsOptions :: [String]
@@ -163,7 +163,7 @@ instance Monoid BuildInfo where
       , cmmOptions = []
       , ccOptions = []
       , cxxOptions = []
-      , jspOptions = []
+      , jsppOptions = []
       , ldOptions = []
       , hsc2hsOptions = []
       , pkgconfigDepends = []
@@ -217,7 +217,7 @@ instance Semigroup BuildInfo where
       , cmmOptions = combine cmmOptions
       , ccOptions = combine ccOptions
       , cxxOptions = combine cxxOptions
-      , jspOptions = combine jspOptions
+      , jsppOptions = combine jsppOptions
       , ldOptions = combine ldOptions
       , hsc2hsOptions = combine hsc2hsOptions
       , pkgconfigDepends = combine pkgconfigDepends

Cabal-syntax/src/Distribution/Types/BuildInfo/Lens.hs

@@ -59,9 +59,9 @@ class HasBuildInfo a where
   cxxOptions = buildInfo . cxxOptions
   {-# INLINE cxxOptions #-}
 
-  jspOptions :: Lens' a [String]
-  jspOptions = buildInfo . jspOptions
-  {-# INLINE jspOptions #-}
+  jsppOptions :: Lens' a [String]
+  jsppOptions = buildInfo . jsppOptions
+  {-# INLINE jsppOptions #-}
 
   ldOptions :: Lens' a [String]
   ldOptions = buildInfo . ldOptions

Cabal-tests/tests/UnitTests/Distribution/Utils/Structured.hs

@@ -29,8 +29,8 @@ md5Check proxy md5Int = structureHash proxy @?= md5FromInteger md5Int
 
 md5CheckGenericPackageDescription :: Proxy GenericPackageDescription -> Assertion
 md5CheckGenericPackageDescription proxy = md5Check proxy
-    0xe95038393adbd46b119188757a3a2b63
+    0x42685b0be2909b20bfcd2f32c503ec7b
 
 md5CheckLocalBuildInfo :: Proxy LocalBuildInfo -> Assertion
 md5CheckLocalBuildInfo proxy = md5Check proxy
-    0x364f8e404df9ada84ea3b4e3b3084a10
+    0x3d5f7afb3f2f9d8a8ea0e9487a74a006

Cabal/src/Distribution/PackageDescription/Check/Target.hs

@@ -814,7 +814,7 @@ checkBuildInfoOptions t bi = do
   checkCLikeOptions LangC "cc-options" (ccOptions bi) ldOpts
   checkCLikeOptions LangCPlusPlus "cxx-options" (cxxOptions bi) ldOpts
   checkCPPOptions (cppOptions bi)
-  checkJSPOptions (jspOptions bi)
+  checkJSPOptions (jsppOptions bi)
 
 -- | Checks GHC options for commonly misused or non-portable flags.
 checkGHCOptions
@@ -907,7 +907,7 @@ checkGHCOptions title t opts = do
         )
       checkAlternatives
         title
-        "jsp-options"
+        "jspp-options"
         ( [(flag, flag) | flag@('-' : 'D' : _) <- ghcNoRts]
             ++ [(flag, flag) | flag@('-' : 'U' : _) <- ghcNoRts]
         )
@@ -1107,14 +1107,13 @@ checkJSPOptions
   -> CheckM m ()
 checkJSPOptions opts = do
   checkAlternatives
-    "jsp-options"
+    "jspp-options"
     "include-dirs"
     [(flag, dir) | flag@('-' : 'I' : dir) <- opts]
   mapM_
     ( \opt ->
         checkP
           (not $ any (`isPrefixOf` opt) ["-D", "-U", "-I"])
-          (PackageBuildWarning (OptJSP opt))
+          (PackageBuildWarning (OptJSPP opt))
     )
     opts
-

Cabal/src/Distribution/PackageDescription/Check/Warning.hs

@@ -214,7 +214,7 @@ data CheckExplanation
   | OptWithRts String
   | COptONumber String WarnLang
   | COptCPP String
-  | OptJSP String
+  | OptJSPP String
   | OptAlternatives String String [(String, String)]
   | RelativeOutside String FilePath
   | AbsolutePath String FilePath
@@ -381,7 +381,7 @@ data CheckExplanationID
   | CIOptWithRts
   | CICOptONumber
   | CICOptCPP
-  | CIOptJSP
+  | CIOptJSPP
   | CIOptAlternatives
   | CIRelativeOutside
   | CIAbsolutePath
@@ -527,7 +527,7 @@ checkExplanationId (OptRts{}) = CIOptRts
 checkExplanationId (OptWithRts{}) = CIOptWithRts
 checkExplanationId (COptONumber{}) = CICOptONumber
 checkExplanationId (COptCPP{}) = CICOptCPP
-checkExplanationId (OptJSP{}) = CIOptJSP
+checkExplanationId (OptJSPP{}) = CIOptJSPP
 checkExplanationId (OptAlternatives{}) = CIOptAlternatives
 checkExplanationId (RelativeOutside{}) = CIRelativeOutside
 checkExplanationId (AbsolutePath{}) = CIAbsolutePath
@@ -680,7 +680,7 @@ ppCheckExplanationId CIOptRts = "option-rtsopts"
 ppCheckExplanationId CIOptWithRts = "option-with-rtsopts"
 ppCheckExplanationId CICOptONumber = "option-opt-c"
 ppCheckExplanationId CICOptCPP = "cpp-options"
-ppCheckExplanationId CIOptJSP = "jsp-options"
+ppCheckExplanationId CIOptJSPP = "jspp-options"
 ppCheckExplanationId CIOptAlternatives = "misplaced-c-opt"
 ppCheckExplanationId CIRelativeOutside = "relative-path-outside"
 ppCheckExplanationId CIAbsolutePath = "absolute-path"
@@ -1090,8 +1090,8 @@ ppExplanation (COptONumber prefix label) =
     ++ " --disable-optimization flag."
 ppExplanation (COptCPP opt) =
   "'cpp-options: " ++ opt ++ "' is not a portable C-preprocessor flag."
-ppExplanation (OptJSP opt) =
-  "'jsp-options: " ++ opt ++ "' is not a portable C-preprocessor flag."
+ppExplanation (OptJSPP opt) =
+  "'jspp-options: " ++ opt ++ "' not a portable JavaScript-preprocessor flag."
 ppExplanation (OptAlternatives badField goodField flags) =
   "Instead of "
     ++ quote (badField ++ ": " ++ unwords badFlags)

Cabal/src/Distribution/Simple/GHC/Internal.hs

@@ -510,7 +510,7 @@ componentJsGhcOptions verbosity lbi bi clbi odir filename =
     , ghcOptPackageDBs = withPackageDB lbi
     , ghcOptPackages = toNubListR $ mkGhcOptPackages (promisedPkgs lbi) clbi
     , ghcOptObjDir = toFlag odir
-    , ghcOptExtra = jspOptions bi <> hcOptions GHC bi
+    , ghcOptExtra = jsppOptions bi <> hcOptions GHC bi
     }
 
 componentGhcOptions

cabal-testsuite/PackageTests/Check/ConfiguredPackage/JSPOptions/JSPNotPortable/cabal.out

@@ -0,0 +1,4 @@
+# cabal check
+The following errors are likely to affect your build negatively:
+Error: [jspp-options] 'jspp-options: -Q' is not a portable C-preprocessor flag.
+Error: Hackage would reject this package.

cabal-testsuite/PackageTests/Check/ConfiguredPackage/JSPOptions/JSPNotPortable/cabal.test.hs

@@ -0,0 +1,5 @@
+import Test.Cabal.Prelude
+
+-- `jspp-options`, do not use use non portable flags.
+main = cabalTest $
+  fails $ cabal "check" []

cabal-testsuite/PackageTests/Check/ConfiguredPackage/JSPOptions/JSPNotPortable/pkg.cabal

@@ -0,0 +1,14 @@
+cabal-version: 3.0
+name: pkg
+synopsis: synopsis
+description: description
+version: 0
+category: example
+maintainer: none@example.com
+license: GPL-3.0-or-later
+
+library
+  exposed-modules: Module
+  default-language: Haskell2010
+  if arch(JavaScript)
+    jspp-options: -Q

cabal-testsuite/PackageTests/JS/JSPPOptions/cabal.project

@@ -0,0 +1 @@
+packages: .

cabal-testsuite/PackageTests/JS/JSPPOptions/demo/Main.hs

@@ -0,0 +1,6 @@
+module Main where
+
+import Lib
+
+main :: IO ()
+main = foo

cabal-testsuite/PackageTests/JS/JSPPOptions/js-arch.test.hs

@@ -0,0 +1,9 @@
+import Test.Cabal.Prelude
+
+main = do
+    skipUnlessJavaScript
+    skipIfWindows ""
+    setupAndCabalTest $ do
+        skipUnlessGhcVersion ">= 9.12"
+        res <- cabal' "v2-run" ["demo"]
+        assertOutputContains "Hello definition!" res

cabal-testsuite/PackageTests/JS/JSPPOptions/jsbits/lib.js

@@ -0,0 +1,9 @@
+//#OPTIONS: CPP
+
+function foo() {
+#ifdef PRINT_DEF
+  console.log("Hello definition!");
+#else
+  console.log("Hello!");
+#endif
+}

cabal-testsuite/PackageTests/JS/JSPPOptions/jsppoptions.cabal

@@ -0,0 +1,19 @@
+cabal-version: 3.0
+name: jsppoptions
+version: 0
+build-type: Simple
+
+library
+  default-language: Haskell2010
+  js-sources: jsbits/lib.js
+  if arch(JavaScript)
+    jspp-options: -DPRINT_DEF
+  hs-source-dirs: src
+  exposed-modules: Lib
+  build-depends: base
+
+executable demo
+  default-language: Haskell2010
+  main-is: Main.hs
+  hs-source-dirs: demo
+  build-depends: base, jsppoptions

cabal-testsuite/PackageTests/JS/JSPPOptions/other-arch.out

@@ -0,0 +1,14 @@
+# cabal v2-run
+Configuration is affected by the following files:
+- cabal.project
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - jsppoptions-0 (lib) (first run)
+ - jsppoptions-0 (exe:demo) (first run)
+Configuring library for jsppoptions-0...
+Preprocessing library for jsppoptions-0...
+Building library for jsppoptions-0...
+Configuring executable 'demo' for jsppoptions-0...
+Preprocessing executable 'demo' for jsppoptions-0...
+Building executable 'demo' for jsppoptions-0...

cabal-testsuite/PackageTests/JS/JSPPOptions/other-arch.test.hs

@@ -0,0 +1,8 @@
+import Test.Cabal.Prelude
+
+main = do
+    skipIfJavaScript
+    cabalTest $ do
+        -- Ensure the field `js-sources` does not raise issues
+        res <- cabal' "v2-run" ["demo"]
+        assertOutputContains "Not JS foo" res

cabal-testsuite/PackageTests/JS/JSPPOptions/src/Lib.hs

@@ -0,0 +1,9 @@
+{-# LANGUAGE CPP #-}
+module Lib where
+
+#if defined(javascript_HOST_ARCH)
+foreign import javascript foo :: IO ()
+#else
+foo :: IO ()
+foo = putStrLn "Not JS foo"
+#endif

doc/buildinfo-fields-reference.rst

@@ -256,13 +256,6 @@ cmm-sources
     .. math::
         \mathrm{commalist}\left\{ \mathop{\mathit{hs\text{-}string}}\mid{{[\mathop{\mathord{``}\mathtt{\ }\mathord{"}}\mathop{\mathord{``}\mathtt{\text{,}}\mathord{"}}]^c}}^+_{} \right\}
 
-jsp-options
-    * Monoidal field
-    * Documentation of :pkg-field:`library:jsp-options`
-
-    .. math::
-        {\left\{ \mathop{\mathit{hs\text{-}string}}\mid{{[\mathop{\mathord{``}\mathtt{\ }\mathord{"}}]^c}}^+_{} \right\}}^\ast_{\bullet}
-
 cpp-options
     * Monoidal field
     * Documentation of :pkg-field:`library:cpp-options`
@@ -492,6 +485,14 @@ js-sources
     .. math::
         \mathrm{commalist}\left\{ \mathop{\mathit{hs\text{-}string}}\mid{{[\mathop{\mathord{``}\mathtt{\ }\mathord{"}}\mathop{\mathord{``}\mathtt{\text{,}}\mathord{"}}]^c}}^+_{} \right\}
 
+jspp-options
+    * Monoidal field
+    * Available since ``cabal-version: 3.16``.
+    * Documentation of :pkg-field:`library:jspp-options`
+
+    .. math::
+        {\left\{ \mathop{\mathit{hs\text{-}string}}\mid{{[\mathop{\mathord{``}\mathtt{\ }\mathord{"}}]^c}}^+_{} \right\}}^\ast_{\bullet}
+
 ld-options
     * Monoidal field
     * Documentation of :pkg-field:`library:ld-options`

doc/cabal-commands.rst

@@ -1405,7 +1405,7 @@ A list of all warnings with their constructor:
 - ``option-with-rtsopts``: unnecessary ``-with-rtsopts``.
 - ``option-opt-c``: unnecessary ``-O[n]`` in C code.
 - ``cpp-options``: unportable ``-cpp-options`` flag.
-- ``jsp-options``: unportable ``-jsp-options`` flag.
+- ``jspp-options``: unportable ``-jspp-options`` flag.
 - ``misplaced-c-opt``: C-like options in wrong cabal field.
 - ``relative-path-outside``: relative path outside of source tree.
 - ``absolute-path``: absolute path where not allowed.

doc/cabal-package-description-file.rst

@@ -1992,7 +1992,7 @@ system-dependent values for these fields.
     arguments are compiler-dependent, this field is more useful with the
     setup described in the section on `system-dependent parameters`_.
 
-.. pkg-field:: jsp-options: token list
+.. pkg-field:: jspp-options: token list
 
     Command-line arguments for pre-processing Haskell code. Applies to
     Haskell source and other pre-processed Haskell source like .js.

editors/vim/syntax/cabal.vim

@@ -65,7 +65,7 @@ syn keyword cabalFieldName contained
   \ cmm-options
   \ cmm-sources
   \ copyright
-  \ jsp-options
+  \ jspp-options
   \ cpp-options
   \ cxx-options
   \ cxx-sources