diff --git a/.github/workflows/hackage.yml b/.github/workflows/hackage.yml index 09b1f57de7..ac939f9896 100644 --- a/.github/workflows/hackage.yml +++ b/.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", diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c57c4de3cd..c504aa87bd 100644 --- a/.github/workflows/test.yml +++ b/.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" diff --git a/CODEOWNERS b/CODEOWNERS index 70dc00b939..27cc7e20d4 100644 --- a/CODEOWNERS +++ b/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 diff --git a/cabal.project b/cabal.project index f87c79e86a..bb14019d99 100644 --- a/cabal.project +++ b/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 diff --git a/docs/features.md b/docs/features.md index 58fa945299..4b8b10725f 100644 --- a/docs/features.md +++ b/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` diff --git a/docs/supported-versions.md b/docs/supported-versions.md index 9e010373bf..2adc4c43ce 100644 --- a/docs/supported-versions.md +++ b/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` | | diff --git a/exe/Plugins.hs b/exe/Plugins.hs index 6fbf6cd1dd..f0cd3c208b 100644 --- a/exe/Plugins.hs +++ b/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 diff --git a/ghcide/src/Development/IDE/Core/RuleTypes.hs b/ghcide/src/Development/IDE/Core/RuleTypes.hs index 2a10be92eb..1aa88ed800 100644 --- a/ghcide/src/Development/IDE/Core/RuleTypes.hs +++ b/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 diff --git a/ghcide/src/Development/IDE/Core/Rules.hs b/ghcide/src/Development/IDE/Core/Rules.hs index b82d928fa0..786a4ae156 100644 --- a/ghcide/src/Development/IDE/Core/Rules.hs +++ b/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 diff --git a/haskell-language-server.cabal b/haskell-language-server.cabal index d63b82495c..28193e011d 100644 --- a/haskell-language-server.cabal +++ b/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 diff --git a/plugins/hls-stan-plugin/LICENSE b/plugins/hls-stan-plugin/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/plugins/hls-stan-plugin/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/plugins/hls-stan-plugin/hls-stan-plugin.cabal b/plugins/hls-stan-plugin/hls-stan-plugin.cabal new file mode 100644 index 0000000000..0f63a01a77 --- /dev/null +++ b/plugins/hls-stan-plugin/hls-stan-plugin.cabal @@ -0,0 +1,79 @@ +cabal-version: 2.4 +name: hls-stan-plugin +version: 1.0.0.0 +synopsis: Stan integration plugin with Haskell Language Server +description: + Please see the README on GitHub at + +license: Apache-2.0 +license-file: LICENSE +author: The Haskell IDE Team +maintainer: uhbif19@gmail.com +copyright: The Haskell IDE Team +category: Development +build-type: Simple +extra-source-files: + LICENSE + test/testdata/*.hs + +flag pedantic + description: Enable -Werror + default: False + manual: True + + +library + if impl(ghc < 8.8) || impl(ghc >= 9.0) + buildable: False + else + buildable: True + exposed-modules: Ide.Plugin.Stan + hs-source-dirs: src + build-depends: + base + , containers + , deepseq + , hashable + , hls-plugin-api + , ghc + , ghcide + , lsp-types + , text + , transformers + , unordered-containers + , stan + + default-language: Haskell2010 + default-extensions: + LambdaCase + NamedFieldPuns + DeriveGeneric + TypeFamilies + StandaloneDeriving + DuplicateRecordFields + OverloadedStrings + +test-suite test + if impl(ghc < 8.8) || impl(ghc >= 9.0) + buildable: False + else + buildable: True + type: exitcode-stdio-1.0 + default-language: Haskell2010 + hs-source-dirs: test + main-is: Main.hs + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: + aeson + , base + , containers + , filepath + , hls-stan-plugin + , hls-plugin-api + , hls-test-utils ^>=1.3 + , lens + , lsp-types + , text + default-extensions: + NamedFieldPuns + OverloadedStrings \ No newline at end of file diff --git a/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs new file mode 100644 index 0000000000..0d3607a6b3 --- /dev/null +++ b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs @@ -0,0 +1,120 @@ +module Ide.Plugin.Stan (descriptor) where + +import Control.DeepSeq (NFData) +import Control.Monad (void) +import Control.Monad.IO.Class (liftIO) +import Control.Monad.Trans.Class (lift) +import Control.Monad.Trans.Maybe (MaybeT (MaybeT), runMaybeT) +import Data.Foldable (toList) +import qualified Data.HashMap.Strict as HM +import Data.Hashable (Hashable) +import qualified Data.Map as Map +import Data.Maybe (fromJust, mapMaybe) +import qualified Data.Text as T +import Development.IDE (Action, FileDiagnostic, + GetHieAst (..), + GetModSummaryWithoutTimestamps (..), + GhcSession (..), IdeState, + NormalizedFilePath, + Pretty (..), Recorder, + RuleResult, Rules, + ShowDiagnostic (..), + TypeCheck (..), WithPriority, + action, cmapWithPrio, define, + getFilesOfInterestUntracked, + hscEnv, msrModSummary, + tmrTypechecked, use, uses) +import Development.IDE.Core.RuleTypes (HieAstResult (..)) +import Development.IDE.Core.Rules (getSourceFileSource, + getHieFile) +import qualified Development.IDE.Core.Shake as Shake +import Development.IDE.GHC.Compat (HieASTs (HieASTs), + RealSrcSpan (..), mkHieFile', + mkRealSrcLoc, mkRealSrcSpan, + runHsc, srcSpanEndCol, + srcSpanEndLine, + srcSpanStartCol, + srcSpanStartLine, tcg_exports) +import Development.IDE.GHC.Error (realSrcSpanToRange) +import GHC.Generics (Generic) +import HieTypes (HieASTs, HieFile) +import Ide.Types (PluginDescriptor (..), + PluginId, + defaultPluginDescriptor) +import qualified Language.LSP.Types as LSP +import Stan.Analysis (Analysis (..), runAnalysis) +import Stan.Category (prettyShowCategory) +import Stan.Core.Id (Id (..)) +import Stan.Inspection (Inspection (..)) +import Stan.Inspection.All (inspectionsIds, inspectionsMap) +import Stan.Observation (Observation (..)) +import Stan.Severity (prettyShowSeverity) + +descriptor :: Recorder (WithPriority Log) -> PluginId -> PluginDescriptor IdeState +descriptor recorder plId = (defaultPluginDescriptor plId) {pluginRules = rules recorder} + +newtype Log = LogShake Shake.Log deriving (Show) + +instance Pretty Log where + pretty = \case + LogShake log -> pretty log + +data GetStanDiagnostics = GetStanDiagnostics + deriving (Eq, Show, Generic) + +instance Hashable GetStanDiagnostics + +instance NFData GetStanDiagnostics + +type instance RuleResult GetStanDiagnostics = () + +rules :: Recorder (WithPriority Log) -> Rules () +rules recorder = do + define (cmapWithPrio LogShake recorder) $ + \GetStanDiagnostics file -> do + maybeHie <- getHieFile file + case maybeHie of + Nothing -> return ([], Nothing) + Just hie -> do + let enabledInspections = HM.fromList [(LSP.fromNormalizedFilePath file, inspectionsIds)] + -- This should use Cabal config for extensions and Stan config for inspection preferences is the future + let analysis = runAnalysis Map.empty enabledInspections [] [hie] + return (analysisToDiagnostics file analysis, Just ()) + + action $ do + files <- getFilesOfInterestUntracked + void $ uses GetStanDiagnostics $ HM.keys files + where + analysisToDiagnostics :: NormalizedFilePath -> Analysis -> [FileDiagnostic] + analysisToDiagnostics file = mapMaybe (observationToDianostic file) . toList . analysisObservations + observationToDianostic :: NormalizedFilePath -> Observation -> Maybe FileDiagnostic + observationToDianostic file (Observation {observationSrcSpan, observationInspectionId}) = + do + inspection <- HM.lookup observationInspectionId inspectionsMap + let + -- Looking similar to Stan CLI output + -- We do not use `prettyShowInspection` cuz Id is redundant here + message :: T.Text + message = + T.unlines $ + [ " ✲ Name: " <> inspectionName inspection, + " ✲ Description: " <> inspectionDescription inspection, + " ✲ Severity: " <> (prettyShowSeverity $ + inspectionSeverity inspection), + " ✲ Category: " <> T.intercalate " " + (map prettyShowCategory $ toList $ inspectionCategory inspection), + "Possible solutions:" + ] + ++ map (" - " <>) (inspectionSolution inspection) + return ( file, + ShowDiag, + LSP.Diagnostic + { _range = realSrcSpanToRange $ observationSrcSpan, + _severity = Just LSP.DsHint, + _code = Just (LSP.InR $ unId (inspectionId inspection)), + _source = Just "stan", + _message = message, + _relatedInformation = Nothing, + _tags = Nothing + } + ) diff --git a/plugins/hls-stan-plugin/test/Main.hs b/plugins/hls-stan-plugin/test/Main.hs new file mode 100644 index 0000000000..3f6c5e9bad --- /dev/null +++ b/plugins/hls-stan-plugin/test/Main.hs @@ -0,0 +1,46 @@ +module Main + ( main, + ) +where + +import Control.Lens ((^.)) +import Control.Monad (void) +import Data.List (find) +import Data.Text (Text) +import qualified Data.Text as T +import qualified Data.Text.IO as T +import qualified Ide.Plugin.Stan as Stan +import qualified Language.LSP.Types.Lens as L +import System.FilePath +import Test.Hls + +main :: IO () +main = defaultTestRunner tests + +tests :: TestTree +tests = + testGroup + "stan suggestions" + [ testCase "provides diagnostics" $ + runStanSession "" $ do + doc <- openDoc "test.hs" "haskell" + diags@(reduceDiag : _) <- waitForDiagnosticsFromSource doc "stan" + liftIO $ do + length diags @?= 1 + reduceDiag ^. L.range @?= Range (Position 0 0) (Position 3 19) + reduceDiag ^. L.severity @?= Just DsHint + let expectedPrefix = " ✲ Name: " + assertBool "" $ T.isPrefixOf expectedPrefix (reduceDiag ^. L.message) + reduceDiag ^. L.source @?= Just "stan" + return () + ] + +testDir :: FilePath +testDir = "test/testdata" + +stanPlugin :: PluginDescriptor IdeState +stanPlugin = Stan.descriptor mempty "stan" + +runStanSession :: FilePath -> Session a -> IO a +runStanSession subdir = + failIfSessionTimeout . runSessionWithServer stanPlugin (testDir subdir) diff --git a/plugins/hls-stan-plugin/test/testdata/.hie/Main.hie b/plugins/hls-stan-plugin/test/testdata/.hie/Main.hie new file mode 100644 index 0000000000..0c7367ab46 Binary files /dev/null and b/plugins/hls-stan-plugin/test/testdata/.hie/Main.hie differ diff --git a/plugins/hls-stan-plugin/test/testdata/hie.yaml b/plugins/hls-stan-plugin/test/testdata/hie.yaml new file mode 100644 index 0000000000..577238428b --- /dev/null +++ b/plugins/hls-stan-plugin/test/testdata/hie.yaml @@ -0,0 +1,4 @@ +cradle: + direct: + arguments: + - test.hs \ No newline at end of file diff --git a/plugins/hls-stan-plugin/test/testdata/test.hs b/plugins/hls-stan-plugin/test/testdata/test.hs new file mode 100644 index 0000000000..7a184b01f0 --- /dev/null +++ b/plugins/hls-stan-plugin/test/testdata/test.hs @@ -0,0 +1,4 @@ +orderPair x y + | x < y = 1 + | x > y = 2 + | otherwise = 3 diff --git a/stack-lts16.yaml b/stack-lts16.yaml index 6a057acf0d..826f8730e4 100644 --- a/stack-lts16.yaml +++ b/stack-lts16.yaml @@ -15,6 +15,7 @@ packages: - ./plugins/hls-explicit-imports-plugin - ./plugins/hls-refine-imports-plugin - ./plugins/hls-hlint-plugin + - ./plugins/hls-stan-plugin - ./plugins/hls-rename-plugin - ./plugins/hls-retrie-plugin - ./plugins/hls-splice-plugin @@ -91,6 +92,13 @@ extra-deps: - primitive-extras-0.10.1 - primitive-unlifted-0.1.3.1 - githash-0.1.6.2 + - stan-0.0.1.0 + - dir-traverse-0.2.3.0@sha256:adcc128f201ff95131b15ffe41365dc99c50dc3fa3a910f021521dc734013bfa,2137 + - extensions-0.0.0.1@sha256:16517ab9df3dd6c7a20da746c8ed02cfd59c8cb40ae5719aef8b5dd4edceadc0,3993 + - microaeson-0.1.0.1@sha256:88ba1cc52181b57abc453e222bbb76ca6ab252e38c6507d15a596d6a582fdf69,3968 + - trial-0.0.0.0@sha256:834d3be439dc9b52a759a45a4d3944e5e55c3d50fd5874003147cc1f6231d4aa,4301 + - trial-optparse-applicative-0.0.0.0@sha256:ba05edfc327a281766df5e0f44d91229e6a98afaf59abe1894b293453f076192,2449 + - trial-tomland-0.0.0.0@sha256:743a9baaa36891ed3a44618fdfd5bc4ed9afc39cf9b9fa23ea1b96f3787f5ec0,2526 configure-options: ghcide: