Merge branch 'master' of github.com:haskell/cabal into mattp/reuse-glob-information

Author: parsonsmatt

.git-blame-ignore-revs

@@ -1,3 +1,8 @@
+# 2025
+########################################
+# make *.cabal build-depends consistently formatted
+7d791b9da10b5034e7a997a0044ded5575fe123f
+
 # 2023
 ########################################
 

.github/workflows/validate.yml

@@ -336,7 +336,11 @@ jobs:
           apk add bash curl sudo jq pkgconfig \
           zlib-dev zlib-static binutils-gold curl \
           gcc g++ gmp-dev libc-dev libffi-dev make \
-          musl-dev ncurses-dev perl tar xz
+          musl-dev ncurses-dev perl tar xz git
+
+      # Apparently there's some permissions thing inside vs. outside the container
+      # that Alpine's git doesn't like. Hack around it.
+      - run: git config --global --add safe.directory $(pwd)
 
       - uses: actions/checkout@v4
 
@@ -465,24 +469,21 @@ jobs:
     needs: [validate, validate-old-ghcs, build-alpine, dogfooding]
 
     steps:
-      - uses: liudonghua123/delete-release-action@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          release_name: 'cabal-head'
-
       - uses: actions/download-artifact@v4
         with:
           pattern: cabal-*
           path: binaries
           merge-multiple: true
 
-      - name: Create GitHub prerelease
-        uses: softprops/action-gh-release@v2
+      - name: (Re)Create GitHub prerelease
+        uses: andelf/nightly-release@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           tag_name: cabal-head
+          name: cabal-head
           prerelease: true
-          files: binaries/cabal-*
+          files: "binaries/cabal-*"
 
   prerelease-lts:
     name: Create a GitHub LTS prerelease with the binary artifacts
@@ -496,12 +497,6 @@ jobs:
     needs: [validate, validate-old-ghcs, build-alpine, dogfooding]
 
     steps:
-    - uses: liudonghua123/delete-release-action@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        release_name: 'cabal-lts-head'
-
     - uses: actions/download-artifact@v4
       with:
         pattern: cabal-*
@@ -515,12 +510,15 @@ jobs:
           mv "$f" "cabal-lts-${f##cabal-}"
         done
 
-    - name: Create GitHub prerelease
-      uses: softprops/action-gh-release@v2
+    - name: (Re)Create GitHub prerelease
+      uses: andelf/nightly-release@main
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         tag_name: cabal-lts-head
+        name: cabal-lts-head
         prerelease: true
-        files: binaries/cabal-*
+        files: "binaries/cabal-*"
 
   # We use this job as a summary of the workflow
   # It will fail if any of the previous jobs does

.gitignore

@@ -15,6 +15,7 @@ register.sh
 ./cabal.config
 cabal-tests.log
 bootstrap/*.plan.json
+haddocks
 
 /Cabal/dist/
 /Cabal/tests/Setup

.hlint.yaml

@@ -1,7 +1,7 @@
 # Warnings currently triggered by your code
 - ignore: {name: "Avoid NonEmpty.unzip"} # 1 hint
 - ignore: {name: "Avoid lambda"} # 47 hints
-- ignore: {name: "Avoid lambda using `infix`"} # 22 hints
+- ignore: {name: "Avoid lambda using `infix`"} # 23 hints
 - ignore: {name: "Eta reduce"} # 124 hints
 - ignore: {name: "Evaluate"} # 10 hints
 - ignore: {name: "Functor law"} # 10 hints
@@ -16,11 +16,11 @@
 - ignore: {name: "Monoid law, right identity"} # 3 hints
 - ignore: {name: "Move filter"} # 4 hints
 - ignore: {name: "Move guards forward"} # 4 hints
-- ignore: {name: "Redundant $"} # 179 hints
+- ignore: {name: "Redundant $"} # 178 hints
 - ignore: {name: "Redundant $!"} # 1 hint
 - ignore: {name: "Redundant <$>"} # 16 hints
 - ignore: {name: "Redundant =="} # 1 hint
-- ignore: {name: "Redundant bracket"} # 239 hints
+- ignore: {name: "Redundant bracket"} # 240 hints
 - ignore: {name: "Redundant fmap"} # 1 hint
 - ignore: {name: "Redundant guard"} # 2 hints
 - ignore: {name: "Redundant if"} # 6 hints
@@ -48,9 +48,8 @@
 - ignore: {name: "Use concatMap"} # 2 hints
 - ignore: {name: "Use const"} # 36 hints
 - ignore: {name: "Use elem"} # 2 hints
-- ignore: {name: "Use fewer imports"} # 13 hints
 - ignore: {name: "Use first"} # 4 hints
-- ignore: {name: "Use fmap"} # 26 hints
+- ignore: {name: "Use fmap"} # 25 hints
 - ignore: {name: "Use fold"} # 1 hint
 - ignore: {name: "Use for"} # 1 hint
 - ignore: {name: "Use forM_"} # 1 hint
@@ -66,7 +65,7 @@
 - ignore: {name: "Use isNothing"} # 1 hint
 - ignore: {name: "Use lambda-case"} # 55 hints
 - ignore: {name: "Use lefts"} # 1 hint
-- ignore: {name: "Use list comprehension"} # 18 hints
+- ignore: {name: "Use list comprehension"} # 19 hints
 - ignore: {name: "Use list literal"} # 3 hints
 - ignore: {name: "Use list literal pattern"} # 11 hints
 - ignore: {name: "Use map once"} # 7 hints
@@ -95,6 +94,8 @@
 
 - arguments:
     - --ignore-glob=Cabal-syntax/src/Distribution/Fields/Lexer.hs
+    - --ignore-glob=Cabal-tests/tests/custom-setup/CabalDoctestSetup.hs
+    - --ignore-glob=Cabal-tests/tests/custom-setup/IdrisSetup.hs
     - --ignore-glob=cabal-testsuite/PackageTests/BuildWays/q/app/Main.hs
     - --ignore-glob=cabal-testsuite/PackageTests/CmmSources/src/Demo.hs
     - --ignore-glob=cabal-testsuite/PackageTests/CmmSourcesDyn/src/Demo.hs

.typos.toml

@@ -1,2 +1,7 @@
 [default]
 extend-ignore-re = ["(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on"]
+
+[default.extend-words]
+# Extinguish false positive in cabal-package-description-file.rst. 'Nd' is a
+# Unicode category, not a misspelling of 'And'.
+nd = "nd"

CONTRIBUTING.md

@@ -360,6 +360,23 @@ If your PR is trivial you can omit this process (but explain in the PR why you
 think it does not warrant an issue). Feel free to open a new issue (or new
 issues) when appropriate.
 
+### Pull request size
+
+Keep your pull requests small, write one pull request per feature, let
+the content of the pull request match the title of the pull request.
+
+To get merged, your pull request needs to be reviewed by two other
+contributors. Large pull requests are daunting to inspect, and the
+back-and-forth between the author and reviewer can get frustrating and
+difficult to follow.
+
+Split your pull requests in multiple ones if possible (e.g. a refactor
+and a feature implementation should go in two different pull requests).
+This is *especially* important when we decide to backport a pull request
+(be it fix or a feature).
+
+Thorough reviews mean less regressions, keeping your pull requests small
+will improve Cabal codebase quality.
 
 ## Changelog
 
@@ -395,9 +412,12 @@ description: {
 }
 ```
 
-Changelogs may also be written in "markdown-frontmatter" format. This is useful if your
-description contains braces, which must be escaped with backslashes in `.cabal` file
-format. The front matter is in YAML syntax, not `.cabal` file syntax, and the file
+Changelogs may also be written in "markdown-frontmatter" format. This is useful
+if your description contains braces, which must be escaped with backslashes in
+`.cabal` file format. Another benefit of using an `.md` extension with your
+changelog is that it will be checked for typos.
+
+The front matter is in YAML syntax, not `.cabal` file syntax, and the file
 _must_ begin with a line containing only hyphens.
 
 ```markdown

Cabal-QuickCheck/src/Test/QuickCheck/GenericArbitrary.hs

@@ -1,4 +1,3 @@
-{-# LANGUAGE CPP              #-}
 {-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE GADTs            #-}
 {-# LANGUAGE TypeOperators #-}

Cabal-QuickCheck/src/Test/QuickCheck/Instances/Cabal.hs

@@ -1,6 +1,6 @@
 {-# LANGUAGE CPP           #-}
 {-# LANGUAGE FlexibleInstances #-}
-{-# OPTIONS_GHC -fno-warn-orphans #-}
+{-# OPTIONS_GHC -Wno-orphans #-}
 module Test.QuickCheck.Instances.Cabal () where
 
 #if !MIN_VERSION_base(4,18,0)

Cabal-described/src/Distribution/Described.hs

@@ -168,8 +168,8 @@ reUnqualComponent = RENamed "unqual-name" $
         -- currently the parser accepts "csAlphaNum `difference` "0123456789"
         -- which is larger set than CS.alpha
         --
-        -- Hackage rejects non ANSI names, so it's not so relevant.
-        <> RECharSet CS.alpha
+        -- Hackage, however, rejects non ANSI names.
+        <> RECharSet csAlphaNumNotDigit
         <> REMunch reEps (RECharSet csAlphaNum)
 
 reDot :: GrammarRegex a
@@ -194,6 +194,9 @@ csAlpha = CS.alpha
 csAlphaNum :: CS.CharSet
 csAlphaNum = CS.alphanum
 
+csAlphaNumNotDigit :: CS.CharSet
+csAlphaNumNotDigit = CS.alphanumNotDigit
+
 csUpper :: CS.CharSet
 csUpper = CS.upper
 

Cabal-described/src/Distribution/Utils/CharSet.hs

@@ -27,16 +27,17 @@ module Distribution.Utils.CharSet (
     -- * Special lists
     alpha,
     alphanum,
+    alphanumNotDigit,
     upper,
     ) where
 
-import Data.Char                     (chr, isAlpha, isAlphaNum, isUpper, ord)
+import Data.Char                     (chr, isAlpha, isAlphaNum, isDigit, isUpper, ord)
 import Data.List                     (foldl', sortBy)
 import Data.Monoid                   (Monoid (..))
 import Data.String                   (IsString (..))
 import Distribution.Compat.Semigroup (Semigroup (..))
 import Prelude
-       (Bool (..), Bounded (..), Char, Enum (..), Eq (..), Int, Maybe (..), Num (..), Ord (..), Show (..), String, concatMap, flip, fst, otherwise, showParen,
+       (Bool (..), Bounded (..), Char, Enum (..), Eq (..), Int, Maybe (..), Num (..), Ord (..), Show (..), String, (&&), concatMap, flip, fst, not, otherwise, showParen,
        showString, uncurry, ($), (.))
 
 #if MIN_VERSION_containers(0,5,0)
@@ -113,7 +114,9 @@ member c (CS m) = go (IM.toList m)
     i = ord c
 
 -- | Insert 'Char' into 'CharSet'.
+{- FOURMOLU_DISABLE -}
 insert :: Char -> CharSet -> CharSet
+{- FOURMOLU_ENABLE -}
 insert c (CS m) = normalise (IM.insert (ord c) (ord c) m)
 
 -- | Union of two 'CharSet's.
@@ -229,10 +232,16 @@ alpha :: CharSet
 alpha = foldl' (flip insert) empty [ c | c <- [ minBound .. maxBound ], isAlpha c ]
 {-# NOINLINE alpha #-}
 
+-- | Note: this set varies depending on @base@ version.
+--
+alphanumNotDigit :: CharSet
+alphanumNotDigit = foldl' (flip insert) empty [ c | c <- [ minBound .. maxBound ], isAlphaNum c && not (isDigit c) ]
+{-# NOINLINE alphanumNotDigit #-}
+
 -- | Note: this set varies depending on @base@ version.
 --
 alphanum :: CharSet
-alphanum = foldl' (flip insert) empty [ c | c <- [ minBound .. maxBound ], isAlphaNum c ]
+alphanum = foldl' (flip insert) alphanumNotDigit ['0' .. '9' ]
 {-# NOINLINE alphanum #-}
 
 -- | Note: this set varies depending on @base@ version.

Cabal-described/src/Distribution/Utils/GrammarRegex.hs

@@ -194,9 +194,10 @@ mathtt d = "\\mathtt{" <<>> d <<>> "}"
 
 charsetDoc :: CS.CharSet -> PP.Doc
 charsetDoc acs
-    | acs == CS.alpha    = terminalDoc "alpha"
-    | acs == CS.alphanum = terminalDoc "alpha-num"
-    | acs == CS.upper    = terminalDoc "upper"
+    | acs == CS.alpha            = terminalDoc "alpha"
+    | acs == CS.alphanum         = terminalDoc "alpha-num"
+    | acs == CS.alphanumNotDigit = terminalDoc "alpha-num-not-digit"
+    | acs == CS.upper            = terminalDoc "upper"
 charsetDoc acs = case CS.toIntervalList acs of
     []               -> "\\emptyset"
     [(x,y)] | x == y -> inquotes $ mathtt $ charDoc x

Cabal-hooks/changelog.md renamed to Cabal-hooks/CHANGELOG.md

@@ -15,7 +15,7 @@ category:       Distribution
 build-type:     Simple
 
 extra-source-files:
-  readme.md changelog.md
+  README.md CHANGELOG.md
 
 source-repository head
   type:     git
@@ -27,13 +27,13 @@ library
   hs-source-dirs: src
 
   build-depends:
-    Cabal-syntax    >= 3.15      && < 3.17,
-    Cabal           >= 3.15      && < 3.17,
-    base            >= 4.13      && < 5,
-    containers      >= 0.5.0.0   && < 0.8,
-    transformers    >= 0.5.6.0   && < 0.7
+    , Cabal-syntax    >= 3.15      && < 3.17
+    , Cabal           >= 3.15      && < 3.17
+    , base            >= 4.13      && < 5
+    , containers      >= 0.5.0.0   && < 0.9
+    , transformers    >= 0.5.6.0   && < 0.7
 
-  ghc-options: -Wall -fno-ignore-asserts -fwarn-tabs -fwarn-incomplete-uni-patterns -fwarn-incomplete-record-updates
+  ghc-options: -Wall -fno-ignore-asserts -Wtabs -Wincomplete-uni-patterns -Wincomplete-record-updates
 
   exposed-modules:
     Distribution.Simple.SetupHooks

Cabal-hooks/Cabal-hooks.cabal

@@ -28,30 +28,30 @@ library
   hs-source-dirs: src
 
   build-depends:
-    array      >= 0.4.0.1  && < 0.6,
-    base       >= 4.13     && < 5,
-    binary     >= 0.7      && < 0.9,
-    bytestring >= 0.10.0.0 && < 0.13,
-    containers >= 0.5.0.0  && < 0.8,
-    deepseq    >= 1.3.0.1  && < 1.7,
-    directory  >= 1.2      && < 1.4,
-    filepath   >= 1.3.0.1  && < 1.6,
-    mtl        >= 2.1      && < 2.4,
-    parsec     >= 3.1.13.0 && < 3.2,
-    pretty     >= 1.1.1    && < 1.2,
-    text       (>= 1.2.3.0 && < 1.3) || (>= 2.0 && < 2.2),
-    time       >= 1.4.0.1  && < 1.15,
+    , array      >= 0.4.0.1  && < 0.6
+    , base       >= 4.13     && < 5
+    , binary     >= 0.7      && < 0.9
+    , bytestring >= 0.10.0.0 && < 0.13
+    , containers >= 0.5.0.0  && < 0.9
+    , deepseq    >= 1.3.0.1  && < 1.7
+    , directory  >= 1.2      && < 1.4
+    , filepath   >= 1.3.0.1  && < 1.6
+    , mtl        >= 2.1      && < 2.4
+    , parsec     >= 3.1.13.0 && < 3.2
+    , pretty     >= 1.1.1    && < 1.2
+    , text       (>= 1.2.3.0 && < 1.3) || (>= 2.0 && < 2.2)
+    , time       >= 1.4.0.1  && < 1.15
     -- transformers-0.4.0.0 doesn't have record syntax e.g. for Identity
     -- See also https://github.com/ekmett/transformers-compat/issues/35
-    transformers (>= 0.3      && < 0.4) || (>=0.4.1.0 && <0.7)
+    , transformers (>= 0.3      && < 0.4) || (>=0.4.1.0 && <0.7)
 
   ghc-options:
     -Wall
     -fno-ignore-asserts
-    -fwarn-tabs
-    -fwarn-incomplete-uni-patterns
-    -fwarn-incomplete-record-updates
-    -fno-warn-unticked-promoted-constructors
+    -Wtabs
+    -Wincomplete-uni-patterns
+    -Wincomplete-record-updates
+    -Wno-unticked-promoted-constructors
 
   if impl(ghc >= 8.0)
     ghc-options: -Wcompat -Wnoncanonical-monad-instances

Cabal-hooks/readme.md renamed to Cabal-hooks/README.md

@@ -1,5 +1,3 @@
-{-# LANGUAGE CPP #-}
-
 module Distribution.Compat.Binary
   ( decodeOrFailIO
   , decodeFileOrFail'

Cabal-syntax/Cabal-syntax.cabal

@@ -1,5 +1,3 @@
-{-# LANGUAGE CPP #-}
-
 module Distribution.Compat.Exception
   ( catchIO
   , catchExit

Cabal-syntax/src/Distribution/Compat/Binary.hs

@@ -1,15 +1,10 @@
 {-# LANGUAGE BangPatterns #-}
-{-# LANGUAGE CPP #-}
 {-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE TypeOperators #-}
 {-# LANGUAGE UndecidableInstances #-}
 
------------------------------------------------------------------------------
-
------------------------------------------------------------------------------
-
 -- |
 -- Module      :  Distribution.Compat.Graph
 -- Copyright   :  (c) Edward Z. Yang 2016