Skip to content

Commit 4b5b209

Browse files
uhbif19uhbif19
committed
Initial HIndent support
1 parent e64b61e commit 4b5b209

13 files changed

+505
-0
lines changed

‎cabal.project

+6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ packages:
2929
./plugins/hls-selection-range-plugin
3030
./plugins/hls-change-type-signature-plugin
3131
./plugins/hls-gadt-plugin
32+
./plugins/hls-hident-plugin
33+
34+
source-repository-package
35+
type: git
36+
location: https://github.com/uhbif19/hindent.git
37+
tag: dda88a4ab9fefbd07ba2614c02fecf73b20fe9d5
3238

3339
-- Standard location for temporary packages needed for particular environments
3440
-- For example it is used in the project gitlab mirror to help in the MAcOS M1 build script

‎exe/Plugins.hs

+8
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,11 @@ import qualified Ide.Plugin.StylishHaskell as StylishHaskell
108108
import qualified Ide.Plugin.Brittany as Brittany
109109
#endif
110110

111+
#if hindent
112+
import qualified Ide.Plugin.HIndent as HIndent
113+
#endif
114+
115+
111116
data Log = forall a. (Pretty a) => Log a
112117

113118
instance Pretty Log where
@@ -156,6 +161,9 @@ idePlugins recorder includeExamples = pluginDescToIdePlugins allPlugins
156161
#if brittany
157162
Brittany.descriptor "brittany" :
158163
#endif
164+
#if hindent
165+
HIndent.descriptor "hindent" :
166+
#endif
159167
#if callHierarchy
160168
CallHierarchy.descriptor :
161169
#endif

‎haskell-language-server.cabal

+12
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,12 @@ flag brittany
218218
default: True
219219
manual: True
220220

221+
flag hindent
222+
description: Enable hindent plugin
223+
default: True
224+
manual: True
225+
226+
221227
flag dynamic
222228
description: Build with the dyn rts
223229
default: True
@@ -340,6 +346,11 @@ common stylishHaskell
340346
build-depends: hls-stylish-haskell-plugin ^>= 1.0
341347
cpp-options: -DstylishHaskell
342348

349+
common hindent
350+
if flag(hindent)
351+
build-depends: hls-hindent-plugin ^>= 1.0
352+
cpp-options: -Dhindent
353+
343354
common brittany
344355
if flag(brittany) && (impl(ghc < 9.0.2) || flag(ignore-plugins-ghc-bounds))
345356
build-depends: hls-brittany-plugin ^>= 1.0
@@ -375,6 +386,7 @@ executable haskell-language-server
375386
, ormolu
376387
, stylishHaskell
377388
, brittany
389+
, hindent
378390

379391
main-is: Main.hs
380392
hs-source-dirs: exe

‎plugins/hls-hident-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.

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

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
cabal-version: 2.4
2+
name: hls-hindent-plugin
3+
version: 1.0.0.0
4+
synopsis: Integration with the HIndent code formatter
5+
description:
6+
Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>
7+
license: Apache-2.0
8+
license-file: LICENSE
9+
author: The Haskell IDE Team
10+
copyright: The Haskell IDE Team
11+
maintainer: uhbif19@gmail.com
12+
category: Development
13+
build-type: Simple
14+
extra-source-files:
15+
LICENSE
16+
test/testdata/*.hs
17+
18+
library
19+
exposed-modules:
20+
Ide.Plugin.HIndent
21+
other-modules:
22+
Path.Find
23+
hs-source-dirs: src
24+
build-depends:
25+
, base >=4.12 && <5
26+
, binary
27+
, bytestring
28+
, deepseq
29+
, exceptions
30+
, filepath
31+
, ghcide ^>=1.7
32+
, hindent ^>=5.3.2
33+
, hls-plugin-api ^>=1.4
34+
, lsp-types
35+
, path
36+
, path-io
37+
, text
38+
, unix-compat
39+
, yaml
40+
41+
default-language: Haskell2010
42+
43+
test-suite tests
44+
type: exitcode-stdio-1.0
45+
default-language: Haskell2010
46+
hs-source-dirs: test
47+
main-is: Main.hs
48+
ghc-options: -threaded -rtsopts -with-rtsopts=-N
49+
build-depends:
50+
, base
51+
, filepath
52+
, hls-hindent-plugin
53+
, hls-test-utils ^>=1.3

‎plugins/hls-hident-plugin/src/Ide/Plugin/HIndent.hs

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{-# LANGUAGE OverloadedStrings #-}
2+
module Ide.Plugin.HIndent
3+
(
4+
descriptor
5+
, provider
6+
)
7+
where
8+
9+
import Control.Monad.IO.Class (liftIO)
10+
import Data.Binary.Builder (toLazyByteString)
11+
import qualified Data.ByteString as B (concat)
12+
import qualified Data.ByteString.Lazy as BL (toChunks)
13+
import qualified Data.Text as T
14+
import qualified Data.Text.Encoding as TE
15+
import qualified Data.Yaml
16+
import Development.IDE (IdeState, fromNormalizedFilePath)
17+
import HIndent (reformat)
18+
import HIndent.Types (Config, defaultConfig)
19+
import Ide.PluginUtils (extractRange, fullRange, normalize,
20+
responseError)
21+
import Ide.Types (FormattingHandler,
22+
FormattingType (FormatRange, FormatText),
23+
PluginDescriptor (pluginHandlers),
24+
PluginId, defaultPluginDescriptor,
25+
mkFormattingHandlers)
26+
import Language.LSP.Types as J (List (List), TextEdit (TextEdit))
27+
import Path (filename, toFilePath)
28+
import qualified Path.Find as Path
29+
import qualified Path.IO as Path
30+
31+
descriptor :: PluginId -> PluginDescriptor IdeState
32+
descriptor plId = (defaultPluginDescriptor plId)
33+
{ pluginHandlers = mkFormattingHandlers provider
34+
}
35+
36+
provider :: FormattingHandler IdeState
37+
provider ide typ contents fp _opts = do
38+
let file = fromNormalizedFilePath fp
39+
let (range, selectedContents) = case typ of
40+
FormatText -> (fullRange contents, contents)
41+
FormatRange r -> (normalize r, extractRange r contents)
42+
let extensions = Nothing -- Extensions should be covered by Config
43+
config <- liftIO getHIndentConfig
44+
let result = HIndent.reformat config extensions (Just file) (TE.encodeUtf8 selectedContents)
45+
convertToTextEdit result range
46+
where
47+
builderToText = TE.decodeUtf8 . B.concat . BL.toChunks . toLazyByteString
48+
convertToTextEdit result range = case result of
49+
Left err -> return $ Left $ responseError $ T.pack $ "hident: " ++ err
50+
Right new -> return $ Right $ J.List [TextEdit range (builderToText new)]
51+
52+
-- Copied from
53+
-- https://github.com/mihaimaruseac/hindent/blob/master/src/main/Main.hs#L77
54+
55+
getHIndentConfig :: IO Config
56+
getHIndentConfig = do
57+
cur <- Path.getCurrentDir
58+
homeDir <- Path.getHomeDir
59+
mfile <-
60+
Path.findFileUp cur ((== ".hindent.yaml") . toFilePath . filename) (Just homeDir)
61+
case mfile of
62+
Nothing -> return defaultConfig
63+
Just file -> do
64+
result <- Data.Yaml.decodeFileEither (toFilePath file)
65+
case result of
66+
Left e -> error (show e)
67+
Right config -> return config

0 commit comments

Comments
 (0)