hls-pragmas-plugin (empty) → 1.0.0.0
raw patch · 22 files changed
+812/−0 lines, 22 filesdep +basedep +extradep +filepath
Dependencies added: base, extra, filepath, fuzzy, ghcide, hls-plugin-api, hls-pragmas-plugin, hls-test-utils, lens, lsp, lsp-test, lsp-types, text, transformers, unordered-containers
Files
- LICENSE +201/−0
- hls-pragmas-plugin.cabal +50/−0
- src/Ide/Plugin/Pragmas.hs +191/−0
- test/Main.hs +197/−0
- test/testdata/AfterShebang.expected.hs +13/−0
- test/testdata/AfterShebang.hs +12/−0
- test/testdata/AppendToExisting.expected.hs +12/−0
- test/testdata/AppendToExisting.hs +11/−0
- test/testdata/BeforeDocComment.expected.hs +15/−0
- test/testdata/BeforeDocComment.hs +14/−0
- test/testdata/Completion.hs +9/−0
- test/testdata/MissingSignatures.expected.hs +3/−0
- test/testdata/MissingSignatures.hs +2/−0
- test/testdata/NamedFieldPuns.expected.hs +10/−0
- test/testdata/NamedFieldPuns.hs +9/−0
- test/testdata/NeedsPragmas.expected.hs +17/−0
- test/testdata/NeedsPragmas.hs +16/−0
- test/testdata/TypeApplications.expected.hs +6/−0
- test/testdata/TypeApplications.hs +5/−0
- test/testdata/UnusedImports.expected.hs +7/−0
- test/testdata/UnusedImports.hs +6/−0
- test/testdata/hie.yaml +6/−0
+ LICENSE view
@@ -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.
+ hls-pragmas-plugin.cabal view
@@ -0,0 +1,50 @@+cabal-version: 2.4+name: hls-pragmas-plugin+version: 1.0.0.0+synopsis: Pragmas plugin for Haskell Language Server+description:+ Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>++license: Apache-2.0+license-file: LICENSE+author: The Haskell IDE Team+copyright: The Haskell IDE Team+maintainer: alan.zimm@gmail.com+category: Development+build-type: Simple+extra-source-files:+ LICENSE+ test/testdata/*.hs+ test/testdata/*.yaml++library+ exposed-modules: Ide.Plugin.Pragmas+ hs-source-dirs: src+ build-depends:+ base >=4.12 && <5+ , extra+ , fuzzy+ , ghcide >=1.2 && <1.4+ , hls-plugin-api ^>=1.1+ , lens+ , lsp+ , text+ , transformers+ , unordered-containers+ default-language: Haskell2010++test-suite tests+ 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:+ , base+ , filepath+ , hls-pragmas-plugin+ , hls-test-utils ^>=1.0+ , lens+ , lsp-test+ , lsp-types+ , text
+ src/Ide/Plugin/Pragmas.hs view
@@ -0,0 +1,191 @@+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE DuplicateRecordFields #-}+{-# LANGUAGE NamedFieldPuns #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE TypeOperators #-}+{-# LANGUAGE ViewPatterns #-}++-- | Provides code actions to add missing pragmas (whenever GHC suggests to)+module Ide.Plugin.Pragmas (descriptor) where++import Control.Applicative ((<|>))+import Control.Lens hiding (List)+import Control.Monad (join)+import Control.Monad.IO.Class (MonadIO (liftIO))+import qualified Data.HashMap.Strict as H+import Data.List+import Data.List.Extra (nubOrdOn)+import Data.Maybe (catMaybes, listToMaybe)+import qualified Data.Text as T+import Development.IDE as D+import Development.IDE.GHC.Compat+import Ide.Types+import qualified Language.LSP.Server as LSP+import qualified Language.LSP.Types as J+import qualified Language.LSP.Types.Lens as J+import qualified Language.LSP.VFS as VFS+import qualified Text.Fuzzy as Fuzzy++-- ---------------------------------------------------------------------++descriptor :: PluginId -> PluginDescriptor IdeState+descriptor plId = (defaultPluginDescriptor plId)+ { pluginHandlers = mkPluginHandler J.STextDocumentCodeAction codeActionProvider+ <> mkPluginHandler J.STextDocumentCompletion completion+ }++-- ---------------------------------------------------------------------++-- | Title and pragma+type PragmaEdit = (T.Text, Pragma)++data Pragma = LangExt T.Text | OptGHC T.Text+ deriving (Show, Eq, Ord)++codeActionProvider :: PluginMethodHandler IdeState 'J.TextDocumentCodeAction+codeActionProvider state _plId (J.CodeActionParams _ _ docId _ (J.CodeActionContext (J.List diags) _monly)) = do+ let mFile = docId ^. J.uri & J.uriToFilePath <&> toNormalizedFilePath'+ uri = docId ^. J.uri+ pm <- liftIO $ fmap join $ runAction "Pragmas.GetParsedModule" state $ getParsedModule `traverse` mFile+ mbContents <- liftIO $ fmap (snd =<<) $ runAction "Pragmas.GetFileContents" state $ getFileContents `traverse` mFile+ let dflags = ms_hspp_opts . pm_mod_summary <$> pm+ insertRange = maybe (Range (Position 0 0) (Position 0 0)) endOfModuleHeader mbContents+ pedits = nubOrdOn snd . concat $ suggest dflags <$> diags+ return $ Right $ List $ pragmaEditToAction uri insertRange <$> pedits++-- | Add a Pragma to the given URI at the top of the file.+-- It is assumed that the pragma name is a valid pragma,+-- thus, not validated.+pragmaEditToAction :: Uri -> Range -> PragmaEdit -> (J.Command J.|? J.CodeAction)+pragmaEditToAction uri range (title, p) =+ J.InR $ J.CodeAction title (Just J.CodeActionQuickFix) (Just (J.List [])) Nothing Nothing (Just edit) Nothing Nothing+ where+ render (OptGHC x) = "{-# OPTIONS_GHC -Wno-" <> x <> " #-}\n"+ render (LangExt x) = "{-# LANGUAGE " <> x <> " #-}\n"+ textEdits = J.List [J.TextEdit range $ render p]+ edit =+ J.WorkspaceEdit+ (Just $ H.singleton uri textEdits)+ Nothing+ Nothing++suggest :: Maybe DynFlags -> Diagnostic -> [PragmaEdit]+suggest dflags diag =+ suggestAddPragma dflags diag+ ++ suggestDisableWarning diag++-- ---------------------------------------------------------------------++suggestDisableWarning :: Diagnostic -> [PragmaEdit]+suggestDisableWarning Diagnostic {_code}+ | Just (J.InR (T.stripPrefix "-W" -> Just w)) <- _code =+ pure ("Disable \"" <> w <> "\" warnings", OptGHC w)+ | otherwise = []++-- ---------------------------------------------------------------------++-- | Offer to add a missing Language Pragma to the top of a file.+-- Pragmas are defined by a curated list of known pragmas, see 'possiblePragmas'.+suggestAddPragma :: Maybe DynFlags -> Diagnostic -> [PragmaEdit]+suggestAddPragma mDynflags Diagnostic {_message} = genPragma _message+ where+ genPragma target =+ [("Add \"" <> r <> "\"", LangExt r) | r <- findPragma target, r `notElem` disabled]+ disabled+ | Just dynFlags <- mDynflags =+ -- GHC does not export 'OnOff', so we have to view it as string+ catMaybes $ T.stripPrefix "Off " . T.pack . prettyPrint <$> extensions dynFlags+ | otherwise =+ -- When the module failed to parse, we don't have access to its+ -- dynFlags. In that case, simply don't disable any pragmas.+ []++-- | Find all Pragmas are an infix of the search term.+findPragma :: T.Text -> [T.Text]+findPragma str = concatMap check possiblePragmas+ where+ check p = [p | T.isInfixOf p str]++ -- We exclude the Strict extension as it causes many false positives, see+ -- the discussion at https://github.com/haskell/ghcide/pull/638+ --+ -- We don't include the No- variants, as GHC never suggests disabling an+ -- extension in an error message.+ possiblePragmas :: [T.Text]+ possiblePragmas =+ [ name+ | FlagSpec{flagSpecName = T.pack -> name} <- xFlags+ , "Strict" /= name+ ]++-- | All language pragmas, including the No- variants+allPragmas :: [T.Text]+allPragmas =+ concat+ [ [name, "No" <> name]+ | FlagSpec{flagSpecName = T.pack -> name} <- xFlags+ ]+ <>+ -- These pragmas are not part of xFlags as they are not reversable+ -- by prepending "No".+ [ -- Safe Haskell+ "Unsafe"+ , "Trustworthy"+ , "Safe"++ -- Language Version Extensions+ , "Haskell98"+ , "Haskell2010"+ -- Maybe, GHC 2021 after its release?+ ]++-- ---------------------------------------------------------------------++completion :: PluginMethodHandler IdeState 'J.TextDocumentCompletion+completion _ide _ complParams = do+ let (J.TextDocumentIdentifier uri) = complParams ^. J.textDocument+ position = complParams ^. J.position+ contents <- LSP.getVirtualFile $ toNormalizedUri uri+ fmap (Right . J.InL) $ case (contents, uriToFilePath' uri) of+ (Just cnts, Just _path) ->+ result <$> VFS.getCompletionPrefix position cnts+ where+ result (Just pfix)+ | "{-# LANGUAGE" `T.isPrefixOf` VFS.fullLine pfix+ = J.List $ map buildCompletion+ (Fuzzy.simpleFilter (VFS.prefixText pfix) allPragmas)+ | otherwise+ = J.List []+ result Nothing = J.List []+ buildCompletion p =+ J.CompletionItem+ { _label = p,+ _kind = Just J.CiKeyword,+ _tags = Nothing,+ _detail = Nothing,+ _documentation = Nothing,+ _deprecated = Nothing,+ _preselect = Nothing,+ _sortText = Nothing,+ _filterText = Nothing,+ _insertText = Nothing,+ _insertTextFormat = Nothing,+ _insertTextMode = Nothing,+ _textEdit = Nothing,+ _additionalTextEdits = Nothing,+ _commitCharacters = Nothing,+ _command = Nothing,+ _xdata = Nothing+ }+ _ -> return $ J.List []++-- ---------------------------------------------------------------------++-- | Find first line after (last pragma / last shebang / beginning of file).+-- Useful for inserting pragmas.+endOfModuleHeader :: T.Text -> Range+endOfModuleHeader contents = Range loc loc+ where+ loc = Position line 0+ line = maybe 0 succ (lastLineWithPrefix "{-#" <|> lastLineWithPrefix "#!")+ lastLineWithPrefix pre = listToMaybe $ reverse $ findIndices (T.isPrefixOf pre) $ T.lines contents
+ test/Main.hs view
@@ -0,0 +1,197 @@+{-# LANGUAGE DuplicateRecordFields #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE ScopedTypeVariables #-}+module Main (+ main,+) where++import Control.Lens ((^.))+import qualified Data.Text as T+import qualified Data.Text.IO as T+import qualified Data.Text.Lazy as TL+import qualified Data.Text.Lazy.Encoding as TL+import qualified Ide.Plugin.Pragmas as Pragmas+import qualified Language.LSP.Types.Lens as L+import System.FilePath+import Test.Hls++main :: IO ()+main = defaultTestRunner tests++pragmasPlugin :: PluginDescriptor IdeState+pragmasPlugin = Pragmas.descriptor "pragmas"++tests :: TestTree+tests =+ testGroup "pragmas"+ [ codeActionTests+ , completionTests+ ]++codeActionTests :: TestTree+codeActionTests =+ testGroup "code actions"+ [ pragmasGolden "adds TypeSynonymInstances pragma" "NeedsPragmas" $ \path -> do+ doc <- openDoc path "haskell"+ _ <- waitForDiagnosticsFromSource doc "typecheck"+ cas <- map fromAction <$> getAllCodeActions doc+ liftIO $ "Add \"TypeSynonymInstances\"" `elem` map (^. L.title) cas @? "Contains TypeSynonymInstances code action"+ liftIO $ "Add \"FlexibleInstances\"" `elem` map (^. L.title) cas @? "Contains FlexibleInstances code action"+ executeCodeAction $ head cas+ documentContents doc++ , pragmasGolden "adds TypeApplications pragma" "TypeApplications" $ \path -> do+ doc <- openDoc path "haskell"+ _ <- waitForDiagnosticsFrom doc+ cas <- map fromAction <$> getAllCodeActions doc+ liftIO $ "Add \"TypeApplications\"" `elem` map (^. L.title) cas @? "Contains TypeApplications code action"+ executeCodeAction $ head cas+ documentContents doc++ , pragmasGolden "no duplication" "NamedFieldPuns" $ \path -> do+ doc <- openDoc path "haskell"+ _ <- waitForDiagnosticsFrom doc+ cas <- map fromAction <$> getCodeActions doc (Range (Position 8 9) (Position 8 9))+ liftIO $ length cas == 1 @? "Expected one code action, but got: " <> show cas+ let ca = head cas+ liftIO $ (ca ^. L.title == "Add \"NamedFieldPuns\"") @? "NamedFieldPuns code action"+ executeCodeAction ca+ documentContents doc++ , pragmasGolden "after shebang" "AfterShebang" $ \path -> do+ doc <- openDoc path "haskell"+ _ <- waitForDiagnosticsFrom doc+ cas <- map fromAction <$> getAllCodeActions doc+ liftIO $ "Add \"NamedFieldPuns\"" `elem` map (^. L.title) cas @? "Contains NamedFieldPuns code action"+ executeCodeAction $ head cas+ documentContents doc++ , pragmasGolden "append to existing pragmas" "AppendToExisting" $ \path -> do+ doc <- openDoc path "haskell"+ _ <- waitForDiagnosticsFrom doc+ cas <- map fromAction <$> getAllCodeActions doc+ liftIO $ "Add \"NamedFieldPuns\"" `elem` map (^. L.title) cas @? "Contains NamedFieldPuns code action"+ executeCodeAction $ head cas+ documentContents doc++ , pragmasGolden "before doc comments" "BeforeDocComment" $ \path -> do+ doc <- openDoc path "haskell"+ _ <- waitForDiagnosticsFrom doc+ cas <- map fromAction <$> getAllCodeActions doc+ liftIO $ "Add \"NamedFieldPuns\"" `elem` map (^. L.title) cas @? "Contains NamedFieldPuns code action"+ executeCodeAction $ head cas+ documentContents doc++ , pragmasGolden "before doc comments" "MissingSignatures" $ \path -> do+ doc <- openDoc path "haskell"+ _ <- waitForDiagnosticsFrom doc+ cas <- map fromAction <$> getAllCodeActions doc+ liftIO $ "Disable \"missing-signatures\" warnings" `elem` map (^. L.title) cas @? "Contains missing-signatures code action"+ executeCodeAction $ head cas+ documentContents doc++ , pragmasGolden "before doc comments" "UnusedImports" $ \path -> do+ doc <- openDoc path "haskell"+ _ <- waitForDiagnosticsFrom doc+ cas <- map fromAction <$> getAllCodeActions doc+ liftIO $ "Disable \"unused-imports\" warnings" `elem` map (^. L.title) cas @? "Contains unused-imports code action"+ executeCodeAction $ head cas+ documentContents doc+ ]++completionTests :: TestTree+completionTests =+ testGroup "completions"+ [ testCase "completes pragmas" $ runSessionWithServer pragmasPlugin testDirectory $ do+ doc <- openDoc "Completion.hs" "haskell"+ _ <- waitForDiagnostics+ let te = TextEdit (Range (Position 0 4) (Position 0 34)) ""+ _ <- applyEdit doc te+ compls <- getCompletions doc (Position 0 4)+ let item = head $ filter ((== "LANGUAGE") . (^. L.label)) compls+ liftIO $ do+ item ^. L.label @?= "LANGUAGE"+ item ^. L.kind @?= Just CiKeyword+ item ^. L.insertTextFormat @?= Just Snippet+ item ^. L.insertText @?= Just "LANGUAGE ${1:extension} #-}"++ , testCase "completes pragmas no close" $ runSessionWithServer pragmasPlugin testDirectory $ do+ doc <- openDoc "Completion.hs" "haskell"+ let te = TextEdit (Range (Position 0 4) (Position 0 24)) ""+ _ <- applyEdit doc te+ compls <- getCompletions doc (Position 0 4)+ let item = head $ filter ((== "LANGUAGE") . (^. L.label)) compls+ liftIO $ do+ item ^. L.label @?= "LANGUAGE"+ item ^. L.kind @?= Just CiKeyword+ item ^. L.insertTextFormat @?= Just Snippet+ item ^. L.insertText @?= Just "LANGUAGE ${1:extension}"++ , testCase "completes options pragma" $ runSessionWithServer pragmasPlugin testDirectory $ do+ doc <- openDoc "Completion.hs" "haskell"+ _ <- waitForDiagnostics+ let te = TextEdit (Range (Position 0 4) (Position 0 34)) "OPTIONS"+ _ <- applyEdit doc te+ compls <- getCompletions doc (Position 0 4)+ let item = head $ filter ((== "OPTIONS_GHC") . (^. L.label)) compls+ liftIO $ do+ item ^. L.label @?= "OPTIONS_GHC"+ item ^. L.kind @?= Just CiKeyword+ item ^. L.insertTextFormat @?= Just Snippet+ item ^. L.insertText @?= Just "OPTIONS_GHC -${1:option} #-}"++ , testCase "completes ghc options pragma values" $ runSessionWithServer pragmasPlugin testDirectory $ do+ doc <- openDoc "Completion.hs" "haskell"+ let te = TextEdit (Range (Position 0 0) (Position 0 0)) "{-# OPTIONS_GHC -Wno-red #-}\n"+ _ <- applyEdit doc te+ compls <- getCompletions doc (Position 0 24)+ let item = head $ filter ((== "Wno-redundant-constraints") . (^. L.label)) compls+ liftIO $ do+ item ^. L.label @?= "Wno-redundant-constraints"+ item ^. L.kind @?= Just CiKeyword+ item ^. L.insertTextFormat @?= Nothing+ item ^. L.insertText @?= Nothing++ , testCase "completes language extensions" $ runSessionWithServer pragmasPlugin testDirectory $ do+ doc <- openDoc "Completion.hs" "haskell"+ _ <- waitForDiagnostics+ let te = TextEdit (Range (Position 0 24) (Position 0 31)) ""+ _ <- applyEdit doc te+ compls <- getCompletions doc (Position 0 24)+ let item = head $ filter ((== "OverloadedStrings") . (^. L.label)) compls+ liftIO $ do+ item ^. L.label @?= "OverloadedStrings"+ item ^. L.kind @?= Just CiKeyword++ , testCase "completes the Strict language extension" $ runSessionWithServer pragmasPlugin testDirectory $ do+ doc <- openDoc "Completion.hs" "haskell"+ _ <- waitForDiagnostics+ let te = TextEdit (Range (Position 0 13) (Position 0 31)) "Str"+ _ <- applyEdit doc te+ compls <- getCompletions doc (Position 0 16)+ let item = head $ filter ((== "Strict") . (^. L.label)) compls+ liftIO $ do+ item ^. L.label @?= "Strict"+ item ^. L.kind @?= Just CiKeyword++ , testCase "completes No- language extensions" $ runSessionWithServer pragmasPlugin testDirectory $ do+ doc <- openDoc "Completion.hs" "haskell"+ _ <- waitForDiagnostics+ let te = TextEdit (Range (Position 0 13) (Position 0 31)) "NoOverload"+ _ <- applyEdit doc te+ compls <- getCompletions doc (Position 0 23)+ let item = head $ filter ((== "NoOverloadedStrings") . (^. L.label)) compls+ liftIO $ do+ item ^. L.label @?= "NoOverloadedStrings"+ item ^. L.kind @?= Just CiKeyword+ ]++pragmasGolden :: TestName -> FilePath -> (FilePath -> Session T.Text) -> TestTree+pragmasGolden title path action =+ goldenGitDiff title (testDirectory </> path <.> "expected.hs")+ $ runSessionWithServer pragmasPlugin testDirectory+ $ TL.encodeUtf8 . TL.fromStrict+ <$> action (path <.> "hs")++testDirectory :: FilePath+testDirectory = "test" </> "testdata"
+ test/testdata/AfterShebang.expected.hs view
@@ -0,0 +1,13 @@+#! /usr/bin/env nix-shell+#! nix-shell --pure -i runghc -p "haskellPackages.ghcWithPackages (hp: with hp; [ turtle ])"+{-# LANGUAGE NamedFieldPuns #-}++module AfterShebang where++data Record = Record+ { a :: Int,+ b :: Double,+ c :: String+ }++f Record{a, b} = a
+ test/testdata/AfterShebang.hs view
@@ -0,0 +1,12 @@+#! /usr/bin/env nix-shell+#! nix-shell --pure -i runghc -p "haskellPackages.ghcWithPackages (hp: with hp; [ turtle ])"++module AfterShebang where++data Record = Record+ { a :: Int,+ b :: Double,+ c :: String+ }++f Record{a, b} = a
+ test/testdata/AppendToExisting.expected.hs view
@@ -0,0 +1,12 @@+-- | Doc before pragma+{-# OPTIONS_GHC -Wno-dodgy-imports #-}+{-# LANGUAGE NamedFieldPuns #-}+module AppendToExisting where++data Record = Record+ { a :: Int,+ b :: Double,+ c :: String+ }++f Record{a, b} = a
+ test/testdata/AppendToExisting.hs view
@@ -0,0 +1,11 @@+-- | Doc before pragma+{-# OPTIONS_GHC -Wno-dodgy-imports #-}+module AppendToExisting where++data Record = Record+ { a :: Int,+ b :: Double,+ c :: String+ }++f Record{a, b} = a
+ test/testdata/BeforeDocComment.expected.hs view
@@ -0,0 +1,15 @@+#! /usr/bin/env nix-shell+#! nix-shell --pure -i runghc -p "haskellPackages.ghcWithPackages (hp: with hp; [ turtle ])"+{-# LANGUAGE NamedFieldPuns #-}+-- | Doc Comment+{- Block -}++module BeforeDocComment where++data Record = Record+ { a :: Int,+ b :: Double,+ c :: String+ }++f Record{a, b} = a
+ test/testdata/BeforeDocComment.hs view
@@ -0,0 +1,14 @@+#! /usr/bin/env nix-shell+#! nix-shell --pure -i runghc -p "haskellPackages.ghcWithPackages (hp: with hp; [ turtle ])"+-- | Doc Comment+{- Block -}++module BeforeDocComment where++data Record = Record+ { a :: Int,+ b :: Double,+ c :: String+ }++f Record{a, b} = a
+ test/testdata/Completion.hs view
@@ -0,0 +1,9 @@+{-# LANGUAGE OverloadedStrings #-}+import Data.Maybe+import qualified Data.List++main :: IO ()+main = putStrLn "hello"++foo :: Either a b -> Either a b+foo = id
+ test/testdata/MissingSignatures.expected.hs view
@@ -0,0 +1,3 @@+{-# OPTIONS_GHC -Wall #-}+{-# OPTIONS_GHC -Wno-missing-signatures #-}+main = putStrLn "hello"
+ test/testdata/MissingSignatures.hs view
@@ -0,0 +1,2 @@+{-# OPTIONS_GHC -Wall #-}+main = putStrLn "hello"
+ test/testdata/NamedFieldPuns.expected.hs view
@@ -0,0 +1,10 @@+{-# LANGUAGE NamedFieldPuns #-}+module NamedFieldPuns where++data Record = Record+ { a :: Int,+ b :: Double,+ c :: String+ }++f Record{a, b} = a
+ test/testdata/NamedFieldPuns.hs view
@@ -0,0 +1,9 @@+module NamedFieldPuns where++data Record = Record+ { a :: Int,+ b :: Double,+ c :: String+ }++f Record{a, b} = a
+ test/testdata/NeedsPragmas.expected.hs view
@@ -0,0 +1,17 @@+{-# LANGUAGE TypeSynonymInstances #-}+module NeedsPragmas where++import GHC.Generics++main = putStrLn "hello"++type Foo = Int++instance Show Foo where+ show x = undefined++instance Show (Int,String) where+ show = undefined++data FFF a = FFF Int String a+ deriving (Generic,Functor,Traversable)
+ test/testdata/NeedsPragmas.hs view
@@ -0,0 +1,16 @@+module NeedsPragmas where++import GHC.Generics++main = putStrLn "hello"++type Foo = Int++instance Show Foo where+ show x = undefined++instance Show (Int,String) where+ show = undefined++data FFF a = FFF Int String a+ deriving (Generic,Functor,Traversable)
+ test/testdata/TypeApplications.expected.hs view
@@ -0,0 +1,6 @@+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TypeApplications #-}+module TypeApplications where++foo :: forall a. a -> a+foo = id @a
+ test/testdata/TypeApplications.hs view
@@ -0,0 +1,5 @@+{-# LANGUAGE ScopedTypeVariables #-}+module TypeApplications where++foo :: forall a. a -> a+foo = id @a
+ test/testdata/UnusedImports.expected.hs view
@@ -0,0 +1,7 @@+{-# OPTIONS_GHC -Wall #-}+{-# OPTIONS_GHC -Wno-unused-imports #-}+++module M where++import Data.Functor
+ test/testdata/UnusedImports.hs view
@@ -0,0 +1,6 @@+{-# OPTIONS_GHC -Wall #-}+++module M where++import Data.Functor
+ test/testdata/hie.yaml view
@@ -0,0 +1,6 @@+cradle:+ direct:+ arguments:+ - "NeedsPragmas"+ - "TypeApplications"+ - "NamedFieldPuns"