Add revision information to plan.json

Closes #6186

Author: fgaz

cabal-install/src/Distribution/Client/ProjectPlanOutput.hs

@@ -66,6 +66,8 @@ import Distribution.Verbosity
 import Distribution.Client.Compat.Prelude
 import Prelude ()
 
+import Control.Monad ((<=<))
+
 import qualified Data.ByteString.Builder as BB
 import qualified Data.ByteString.Lazy as BS
 import qualified Data.Map as Map
@@ -259,13 +261,24 @@ encodePlanAsJson distDirLayout elaboratedInstallPlan elaboratedSharedConfig =
               J.object
                 [ "type" J..= J.String "remote-repo"
                 , "uri" J..= J.String (show (remoteRepoURI repoRemote))
+                , -- The x-revision field is a feature of remote repos,
+                  -- so we only output it for remote/secure repos, in the "repo" object.
+                  "pkg-revision" J..= J.Number (elaboratedPackageToRevision elab)
                 ]
             RepoSecure{..} ->
               J.object
                 [ "type" J..= J.String "secure-repo"
                 , "uri" J..= J.String (show (remoteRepoURI repoRemote))
+                , "pkg-revision" J..= J.Number (elaboratedPackageToRevision elab)
                 ]
 
+        elaboratedPackageToRevision :: ElaboratedConfiguredPackage -> Double
+        elaboratedPackageToRevision =
+          fromMaybe 0
+            . (readMaybe <=< lookup "x-revision")
+            . PD.customFieldsPD
+            . elabPkgDescription
+
         sourceRepoToJ :: SourceRepoMaybe -> J.Value
         sourceRepoToJ SourceRepositoryPackage{..} =
           J.object $

changelog.d/pr-10980

@@ -0,0 +1,9 @@
+synopsis: Added revision information to `plan.json`
+packages: cabal-install
+prs: #10980
+issues: #6186
+
+description: {
+  The contents of `x-revision` `.cabal` fields are now available in `plan.json`.
+  They are located under `pkg-src.repo.pkg-revision`, have type `Number`, and are only available for `repo-tar` repositories of type `remote-repo` or `secure-repo`.
+}