Stan integration haskell#258 (haskell#2908)

Author: uhbif19

.github/workflows/hackage.yml

@@ -31,7 +31,7 @@ jobs:
                   "hls-brittany-plugin", "hls-floskell-plugin", "hls-fourmolu-plugin",
                   "hls-ormolu-plugin", "hls-stylish-haskell-plugin",
                   "hls-class-plugin", "hls-eval-plugin", "hls-explicit-imports-plugin",
-                  "hls-haddock-comments-plugin", "hls-hlint-plugin",
+                  "hls-haddock-comments-plugin", "hls-hlint-plugin", "hls-stan-plugin",
                   "hls-module-name-plugin", "hls-pragmas-plugin",
                   "hls-refine-imports-plugin", "hls-rename-plugin", "hls-retrie-plugin",
                   "hls-splice-plugin", "hls-tactics-plugin",

.github/workflows/test.yml

@@ -223,6 +223,10 @@ jobs:
         name: Test hls-hlint-plugin test suite
         run: cabal test hls-hlint-plugin --test-options="$TEST_OPTS" || cabal test hls-hlint-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-hlint-plugin --test-options="$TEST_OPTS"
 
+      - if: matrix.test && matrix.ghc != '9.0.1' && matrix.ghc != '9.0.2' && matrix.ghc != '9.2.2'
+        name: Test hls-stan-plugin test suite
+        run: cabal test hls-stan-plugin --test-options="$TEST_OPTS" || cabal test hls-hlint-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-stan-plugin --test-options="$TEST_OPTS"
+
       - if: matrix.test
         name: Test hls-module-name-plugin test suite
         run: cabal test hls-module-name-plugin --test-options="$TEST_OPTS" || cabal test hls-module-name-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-module-name-plugin --test-options="$TEST_OPTS"

CODEOWNERS

@@ -29,6 +29,7 @@
 /plugins/hls-splice-plugin @konn
 /plugins/hls-stylish-haskell-plugin @Ailrun
 /plugins/hls-tactics-plugin @isovector
+/plugins/hls-stan-plugin @uhbif19
 
 # Benchmarking
 /shake-bench @pepeiborra

cabal.project

@@ -28,6 +28,7 @@ packages:
          ./plugins/hls-qualify-imported-names-plugin
          ./plugins/hls-code-range-plugin
          ./plugins/hls-change-type-signature-plugin
+         ./plugins/hls-stan-plugin
          ./plugins/hls-gadt-plugin
 
 -- Standard location for temporary packages needed for particular environments

docs/features.md

@@ -38,6 +38,12 @@ Provided by: `hls-hlint-plugin`
 
 Provides hlint hints as diagnostics.
 
+### Stan hints
+
+Provided by: `hls-stan-plugin`
+
+Provides Stan hints as diagnostics.
+
 ## Hovers
 
 Provided by: `ghcide`

docs/supported-versions.md

@@ -58,6 +58,7 @@ Sometimes a plugin will be supported in the pre-built binaries but not in a HLS
 | `hls-fourmolu-plugin`               |                          |
 | `hls-haddock-comments-plugin`       | 9.2                      |
 | `hls-hlint-plugin`                  |                          |
+| `hls-stan-plugin`                   | 8.6, 9.0, 9.2            |
 | `hls-module-name-plugin`            |                          |
 | `hls-ormolu-plugin`                 |                          |
 | `hls-pragmas-plugin`                |                          |

exe/Plugins.hs

@@ -60,6 +60,11 @@ import qualified Ide.Plugin.Tactic                 as Tactic
 import qualified Ide.Plugin.Hlint                  as Hlint
 #endif
 
+#if stan
+import qualified Ide.Plugin.Stan                   as Stan
+#endif
+
+
 #if moduleName
 import qualified Ide.Plugin.ModuleName             as ModuleName
 #endif
@@ -184,6 +189,9 @@ idePlugins recorder includeExamples = pluginDescToIdePlugins allPlugins
 #if hlint
       Hlint.descriptor pluginRecorder "hlint" :
 #endif
+#if stan
+      Stan.descriptor pluginRecorder "stan" :
+#endif
 #if splice
       Splice.descriptor "splice" :
 #endif

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

@@ -207,7 +207,7 @@ instance Show HiFileResult where
 
 -- | Save the uncompressed AST here, we compress it just before writing to disk
 data HieAstResult
-  = forall a. HAR
+  = forall a . (Typeable a) =>  HAR
   { hieModule :: Module
   , hieAst    :: !(HieASTs a)
   , refMap    :: RefMap a

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

@@ -28,6 +28,7 @@ module Development.IDE.Core.Rules(
     getParsedModuleWithComments,
     getClientConfigAction,
     usePropertyAction,
+    getHieFile,
     -- * Rules
     CompiledLinkables(..),
     getParsedModuleRule,
@@ -55,6 +56,7 @@ module Development.IDE.Core.Rules(
     getParsedModuleDefinition,
     typeCheckRuleDefinition,
     getRebuildCount,
+    getSourceFileSource,
     GhcSessionDepsConfig(..),
     Log(..),
     DisplayTHWarning(..),
@@ -96,6 +98,7 @@ import qualified Data.Text                                    as T
 import qualified Data.Text.Encoding                           as T
 import           Data.Time                                    (UTCTime (..))
 import           Data.Tuple.Extra
+import           Data.Typeable                                (cast)
 import           Development.IDE.Core.Compile
 import           Development.IDE.Core.FileExists hiding (LogShake, Log)
 import           Development.IDE.Core.FileStore               (getFileContents,
@@ -1232,3 +1235,15 @@ mainRule recorder RulesConfig{..} = do
     persistentDocMapRule
     persistentImportMapRule
     getLinkableRule recorder
+
+-- | Get HieFile for haskell file on NormalizedFilePath
+getHieFile :: NormalizedFilePath -> Action (Maybe HieFile)
+getHieFile nfp = runMaybeT $ do
+  HAR {hieAst} <- MaybeT $ use GetHieAst nfp
+  tmr <- MaybeT $ use TypeCheck nfp
+  ghc <- MaybeT $ use GhcSession nfp
+  msr <- MaybeT $ use GetModSummaryWithoutTimestamps nfp
+  source <- lift $ getSourceFileSource nfp
+  let exports = tcg_exports $ tmrTypechecked tmr
+  typedAst <- MaybeT $ pure $ cast hieAst
+  liftIO $ runHsc (hscEnv ghc) $ mkHieFile' (msrModSummary msr) exports typedAst source

haskell-language-server.cabal

@@ -151,6 +151,11 @@ flag hlint
   default:     True
   manual:      True
 
+flag stan
+  description: Enable stan plugin
+  default:     True
+  manual:      True
+
 flag moduleName
   description: Enable moduleName plugin
   default:     True
@@ -279,6 +284,11 @@ common hlint
     build-depends: hls-hlint-plugin ^>= 1.0
     cpp-options: -Dhlint
 
+common stan
+  if flag(stan) && (impl(ghc >= 8.8) && impl(ghc < 9.0))
+    build-depends: hls-stan-plugin ^>= 1.0
+    cpp-options: -Dstan
+
 common moduleName
   if flag(moduleName)
     build-depends: hls-module-name-plugin ^>= 1.0
@@ -364,6 +374,7 @@ executable haskell-language-server
                     , retrie
                     , tactic
                     , hlint
+                    , stan
                     , moduleName
                     , pragmas
                     , splice