Skip to content

Commit 1c1a7d0

Browse files
berbermanberberman
committed
Add haddock comments plugin
1 parent 6a692de commit 1c1a7d0

File tree

6 files changed

+337
-0
lines changed

6 files changed

+337
-0
lines changed

‎cabal.project

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ packages:
77
./plugins/hls-hlint-plugin
88
./plugins/hls-explicit-imports-plugin
99
./plugins/hls-retrie-plugin
10+
./plugins/hls-haddock-comments-plugin
1011

1112
tests: true
1213

‎exe/Main.hs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import Ide.Plugin.Retrie as Retrie
2424
import Ide.Plugin.StylishHaskell as StylishHaskell
2525
import Ide.Plugin.Tactic as Tactic
2626
import Ide.Plugin.Hlint as Hlint
27+
import Ide.Plugin.HaddockComments as HaddockComments
2728
#if AGPL
2829
import Ide.Plugin.Brittany as Brittany
2930
#endif
@@ -63,6 +64,7 @@ idePlugins includeExamples = pluginDescToIdePlugins allPlugins
6364
, ExplicitImports.descriptor "importLens"
6465
, ModuleName.descriptor "moduleName"
6566
, Hlint.descriptor "hlint"
67+
, HaddockComments.descriptor "haddockComments"
6668
]
6769
examplePlugins =
6870
[Example.descriptor "eg"

‎haskell-language-server.cabal

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ executable haskell-language-server
122122
, hls-tactics-plugin
123123
, hls-explicit-imports-plugin
124124
, hls-retrie-plugin
125+
, hls-haddock-comments-plugin
125126
, lens
126127
, ormolu ^>=0.1.2
127128
, regex-tdfa

‎plugins/hls-haddock-comments-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-haddock-comments-plugin/hls-haddock-comments-plugin.cabal

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
cabal-version: 2.2
2+
name: hls-haddock-comments-plugin
3+
version: 0.1.0.0
4+
synopsis:
5+
Haddock comments generator plugin for Haskell Language Server
6+
7+
license: Apache-2.0
8+
license-file: LICENSE
9+
author: Potato Hatsue
10+
maintainer: [email protected]
11+
category: Development
12+
build-type: Simple
13+
extra-source-files: LICENSE
14+
15+
library
16+
exposed-modules: Ide.Plugin.HaddockComments
17+
hs-source-dirs: src
18+
ghc-options: -Wall -Wno-name-shadowing -Wredundant-constraints
19+
build-depends:
20+
, base
21+
, containers
22+
, ghc
23+
, ghc-exactprint
24+
, ghcide
25+
, haskell-lsp-types
26+
, hls-plugin-api
27+
, text
28+
, unordered-containers
29+
30+
default-language: Haskell2010

‎plugins/hls-haddock-comments-plugin/src/Ide/Plugin/HaddockComments.hs

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
{-# LANGUAGE NamedFieldPuns #-}
2+
{-# LANGUAGE OverloadedStrings #-}
3+
{-# LANGUAGE RecordWildCards #-}
4+
{-# LANGUAGE ViewPatterns #-}
5+
6+
module Ide.Plugin.HaddockComments where
7+
8+
import Control.Monad (join)
9+
import qualified Data.HashMap.Strict as HashMap
10+
import qualified Data.Map as Map
11+
import qualified Data.Text as T
12+
import Development.IDE
13+
import Development.IDE.Core.PositionMapping
14+
import Development.IDE.GHC.Compat
15+
import Ide.Types
16+
import Language.Haskell.GHC.ExactPrint
17+
import Language.Haskell.GHC.ExactPrint.Types hiding (GhcPs)
18+
import Language.Haskell.GHC.ExactPrint.Utils
19+
import Language.Haskell.LSP.Types
20+
21+
-----------------------------------------------------------------------------
22+
descriptor :: PluginId -> PluginDescriptor
23+
descriptor plId =
24+
(defaultPluginDescriptor plId)
25+
{ pluginCodeActionProvider = Just codeActionProvider
26+
}
27+
28+
haddockCommentsId :: CommandId
29+
haddockCommentsId = "HaddockCommentsCommand"
30+
31+
codeActionProvider :: CodeActionProvider
32+
codeActionProvider _lspFuncs ideState _pId (TextDocumentIdentifier uri) range _context =
33+
do
34+
let nfp = uriToNormalizedFilePath $ toNormalizedUri uri
35+
(join -> pm) <- runAction "HaddockComments" ideState $ use GetParsedModule `traverse` nfp
36+
let edits = genComments pm range
37+
return $ Right $ List [CACodeAction $ toAction title uri edit | (title, edit) <- edits]
38+
39+
toAction :: T.Text -> Uri -> TextEdit -> CodeAction
40+
toAction title uri edit = CodeAction {..}
41+
where
42+
_title = title
43+
_kind = Just CodeActionQuickFix
44+
_diagnostics = Nothing
45+
_command = Nothing
46+
_changes = Just $ HashMap.singleton uri $ List [edit]
47+
_documentChanges = Nothing
48+
_edit = Just WorkspaceEdit {..}
49+
50+
-----------------------------------------------------------------------------
51+
52+
genComments :: Maybe ParsedModule -> Range -> [(T.Text, TextEdit)]
53+
genComments pm range
54+
| Just ParsedModule {pm_parsed_source, pm_annotations} <- pm,
55+
anns <- relativiseApiAnns pm_parsed_source pm_annotations,
56+
locDecls <- hsmodDecls $ unLoc pm_parsed_source,
57+
[(locDecl, src, sig)] <- [(locDecl, l, sig) | locDecl@(L l (SigD _ (unSig -> Just sig))) <- locDecls, inRange range l],
58+
annKeys <- keyFromTyVar 0 sig,
59+
and $ maybe False isFresh . flip Map.lookup anns <$> annKeys,
60+
anns' <- updateAnns annKeys anns,
61+
(RealSrcSpan span) <- src,
62+
Just range' <- toCurrentRange zeroMapping $ realSrcSpanToRange span,
63+
result <- T.strip . T.pack $ exactPrint locDecl anns' =
64+
[("Generate haddock comments", TextEdit range' result)]
65+
| otherwise = []
66+
67+
-----------------------------------------------------------------------------
68+
69+
updateAnns :: [AnnKey] -> Anns -> Anns
70+
updateAnns keys anns = foldr (Map.adjust update) anns keys
71+
where
72+
comment = mkComment "-- ^ ____" noSrcSpan
73+
dp = [(AnnComment comment, DP (0, 1)), (G AnnRarrow, DP (1, 2))]
74+
update x
75+
| isFresh x = x {annEntryDelta = DP (0, 1), annsDP = dp}
76+
| otherwise = x
77+
78+
-----------------------------------------------------------------------------
79+
80+
isFresh :: Annotation -> Bool
81+
isFresh Ann {annsDP}
82+
| null [() | (AnnComment _, _) <- annsDP] = True
83+
| otherwise = False
84+
85+
inRange :: Range -> SrcSpan -> Bool
86+
inRange range x = isInsideSrcSpan (_start range) x || isInsideSrcSpan (_end range) x
87+
88+
unSig :: Sig GhcPs -> Maybe (LHsType GhcPs)
89+
unSig (TypeSig _ _ (HsWC _ (HsIB _ x))) = Just x
90+
unSig _ = Nothing
91+
92+
keyFromTyVar :: Int -> LHsType GhcPs -> [AnnKey]
93+
keyFromTyVar dep c@(L _ (HsFunTy _ x y))
94+
| dep <= 1 = mkAnnKey c : (keyFromTyVar (succ dep) x <> keyFromTyVar (succ dep) y)
95+
| otherwise = []
96+
keyFromTyVar dep (L _ (HsForAllTy _ _ _ x)) = keyFromTyVar dep x
97+
keyFromTyVar dep (L _ (HsQualTy _ _ x)) = keyFromTyVar dep x
98+
keyFromTyVar dep (L _ (HsParTy _ x)) = keyFromTyVar (succ dep) x
99+
keyFromTyVar dep (L _ (HsBangTy _ _ x)) = keyFromTyVar dep x
100+
keyFromTyVar _ _ = []
101+
102+
-----------------------------------------------------------------------------

0 commit comments

Comments
 (0)