Accept a list for category (fixes #624)

Author: sol

.github/workflows/build.yml

@@ -37,7 +37,7 @@ jobs:
           - os: windows-latest
             ghc: '9.10'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
       - uses: hspec/setup-haskell@v1
         with:
           ghc-version: ${{ matrix.ghc }}
@@ -54,6 +54,6 @@ jobs:
       - run: false
         if: needs.build.result != 'success'
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
       - name: Check for trailing whitespace
         run: '! git grep -I "\s\+$"'

CHANGELOG.md

@@ -1,3 +1,6 @@
+## Changes in 0.38.3
+  - Accept a list for `category` (see #624)
+
 ## Changes in 0.38.2
   - Infer `cabal-version: 3.12` when `PackageInfo_*` is used (see #620)
 

README.md

@@ -131,7 +131,7 @@ library:
 | `version` | · | `0.0.0` | | | |
 | `synopsis` | · | | | | |
 | `description` | · | | | | |
-| `category` | · | | | | |
+| `category` | · | | May be a list (since `0.38.3`) | | |
 | `stability` | · | | | | |
 | `homepage` | · | If `github` given, `<repo>#readme` | | | |
 | `bug-reports` | · | If `github` given, `<repo>/issues` | | | |

hpack.cabal

@@ -1,15 +1,15 @@
 spec-version: 0.36.0
 name: hpack
-version: 0.38.2
+version: 0.38.3
 synopsis: A modern format for Haskell packages
 description: See README at <https://github.com/sol/hpack#readme>
 author: Simon Hengel <sol@typeful.net>
-maintainer: Simon Hengel <sol@typeful.net>
 github: sol/hpack
 category: Development
-extra-source-files:
-  - CHANGELOG.md
-  - resources/**/*
+
+extra-source-files: resources/**/*
+
+extra-doc-files: CHANGELOG.md
 
 ghc-options: -Wall -fno-warn-incomplete-uni-patterns
 

package.yaml

@@ -148,7 +148,7 @@ package name version = Package {
   , packageDescription = Nothing
   , packageHomepage = Nothing
   , packageBugReports = Nothing
-  , packageCategory = Nothing
+  , packageCategory = []
   , packageStability = Nothing
   , packageAuthor = []
   , packageMaintainer = []
@@ -591,7 +591,7 @@ data PackageConfig_ library executable = PackageConfig {
 , packageConfigDescription :: Maybe String
 , packageConfigHomepage :: Maybe (Maybe String)
 , packageConfigBugReports :: Maybe (Maybe String)
-, packageConfigCategory :: Maybe String
+, packageConfigCategory :: Maybe (List String)
 , packageConfigStability :: Maybe String
 , packageConfigAuthor :: Maybe (List String)
 , packageConfigMaintainer :: Maybe (Maybe (List String))
@@ -1032,7 +1032,7 @@ data Package = Package {
 , packageDescription :: Maybe String
 , packageHomepage :: Maybe String
 , packageBugReports :: Maybe String
-, packageCategory :: Maybe String
+, packageCategory :: [String]
 , packageStability :: Maybe String
 , packageAuthor :: [String]
 , packageMaintainer :: [String]
@@ -1326,7 +1326,7 @@ toPackage_ dir (Product g PackageConfig{..}) = do
       , packageDescription = packageConfigDescription
       , packageHomepage = homepage
       , packageBugReports = bugReports
-      , packageCategory = packageConfigCategory
+      , packageCategory = fromMaybeList packageConfigCategory
       , packageStability = packageConfigStability
       , packageAuthor = fromMaybeList packageConfigAuthor
       , packageMaintainer = fromMaybeList maintainer

src/Hpack/Config.hs

@@ -118,24 +118,30 @@ renderPackageWith settings headerFieldsAlignment existingFieldOrder sectionsFiel
       , ("version", Just packageVersion)
       , ("synopsis", packageSynopsis)
       , ("description", (formatDescription packageCabalVersion headerFieldsAlignment <$> packageDescription))
-      , ("category", packageCategory)
+      , formatList "category" packageCategory
       , ("stability", packageStability)
       , ("homepage", packageHomepage)
       , ("bug-reports", packageBugReports)
-      , ("author", formatList packageAuthor)
-      , ("maintainer", formatList packageMaintainer)
-      , ("copyright", formatList packageCopyright)
+      , formatList "author" packageAuthor
+      , formatList "maintainer" packageMaintainer
+      , formatList "copyright" packageCopyright
       , ("license", packageLicense)
       , case packageLicenseFile of
           [file] -> ("license-file", Just file)
-          files  -> ("license-files", formatList files)
+          files  -> formatList "license-files" files
       , ("build-type", Just (show packageBuildType))
       ]
 
-    formatList :: [String] -> Maybe String
-    formatList xs = guard (not $ null xs) >> (Just $ intercalate separator xs)
+    formatList :: String -> [String] -> (String, Maybe String)
+    formatList field = (,) field . formatValues
       where
-        separator = let Alignment n = headerFieldsAlignment in ",\n" ++ replicate n ' '
+        formatValues :: [String] -> Maybe String
+        formatValues values = guard (not $ null values) >> (Just $ intercalate separator values)
+          where
+            separator :: String
+            separator = ",\n" ++ replicate n ' '
+              where
+                Alignment n = max headerFieldsAlignment (Alignment $ length field + 2)
 
 sortStanzaFields :: [(String, [String])] -> [Element] -> [Element]
 sortStanzaFields sectionsFieldOrder = go

src/Hpack/Render.hs

@@ -46,7 +46,7 @@ newtype Nesting = Nesting Int
   deriving (Eq, Show, Num, Enum)
 
 newtype Alignment = Alignment Int
-  deriving (Eq, Show, Num)
+  deriving (Eq, Ord, Show, Num)
 
 data RenderSettings = RenderSettings {
   renderSettingsIndentation :: Int

src/Hpack/Render/Dsl.hs

@@ -103,6 +103,24 @@ spec = around_ (inTempDirectoryNamed "my-package") $ do
                        baz
           |]) { packageCabalVersion = "3.0" }
 
+    describe "category" $ do
+      it "accepts a single category" $ do
+        [i|
+        category: Testing
+        |] `shouldRenderTo` package [i|
+        category: Testing
+        |]
+
+      it "accepts a list of categories" $ do
+        [i|
+        category:
+          - Development
+          - Testing
+        |] `shouldRenderTo` package [i|
+        category: Development,
+                  Testing
+        |]
+
     describe "handling of Paths_ module" $ do
       it "adds Paths_ to other-modules" $ do
         [i|

test/EndToEndSpec.hs

@@ -225,7 +225,7 @@ spec = do
       withPackageConfig_ [i|
         category: Data
         |]
-        (`shouldBe` package {packageCategory = Just "Data"})
+        (`shouldBe` package {packageCategory = ["Data"]})
 
     it "accepts author" $ do
       withPackageConfig_ [i|