added option to always insert pragmas at top of file

Author: OliverMadine

haskell-language-server.cabal

@@ -229,7 +229,9 @@ common moduleName
 common pragmas
   if flag(pragmas) || flag(all-plugins)
     hs-source-dirs: plugins/default/src
-    build-depends: fuzzy
+    build-depends:
+      , fuzzy
+      , data-default
     other-modules: Ide.Plugin.Pragmas
     cpp-options: -Dpragmas
 

hls-plugin-api/src/Ide/Plugin/Config.hs

@@ -55,6 +55,7 @@ data Config =
     , diagnosticsDebounceDuration :: !Int
     , liquidOn                    :: !Bool
     , formatOnImportOn            :: !Bool
+    , pragmaInsertAfterComments   :: !Bool
     , formattingProvider          :: !T.Text
     , maxCompletions              :: !Int
     , plugins                     :: !(Map.Map T.Text PluginConfig)
@@ -69,6 +70,7 @@ instance Default Config where
     , diagnosticsDebounceDuration = 350000
     , liquidOn                    = False
     , formatOnImportOn            = True
+    , pragmaInsertAfterComments   = True
     -- , formattingProvider          = "brittany"
     , formattingProvider          = "ormolu"
     -- , formattingProvider          = "floskell"
@@ -93,6 +95,7 @@ parseConfig defValue = A.withObject "Config" $ \v -> do
         <*> o .:? "diagnosticsDebounceDuration"             .!= diagnosticsDebounceDuration defValue
         <*> o .:? "liquidOn"                                .!= liquidOn defValue
         <*> o .:? "formatOnImportOn"                        .!= formatOnImportOn defValue
+        <*> o .:? "pragmaInsertAfterComments"               .!= pragmaInsertAfterComments defValue
         <*> o .:? "formattingProvider"                      .!= formattingProvider defValue
         <*> o .:? "maxCompletions"                          .!= maxCompletions defValue
         <*> o .:? "plugin"                                  .!= plugins defValue
@@ -108,6 +111,7 @@ instance A.ToJSON Config where
                  , "diagnosticsDebounceDuration" .= diagnosticsDebounceDuration
                  , "liquidOn"                    .= liquidOn
                  , "formatOnImportOn"            .= formatOnImportOn
+                 , "pragmaInsertAfterComments"   .= pragmaInsertAfterComments
                  , "formattingProvider"          .= formattingProvider
                  , "maxCompletions"              .= maxCompletions
                  , "plugin"                      .= plugins

plugins/default/src/Ide/Plugin/Pragmas.hs

@@ -1,3 +1,4 @@
+
 {-# LANGUAGE DuplicateRecordFields #-}
 {-# LANGUAGE NamedFieldPuns        #-}
 {-# LANGUAGE OverloadedStrings     #-}
@@ -10,6 +11,8 @@ import           Control.Applicative        ((<|>))
 import           Control.Lens               hiding (List)
 import           Control.Monad              (join)
 import           Control.Monad.IO.Class
+import           Ide.Plugin.Config
+import           Data.Default
 import qualified Data.HashMap.Strict        as H
 import           Data.List.Extra            (nubOrdOn)
 import           Data.Maybe                 (catMaybes, listToMaybe)
@@ -42,13 +45,17 @@ data Pragma = LangExt T.Text | OptGHC T.Text
 
 codeActionProvider :: PluginMethodHandler IdeState TextDocumentCodeAction
 codeActionProvider state _plId (CodeActionParams _ _ docId _ (J.CodeActionContext (J.List diags) _monly)) = do
-  let mFile = docId ^. J.uri & uriToFilePath <&> toNormalizedFilePath'
-      uri = docId ^. J.uri
-  pm <- liftIO $ fmap join $ runAction "Pragmas.GetParsedModule" state $ getParsedModule `traverse` mFile
-  let dflags = ms_hspp_opts . pm_mod_summary <$> pm
-      insertRange = maybe (Range (Position 0 0) (Position 0 0)) endOfModuleHeader pm
-      pedits = nubOrdOn snd . concat $ suggest dflags <$> diags
-  return $ Right $ List $ pragmaEditToAction uri insertRange <$> pedits
+    let mFile = docId ^. J.uri & uriToFilePath <&> toNormalizedFilePath'
+        uri = docId ^. J.uri
+    pm <- liftIO $ fmap join $ runAction "Pragmas.GetParsedModule" state $ getParsedModule `traverse` mFile
+    config <- liftIO $ runAction "getConfig" state (getClientConfigAction def)
+    let dflags = ms_hspp_opts . pm_mod_summary <$> pm
+        pedits = nubOrdOn snd . concat $ suggest dflags <$> diags
+        insertAfterComments = pragmaInsertAfterComments config
+    return $ Right $ List $ pragmaEditToAction uri (getInsertRange insertAfterComments pm) <$> pedits
+    where
+        getInsertRange True (Just pm) = endOfModuleHeader pm
+        getInsertRange _ _ = Range (Position 0 0) (Position 0 0)
 
 -- | Add a Pragma to the given URI at the top of the file.
 -- It is assumed that the pragma name is a valid pragma,