Plugins.hs

{-# LANGUAGE CPP                       #-}
{-# LANGUAGE ExistentialQuantification #-}
{-# LANGUAGE OverloadedStrings         #-}
module Plugins where

import           Development.IDE.Types.Logger      (Pretty (pretty), Recorder,
                                                    WithPriority, cmapWithPrio)
import           Ide.PluginUtils                   (pluginDescToIdePlugins)
import           Ide.Types                         (IdePlugins)

-- fixed plugins
import           Development.IDE                   (IdeState)
import qualified Development.IDE.Plugin.HLS.GhcIde as GhcIde
import qualified Ide.Plugin.Example                as Example
import qualified Ide.Plugin.Example2               as Example2

-- haskell-language-server optional plugins
#if qualifyImportedNames
import qualified Ide.Plugin.QualifyImportedNames   as QualifyImportedNames
#endif

#if callHierarchy
import qualified Ide.Plugin.CallHierarchy          as CallHierarchy
#endif

#if class
import qualified Ide.Plugin.Class                  as Class
#endif

#if haddockComments
import qualified Ide.Plugin.HaddockComments        as HaddockComments
#endif

#if eval
import qualified Ide.Plugin.Eval                   as Eval
#endif

#if importLens
import qualified Ide.Plugin.ExplicitImports        as ExplicitImports
#endif

#if refineImports
import qualified Ide.Plugin.RefineImports          as RefineImports
#endif

#if rename
import qualified Ide.Plugin.Rename                 as Rename
#endif

#if retrie
import qualified Ide.Plugin.Retrie                 as Retrie
#endif

#if tactic
import qualified Ide.Plugin.Tactic                 as Tactic
#endif

#if hlint
import qualified Ide.Plugin.Hlint                  as Hlint
#endif

#if moduleName
import qualified Ide.Plugin.ModuleName             as ModuleName
#endif

#if pragmas
import qualified Ide.Plugin.Pragmas                as Pragmas
#endif

#if splice
import qualified Ide.Plugin.Splice                 as Splice
#endif

#if alternateNumberFormat
import qualified Ide.Plugin.AlternateNumberFormat  as AlternateNumberFormat
#endif

#if selectionRange
import           Ide.Plugin.SelectionRange         as SelectionRange
#endif

#if changeTypeSignature
import           Ide.Plugin.ChangeTypeSignature    as ChangeTypeSignature
#endif
-- formatters

#if floskell
import qualified Ide.Plugin.Floskell               as Floskell
#endif

#if fourmolu
import qualified Ide.Plugin.Fourmolu               as Fourmolu
#endif

#if ormolu
import qualified Ide.Plugin.Ormolu                 as Ormolu
#endif

#if stylishHaskell
import qualified Ide.Plugin.StylishHaskell         as StylishHaskell
#endif

#if brittany
import qualified Ide.Plugin.Brittany               as Brittany
#endif

data Log = forall a. (Pretty a) => Log a

instance Pretty Log where
  pretty (Log a) = pretty a

-- ---------------------------------------------------------------------

-- | The plugins configured for use in this instance of the language
-- server.
-- These can be freely added or removed to tailor the available
-- features of the server.

idePlugins :: Recorder (WithPriority Log) -> Bool -> IdePlugins IdeState
idePlugins recorder includeExamples = pluginDescToIdePlugins allPlugins
  where
    pluginRecorder :: forall log. (Pretty log) => Recorder (WithPriority log)
    pluginRecorder = cmapWithPrio Log recorder
    allPlugins = if includeExamples
                   then basePlugins ++ examplePlugins
                   else basePlugins
    basePlugins =
#if pragmas
      Pragmas.descriptor  "pragmas" :
#endif
#if floskell
      Floskell.descriptor "floskell" :
#endif
#if fourmolu
      Fourmolu.descriptor "fourmolu" :
#endif
#if tactic
      Tactic.descriptor pluginRecorder "tactics" :
#endif
#if ormolu
      Ormolu.descriptor   "ormolu" :
#endif
#if stylishHaskell
      StylishHaskell.descriptor "stylish-haskell" :
#endif
#if rename
      Rename.descriptor "rename" :
#endif
#if retrie
      Retrie.descriptor "retrie" :
#endif
#if brittany
      Brittany.descriptor "brittany" :
#endif
#if callHierarchy
      CallHierarchy.descriptor "callHierarchy":
#endif
#if class
      Class.descriptor "class" :
#endif
#if haddockComments
      HaddockComments.descriptor "haddockComments" :
#endif
#if eval
      Eval.descriptor pluginRecorder "eval" :
#endif
#if importLens
      ExplicitImports.descriptor pluginRecorder "importLens" :
#endif
#if qualifyImportedNames
      QualifyImportedNames.descriptor "qualifyImportedNames" :
#endif
#if refineImports
      RefineImports.descriptor pluginRecorder "refineImports" :
#endif
#if moduleName
      ModuleName.descriptor "moduleName" :
#endif
#if hlint
      Hlint.descriptor pluginRecorder "hlint" :
#endif
#if splice
      Splice.descriptor "splice" :
#endif
#if alternateNumberFormat
      AlternateNumberFormat.descriptor pluginRecorder "alternateNumberFormat" :
#endif
#if selectionRange
      SelectionRange.descriptor "selectionRange" :
#endif
#if changeTypeSignature
      ChangeTypeSignature.descriptor "changeTypeSignature" :
#endif
    -- The ghcide descriptors should come last so that the notification handlers
    -- (which restart the Shake build) run after everything else
      GhcIde.descriptors pluginRecorder
    examplePlugins =
      [Example.descriptor  pluginRecorder "eg"
      ,Example2.descriptor pluginRecorder "eg2"
      ]