Skip to content

Commit 7d7cfa2

Browse files
AilrunAilrun
authored
Extract pragmas plugin (#1833)
1 parent 0772f2d commit 7d7cfa2

36 files changed

+581
-367
lines changed

‎cabal.project

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ packages:
1919
./plugins/hls-haddock-comments-plugin
2020
./plugins/hls-splice-plugin
2121
./plugins/hls-floskell-plugin
22+
./plugins/hls-pragmas-plugin
2223
tests: true
2324

2425
package *

‎haskell-language-server.cabal

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,7 @@ common moduleName
237237

238238
common pragmas
239239
if flag(pragmas) || flag(all-plugins)
240-
hs-source-dirs: plugins/default/src
241-
build-depends: fuzzy
242-
other-modules: Ide.Plugin.Pragmas
240+
build-depends: hls-pragmas-plugin ^>= 1.0.0.0
243241
cpp-options: -Dpragmas
244242

245243
common splice

‎nix/default.nix

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ let
4343
hls-splice-plugin = gitignoreSource ../plugins/hls-splice-plugin;
4444
hls-tactics-plugin = gitignoreSource ../plugins/hls-tactics-plugin;
4545
hls-floskell-plugin = gitignoreSource ../plugins/hls-floskell-plugin;
46+
hls-pragmas-plugin = gitignoreSource ../plugins/hls-pragmas-plugin;
4647
};
4748
gitignoreSource = (import sources.gitignore { inherit (pkgs) lib; }).gitignoreSource;
4849
extended = haskellPackages:

‎plugins/hls-pragmas-plugin/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎plugins/hls-pragmas-plugin/hls-pragmas-plugin.cabal

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
cabal-version: 2.4
2+
name: hls-pragmas-plugin
3+
version: 1.0.0.0
4+
synopsis: Pragmas plugin for Haskell Language Server
5+
description:
6+
Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>
7+
8+
license: Apache-2.0
9+
license-file: LICENSE
10+
author: The Haskell IDE Team
11+
copyright: The Haskell IDE Team
12+
maintainer: alan.zimm@gmail.com
13+
category: Development
14+
build-type: Simple
15+
extra-source-files:
16+
LICENSE
17+
test/testdata/*.hs
18+
test/testdata/*.yaml
19+
20+
library
21+
exposed-modules: Ide.Plugin.Pragmas
22+
hs-source-dirs: src
23+
build-depends:
24+
base >=4.12 && <5
25+
, extra
26+
, fuzzy
27+
, ghcide >=1.2 && <1.4
28+
, hls-plugin-api ^>=1.1
29+
, lens
30+
, lsp
31+
, text
32+
, transformers
33+
, unordered-containers
34+
default-language: Haskell2010
35+
36+
test-suite tests
37+
type: exitcode-stdio-1.0
38+
default-language: Haskell2010
39+
hs-source-dirs: test
40+
main-is: Main.hs
41+
ghc-options: -threaded -rtsopts -with-rtsopts=-N
42+
build-depends:
43+
, base
44+
, filepath
45+
, hls-pragmas-plugin
46+
, hls-test-utils ^>=1.0
47+
, lens
48+
, lsp-test
49+
, lsp-types
50+
, text

‎plugins/default/src/Ide/Plugin/Pragmas.hs renamed to ‎plugins/hls-pragmas-plugin/src/Ide/Plugin/Pragmas.hs

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
{-# LANGUAGE DataKinds #-}
12
{-# LANGUAGE DuplicateRecordFields #-}
23
{-# LANGUAGE NamedFieldPuns #-}
34
{-# LANGUAGE OverloadedStrings #-}
5+
{-# LANGUAGE TypeOperators #-}
46
{-# LANGUAGE ViewPatterns #-}
57

68
-- | Provides code actions to add missing pragmas (whenever GHC suggests to)
@@ -9,7 +11,7 @@ module Ide.Plugin.Pragmas (descriptor) where
911
import Control.Applicative ((<|>))
1012
import Control.Lens hiding (List)
1113
import Control.Monad (join)
12-
import Control.Monad.IO.Class
14+
import Control.Monad.IO.Class (MonadIO (liftIO))
1315
import qualified Data.HashMap.Strict as H
1416
import Data.List
1517
import Data.List.Extra (nubOrdOn)
@@ -19,7 +21,6 @@ import Development.IDE as D
1921
import Development.IDE.GHC.Compat
2022
import Ide.Types
2123
import qualified Language.LSP.Server as LSP
22-
import Language.LSP.Types
2324
import qualified Language.LSP.Types as J
2425
import qualified Language.LSP.Types.Lens as J
2526
import qualified Language.LSP.VFS as VFS
@@ -29,8 +30,8 @@ import qualified Text.Fuzzy as Fuzzy
2930

3031
descriptor :: PluginId -> PluginDescriptor IdeState
3132
descriptor plId = (defaultPluginDescriptor plId)
32-
{ pluginHandlers = mkPluginHandler STextDocumentCodeAction codeActionProvider
33-
<> mkPluginHandler STextDocumentCompletion completion
33+
{ pluginHandlers = mkPluginHandler J.STextDocumentCodeAction codeActionProvider
34+
<> mkPluginHandler J.STextDocumentCompletion completion
3435
}
3536

3637
-- ---------------------------------------------------------------------
@@ -41,12 +42,12 @@ type PragmaEdit = (T.Text, Pragma)
4142
data Pragma = LangExt T.Text | OptGHC T.Text
4243
deriving (Show, Eq, Ord)
4344

44-
codeActionProvider :: PluginMethodHandler IdeState TextDocumentCodeAction
45-
codeActionProvider state _plId (CodeActionParams _ _ docId _ (J.CodeActionContext (J.List diags) _monly)) = do
46-
let mFile = docId ^. J.uri & uriToFilePath <&> toNormalizedFilePath'
45+
codeActionProvider :: PluginMethodHandler IdeState 'J.TextDocumentCodeAction
46+
codeActionProvider state _plId (J.CodeActionParams _ _ docId _ (J.CodeActionContext (J.List diags) _monly)) = do
47+
let mFile = docId ^. J.uri & J.uriToFilePath <&> toNormalizedFilePath'
4748
uri = docId ^. J.uri
4849
pm <- liftIO $ fmap join $ runAction "Pragmas.GetParsedModule" state $ getParsedModule `traverse` mFile
49-
mbContents <- liftIO $ fmap (join . fmap snd) $ runAction "Pragmas.GetFileContents" state $ getFileContents `traverse` mFile
50+
mbContents <- liftIO $ fmap (snd =<<) $ runAction "Pragmas.GetFileContents" state $ getFileContents `traverse` mFile
5051
let dflags = ms_hspp_opts . pm_mod_summary <$> pm
5152
insertRange = maybe (Range (Position 0 0) (Position 0 0)) endOfModuleHeader mbContents
5253
pedits = nubOrdOn snd . concat $ suggest dflags <$> diags
@@ -55,9 +56,9 @@ codeActionProvider state _plId (CodeActionParams _ _ docId _ (J.CodeActionContex
5556
-- | Add a Pragma to the given URI at the top of the file.
5657
-- It is assumed that the pragma name is a valid pragma,
5758
-- thus, not validated.
58-
pragmaEditToAction :: Uri -> Range -> PragmaEdit -> (Command |? CodeAction)
59+
pragmaEditToAction :: Uri -> Range -> PragmaEdit -> (J.Command J.|? J.CodeAction)
5960
pragmaEditToAction uri range (title, p) =
60-
InR $ J.CodeAction title (Just J.CodeActionQuickFix) (Just (J.List [])) Nothing Nothing (Just edit) Nothing Nothing
61+
J.InR $ J.CodeAction title (Just J.CodeActionQuickFix) (Just (J.List [])) Nothing Nothing (Just edit) Nothing Nothing
6162
where
6263
render (OptGHC x) = "{-# OPTIONS_GHC -Wno-" <> x <> " #-}\n"
6364
render (LangExt x) = "{-# LANGUAGE " <> x <> " #-}\n"
@@ -77,7 +78,7 @@ suggest dflags diag =
7778

7879
suggestDisableWarning :: Diagnostic -> [PragmaEdit]
7980
suggestDisableWarning Diagnostic {_code}
80-
| Just (InR (T.stripPrefix "-W" -> Just w)) <- _code =
81+
| Just (J.InR (T.stripPrefix "-W" -> Just w)) <- _code =
8182
pure ("Disable \"" <> w <> "\" warnings", OptGHC w)
8283
| otherwise = []
8384

@@ -140,26 +141,26 @@ allPragmas =
140141

141142
-- ---------------------------------------------------------------------
142143

143-
completion :: PluginMethodHandler IdeState TextDocumentCompletion
144+
completion :: PluginMethodHandler IdeState 'J.TextDocumentCompletion
144145
completion _ide _ complParams = do
145-
let (TextDocumentIdentifier uri) = complParams ^. J.textDocument
146+
let (J.TextDocumentIdentifier uri) = complParams ^. J.textDocument
146147
position = complParams ^. J.position
147148
contents <- LSP.getVirtualFile $ toNormalizedUri uri
148-
fmap (Right . InL) $ case (contents, uriToFilePath' uri) of
149+
fmap (Right . J.InL) $ case (contents, uriToFilePath' uri) of
149150
(Just cnts, Just _path) ->
150151
result <$> VFS.getCompletionPrefix position cnts
151152
where
152153
result (Just pfix)
153154
| "{-# LANGUAGE" `T.isPrefixOf` VFS.fullLine pfix
154-
= List $ map buildCompletion
155+
= J.List $ map buildCompletion
155156
(Fuzzy.simpleFilter (VFS.prefixText pfix) allPragmas)
156157
| otherwise
157-
= List []
158-
result Nothing = List []
158+
= J.List []
159+
result Nothing = J.List []
159160
buildCompletion p =
160-
CompletionItem
161+
J.CompletionItem
161162
{ _label = p,
162-
_kind = Just CiKeyword,
163+
_kind = Just J.CiKeyword,
163164
_tags = Nothing,
164165
_detail = Nothing,
165166
_documentation = Nothing,
@@ -176,7 +177,7 @@ completion _ide _ complParams = do
176177
_command = Nothing,
177178
_xdata = Nothing
178179
}
179-
_ -> return $ List []
180+
_ -> return $ J.List []
180181

181182
-- ---------------------------------------------------------------------
182183

0 commit comments

Comments
 (0)