Filter hlint FOIs

Author: nlander

ghcide/src/Development/IDE/Core/RuleTypes.hs

@@ -12,6 +12,7 @@
 --   using the "Shaker" abstraction layer for in-memory use.
 --
 module Development.IDE.Core.RuleTypes(
+    FileOfInterestStatus(..),
     GhcSessionDeps(.., GhcSessionDeps),
     module Development.IDE.Core.RuleTypes
     ) where
@@ -42,6 +43,7 @@ import                          Development.IDE.Spans.Common
 import                          Development.IDE.Spans.LocalBindings
 import                          Development.IDE.Types.Diagnostics
 import                          GHC.Serialized                               (Serialized)
+import                          Ide.Types                                    (FileOfInterestStatus (..))
 import                          Language.LSP.Protocol.Types                  (Int32,
                                                                               NormalizedFilePath)
 
@@ -333,15 +335,6 @@ data GetFileExists = GetFileExists
 instance NFData   GetFileExists
 instance Hashable GetFileExists
 
-data FileOfInterestStatus
-  = OnDisk
-  | ReadOnly
-  | Modified { firstOpen :: !Bool -- ^ was this file just opened
-             }
-  deriving (Eq, Show, Typeable, Generic)
-instance Hashable FileOfInterestStatus
-instance NFData   FileOfInterestStatus
-
 data IsFileOfInterestResult = NotFOI | IsFOI FileOfInterestStatus
   deriving (Eq, Show, Typeable, Generic)
 instance Hashable IsFileOfInterestResult

ghcide/src/Development/IDE/LSP/Notifications.hs

@@ -154,6 +154,7 @@ descriptor recorder plId = (defaultPluginDescriptor plId) { pluginNotificationHa
     -- (which restart the Shake build) run after everything else
         pluginPriority = ghcideNotificationsPluginPriority
     ,   pluginFileType = PluginFileType [FromProject, FromDependency] defaultPluginFileExtensions
+    ,   pluginFOIStatus = ReadOnly : defaultPluginFOIStatus
     }
 
 ghcideNotificationsPluginPriority :: Natural

ghcide/src/Development/IDE/Plugin/HLS/GhcIde.hs

@@ -56,6 +56,7 @@ descriptor plId = (defaultPluginDescriptor plId)
 
   , pluginConfigDescriptor = defaultConfigDescriptor
   , pluginFileType = PluginFileType [FromProject, FromDependency] defaultPluginFileExtensions
+  , pluginFOIStatus = ReadOnly : defaultPluginFOIStatus
   }
 
 -- ---------------------------------------------------------------------

hls-plugin-api/hls-plugin-api.cabal

@@ -51,6 +51,7 @@ library
     , co-log-core
     , containers
     , data-default
+    , deepseq
     , dependent-map
     , dependent-sum         >=0.7
     , Diff                  ^>=0.4.0

hls-plugin-api/src/Ide/Types.hs

@@ -25,6 +25,7 @@
 module Ide.Types
 ( PluginDescriptor(..), defaultPluginDescriptor, defaultCabalPluginDescriptor
 , defaultPluginPriority, defaultPluginFileExtensions
+, defaultPluginFOIStatus
 , IdeCommand(..)
 , IdeMethod(..)
 , IdeNotification(..)
@@ -34,6 +35,7 @@ module Ide.Types
 , ConfigDescriptor(..), defaultConfigDescriptor, configForPlugin, pluginEnabledConfig
 , CustomConfig(..), mkCustomConfig
 , FallbackCodeActionParams(..)
+, FileOfInterestStatus(..)
 , FormattingType(..), FormattingMethod, FormattingHandler, mkFormattingHandlers
 , HasTracing(..)
 , PluginCommand(..), CommandId(..), CommandFunction, mkLspCommand, mkLspCmdId
@@ -55,6 +57,7 @@ module Ide.Types
 , lookupCommandProvider
 , ResolveFunction
 , mkResolveHandler
+, filterResponsibleFOI
 )
     where
 
@@ -71,6 +74,7 @@ import           System.Posix.Signals
 
 import           Control.Applicative           ((<|>))
 import           Control.Arrow                 ((&&&))
+import           Control.DeepSeq               (NFData)
 import           Control.Lens                  (_Just, (.~), (?~), (^.), (^?))
 import           Control.Monad                 (void)
 import           Control.Monad.Error.Class     (MonadError (throwError))
@@ -96,6 +100,7 @@ import           Data.Semigroup
 import           Data.String
 import qualified Data.Text                     as T
 import           Data.Text.Encoding            (encodeUtf8)
+import           Data.Typeable                 (Typeable)
 import           Development.IDE.Graph
 import           GHC                           (DynFlags)
 import           GHC.Generics
@@ -286,6 +291,11 @@ data PluginDescriptor (ideState :: Type) =
                    --   The plugin is only allowed to handle files with these extensions.
                    --   When writing handlers, etc. for this plugin it can be assumed that all handled files are of this type.
                    --   The file extension must have a leading '.'.
+                   , pluginFOIStatus      :: [FileOfInterestStatus]
+                   -- ^ For plugins that have rules that run on files of interest,
+                   --   we specify which FileOfInterestStatus are relevant for the
+                   --   plugin. By default, ReadOnly files of interest are
+                   --   excluded.
                    }
 
 -- | A description of the types of files that the plugin
@@ -335,6 +345,22 @@ pluginResponsible uri pluginDesc
         mfp :: Maybe NormalizedFilePath
         mfp = uriToNormalizedFilePath $ toNormalizedUri uri
 
+data FileOfInterestStatus
+  = OnDisk
+  | ReadOnly
+  | Modified { firstOpen :: !Bool -- ^ was this file just opened
+             }
+  deriving (Eq, Show, Typeable, Generic)
+instance Hashable FileOfInterestStatus
+instance NFData   FileOfInterestStatus
+
+filterResponsibleFOI
+  :: PluginDescriptor c
+  -> HashMap NormalizedFilePath FileOfInterestStatus
+  -> HashMap NormalizedFilePath FileOfInterestStatus
+filterResponsibleFOI pluginDesc =
+  HashMap.filter (\foiStatus -> foiStatus `elem` pluginFOIStatus pluginDesc)
+
 -- | An existential wrapper of 'Properties'
 data CustomConfig = forall r. CustomConfig (Properties r)
 
@@ -905,10 +931,14 @@ defaultPluginDescriptor plId =
     mempty
     Nothing
     (PluginFileType [FromProject] defaultPluginFileExtensions)
+    defaultPluginFOIStatus
 
 defaultPluginFileExtensions :: [T.Text]
 defaultPluginFileExtensions = [".hs", ".lhs", ".hs-boot"]
 
+defaultPluginFOIStatus :: [FileOfInterestStatus]
+defaultPluginFOIStatus = [OnDisk, Modified True, Modified False]
+
 -- | Set up a plugin descriptor, initialized with default values.
 -- This plugin descriptor is prepared for @.cabal@ files and as such,
 -- will only respond / run when @.cabal@ files are currently in scope.
@@ -928,6 +958,7 @@ defaultCabalPluginDescriptor plId =
     mempty
     Nothing
     (PluginFileType [FromProject] [".cabal"])
+    defaultPluginFOIStatus
 
 newtype CommandId = CommandId T.Text
   deriving (Show, Read, Eq, Ord)

plugins/hls-hlint-plugin/src/Ide/Plugin/Hlint.hs

@@ -234,7 +234,7 @@ rules recorder plugin = do
     liftIO $ argsSettings flags
 
   action $ do
-    files <- getFilesOfInterestUntracked
+    files <- filterResponsibleFOI (descriptor recorder plugin) <$> getFilesOfInterestUntracked
     void $ uses GetHlintDiagnostics $ Map.keys files
 
   where