├── .github ├── ISSUE_TEMPLATE.md └── workflows │ ├── docs.yml │ └── test.yml ├── .gitignore ├── .travis.yml ├── CONTIBUTING.md ├── Eask ├── LICENSE ├── Makefile ├── README.md ├── docs └── stylesheets │ └── extra.css ├── images └── logo.png ├── lsp-haskell.el └── mkdocs.yml /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /.github/workflows/docs.yml: -------------------------------------------------------------------------------- 1 | name: Docs 2 | 3 | on: 4 | push: 5 | 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Checkout 11 | uses: actions/checkout@v4 12 | with: 13 | fetch-depth: 0 14 | 15 | - uses: actions/setup-python@v5 16 | with: 17 | python-version: 3.x 18 | 19 | - run: pip install mkdocs-material mkdocs-awesome-pages-plugin mkdocs-git-revision-date-localized-plugin 20 | - run: cp -r README.md images docs 21 | - run: mkdocs gh-deploy --force 22 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | 11 | jobs: 12 | build: 13 | runs-on: ${{ matrix.os }} 14 | continue-on-error: ${{ matrix.experimental }} 15 | strategy: 16 | fail-fast: false 17 | matrix: 18 | os: [ubuntu-latest, macos-latest, windows-latest] 19 | emacs-version: 20 | - 28.2 21 | - 29.4 22 | - 30.1 23 | experimental: [false] 24 | include: 25 | - os: ubuntu-latest 26 | emacs-version: snapshot 27 | experimental: true 28 | - os: macos-latest 29 | emacs-version: snapshot 30 | experimental: true 31 | - os: windows-latest 32 | emacs-version: snapshot 33 | experimental: true 34 | 35 | steps: 36 | - uses: actions/checkout@v4 37 | 38 | - uses: jcs090218/setup-emacs@master 39 | with: 40 | version: ${{ matrix.emacs-version }} 41 | 42 | - uses: emacs-eask/setup-eask@master 43 | with: 44 | version: 'snapshot' 45 | 46 | - name: Run tests 47 | run: 'make ci' 48 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .eask 2 | /dist 3 | *.elc 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | dist: xenial 2 | language: generic 3 | addons: 4 | apt: 5 | update: true 6 | 7 | jobs: 8 | allow_failures: 9 | - env: EVM_EMACS=emacs-git-snapshot-travis-linux-xenial 10 | include: 11 | - stage: build 12 | env: EVM_EMACS=emacs-26.3-travis-linux-xenial 13 | script: &build 14 | - rm -rf $HOME/.evm 15 | - git clone https://github.com/rejeep/evm.git $HOME/.evm 16 | - export PATH=$HOME/.evm/bin:$HOME/.cask/bin:$PATH 17 | - evm config path /tmp 18 | - evm install $EVM_EMACS --use --skip 19 | - emacs --version 20 | - curl -fsSL https://raw.githubusercontent.com/cask/cask/master/go | python 21 | - travis_retry cask install 22 | - cask build 23 | - stage: build 24 | env: EVM_EMACS=emacs-git-snapshot-travis-linux-xenial 25 | script: *build 26 | -------------------------------------------------------------------------------- /CONTIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to lsp-haskell 2 | 3 | ## Updating the configuration options for lsp-haskell 4 | 5 | 1. Generate the vscode settings file 6 | 7 | ```sh 8 | haskell-language-server-9.6.2 vscode-extension-schema > /tmp/schema.json 9 | ``` 10 | Add `{"contributes": {"configuration": { "properties":` 11 | to the top and 12 | `}}}` to the bottom. 13 | 14 | 2. Generate the settings snippet 15 | 16 | Make sure you have https://github.com/emacs-lsp/lsp-mode/blob/master/scripts/lsp-generate-settings.el 17 | on your machine somewhere. In this example it is at `/tmp/lsp-generate-settings.el` 18 | 19 | In emacs, activate IELM, `M-x ielm` 20 | 21 | In IELM, 22 | 23 | ```elisp 24 | (load-library "/tmp/lsp-generate-settings.el") 25 | ;; Do direct output to buffer 26 | (defun p (x) (move-end-of-line 0) (insert (format "\n%s" x))) 27 | (p (lsp-generate-settings "/tmp/schema.json" 'lsp-haskell)) 28 | ``` 29 | 30 | This will emit settings that do not currently exist in the running 31 | emacs instance. 32 | 33 | Edit them into [lsp-haskell.el](./lsp-haskell.el) 34 | -------------------------------------------------------------------------------- /Eask: -------------------------------------------------------------------------------- 1 | ;; -*- mode: eask; lexical-binding: t -*- 2 | 3 | (package "lsp-haskell" 4 | "1.1" 5 | "Haskell support for lsp-mode") 6 | 7 | (website-url "https://github.com/emacs-lsp/lsp-haskell") 8 | (keywords "haskell") 9 | 10 | (package-file "lsp-haskell.el") 11 | 12 | (script "test" "echo \"Error: no test specified\" && exit 1") 13 | 14 | (source 'gnu) 15 | (source 'melpa) 16 | 17 | (depends-on "emacs" "28.1") 18 | (depends-on "lsp-mode") 19 | 20 | (development 21 | (depends-on "f") 22 | (depends-on "ecukes") 23 | (depends-on "ert-runner") 24 | (depends-on "el-mock") 25 | (depends-on "spinner")) 26 | 27 | (setq network-security-level 'low) ; see https://github.com/jcs090218/setup-emacs-windows/issues/156#issuecomment-932956432 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | SHELL=/usr/bin/env bash 2 | 3 | EMACS ?= emacs 4 | EASK ?= eask 5 | 6 | ci: build compile checkdoc lint 7 | 8 | build: 9 | $(EASK) package 10 | $(EASK) install 11 | 12 | compile: 13 | @echo "Compiling..." 14 | $(EASK) compile 15 | 16 | checkdoc: 17 | $(EASK) lint checkdoc 18 | 19 | lint: 20 | @echo "package linting..." 21 | $(EASK) lint package 22 | 23 | clean: 24 | $(EASK) clean all 25 | 26 | .PHONY : test compile checkdoc lint clean tag 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | lsp-haskell 2 | =========== 3 | 4 | [![MELPA](https://melpa.org/packages/lsp-haskell-badge.svg)](https://melpa.org/#/lsp-haskell) ![Build Status](https://github.com/emacs-lsp/lsp-haskell/actions/workflows/test.yml/badge.svg) ![Docs](https://github.com/emacs-lsp/lsp-haskell/actions/workflows/docs.yml/badge.svg) 5 | 6 | An Emacs Lisp library for interacting with a Haskell language server such as [`haskell-language-server`](https://github.com/haskell/haskell-language-server/) using Microsoft's [Language Server Protocol](https://github.com/Microsoft/language-server-protocol/). 7 | 8 | The library acts as a client for [`lsp-mode`](https://github.com/emacs-lsp/lsp-mode). 9 | 10 | ## Functionality 11 | 12 | This main functionality of `lsp-haskell` is: 13 | - Finding and launching the `haskell-language-server` binary 14 | - Providing configuration options to `haskell-language-server` 15 | 16 | If you would like to know about how LSP functionality is provided in Emacs and how to use it, please consult [`lsp-mode`](https://github.com/emacs-lsp/lsp-mode). 17 | If you would like to know about the LSP functionality which is provided by the Haskell language server, please consult [`haskell-language-server`](https://github.com/haskell/haskell-language-server). 18 | 19 | ## Installation 20 | 21 | Follow the `lsp-mode` [installation instructions](https://emacs-lsp.github.io/lsp-mode/page/installation/). 22 | Do not skip this! 23 | It has important information. 24 | 25 | `lsp-mode` automatically requires the `lsp-haskell` package , so you do not need to `require` `lsp-haskell` unless you like being explicit. 26 | 27 | You will need to set some hooks to ensure that `lsp-mode` is triggered when your Haskell major mode (e.g., `haskell-mode` or `haskell-ts-mode`) is entered. 28 | 29 | ```emacs-lisp 30 | (add-hook 'haskell-mode-hook #'lsp) 31 | (add-hook 'haskell-literate-mode-hook #'lsp) 32 | ``` 33 | 34 | ## Configuration 35 | 36 | HLS has some [configuration](https://haskell-language-server.readthedocs.io/en/latest/configuration.html) you can modify using either the `lsp-haskell` or `lsp` customization groups: 37 | 38 | ```emacs-lisp 39 | (customize-group 'lsp-haskell) 40 | 41 | ; or 42 | 43 | (customize-group 'lsp) 44 | ``` 45 | 46 | If you want to modify some configuration that this project doesn't support yet you can customize things explicitly yourself using `lsp--set-configuration`. For example: 47 | 48 | ```emacs-lisp 49 | (add-hook 'lsp-after-initialize-hook 50 | '(lambda () 51 | (lsp--set-configuration 52 | '(:haskell (:plugin (:tactics (:config (:timeout_duration 5))))) 53 | ))) 54 | ``` 55 | 56 | 57 | ## Language server installation 58 | 59 | Follow the instructions on the [`haskell-language-server`](https://github.com/haskell/haskell-language-server) repositories to install the server binaries. 60 | 61 | If you have installed the binaries to a location that is not on your `PATH`, or you are not using the `haskell-language-server-wrapper`, then you will need to customize the `lsp-haskell-server-path` variable to point to the executable you want to launch. 62 | 63 | ## Server configuration 64 | 65 | `lsp-haskell` provides a few options for for setting the server executable and arguments, and numerous settings for configuring the server itself (`hlint`, choice of formatting provider, etc.). 66 | 67 | Note that server configuration settings will currently [not](https://github.com/emacs-lsp/lsp-mode/issues/1174) be applied until the server is restarted. 68 | 69 | ## Troubleshooting 70 | 71 | `lsp-haskell` is *just* the glue between `lsp-mode` and `haskell-language-server`. 72 | 73 | If you have an issue with Emacs, it is probably a `lsp-mode` issue. 74 | If you have an issue with the Haskell functionality itself, it is probably a `haskell-language-server` issue. 75 | If you have an issue specifically with how the two are joined together, then it belongs here! 76 | 77 | If you're not sure what the problem is, the `haskell-language-server` README provides some troubleshooting instructions. 78 | -------------------------------------------------------------------------------- /docs/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | :root { 2 | --md-primary-fg-color: #333333; 3 | --md-accent-fg-color: #EB7A2F; 4 | --md-default-fg-color--light: #999999; 5 | } 6 | 7 | .md-footer { 8 | --md-default-fg-color: #333333; 9 | } 10 | 11 | .md-grid { 12 | max-width: 70rem; 13 | } 14 | 15 | .md-typeset a { 16 | color: #999999; 17 | } 18 | -------------------------------------------------------------------------------- /images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emacs-lsp/lsp-haskell/081d5115ceb1f1647497a8a3de4ca0702aaadb48/images/logo.png -------------------------------------------------------------------------------- /lsp-haskell.el: -------------------------------------------------------------------------------- 1 | ;;; lsp-haskell.el --- Haskell support for lsp-mode -*- lexical-binding: t; -*- 2 | 3 | ;; Version: 1.1 4 | ;; Package-Requires: ((emacs "28.1") (lsp-mode "3.0")) 5 | ;; Keywords: haskell 6 | ;; URL: https://github.com/emacs-lsp/lsp-haskell 7 | 8 | ;;; License 9 | ;; 10 | ;; This program is free software; you can redistribute it and/or modify 11 | ;; it under the terms of the GNU General Public License as published by 12 | ;; the Free Software Foundation; either version 3, or (at your option) 13 | ;; any later version. 14 | 15 | ;; This program is distributed in the hope that it will be useful, 16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | ;; GNU General Public License for more details. 19 | 20 | ;; You should have received a copy of the GNU General Public License 21 | ;; along with this program; see the file COPYING. If not, write to 22 | ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth 23 | ;; Floor, Boston, MA 02110-1301, USA. 24 | 25 | ;;; Commentary: 26 | 27 | ;; Haskell specific adapter for LSP mode 28 | 29 | ;;; Code: 30 | 31 | (require 'lsp-mode) 32 | 33 | ;; --------------------------------------------------------------------- 34 | ;; Configuration 35 | 36 | (defgroup lsp-haskell nil 37 | "Customization group for ‘lsp-haskell’." 38 | :group 'lsp-mode) 39 | 40 | ;; --------------------------------------------------------------------- 41 | ;; Language server options 42 | 43 | ;; These are registered with lsp-mode below, which handles preparing them for the server. 44 | ;; Originally generated from the vscode extension's package.json using lsp-generate-bindings. 45 | ;; Should ideally stay in sync with what's offered in the vscode extension. 46 | 47 | (defcustom-lsp lsp-haskell-formatting-provider 48 | "ormolu" 49 | "The formatter to use when formatting a document or range. 50 | Ensure the plugin is enabled." 51 | :group 'lsp-haskell 52 | :type '(choice (const "brittany") (const "floskell") (const "fourmolu") (const "ormolu") (const "stylish-haskell") (const "none")) 53 | :lsp-path "haskell.formattingProvider") 54 | (defcustom-lsp lsp-haskell-check-project 55 | t 56 | "Whether to typecheck the entire project on load. 57 | It could lead to bad perfomance in large projects." 58 | :group 'lsp-haskell 59 | :type 'boolean 60 | :lsp-path "haskell.checkProject") 61 | (defcustom-lsp lsp-haskell-max-completions 62 | 40 63 | "Maximum number of completions sent to the editor." 64 | :group 'lsp-haskell 65 | :type 'number 66 | :lsp-path "haskell.maxCompletions") 67 | (defcustom-lsp lsp-haskell-session-loading 68 | "singleComponent" 69 | "Preferred approach for loading package components. Setting this 70 | to 'multipleComponents' (EXPERIMENTAL) allows the build 71 | tool (such as `cabal` or `stack`) to load multiple components at 72 | once `https://github.com/haskell/cabal/pull/8726', which is a 73 | significant improvement." 74 | :group 'lsp-haskell 75 | :type '(choice (const "singleComponent") (const "multipleComponents")) 76 | :lsp-path "haskell.sessionLoading") 77 | 78 | ;; --------------------------------------------------------------------- 79 | ;; Plugin-specific configuration 80 | (defgroup lsp-haskell-plugins nil 81 | "Customization group for 'lsp-haskell' plugins." 82 | :group 'lsp-haskell) 83 | 84 | (defcustom-lsp lsp-haskell-plugin-import-lens-code-actions-on 85 | t 86 | "Enables explicit imports code actions" 87 | :group 'lsp-haskell-plugins 88 | :type 'boolean 89 | :lsp-path "haskell.plugin.importLens.codeActionsOn") 90 | (defcustom-lsp lsp-haskell-plugin-import-lens-code-lens-on 91 | t 92 | "Enables explicit imports code lenses" 93 | :group 'lsp-haskell-plugins 94 | :type 'boolean 95 | :lsp-path "haskell.plugin.importLens.codeLensOn") 96 | (defcustom-lsp lsp-haskell-plugin-hlint-code-actions-on 97 | t 98 | "Enables hlint code actions (apply hints)" 99 | :group 'lsp-haskell-plugins 100 | :type 'boolean 101 | :lsp-path "haskell.plugin.hlint.codeActionsOn") 102 | (defcustom-lsp lsp-haskell-plugin-hlint-diagnostics-on 103 | t 104 | "Enables hlint diagnostics" 105 | :group 'lsp-haskell-plugins 106 | :type 'boolean 107 | :lsp-path "haskell.plugin.hlint.diagnosticsOn") 108 | (defcustom-lsp lsp-haskell-plugin-hlint-config-flags 109 | nil 110 | "Flags used by hlint" 111 | :group 'lsp-haskell-plugins 112 | :type 'lsp-string-vector 113 | :lsp-path "haskell.plugin.hlint.config.flags") 114 | (defcustom-lsp lsp-haskell-plugin-eval-global-on 115 | t 116 | "Enables eval plugin" 117 | :group 'lsp-haskell-plugins 118 | :type 'boolean 119 | :lsp-path "haskell.plugin.eval.globalOn") 120 | (defcustom-lsp lsp-haskell-plugin-module-name-global-on 121 | t 122 | "Enables module name plugin" 123 | :group 'lsp-haskell-plugins 124 | :type 'boolean 125 | :lsp-path "haskell.plugin.moduleName.globalOn") 126 | (defcustom-lsp lsp-haskell-plugin-splice-global-on 127 | t 128 | "Enables splice plugin (expand template haskell definitions)" 129 | :group 'lsp-haskell-plugins 130 | :type 'boolean 131 | :lsp-path "haskell.plugin.splice.globalOn") 132 | (defcustom-lsp lsp-haskell-plugin-haddock-comments-global-on 133 | t 134 | "Enables haddock comments plugin" 135 | :group 'lsp-haskell-plugins 136 | :type 'boolean 137 | :lsp-path "haskell.plugin.haddockComments.globalOn") 138 | (defcustom-lsp lsp-haskell-plugin-class-global-on 139 | t 140 | "Enables type class plugin" 141 | :group 'lsp-haskell-plugins 142 | :type 'boolean 143 | :lsp-path "haskell.plugin.class.globalOn") 144 | (defcustom-lsp lsp-haskell-plugin-retrie-global-on 145 | t 146 | "Enables retrie plugin" 147 | :group 'lsp-haskell-plugins 148 | :type 'boolean 149 | :lsp-path "haskell.plugin.retrie.globalOn") 150 | (defcustom-lsp lsp-haskell-plugin-stan-global-on 151 | t 152 | "Enables stan plugin" 153 | :group 'lsp-haskell-plugins 154 | :type 'boolean 155 | :lsp-path "haskell.plugin.stan.globalOn") 156 | (defcustom-lsp lsp-haskell-plugin-tactics-global-on 157 | t 158 | "Enables Wingman (tactics) plugin" 159 | :group 'lsp-haskell-plugins 160 | :type 'boolean 161 | :lsp-path "haskell.plugin.tactics.globalOn") 162 | (defcustom-lsp lsp-haskell-plugin-tactics-config-auto-gas 163 | 4 164 | "The depth of the search tree when performing \"Attempt to fill hole\". 165 | Bigger values will be able to derive more solutions, 166 | but will take exponentially more time." 167 | :group 'lsp-haskell-plugins 168 | :type 'number 169 | :lsp-path "haskell.plugin.tactics.config.auto_gas") 170 | (defcustom-lsp lsp-haskell-plugin-tactics-config-hole-severity 171 | nil 172 | "The severity to use when showing hole diagnostics." 173 | :group 'lsp-haskell-plugins 174 | :type '(choice (const 1) (const 2) (const 3) (const 4) (const nil)) 175 | :lsp-path "haskell.plugin.tactics.config.hole_severity") 176 | (defcustom-lsp lsp-haskell-plugin-tactics-config-max-use-ctor-actions 177 | 5 178 | "Maximum number of `Use constructor ` code actions that can appear" 179 | :group 'lsp-haskell-plugins 180 | :type 'number 181 | :lsp-path "haskell.plugin.tactics.config.max_use_ctor_actions") 182 | (defcustom-lsp lsp-haskell-plugin-tactics-config-timeout-duration 183 | 2 184 | "The timeout for Wingman actions, in seconds" 185 | :group 'lsp-haskell-plugins 186 | :type 'number 187 | :lsp-path "haskell.plugin.tactics.config.timeout_duration") 188 | (defcustom-lsp lsp-haskell-plugin-tactics-config-proofstate-styling 189 | t 190 | "Should Wingman emit styling markup when showing metaprogram proof states?" 191 | :group 'lsp-haskell-plugins 192 | :type 'boolean 193 | :lsp-path "haskell.plugin.tactics.config.proofstate_styling") 194 | (defcustom-lsp lsp-haskell-plugin-pragmas-code-actions-on 195 | t 196 | "Enables pragmas code actions" 197 | :group 'lsp-haskell-plugins 198 | :type 'boolean 199 | :lsp-path "haskell.plugin.pragmas.codeActionsOn") 200 | (defcustom-lsp lsp-haskell-plugin-pragmas-completion-on 201 | t 202 | "Enables pragmas completions" 203 | :group 'lsp-haskell-plugins 204 | :type 'boolean 205 | :lsp-path "haskell.plugin.pragmas.completionsOn") 206 | (defcustom-lsp lsp-haskell-plugin-ghcide-completions-config-auto-extend-on 207 | t 208 | "Extends the import list automatically when completing a out-of-scope identifier" 209 | :group 'lsp-haskell-plugins 210 | :type 'boolean 211 | :lsp-path "haskell.plugin.ghcide-completions.config.autoExtendOn") 212 | (defcustom-lsp lsp-haskell-plugin-ghcide-completions-config-snippets-on 213 | lsp-enable-snippet 214 | "Inserts snippets when using code completions" 215 | :group 'lsp-haskell-plugins 216 | :type 'boolean 217 | :lsp-path "haskell.plugin.ghcide-completions.config.snippetsOn") 218 | (defcustom-lsp lsp-haskell-plugin-ghcide-type-lenses-global-on 219 | t 220 | "Enables type lenses plugin" 221 | :group 'lsp-haskell-plugins 222 | :type 'boolean 223 | :lsp-path "haskell.plugin.ghcide-type-lenses.globalOn") 224 | (defcustom-lsp lsp-haskell-plugin-ghcide-type-lenses-config-mode 225 | t 226 | "Control how type lenses are shown" 227 | :group 'lsp-haskell-plugins 228 | :type '(choice (const "always") (const "exported") (const "diagnostics")) 229 | :lsp-path "haskell.plugin.ghcide-type-lenses.config.mode") 230 | (defcustom-lsp lsp-haskell-plugin-refine-imports-global-on 231 | t 232 | "Enables refine imports plugin" 233 | :group 'lsp-haskell-plugins 234 | :type 'boolean 235 | :lsp-path "haskell.plugin.refineImports.globalOn") 236 | 237 | ;; Updated for haskell-language-server 2.1.0.0 238 | 239 | (lsp-defcustom lsp-haskell-plugin-cabal-code-actions-on t 240 | "Enables cabal code actions" 241 | :type 'boolean 242 | :group 'lsp-haskell-plugins 243 | :package-version '(lsp-mode . "8.0.1") 244 | :lsp-path "haskell.plugin.cabal.codeActionsOn") 245 | 246 | (lsp-defcustom lsp-haskell-plugin-cabal-completion-on t 247 | "Enables cabal completions" 248 | :type 'boolean 249 | :group 'lsp-haskell-plugins 250 | :package-version '(lsp-mode . "8.0.1") 251 | :lsp-path "haskell.plugin.cabal.completionOn") 252 | 253 | (lsp-defcustom lsp-haskell-plugin-pragmas-suggest-global-on t 254 | "Enables pragmas-suggest plugin" 255 | :type 'boolean 256 | :group 'lsp-haskell-plugins 257 | :package-version '(lsp-mode . "8.0.1") 258 | :lsp-path "haskell.plugin.pragmas-suggest.globalOn") 259 | 260 | (lsp-defcustom lsp-haskell-plugin-alternate-number-format-global-on t 261 | "Enables alternateNumberFormat plugin" 262 | :type 'boolean 263 | :group 'lsp-haskell-plugins 264 | :package-version '(lsp-mode . "8.0.1") 265 | :lsp-path "haskell.plugin.alternateNumberFormat.globalOn") 266 | 267 | (lsp-defcustom lsp-haskell-plugin-call-hierarchy-global-on t 268 | "Enables callHierarchy plugin" 269 | :type 'boolean 270 | :group 'lsp-haskell-plugins 271 | :package-version '(lsp-mode . "8.0.1") 272 | :lsp-path "haskell.plugin.callHierarchy.globalOn") 273 | 274 | (lsp-defcustom lsp-haskell-plugin-change-type-signature-global-on t 275 | "Enables changeTypeSignature plugin" 276 | :type 'boolean 277 | :group 'lsp-haskell-plugins 278 | :package-version '(lsp-mode . "8.0.1") 279 | :lsp-path "haskell.plugin.changeTypeSignature.globalOn") 280 | 281 | (lsp-defcustom lsp-haskell-plugin-class-code-actions-on t 282 | "Enables class code actions" 283 | :type 'boolean 284 | :group 'lsp-haskell-plugins 285 | :package-version '(lsp-mode . "8.0.1") 286 | :lsp-path "haskell.plugin.class.codeActionsOn") 287 | 288 | (lsp-defcustom lsp-haskell-plugin-class-code-lens-on t 289 | "Enables class code lenses" 290 | :type 'boolean 291 | :group 'lsp-haskell-plugins 292 | :package-version '(lsp-mode . "8.0.1") 293 | :lsp-path "haskell.plugin.class.codeLensOn") 294 | 295 | (lsp-defcustom lsp-haskell-plugin-eval-config-diff t 296 | "Enable the diff output (WAS/NOW) of eval lenses" 297 | :type 'boolean 298 | :group 'lsp-haskell-plugins 299 | :package-version '(lsp-mode . "8.0.1") 300 | :lsp-path "haskell.plugin.eval.config.diff") 301 | 302 | (lsp-defcustom lsp-haskell-plugin-eval-config-exception nil 303 | "Enable marking exceptions with `*** Exception:` similarly to doctest and GHCi." 304 | :type 'boolean 305 | :group 'lsp-haskell-plugins 306 | :package-version '(lsp-mode . "8.0.1") 307 | :lsp-path "haskell.plugin.eval.config.exception") 308 | 309 | (lsp-defcustom lsp-haskell-plugin-explicit-fields-global-on t 310 | "Enables explicit-fields plugin" 311 | :type 'boolean 312 | :group 'lsp-haskell-plugins 313 | :package-version '(lsp-mode . "8.0.1") 314 | :lsp-path "haskell.plugin.explicit-fields.globalOn") 315 | 316 | (lsp-defcustom lsp-haskell-plugin-explicit-fixity-global-on t 317 | "Enables explicit-fixity plugin" 318 | :type 'boolean 319 | :group 'lsp-haskell-plugins 320 | :package-version '(lsp-mode . "8.0.1") 321 | :lsp-path "haskell.plugin.explicit-fixity.globalOn") 322 | 323 | (lsp-defcustom lsp-haskell-plugin-fourmolu-config-external nil 324 | "Call out to an external \"fourmolu\" executable, rather than using the bundled library" 325 | :type 'boolean 326 | :group 'lsp-haskell-plugins 327 | :package-version '(lsp-mode . "8.0.1") 328 | :lsp-path "haskell.plugin.fourmolu.config.external") 329 | 330 | (lsp-defcustom lsp-haskell-plugin-gadt-global-on t 331 | "Enables gadt plugin" 332 | :type 'boolean 333 | :group 'lsp-haskell-plugins 334 | :package-version '(lsp-mode . "8.0.1") 335 | :lsp-path "haskell.plugin.gadt.globalOn") 336 | 337 | (lsp-defcustom lsp-haskell-plugin-ghcide-code-actions-bindings-global-on t 338 | "Enables ghcide-code-actions-bindings plugin" 339 | :type 'boolean 340 | :group 'lsp-haskell-plugins 341 | :package-version '(lsp-mode . "8.0.1") 342 | :lsp-path "haskell.plugin.ghcide-code-actions-bindings.globalOn") 343 | 344 | (lsp-defcustom lsp-haskell-plugin-ghcide-code-actions-fill-holes-global-on t 345 | "Enables ghcide-code-actions-fill-holes plugin" 346 | :type 'boolean 347 | :group 'lsp-haskell-plugins 348 | :package-version '(lsp-mode . "8.0.1") 349 | :lsp-path "haskell.plugin.ghcide-code-actions-fill-holes.globalOn") 350 | 351 | (lsp-defcustom lsp-haskell-plugin-ghcide-code-actions-imports-exports-global-on t 352 | "Enables ghcide-code-actions-imports-exports plugin" 353 | :type 'boolean 354 | :group 'lsp-haskell-plugins 355 | :package-version '(lsp-mode . "8.0.1") 356 | :lsp-path "haskell.plugin.ghcide-code-actions-imports-exports.globalOn") 357 | 358 | (lsp-defcustom lsp-haskell-plugin-ghcide-code-actions-type-signatures-global-on t 359 | "Enables ghcide-code-actions-type-signatures plugin" 360 | :type 'boolean 361 | :group 'lsp-haskell-plugins 362 | :package-version '(lsp-mode . "8.0.1") 363 | :lsp-path "haskell.plugin.ghcide-code-actions-type-signatures.globalOn") 364 | 365 | (lsp-defcustom lsp-haskell-plugin-ghcide-completions-global-on t 366 | "Enables ghcide-completions plugin" 367 | :type 'boolean 368 | :group 'lsp-haskell-plugins 369 | :package-version '(lsp-mode . "8.0.1") 370 | :lsp-path "haskell.plugin.ghcide-completions.globalOn") 371 | 372 | (lsp-defcustom lsp-haskell-plugin-ghcide-hover-and-symbols-hover-on t 373 | "Enables ghcide-hover-and-symbols hover" 374 | :type 'boolean 375 | :group 'lsp-haskell-plugins 376 | :package-version '(lsp-mode . "8.0.1") 377 | :lsp-path "haskell.plugin.ghcide-hover-and-symbols.hoverOn") 378 | 379 | (lsp-defcustom lsp-haskell-plugin-ghcide-hover-and-symbols-symbols-on t 380 | "Enables ghcide-hover-and-symbols symbols" 381 | :type 'boolean 382 | :group 'lsp-haskell-plugins 383 | :package-version '(lsp-mode . "8.0.1") 384 | :lsp-path "haskell.plugin.ghcide-hover-and-symbols.symbolsOn") 385 | 386 | (lsp-defcustom lsp-haskell-plugin-ormolu-config-external nil 387 | "Call out to an external 'ormolu' executable, rather than using the bundled library" 388 | :type 'boolean 389 | :group 'lsp-haskell-plugins 390 | :package-version '(lsp-mode . "8.0.1") 391 | :lsp-path "haskell.plugin.ormolu.config.external") 392 | 393 | (lsp-defcustom lsp-haskell-plugin-overloaded-record-dot-global-on t 394 | "Enables overloaded-record-dot plugin" 395 | :type 'boolean 396 | :group 'lsp-haskell-plugins 397 | :package-version '(lsp-mode . "8.0.1") 398 | :lsp-path "haskell.plugin.overloaded-record-dot.globalOn") 399 | 400 | (lsp-defcustom lsp-haskell-plugin-pragmas-completion-global-on t 401 | "Enables pragmas-completion plugin" 402 | :type 'boolean 403 | :group 'lsp-haskell-plugins 404 | :package-version '(lsp-mode . "8.0.1") 405 | :lsp-path "haskell.plugin.pragmas-completion.globalOn") 406 | 407 | (lsp-defcustom lsp-haskell-plugin-pragmas-disable-global-on t 408 | "Enables pragmas-disable plugin" 409 | :type 'boolean 410 | :group 'lsp-haskell-plugins 411 | :package-version '(lsp-mode . "8.0.1") 412 | :lsp-path "haskell.plugin.pragmas-disable.globalOn") 413 | 414 | (lsp-defcustom lsp-haskell-plugin-qualify-imported-names-global-on t 415 | "Enables qualifyImportedNames plugin" 416 | :type 'boolean 417 | :group 'lsp-haskell-plugins 418 | :package-version '(lsp-mode . "8.0.1") 419 | :lsp-path "haskell.plugin.qualifyImportedNames.globalOn") 420 | 421 | (lsp-defcustom lsp-haskell-plugin-rename-config-cross-module nil 422 | "Enable experimental cross-module renaming" 423 | :type 'boolean 424 | :group 'lsp-haskell-plugins 425 | :package-version '(lsp-mode . "8.0.1") 426 | :lsp-path "haskell.plugin.rename.config.crossModule") 427 | 428 | (lsp-defcustom lsp-haskell-plugin-rename-global-on t 429 | "Enables rename plugin" 430 | :type 'boolean 431 | :group 'lsp-haskell-plugins 432 | :package-version '(lsp-mode . "8.0.1") 433 | :lsp-path "haskell.plugin.rename.globalOn") 434 | 435 | ;; Updated for haskell-language-server 2.9.0.1 436 | 437 | (lsp-defcustom lsp-haskell-plugin-cabal-fmt-config-path "cabal-fmt" 438 | "Set path to 'cabal-fmt' executable" 439 | :type 'string 440 | :group 'lsp-haskell-plugins 441 | :package-version '(lsp-mode . "9.0.0") 442 | :lsp-path "haskell.plugin.cabal-fmt.config.path") 443 | 444 | (lsp-defcustom lsp-haskell-plugin-cabal-gild-config-path "cabal-gild" 445 | "Set path to 'cabal-gild' executable" 446 | :type 'string 447 | :group 'lsp-haskell-plugins 448 | :package-version '(lsp-mode . "9.0.0") 449 | :lsp-path "haskell.plugin.cabal-gild.config.path") 450 | 451 | (lsp-defcustom lsp-haskell-plugin-cabal-diagnostics-on t 452 | "Enables cabal diagnostics" 453 | :type 'boolean 454 | :group 'lsp-haskell-plugins 455 | :package-version '(lsp-mode . "9.0.0") 456 | :lsp-path "haskell.plugin.cabal.diagnosticsOn") 457 | 458 | (lsp-defcustom lsp-haskell-plugin-fourmolu-config-path "fourmolu" 459 | "Set path to executable (for \"external\" mode)." 460 | :type 'string 461 | :group 'lsp-haskell-plugins 462 | :package-version '(lsp-mode . "9.0.0") 463 | :lsp-path "haskell.plugin.fourmolu.config.path") 464 | 465 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-class-method-token 466 | "method" 467 | "LSP semantic token type to use for typeclass methods" 468 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 469 | (const "interface") (const "struct") (const "typeParameter") 470 | (const "parameter") (const "variable") (const "property") (const "enumMember") 471 | (const "event") (const "function") (const "method") (const "macro") 472 | (const "keyword") (const "modifier") (const "comment") (const "string") 473 | (const "number") (const "regexp") (const "operator") (const "decorator")) 474 | :group 'lsp-haskell-plugins 475 | :package-version '(lsp-mode . "9.0.0") 476 | :lsp-path "haskell.plugin.semanticTokens.config.classMethodToken") 477 | 478 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-class-token 479 | "class" 480 | "LSP semantic token type to use for typeclasses" 481 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 482 | (const "interface") (const "struct") (const "typeParameter") 483 | (const "parameter") (const "variable") (const "property") (const "enumMember") 484 | (const "event") (const "function") (const "method") (const "macro") 485 | (const "keyword") (const "modifier") (const "comment") (const "string") 486 | (const "number") (const "regexp") (const "operator") (const "decorator")) 487 | :group 'lsp-haskell-plugins 488 | :package-version '(lsp-mode . "9.0.0") 489 | :lsp-path "haskell.plugin.semanticTokens.config.classToken") 490 | 491 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-data-constructor-token 492 | "enumMember" 493 | "LSP semantic token type to use for data constructors" 494 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 495 | (const "interface") (const "struct") (const "typeParameter") 496 | (const "parameter") (const "variable") (const "property") (const "enumMember") 497 | (const "event") (const "function") (const "method") (const "macro") 498 | (const "keyword") (const "modifier") (const "comment") (const "string") 499 | (const "number") (const "regexp") (const "operator") (const "decorator")) 500 | :group 'lsp-haskell-plugins 501 | :package-version '(lsp-mode . "9.0.0") 502 | :lsp-path "haskell.plugin.semanticTokens.config.dataConstructorToken") 503 | 504 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-function-token 505 | "function" 506 | "LSP semantic token type to use for functions" 507 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 508 | (const "interface") (const "struct") (const "typeParameter") 509 | (const "parameter") (const "variable") (const "property") (const "enumMember") 510 | (const "event") (const "function") (const "method") (const "macro") 511 | (const "keyword") (const "modifier") (const "comment") (const "string") 512 | (const "number") (const "regexp") (const "operator") (const "decorator")) 513 | :group 'lsp-haskell-plugins 514 | :package-version '(lsp-mode . "9.0.0") 515 | :lsp-path "haskell.plugin.semanticTokens.config.functionToken") 516 | 517 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-module-token 518 | "namespace" 519 | "LSP semantic token type to use for modules" 520 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 521 | (const "interface") (const "struct") (const "typeParameter") 522 | (const "parameter") (const "variable") (const "property") (const "enumMember") 523 | (const "event") (const "function") (const "method") (const "macro") 524 | (const "keyword") (const "modifier") (const "comment") (const "string") 525 | (const "number") (const "regexp") (const "operator") (const "decorator")) 526 | :group 'lsp-haskell-plugins 527 | :package-version '(lsp-mode . "9.0.0") 528 | :lsp-path "haskell.plugin.semanticTokens.config.moduleToken") 529 | 530 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-operator-token 531 | "operator" 532 | "LSP semantic token type to use for operators" 533 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 534 | (const "interface") (const "struct") (const "typeParameter") 535 | (const "parameter") (const "variable") (const "property") (const "enumMember") 536 | (const "event") (const "function") (const "method") (const "macro") 537 | (const "keyword") (const "modifier") (const "comment") (const "string") 538 | (const "number") (const "regexp") (const "operator") (const "decorator")) 539 | :group 'lsp-haskell-plugins 540 | :package-version '(lsp-mode . "9.0.0") 541 | :lsp-path "haskell.plugin.semanticTokens.config.operatorToken") 542 | 543 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-pattern-synonym-token 544 | "macro" 545 | "LSP semantic token type to use for pattern synonyms" 546 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 547 | (const "interface") (const "struct") (const "typeParameter") 548 | (const "parameter") (const "variable") (const "property") (const "enumMember") 549 | (const "event") (const "function") (const "method") (const "macro") 550 | (const "keyword") (const "modifier") (const "comment") (const "string") 551 | (const "number") (const "regexp") (const "operator") (const "decorator")) 552 | :group 'lsp-haskell-plugins 553 | :package-version '(lsp-mode . "9.0.0") 554 | :lsp-path "haskell.plugin.semanticTokens.config.patternSynonymToken") 555 | 556 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-record-field-token 557 | "property" 558 | "LSP semantic token type to use for record fields" 559 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 560 | (const "interface") (const "struct") (const "typeParameter") 561 | (const "parameter") (const "variable") (const "property") (const "enumMember") 562 | (const "event") (const "function") (const "method") (const "macro") 563 | (const "keyword") (const "modifier") (const "comment") (const "string") 564 | (const "number") (const "regexp") (const "operator") (const "decorator")) 565 | :group 'lsp-haskell-plugins 566 | :package-version '(lsp-mode . "9.0.0") 567 | :lsp-path "haskell.plugin.semanticTokens.config.recordFieldToken") 568 | 569 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-type-constructor-token 570 | "enum" 571 | "LSP semantic token type to use for type constructors" 572 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 573 | (const "interface") (const "struct") (const "typeParameter") 574 | (const "parameter") (const "variable") (const "property") (const "enumMember") 575 | (const "event") (const "function") (const "method") (const "macro") 576 | (const "keyword") (const "modifier") (const "comment") (const "string") 577 | (const "number") (const "regexp") (const "operator") (const "decorator")) 578 | :group 'lsp-haskell-plugins 579 | :package-version '(lsp-mode . "9.0.0") 580 | :lsp-path "haskell.plugin.semanticTokens.config.typeConstructorToken") 581 | 582 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-type-family-token 583 | "interface" 584 | "LSP semantic token type to use for type families" 585 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 586 | (const "interface") (const "struct") (const "typeParameter") 587 | (const "parameter") (const "variable") (const "property") (const "enumMember") 588 | (const "event") (const "function") (const "method") (const "macro") 589 | (const "keyword") (const "modifier") (const "comment") (const "string") 590 | (const "number") (const "regexp") (const "operator") (const "decorator")) 591 | :group 'lsp-haskell-plugins 592 | :package-version '(lsp-mode . "9.0.0") 593 | :lsp-path "haskell.plugin.semanticTokens.config.typeFamilyToken") 594 | 595 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-type-synonym-token 596 | "type" 597 | "LSP semantic token type to use for type synonyms" 598 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 599 | (const "interface") (const "struct") (const "typeParameter") 600 | (const "parameter") (const "variable") (const "property") (const "enumMember") 601 | (const "event") (const "function") (const "method") (const "macro") 602 | (const "keyword") (const "modifier") (const "comment") (const "string") 603 | (const "number") (const "regexp") (const "operator") (const "decorator")) 604 | :group 'lsp-haskell-plugins 605 | :package-version '(lsp-mode . "9.0.0") 606 | :lsp-path "haskell.plugin.semanticTokens.config.typeSynonymToken") 607 | 608 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-type-variable-token 609 | "typeParameter" 610 | "LSP semantic token type to use for type variables" 611 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 612 | (const "interface") (const "struct") (const "typeParameter") 613 | (const "parameter") (const "variable") (const "property") (const "enumMember") 614 | (const "event") (const "function") (const "method") (const "macro") 615 | (const "keyword") (const "modifier") (const "comment") (const "string") 616 | (const "number") (const "regexp") (const "operator") (const "decorator")) 617 | :group 'lsp-haskell-plugins 618 | :package-version '(lsp-mode . "9.0.0") 619 | :lsp-path "haskell.plugin.semanticTokens.config.typeVariableToken") 620 | 621 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-config-variable-token 622 | "variable" 623 | "LSP semantic token type to use for variables" 624 | :type '(choice (const "namespace") (const "type") (const "class") (const "enum") 625 | (const "interface") (const "struct") (const "typeParameter") 626 | (const "parameter") (const "variable") (const "property") (const "enumMember") 627 | (const "event") (const "function") (const "method") (const "macro") 628 | (const "keyword") (const "modifier") (const "comment") (const "string") 629 | (const "number") (const "regexp") (const "operator") (const "decorator")) 630 | :group 'lsp-haskell-plugins 631 | :package-version '(lsp-mode . "9.0.0") 632 | :lsp-path "haskell.plugin.semanticTokens.config.variableToken") 633 | 634 | (lsp-defcustom lsp-haskell-plugin-semantic-tokens-global-on nil 635 | "Enables semanticTokens plugin" 636 | :type 'boolean 637 | :group 'lsp-haskell-plugins 638 | :package-version '(lsp-mode . "9.0.0") 639 | :lsp-path "haskell.plugin.semanticTokens.globalOn") 640 | 641 | ;; --------------------------------------------------------------------- 642 | ;; Non-language server options 643 | 644 | (defcustom lsp-haskell-server-path 645 | "haskell-language-server-wrapper" 646 | "The language server executable. 647 | Can be something on the $PATH (e.g. 'ghcide') or a path to an executable itself." 648 | :group 'lsp-haskell 649 | :type 'string) 650 | 651 | (defcustom lsp-haskell-server-log-file 652 | (expand-file-name "hls.log" temporary-file-directory) 653 | "The log file used by the server. 654 | Note that this is passed to the server via 'lsp-haskell-server-args', so if 655 | you override that setting then this one will have no effect." 656 | :group 'lsp-haskell 657 | :type 'string) 658 | 659 | (defcustom lsp-haskell-server-args 660 | `("-l" ,lsp-haskell-server-log-file) 661 | "The arguments for starting the language server. 662 | For a debug log when using haskell-language-server, use `-d -l /tmp/hls.log'." 663 | :group 'lsp-haskell 664 | :type '(repeat (string :tag "Argument"))) 665 | 666 | (defcustom lsp-haskell-server-wrapper-function 667 | #'identity 668 | "Use this to wrap the language server process started by lsp-haskell. 669 | For example, use the following the start the process in a nix-shell: 670 | \(lambda (argv) 671 | (append 672 | (append (list \"nix-shell\" \"-I\" \".\" \"--command\" ) 673 | (list (mapconcat 'identity argv \" \")) 674 | ) 675 | (list (concat (lsp--suggest-project-root) \"/shell.nix\")) 676 | ) 677 | )" 678 | :group 'lsp-haskell 679 | :type '(choice 680 | (function-item :tag "None" :value identity) 681 | (function :tag "Custom function"))) 682 | 683 | ;; --------------------------------------------------------------------- 684 | ;; Miscellaneous options 685 | ;; 686 | (defcustom lsp-haskell-completion-in-comments 687 | t 688 | "Whether to trigger completions in comments. 689 | Note that this must be set to true in order to get completion of pragmas." 690 | :group 'lsp-haskell 691 | :type 'boolean) 692 | 693 | ;; --------------------------------------------------------------------- 694 | ;; Starting the server and registration with lsp-mode 695 | 696 | (defun lsp-haskell--server-command () 697 | "Command and arguments for launching the inferior language server process. 698 | These are assembled from the customizable variables `lsp-haskell-server-path' 699 | and `lsp-haskell-server-args' and `lsp-haskell-server-wrapper-function'." 700 | (funcall lsp-haskell-server-wrapper-function (append (list lsp-haskell-server-path "--lsp") lsp-haskell-server-args) )) 701 | 702 | (defun lsp-haskell--action-filter (command) 703 | "lsp-mode transforms JSON false values in code action 704 | arguments to JSON null values when sending the requests back to 705 | the server. We need to explicitly tell it which code action 706 | arguments are non-nullable booleans." 707 | (lsp-fix-code-action-booleans command '(:restrictToOriginatingFile :withSig))) 708 | 709 | ;; This mapping is set for 'haskell-mode -> haskell' in the lsp-mode repo itself. If we move 710 | ;; it there, then delete it from here. 711 | ;; It also isn't *too* important: it only sets the language ID, see 712 | ;; https://microsoft.github.io/language-server-protocol/specification#textDocumentItem 713 | (add-to-list 'lsp-language-id-configuration '(haskell-literate-mode . "haskell")) 714 | (add-to-list 'lsp-language-id-configuration '(haskell-tng-mode . "haskell")) 715 | (add-to-list 'lsp-language-id-configuration '(haskell-cabal-mode . "haskell")) 716 | (add-to-list 'lsp-language-id-configuration '(haskell-ts-mode . "haskell")) 717 | 718 | ;; Register the client itself 719 | (lsp-register-client 720 | (make-lsp--client 721 | :new-connection (lsp-stdio-connection (lambda () (lsp-haskell--server-command))) 722 | ;; Should run under haskell-mode, haskell-literate-mode and haskell-tng-mode. We need to list haskell-literate-mode even though it's a derived mode of haskell-mode. 723 | :major-modes '(haskell-mode haskell-literate-mode haskell-tng-mode haskell-cabal-mode haskell-ts-mode) 724 | ;; This is arbitrary. 725 | :server-id 'lsp-haskell 726 | :synchronize-sections '("haskell") 727 | ;; This is somewhat irrelevant, but it is listed in lsp-language-id-configuration, so 728 | ;; we should set something consistent here. 729 | :language-id "haskell" 730 | :completion-in-comments? lsp-haskell-completion-in-comments 731 | :action-filter #'lsp-haskell--action-filter 732 | )) 733 | 734 | ;; --------------------------------------------------------------------- 735 | 736 | (provide 'lsp-haskell) 737 | ;;; lsp-haskell.el ends here 738 | -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: LSP Haskell 2 | 3 | extra_css: 4 | - stylesheets/extra.css 5 | 6 | theme: 7 | name: material 8 | logo: images/logo.png 9 | favicon: images/logo.png 10 | icon: 11 | repo: fontawesome/brands/github 12 | 13 | extra: 14 | social: 15 | - icon: fontawesome/brands/github-alt 16 | link: https://github.com/emacs-lsp 17 | - icon: fontawesome/brands/twitter 18 | link: https://twitter.com/yonchovski 19 | - icon: fontawesome/brands/gitter 20 | link: https://gitter.im/emacs-lsp/lsp-mode 21 | 22 | repo_name: emacs-lsp/lsp-haskell 23 | repo_url: https://github.com/emacs-lsp/lsp-haskell 24 | 25 | markdown_extensions: 26 | - pymdownx.superfences 27 | - pymdownx.emoji: 28 | emoji_index: !!python/name:material.extensions.emoji.twemoji 29 | emoji_generator: !!python/name:material.extensions.emoji.to_svg 30 | - codehilite 31 | - toc: 32 | permalink: '#' 33 | 34 | plugins: 35 | - search 36 | - awesome-pages 37 | - git-revision-date-localized 38 | --------------------------------------------------------------------------------