From 990f0bbf5654161049fe818486a9f6ff9be9f320 Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Mon, 16 May 2022 06:15:37 +0300 Subject: [PATCH 01/10] Initial Stan support --- .github/workflows/hackage.yml | 2 +- .github/workflows/test.yml | 4 + CODEOWNERS | 1 + cabal.project | 1 + docs/supported-versions.md | 1 + exe/Plugins.hs | 8 + ghcide/src/Development/IDE/Core/RuleTypes.hs | 2 +- ghcide/src/Development/IDE/Core/Rules.hs | 1 + haskell-language-server.cabal | 12 +- plugins/hls-stan-plugin/LICENSE | 201 ++++++++++++++++++ plugins/hls-stan-plugin/hls-stan-plugin.cabal | 71 +++++++ .../hls-stan-plugin/src/Ide/Plugin/Stan.hs | 119 +++++++++++ plugins/hls-stan-plugin/test/Main.hs | 46 ++++ .../test/testdata/.hie/Main.hie | Bin 0 -> 1056 bytes .../hls-stan-plugin/test/testdata/hie.yaml | 4 + plugins/hls-stan-plugin/test/testdata/test.hs | 4 + stack-lts16.yaml | 1 + 17 files changed, 475 insertions(+), 3 deletions(-) create mode 100644 plugins/hls-stan-plugin/LICENSE create mode 100644 plugins/hls-stan-plugin/hls-stan-plugin.cabal create mode 100644 plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs create mode 100644 plugins/hls-stan-plugin/test/Main.hs create mode 100644 plugins/hls-stan-plugin/test/testdata/.hie/Main.hie create mode 100644 plugins/hls-stan-plugin/test/testdata/hie.yaml create mode 100644 plugins/hls-stan-plugin/test/testdata/test.hs diff --git a/.github/workflows/hackage.yml b/.github/workflows/hackage.yml index f90518f5d1..8abe74b177 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 41552cf49f..9f7f94a73d 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -226,6 +226,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 7d12e86a70..2e83a4cf6d 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -28,6 +28,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 4cc16fa34a..73cc59d9f2 100644 --- a/cabal.project +++ b/cabal.project @@ -28,6 +28,7 @@ packages: ./plugins/hls-qualify-imported-names-plugin ./plugins/hls-selection-range-plugin ./plugins/hls-change-type-signature-plugin + ./plugins/hls-stan-plugin -- Standard location for temporary packages needed for particular environments -- For example it is used in the project gitlab mirror to help in the MAcOS M1 build script diff --git a/docs/supported-versions.md b/docs/supported-versions.md index 87fd819b5a..a2113a9f4b 100644 --- a/docs/supported-versions.md +++ b/docs/supported-versions.md @@ -44,6 +44,7 @@ Sometimes a plugin will be supported in the prebuilt binaries but not in a HLS b | `hls-fourmolu-plugin` | | | `hls-haddock-comments-plugin` | 9.2 | | `hls-hlint-plugin` | | +| `hls-stan-plugin` | 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 05ccc8fb20..19a1c2f634 100644 --- a/exe/Plugins.hs +++ b/exe/Plugins.hs @@ -59,6 +59,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 @@ -179,6 +184,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 e4c9bcafcd..690ac7ed39 100644 --- a/ghcide/src/Development/IDE/Core/RuleTypes.hs +++ b/ghcide/src/Development/IDE/Core/RuleTypes.hs @@ -188,7 +188,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 9877aee3b4..b9bc315906 100644 --- a/ghcide/src/Development/IDE/Core/Rules.hs +++ b/ghcide/src/Development/IDE/Core/Rules.hs @@ -55,6 +55,7 @@ module Development.IDE.Core.Rules( getParsedModuleDefinition, typeCheckRuleDefinition, getRebuildCount, + getSourceFileSource, GhcSessionDepsConfig(..), Log(..), DisplayTHWarning(..), diff --git a/haskell-language-server.cabal b/haskell-language-server.cabal index 5fc524b9d9..8e7eec58cd 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 @@ -273,6 +278,11 @@ common hlint build-depends: hls-hlint-plugin ^>= 1.0 cpp-options: -Dhlint +common stan + if flag(stan) && 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 @@ -352,7 +362,7 @@ executable haskell-language-server , rename , 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..bf5da02787 --- /dev/null +++ b/plugins/hls-stan-plugin/hls-stan-plugin.cabal @@ -0,0 +1,71 @@ +cabal-version: 2.4 +name: hls-stan-plugin +version: 1.0.4.0 +synopsis: Hlint 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: atreyu.bbb@gmail.com +copyright: The Haskell IDE Team +category: Development +build-type: Simple +extra-source-files: + LICENSE + test/testdata/**/*.yaml + +flag pedantic + description: Enable -Werror + default: False + manual: True + + +library + 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 + 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..0b5eec0476 --- /dev/null +++ b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs @@ -0,0 +1,119 @@ +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) +import qualified Data.Text as T +import Data.Typeable (Typeable, cast) +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) +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.Core.Id (Id (..)) +import Stan.Inspection (Inspection (..)) +import Stan.Inspection.All (inspectionsIds, inspectionsMap) +import Stan.Observation (Observation (..)) + +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 + hie <- fromJust <$> getHieFile file + let enabledInspections = HM.fromList [(LSP.fromNormalizedFilePath file, inspectionsIds)] + 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 = map (observationToDianostic file) . toList . analysisObservations + observationToDianostic :: NormalizedFilePath -> Observation -> FileDiagnostic + observationToDianostic file (Observation {observationSrcSpan, observationInspectionId}) = + ( 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 + } + ) + where + inspection = fromJust $ HM.lookup observationInspectionId inspectionsMap + -- Lookin similar to Stan CLI output + message :: T.Text + message = + T.unlines $ + [ " ✲ Name: " <> inspectionName inspection, + " ✲ Description: " <> inspectionDescription inspection, + "Possible solutions:" + ] + ++ map (" - " <>) (inspectionSolution inspection) + +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/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 0000000000000000000000000000000000000000..0c7367ab46d26d5db6079a385348b51447d72c49 GIT binary patch literal 1056 zcmZ8g+iuf95Z#$w-yJ&_xAelr@QR4qMxuQvmD;M*NUe%mRG!_$B^Ie|c^yb3K826q z3-}4%`2ZgI0%n~{QKMvbX3p%{xg~mcvbVjpYwvZpx4OGFW4y~4emAN_R^6dw4A{md zqeG}KB9bnc5KKc36e$P-gDhPsmav4d9L;vQWTh2s%0Lgh{@wn zJMS)-Dnn%t~yv71|~ua#CS+hjd+U&2fJNUwC{lw{IbY&jpgXvXuSLsTeU1}G_VNvLjJed@w z7D);x<6{{YRwOUJB;{FJK@3HEKg+{W-jAy^&%!jj%@3dyH?d6o)9AQ+RmJ_!-4D|u uk!}>r<9IZxUDk3uFoCK0Y1n^Nl y = 2 + | otherwise = 3 diff --git a/stack-lts16.yaml b/stack-lts16.yaml index ee471e3521..b83d03c429 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 From 21c7a9a060317a8bd0e3812c5f3dd5ae08888f3b Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Mon, 16 May 2022 12:55:00 +0300 Subject: [PATCH 02/10] Fixes --- plugins/hls-stan-plugin/hls-stan-plugin.cabal | 8 +-- .../hls-stan-plugin/src/Ide/Plugin/Stan.hs | 53 ++++++++++--------- 2 files changed, 31 insertions(+), 30 deletions(-) diff --git a/plugins/hls-stan-plugin/hls-stan-plugin.cabal b/plugins/hls-stan-plugin/hls-stan-plugin.cabal index bf5da02787..624a506925 100644 --- a/plugins/hls-stan-plugin/hls-stan-plugin.cabal +++ b/plugins/hls-stan-plugin/hls-stan-plugin.cabal @@ -1,20 +1,20 @@ cabal-version: 2.4 name: hls-stan-plugin -version: 1.0.4.0 -synopsis: Hlint integration plugin with Haskell Language Server +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: atreyu.bbb@gmail.com +maintainer: uhbif19@gmail.com copyright: The Haskell IDE Team category: Development build-type: Simple extra-source-files: LICENSE - test/testdata/**/*.yaml + test/testdata/**/* flag pedantic description: Enable -Werror diff --git a/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs index 0b5eec0476..0282c15c90 100644 --- a/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs +++ b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs @@ -9,7 +9,7 @@ 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) +import Data.Maybe (fromJust, mapMaybe) import qualified Data.Text as T import Data.Typeable (Typeable, cast) import Development.IDE (Action, FileDiagnostic, @@ -80,32 +80,33 @@ rules recorder = do void $ uses GetStanDiagnostics $ HM.keys files where analysisToDiagnostics :: NormalizedFilePath -> Analysis -> [FileDiagnostic] - analysisToDiagnostics file = map (observationToDianostic file) . toList . analysisObservations - observationToDianostic :: NormalizedFilePath -> Observation -> FileDiagnostic + analysisToDiagnostics file = mapMaybe (observationToDianostic file) . toList . analysisObservations + observationToDianostic :: NormalizedFilePath -> Observation -> Maybe FileDiagnostic observationToDianostic file (Observation {observationSrcSpan, observationInspectionId}) = - ( 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 - } - ) - where - inspection = fromJust $ HM.lookup observationInspectionId inspectionsMap - -- Lookin similar to Stan CLI output - message :: T.Text - message = - T.unlines $ - [ " ✲ Name: " <> inspectionName inspection, - " ✲ Description: " <> inspectionDescription inspection, - "Possible solutions:" - ] - ++ map (" - " <>) (inspectionSolution inspection) + do + inspection <- HM.lookup observationInspectionId inspectionsMap + let + -- Looking similar to Stan CLI output + message :: T.Text + message = + T.unlines $ + [ " ✲ Name: " <> inspectionName inspection, + " ✲ Description: " <> inspectionDescription 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 + } + ) getHieFile :: NormalizedFilePath -> Action (Maybe HieFile) getHieFile nfp = runMaybeT $ do From 2d55f5c4e130d2f4c0af31d0a207fdcc4f6b2bc5 Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Mon, 16 May 2022 14:19:33 +0300 Subject: [PATCH 03/10] Fix build --- haskell-language-server.cabal | 2 +- plugins/hls-stan-plugin/hls-stan-plugin.cabal | 10 +++++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/haskell-language-server.cabal b/haskell-language-server.cabal index 8e7eec58cd..4076f2927a 100644 --- a/haskell-language-server.cabal +++ b/haskell-language-server.cabal @@ -279,7 +279,7 @@ common hlint cpp-options: -Dhlint common stan - if flag(stan) && impl(ghc < 9.0) + if flag(stan) && (impl(ghc >= 8.8) && impl(ghc < 9.0)) build-depends: hls-stan-plugin ^>= 1.0 cpp-options: -Dstan diff --git a/plugins/hls-stan-plugin/hls-stan-plugin.cabal b/plugins/hls-stan-plugin/hls-stan-plugin.cabal index 624a506925..0f63a01a77 100644 --- a/plugins/hls-stan-plugin/hls-stan-plugin.cabal +++ b/plugins/hls-stan-plugin/hls-stan-plugin.cabal @@ -14,7 +14,7 @@ category: Development build-type: Simple extra-source-files: LICENSE - test/testdata/**/* + test/testdata/*.hs flag pedantic description: Enable -Werror @@ -23,6 +23,10 @@ flag pedantic 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: @@ -50,6 +54,10 @@ library 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 From 1237ed32ea508db397081b7349ef561994538793 Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Thu, 19 May 2022 22:18:08 +0300 Subject: [PATCH 04/10] Get rid of fromJust, more text, comments --- .../hls-stan-plugin/src/Ide/Plugin/Stan.hs | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs index 0282c15c90..53733431c2 100644 --- a/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs +++ b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs @@ -43,10 +43,12 @@ import Ide.Types (PluginDescriptor (..), 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} @@ -70,10 +72,14 @@ rules :: Recorder (WithPriority Log) -> Rules () rules recorder = do define (cmapWithPrio LogShake recorder) $ \GetStanDiagnostics file -> do - hie <- fromJust <$> getHieFile file - let enabledInspections = HM.fromList [(LSP.fromNormalizedFilePath file, inspectionsIds)] - let analysis = runAnalysis Map.empty enabledInspections [] [hie] - return (analysisToDiagnostics file analysis, Just ()) + 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 @@ -87,11 +93,16 @@ rules recorder = do inspection <- HM.lookup observationInspectionId inspectionsMap let -- Looking similar to Stan CLI output + -- We do not use `prettyShowInspection` cuz Id and Categories 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) From 0ce3c7a273e05e6fb921963bedf9e72a1566971a Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Fri, 20 May 2022 13:43:43 +0300 Subject: [PATCH 05/10] Fixes --- haskell-language-server.cabal | 1 + plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/haskell-language-server.cabal b/haskell-language-server.cabal index 4076f2927a..99b0991f76 100644 --- a/haskell-language-server.cabal +++ b/haskell-language-server.cabal @@ -362,6 +362,7 @@ executable haskell-language-server , rename , retrie , tactic + , hlint , stan , moduleName , pragmas diff --git a/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs index 53733431c2..6db0262fc3 100644 --- a/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs +++ b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs @@ -93,7 +93,7 @@ rules recorder = do inspection <- HM.lookup observationInspectionId inspectionsMap let -- Looking similar to Stan CLI output - -- We do not use `prettyShowInspection` cuz Id and Categories is redundant here + -- We do not use `prettyShowInspection` cuz Id is redundant here message :: T.Text message = T.unlines $ From b2f04a7836652ba8e0c0ae8577b384cdf684b328 Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Fri, 20 May 2022 13:45:39 +0300 Subject: [PATCH 06/10] Add to Features fixed supported versions --- docs/features.md | 6 ++++++ docs/supported-versions.md | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/features.md b/docs/features.md index 74a686b8cd..da709196dd 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 a2113a9f4b..8558221aa5 100644 --- a/docs/supported-versions.md +++ b/docs/supported-versions.md @@ -44,7 +44,7 @@ Sometimes a plugin will be supported in the prebuilt binaries but not in a HLS b | `hls-fourmolu-plugin` | | | `hls-haddock-comments-plugin` | 9.2 | | `hls-hlint-plugin` | | -| `hls-stan-plugin` | 9.0, 9.2 | +| `hls-stan-plugin` | 8.6, 9.0, 9.2 | | `hls-module-name-plugin` | | | `hls-ormolu-plugin` | | | `hls-pragmas-plugin` | | From 2abaa35675679a22f80184518216dfbb8c97284f Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Fri, 15 Jul 2022 18:00:05 +0300 Subject: [PATCH 07/10] Add stan to Stack extra-deps to fix build bug --- stack-lts16.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/stack-lts16.yaml b/stack-lts16.yaml index 9c3bcdd3c3..72f114d040 100644 --- a/stack-lts16.yaml +++ b/stack-lts16.yaml @@ -92,6 +92,7 @@ extra-deps: - primitive-extras-0.10.1 - primitive-unlifted-0.1.3.1 - githash-0.1.6.2 + - stan-0.0.1.0 configure-options: ghcide: From 29d773c0075f4da2fcc1d2644301a97aa047ed3b Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Wed, 20 Jul 2022 21:45:04 +0300 Subject: [PATCH 08/10] Add stan deps to Stack extra-deps to fix build bug --- stack-lts16.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/stack-lts16.yaml b/stack-lts16.yaml index 7976e116c8..826f8730e4 100644 --- a/stack-lts16.yaml +++ b/stack-lts16.yaml @@ -93,6 +93,12 @@ extra-deps: - 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: From 1ac2daba52c6102cb094d23df54ba9dc98e4b8fa Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Wed, 20 Jul 2022 23:15:05 +0300 Subject: [PATCH 09/10] Move getHieFile --- ghcide/src/Development/IDE/Core/Rules.hs | 14 ++++++++++++++ plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs | 15 ++------------- 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/ghcide/src/Development/IDE/Core/Rules.hs b/ghcide/src/Development/IDE/Core/Rules.hs index e1de57cdbf..17110aff43 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, @@ -97,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, @@ -1218,3 +1220,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/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs index 6db0262fc3..0d3607a6b3 100644 --- a/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs +++ b/plugins/hls-stan-plugin/src/Ide/Plugin/Stan.hs @@ -11,7 +11,6 @@ import Data.Hashable (Hashable) import qualified Data.Map as Map import Data.Maybe (fromJust, mapMaybe) import qualified Data.Text as T -import Data.Typeable (Typeable, cast) import Development.IDE (Action, FileDiagnostic, GetHieAst (..), GetModSummaryWithoutTimestamps (..), @@ -26,7 +25,8 @@ import Development.IDE (Action, FileDiagnostic, hscEnv, msrModSummary, tmrTypechecked, use, uses) import Development.IDE.Core.RuleTypes (HieAstResult (..)) -import Development.IDE.Core.Rules (getSourceFileSource) +import Development.IDE.Core.Rules (getSourceFileSource, + getHieFile) import qualified Development.IDE.Core.Shake as Shake import Development.IDE.GHC.Compat (HieASTs (HieASTs), RealSrcSpan (..), mkHieFile', @@ -118,14 +118,3 @@ rules recorder = do _tags = Nothing } ) - -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 From ed078d67d98c624c4e67dea6806bc6f23f9a2627 Mon Sep 17 00:00:00 2001 From: uhbif19 Date: Fri, 22 Jul 2022 22:42:34 +0300 Subject: [PATCH 10/10] Trigger CI