Skip to content

Commit 3ee15cb

Browse files
committed
Extract fourmolu plugin into a standalone package
1 parent 1538140 commit 3ee15cb

22 files changed

+333
-17
lines changed

.github/workflows/test.yml

+4
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,10 @@ jobs:
170170
name: Test hls-stylish-haskell-plugin
171171
run: cabal test hls-stylish-haskell-plugin --test-options="-j1 --rerun-update" || cabal test hls-stylish-haskell-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-stylish-haskell-plugin --test-options="-j1 --rerun"
172172

173+
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
174+
name: Test hls-fourmolu-plugin
175+
run: cabal test hls-fourmolu-plugin --test-options="-j1 --rerun-update" || cabal test hls-fourmolu-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-fourmolu-plugin --test-options="-j1 --rerun"
176+
173177
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
174178
name: Test hls-tactics-plugin test suite
175179
run: cabal test hls-tactics-plugin --test-options="-j1 --rerun-update" || cabal test hls-tactics-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-tactics-plugin --test-options="-j1 --rerun"

cabal.project

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ packages:
99
./plugins/hls-tactics-plugin
1010
./plugins/hls-brittany-plugin
1111
./plugins/hls-stylish-haskell-plugin
12+
./plugins/hls-fourmolu-plugin
1213
./plugins/hls-class-plugin
1314
./plugins/hls-eval-plugin
1415
./plugins/hls-explicit-imports-plugin

haskell-language-server.cabal

+1-3
Original file line numberDiff line numberDiff line change
@@ -256,9 +256,7 @@ common floskell
256256

257257
common fourmolu
258258
if flag(fourmolu) || flag(all-formatters)
259-
hs-source-dirs: plugins/default/src
260-
other-modules: Ide.Plugin.Fourmolu
261-
build-depends: fourmolu ^>=0.3
259+
build-depends: hls-fourmolu-plugin ^>= 1.0.0.0
262260
cpp-options: -Dfourmolu
263261

264262
common ormolu

nix/default.nix

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ let
3232
hls-test-utils = gitignoreSource ../hls-test-utils;
3333
hls-brittany-plugin = gitignoreSource ../plugins/hls-brittany-plugin;
3434
hls-stylish-haskell-plugin = gitignoreSource ../plugins/hls-stylish-haskell-plugin;
35+
hls-fourmolu-plugin = gitignoreSource ../plugins/hls-fourmolu-plugin;
3536
hls-class-plugin = gitignoreSource ../plugins/hls-class-plugin;
3637
hls-haddock-comments-plugin = gitignoreSource ../plugins/hls-haddock-comments-plugin;
3738
hls-eval-plugin = gitignoreSource ../plugins/hls-eval-plugin;

plugins/hls-fourmolu-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 2021 The Haskell IDE team
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.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
cabal-version: 2.4
2+
name: hls-fourmolu-plugin
3+
version: 1.0.0.0
4+
synopsis: Integration with the Fourmolu code formatter
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+
19+
library
20+
exposed-modules: Ide.Plugin.Fourmolu
21+
hs-source-dirs: src
22+
build-depends:
23+
, base >=4.12 && <5
24+
, extra
25+
, fourmolu ^>=0.3
26+
, filepath
27+
, ghc
28+
, ghc-boot-th
29+
, ghcide >=1.2 && <1.4
30+
, hls-plugin-api ^>=1.1
31+
, lens
32+
, lsp
33+
, lsp-types
34+
, text
35+
36+
default-language: Haskell2010
37+
38+
test-suite tests
39+
type: exitcode-stdio-1.0
40+
default-language: Haskell2010
41+
hs-source-dirs: test
42+
main-is: Main.hs
43+
ghc-options: -threaded -rtsopts -with-rtsopts=-N
44+
build-depends:
45+
, base
46+
, bytestring
47+
, hls-fourmolu-plugin
48+
, text
49+
, data-default
50+
, hspec-expectations
51+
, lens
52+
, ghcide
53+
, filepath
54+
, hls-test-utils ^>= 1.0
55+
, lsp-types
56+
, aeson
57+
, hls-plugin-api
58+
, lsp-test
59+
, containers
60+
, unordered-containers
+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{-# LANGUAGE OverloadedStrings #-}
2+
module Main(main) where
3+
4+
import Control.Monad.IO.Class
5+
import Data.Aeson
6+
import qualified Data.ByteString.Lazy as BS
7+
import qualified Data.Text.Encoding as T
8+
import qualified Data.Text.IO as T
9+
import Language.LSP.Test
10+
import Language.LSP.Types
11+
import Test.Hls
12+
import qualified Ide.Plugin.Fourmolu as Fourmolu
13+
import System.FilePath
14+
15+
main :: IO ()
16+
main = defaultTestRunner tests
17+
18+
plugin :: PluginDescriptor IdeState
19+
plugin = Fourmolu.descriptor "fourmolu"
20+
21+
testDataDir :: FilePath
22+
testDataDir = "test/testdata/"
23+
24+
tests :: TestTree
25+
tests = testGroup "fourmolu"
26+
[ goldenGitDiff "formats correctly" (testDataDir </> "Format.fourmolu.formatted.hs") $
27+
runSessionWithServerFormatter plugin "fourmolu" testDataDir $ do
28+
doc <- openDoc "Format.hs" "haskell"
29+
formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing)
30+
BS.fromStrict . T.encodeUtf8 <$> documentContents doc
31+
, goldenGitDiff "formats imports correctly" (testDataDir </> "Format2.fourmolu.formatted.hs") $
32+
runSessionWithServerFormatter plugin "fourmolu" testDataDir $ do
33+
doc <- openDoc "Format2.hs" "haskell"
34+
formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing)
35+
BS.fromStrict . T.encodeUtf8 <$> documentContents doc
36+
]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
module Format where
2+
import Data.List
3+
4+
import Prelude
5+
import Data.Int
6+
foo :: Int -> Int
7+
foo 3 = 2
8+
foo x = x
9+
bar :: String -> IO String
10+
bar s = do
11+
x <- return "hello"
12+
return "asdf"
13+
14+
data Baz = Baz { a :: Int, b :: String }
15+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import Data.Char
2+
import Data.Either
3+
import Data.Int
4+
import Data.Data
5+
import Data.Bool

stack-8.10.2.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ packages:
2020
- ./plugins/hls-brittany-plugin
2121
- ./plugins/hls-stylish-haskell-plugin
2222
- ./plugins/hls-floskell-plugin
23+
- ./plugins/hls-fourmolu-plugin
2324

2425
ghc-options:
2526
"$everything": -haddock

stack-8.10.3.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ packages:
2020
- ./plugins/hls-brittany-plugin
2121
- ./plugins/hls-stylish-haskell-plugin
2222
- ./plugins/hls-floskell-plugin
23+
- ./plugins/hls-fourmolu-plugin
2324

2425
ghc-options:
2526
"$everything": -haddock

stack-8.10.4.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ packages:
2020
- ./plugins/hls-brittany-plugin
2121
- ./plugins/hls-stylish-haskell-plugin
2222
- ./plugins/hls-floskell-plugin
23+
- ./plugins/hls-fourmolu-plugin
2324

2425
ghc-options:
2526
"$everything": -haddock

stack-8.6.4.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ packages:
2121
- ./plugins/hls-brittany-plugin
2222
- ./plugins/hls-stylish-haskell-plugin
2323
- ./plugins/hls-floskell-plugin
24+
- ./plugins/hls-fourmolu-plugin
2425

2526
ghc-options:
2627
"$everything": -haddock

stack-8.6.5.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ packages:
2020
- ./plugins/hls-brittany-plugin
2121
- ./plugins/hls-stylish-haskell-plugin
2222
- ./plugins/hls-floskell-plugin
23+
- ./plugins/hls-fourmolu-plugin
2324

2425
ghc-options:
2526
"$everything": -haddock

0 commit comments

Comments
 (0)