Skip to content

Commit 5673556

Browse files
authored
Merge pull request #166 from jneira/hlint-plugin-ghc-lib
Hlint plugin using ghc-lib
2 parents b3f7ec8 + 94b7a3e commit 5673556

26 files changed

+882
-144
lines changed

Diff for: .github/workflows/test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,5 @@ jobs:
6464
# run the tests without parallelism, otherwise tasty will attempt to run
6565
# all functional test cases simultaneously which causes way too many hls
6666
# instances to be spun up for the poor github actions runner to handle
67-
run: cabal test --test-options=-j1
67+
run: cabal test --test-options="-j1 --rerun-update" || cabal test --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test --test-options="-j1 --rerun"
6868

Diff for: .gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ cabal.project.local
66
*~
77
*.lock
88

9+
.tasty-rerun-log
10+
911
# shake build information
1012
_build/
1113

Diff for: cabal.project

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ packages:
33
ghcide
44
hls-plugin-api
55
./plugins/tactics
6+
./plugins/hls-hlint-plugin
67

78
source-repository-package
89
type: git

Diff for: exe/Main.hs

+4-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import Ide.Main (defaultMain)
1111
import Ide.Types (IdePlugins)
1212

1313
-- haskell-language-server plugins
14+
1415
import Ide.Plugin.Eval as Eval
1516
import Ide.Plugin.Example as Example
1617
import Ide.Plugin.Example2 as Example2
@@ -22,6 +23,7 @@ import Ide.Plugin.Ormolu as Ormolu
2223
import Ide.Plugin.Retrie as Retrie
2324
import Ide.Plugin.StylishHaskell as StylishHaskell
2425
import Ide.Plugin.Tactic as Tactic
26+
import Ide.Plugin.Hlint as Hlint
2527
#if AGPL
2628
import Ide.Plugin.Brittany as Brittany
2729
#endif
@@ -55,11 +57,12 @@ idePlugins includeExamples = pluginDescToIdePlugins allPlugins
5557
, StylishHaskell.descriptor "stylish-haskell"
5658
, Retrie.descriptor "retrie"
5759
#if AGPL
58-
, Brittany.descriptor "brittany"
60+
, Brittany.descriptor "brittany"
5961
#endif
6062
, Eval.descriptor "eval"
6163
, ImportLens.descriptor "importLens"
6264
, ModuleName.descriptor "moduleName"
65+
, Hlint.descriptor "hlint"
6366
]
6467
examplePlugins =
6568
[Example.descriptor "eg"

Diff for: haskell-language-server.cabal

+4-1
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ library
7777

7878
default-language: Haskell2010
7979

80+
8081
executable haskell-language-server
8182
import: agpl, common-deps
8283
main-is: Main.hs
@@ -119,6 +120,7 @@ executable haskell-language-server
119120
, hashable
120121
, haskell-language-server
121122
, haskell-lsp ^>=0.22
123+
, hls-hlint-plugin
122124
, hls-plugin-api
123125
, hls-tactics-plugin
124126
, lens
@@ -197,7 +199,7 @@ common hls-test-utils
197199
, hslogger
198200
, hspec
199201
, hspec-core
200-
, lsp-test >=0.11.0.4
202+
, lsp-test >=0.11.0.6
201203
, stm
202204
, tasty-hunit
203205
, temporary
@@ -274,6 +276,7 @@ test-suite wrapper-test
274276
, process
275277
, tasty
276278
, tasty-ant-xml >=1.1.6
279+
, tasty-rerun
277280

278281
hs-source-dirs: test/wrapper
279282
main-is: Main.hs

Diff for: hie.yaml.cbl

+4-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ cradle:
3434
- path: "./src"
3535
component: "lib:haskell-language-server"
3636

37-
- path: "./.stack-work/"
37+
- path: "./dist-newstyle/"
3838
component: "lib:haskell-language-server"
3939

4040
- path: "./ghcide/src"
@@ -45,3 +45,6 @@ cradle:
4545

4646
- path: "./hls-plugin-api/src"
4747
component: "hls-plugin-api:lib:hls-plugin-api"
48+
49+
- path: "./plugins/hls-hlint-plugin/src"
50+
component: "lib:hls-hlint-plugin"

Diff for: hie.yaml.stack

+3
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,6 @@ cradle:
4848

4949
- path: "./hls-plugin-api/src"
5050
component: "hls-plugin-api:lib:hls-plugin-api"
51+
52+
- path: "./plugins/hls-hlint-plugin/src"
53+
component: "hls-hlint-plugin:lib:hls-hlint-plugin"

Diff for: hls-plugin-api/hls-plugin-api.cabal

+1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ library
4444
, ghc-boot-th
4545
, ghcide >=0.4
4646
, haskell-lsp ^>=0.22
47+
, hashable
4748
, hslogger
4849
, lens
4950
, process

Diff for: hls-plugin-api/src/Ide/Plugin.hs

+13
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ module Ide.Plugin
1717
, allLspCmdIds'
1818
, getPid
1919
, responseError
20+
, getClientConfig
21+
, getClientConfigAction
2022
) where
2123

2224
import Control.Exception(SomeException, catch)
@@ -25,13 +27,15 @@ import Control.Monad
2527
import qualified Data.Aeson as J
2628
import qualified Data.Default
2729
import Data.Either
30+
import Data.Hashable (unhashed)
2831
import qualified Data.List as List
2932
import qualified Data.Map as Map
3033
import Data.Maybe
3134
import qualified Data.Text as T
3235
import Development.IDE hiding (pluginRules)
3336
import Development.IDE.LSP.Server
3437
import GHC.Generics
38+
import Ide.Logger
3539
import Ide.Plugin.Config
3640
import Ide.Plugin.Formatter
3741
import Ide.Types
@@ -588,4 +592,13 @@ getPrefixAtPos lf uri pos = do
588592
getClientConfig :: LSP.LspFuncs Config -> IO Config
589593
getClientConfig lf = fromMaybe Data.Default.def <$> LSP.config lf
590594

595+
-- | Returns the client configurarion stored in the IdeState.
596+
-- You can use this function to access it from shake Rules
597+
getClientConfigAction :: Action Config
598+
getClientConfigAction = do
599+
mbVal <- unhashed <$> useNoFile_ GetClientSettings
600+
logm $ "getClientConfigAction:clientSettings:" ++ show mbVal
601+
case J.fromJSON <$> mbVal of
602+
Just (J.Success c) -> return c
603+
_ -> return Data.Default.def
591604
-- ---------------------------------------------------------------------

Diff for: plugins/hls-hlint-plugin/LICENSE

+201
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.

0 commit comments

Comments
 (0)