Add Pretty instances for LSP types

The instances just prettyprint their JSON representations, which is
often what we want and is better than using `Show`!

Author: michaelpj

lsp-types/ChangeLog.md

@@ -1,5 +1,11 @@
 # Revision history for lsp-types
 
+## Unreleased
+
+- Add `Language.LSP.Protocol.Utils.Misc.prettyJSON :: Value -> Doc ann` for prettyprinting JSON, 
+  and `ViaJSON` as a deriving-via newtype wrapper for it.
+- Generate `Pretty` instances for all LSP types using `ViaJSON`.
+
 ## 2.0.1.1
 
 * Fix parsing of notifications with missing params

lsp-types/generated/Language/LSP/Protocol/Internal/Types/AnnotatedTextEdit.hs

@@ -8,6 +8,8 @@ module Language.LSP.Protocol.Internal.Types.AnnotatedTextEdit where
 import Control.DeepSeq
 import Data.Hashable
 import GHC.Generics
+import Language.LSP.Protocol.Utils.Misc
+import Prettyprinter
 import qualified Data.Aeson as Aeson
 import qualified Data.Row.Aeson as Aeson
 import qualified Data.Row.Hashable as Hashable
@@ -39,6 +41,7 @@ data AnnotatedTextEdit = AnnotatedTextEdit
   }
   deriving stock (Show, Eq, Ord, Generic)
   deriving anyclass (NFData, Hashable)
+  deriving Pretty via (ViaJSON AnnotatedTextEdit)
 
 instance Aeson.ToJSON AnnotatedTextEdit where
   toJSON (AnnotatedTextEdit arg0 arg1 arg2) = Aeson.object $ concat $  [["range" Aeson..= arg0]

lsp-types/generated/Language/LSP/Protocol/Internal/Types/ApplyWorkspaceEditParams.hs

@@ -8,6 +8,8 @@ module Language.LSP.Protocol.Internal.Types.ApplyWorkspaceEditParams where
 import Control.DeepSeq
 import Data.Hashable
 import GHC.Generics
+import Language.LSP.Protocol.Utils.Misc
+import Prettyprinter
 import qualified Data.Aeson as Aeson
 import qualified Data.Row.Aeson as Aeson
 import qualified Data.Row.Hashable as Hashable
@@ -32,6 +34,7 @@ data ApplyWorkspaceEditParams = ApplyWorkspaceEditParams
   }
   deriving stock (Show, Eq, Ord, Generic)
   deriving anyclass (NFData, Hashable)
+  deriving Pretty via (ViaJSON ApplyWorkspaceEditParams)
 
 instance Aeson.ToJSON ApplyWorkspaceEditParams where
   toJSON (ApplyWorkspaceEditParams arg0 arg1) = Aeson.object $ concat $  ["label" Language.LSP.Protocol.Types.Common..=? arg0

lsp-types/generated/Language/LSP/Protocol/Internal/Types/ApplyWorkspaceEditResult.hs

@@ -8,6 +8,8 @@ module Language.LSP.Protocol.Internal.Types.ApplyWorkspaceEditResult where
 import Control.DeepSeq
 import Data.Hashable
 import GHC.Generics
+import Language.LSP.Protocol.Utils.Misc
+import Prettyprinter
 import qualified Data.Aeson as Aeson
 import qualified Data.Row.Aeson as Aeson
 import qualified Data.Row.Hashable as Hashable
@@ -39,6 +41,7 @@ data ApplyWorkspaceEditResult = ApplyWorkspaceEditResult
   }
   deriving stock (Show, Eq, Ord, Generic)
   deriving anyclass (NFData, Hashable)
+  deriving Pretty via (ViaJSON ApplyWorkspaceEditResult)
 
 instance Aeson.ToJSON ApplyWorkspaceEditResult where
   toJSON (ApplyWorkspaceEditResult arg0 arg1 arg2) = Aeson.object $ concat $  [["applied" Aeson..= arg0]

lsp-types/generated/Language/LSP/Protocol/Internal/Types/BaseSymbolInformation.hs

@@ -8,6 +8,8 @@ module Language.LSP.Protocol.Internal.Types.BaseSymbolInformation where
 import Control.DeepSeq
 import Data.Hashable
 import GHC.Generics
+import Language.LSP.Protocol.Utils.Misc
+import Prettyprinter
 import qualified Data.Aeson as Aeson
 import qualified Data.Row.Aeson as Aeson
 import qualified Data.Row.Hashable as Hashable
@@ -44,6 +46,7 @@ data BaseSymbolInformation = BaseSymbolInformation
   }
   deriving stock (Show, Eq, Ord, Generic)
   deriving anyclass (NFData, Hashable)
+  deriving Pretty via (ViaJSON BaseSymbolInformation)
 
 instance Aeson.ToJSON BaseSymbolInformation where
   toJSON (BaseSymbolInformation arg0 arg1 arg2 arg3) = Aeson.object $ concat $  [["name" Aeson..= arg0]

lsp-types/generated/Language/LSP/Protocol/Internal/Types/CallHierarchyClientCapabilities.hs

@@ -8,6 +8,8 @@ module Language.LSP.Protocol.Internal.Types.CallHierarchyClientCapabilities wher
 import Control.DeepSeq
 import Data.Hashable
 import GHC.Generics
+import Language.LSP.Protocol.Utils.Misc
+import Prettyprinter
 import qualified Data.Aeson as Aeson
 import qualified Data.Row.Aeson as Aeson
 import qualified Data.Row.Hashable as Hashable
@@ -26,6 +28,7 @@ data CallHierarchyClientCapabilities = CallHierarchyClientCapabilities
   }
   deriving stock (Show, Eq, Ord, Generic)
   deriving anyclass (NFData, Hashable)
+  deriving Pretty via (ViaJSON CallHierarchyClientCapabilities)
 
 instance Aeson.ToJSON CallHierarchyClientCapabilities where
   toJSON (CallHierarchyClientCapabilities arg0) = Aeson.object $ concat $  ["dynamicRegistration" Language.LSP.Protocol.Types.Common..=? arg0]

lsp-types/generated/Language/LSP/Protocol/Internal/Types/CallHierarchyIncomingCall.hs

@@ -8,6 +8,8 @@ module Language.LSP.Protocol.Internal.Types.CallHierarchyIncomingCall where
 import Control.DeepSeq
 import Data.Hashable
 import GHC.Generics
+import Language.LSP.Protocol.Utils.Misc
+import Prettyprinter
 import qualified Data.Aeson as Aeson
 import qualified Data.Row.Aeson as Aeson
 import qualified Data.Row.Hashable as Hashable
@@ -33,6 +35,7 @@ data CallHierarchyIncomingCall = CallHierarchyIncomingCall
   }
   deriving stock (Show, Eq, Ord, Generic)
   deriving anyclass (NFData, Hashable)
+  deriving Pretty via (ViaJSON CallHierarchyIncomingCall)
 
 instance Aeson.ToJSON CallHierarchyIncomingCall where
   toJSON (CallHierarchyIncomingCall arg0 arg1) = Aeson.object $ concat $  [["from" Aeson..= arg0]

lsp-types/generated/Language/LSP/Protocol/Internal/Types/CallHierarchyIncomingCallsParams.hs

@@ -8,6 +8,8 @@ module Language.LSP.Protocol.Internal.Types.CallHierarchyIncomingCallsParams whe
 import Control.DeepSeq
 import Data.Hashable
 import GHC.Generics
+import Language.LSP.Protocol.Utils.Misc
+import Prettyprinter
 import qualified Data.Aeson as Aeson
 import qualified Data.Row.Aeson as Aeson
 import qualified Data.Row.Hashable as Hashable
@@ -37,6 +39,7 @@ data CallHierarchyIncomingCallsParams = CallHierarchyIncomingCallsParams
   }
   deriving stock (Show, Eq, Ord, Generic)
   deriving anyclass (NFData, Hashable)
+  deriving Pretty via (ViaJSON CallHierarchyIncomingCallsParams)
 
 instance Aeson.ToJSON CallHierarchyIncomingCallsParams where
   toJSON (CallHierarchyIncomingCallsParams arg0 arg1 arg2) = Aeson.object $ concat $  ["workDoneToken" Language.LSP.Protocol.Types.Common..=? arg0

lsp-types/generated/Language/LSP/Protocol/Internal/Types/CallHierarchyItem.hs

@@ -8,6 +8,8 @@ module Language.LSP.Protocol.Internal.Types.CallHierarchyItem where
 import Control.DeepSeq
 import Data.Hashable
 import GHC.Generics
+import Language.LSP.Protocol.Utils.Misc
+import Prettyprinter
 import qualified Data.Aeson
 import qualified Data.Aeson as Aeson
 import qualified Data.Row.Aeson as Aeson
@@ -63,6 +65,7 @@ data CallHierarchyItem = CallHierarchyItem
   }
   deriving stock (Show, Eq, Ord, Generic)
   deriving anyclass (NFData, Hashable)
+  deriving Pretty via (ViaJSON CallHierarchyItem)
 
 instance Aeson.ToJSON CallHierarchyItem where
   toJSON (CallHierarchyItem arg0 arg1 arg2 arg3 arg4 arg5 arg6 arg7) = Aeson.object $ concat $  [["name" Aeson..= arg0]

lsp-types/generated/Language/LSP/Protocol/Internal/Types/CallHierarchyOptions.hs

@@ -8,6 +8,8 @@ module Language.LSP.Protocol.Internal.Types.CallHierarchyOptions where
 import Control.DeepSeq
 import Data.Hashable
 import GHC.Generics
+import Language.LSP.Protocol.Utils.Misc
+import Prettyprinter
 import qualified Data.Aeson as Aeson
 import qualified Data.Row.Aeson as Aeson
 import qualified Data.Row.Hashable as Hashable
@@ -26,6 +28,7 @@ data CallHierarchyOptions = CallHierarchyOptions
   }
   deriving stock (Show, Eq, Ord, Generic)
   deriving anyclass (NFData, Hashable)
+  deriving Pretty via (ViaJSON CallHierarchyOptions)
 
 instance Aeson.ToJSON CallHierarchyOptions where
   toJSON (CallHierarchyOptions arg0) = Aeson.object $ concat $  ["workDoneProgress" Language.LSP.Protocol.Types.Common..=? arg0]