support selection range lsp feature (#2565)

* add selection range support

* add the whole import area as a selection step

* add selection range plugin to all project files

* merge type signature with value definition

* support ghc 9

* fix it for ghc-9.0

* remove unnecessary import

* reformat GhcIde.hs

* selection range: make it easier to understand

* selection range: improve error handling

* update lsp-types to 1.4.0.1

* add selection range to doc

* fix comment for findSelectionRangesByPositions

* remove a use of partial function

* update author & maintainer

* use foldlM1 instead of foldl1

* add testdata to cabal file

* update performace tips and log level

* update lsp-types in nix

Co-authored-by: Pepe Iborra <[email protected]>

Author: Kobayashi

.github/workflows/hackage.yml

@@ -32,7 +32,7 @@ jobs:
                   "hls-refine-imports-plugin", "hls-retrie-plugin",
                   "hls-splice-plugin", "hls-tactics-plugin",
                   "hls-call-hierarchy-plugin", "hls-alternate-number-format-plugin",
-                  "hls-qualify-imported-names-plugin",
+                  "hls-qualify-imported-names-plugin", "hls-selection-range-plugin",
                   "haskell-language-server"]
         ghc: [ "9.0.2"
              , "8.10.7"

.github/workflows/test.yml

@@ -234,6 +234,10 @@ jobs:
         name: Test hls-qualify-imported-names-plugin test suite
         run: cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS" || cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS"
 
+      - if: matrix.test
+        name: Test hls-selection-range-plugin test suite
+        run: cabal test hls-selection-range-plugin --test-options="$TEST_OPTS" || cabal test hls-selection-range-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-selection-range-plugin --test-options="$TEST_OPTS"
+
   test_post_job:
     if: always()
     runs-on: ubuntu-latest

cabal-ghc90.project

@@ -26,6 +26,7 @@ packages:
          ./plugins/hls-ormolu-plugin
          ./plugins/hls-call-hierarchy-plugin
          ./plugins/hls-alternate-number-format-plugin
+         ./plugins/hls-selection-range-plugin
 
 tests: true
 
@@ -35,7 +36,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2022-01-11T22:05:45Z
+index-state: 2022-01-21T11:23:29Z
 
 constraints:
   -- These plugins don't work on GHC9 yet

cabal-ghc921.project

@@ -26,6 +26,7 @@ packages:
          ./plugins/hls-ormolu-plugin
          ./plugins/hls-call-hierarchy-plugin
          ./plugins/hls-alternate-number-format-plugin
+         ./plugins/hls-selection-range-plugin
 
 with-compiler: ghc-9.2.1
 
@@ -37,7 +38,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2022-01-11T22:05:45Z
+index-state: 2022-01-21T11:23:29Z
 
 constraints:
   -- These plugins don't build/work on GHC92 yet

cabal.project

@@ -26,6 +26,7 @@ packages:
          ./plugins/hls-call-hierarchy-plugin
          ./plugins/hls-alternate-number-format-plugin
          ./plugins/hls-qualify-imported-names-plugin
+         ./plugins/hls-selection-range-plugin
 
 -- Standard location for temporary packages needed for particular environments
 -- For example it is used in the project gitlab mirror to help in the MAcOS M1 build script
@@ -40,7 +41,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2022-01-11T22:05:45Z
+index-state: 2022-01-21T11:23:29Z
 
 constraints:
     hyphenation +embed

docs/features.md

@@ -18,6 +18,7 @@ Many of these are standard LSP features, but a lot of special features are provi
 | [Highlight references](#highlight-references)       | `textDocument/documentHighlight`                                                                  |
 | [Code actions](#code-actions)                       | `textDocument/codeAction`                                                                         |
 | [Code lenses](#code-lenses)                         | `textDocument/codeLens`                                                                           |
+| [Selection range](#selection-range)                 | `textDocument/selectionRange` |
 
 The individual sections below also identify which [HLS plugin](./what-is-hls.md#hls-plugins) is responsible for providing the given functionality, which is useful if you want to raise an issue report or contribute!
 Additionally, not all plugins are supported on all versions of GHC, see the [GHC version support page](supported-versions.md) for details.
@@ -141,7 +142,7 @@ Code action kind: `quickfix`
 Rewrites imported names to be qualified.
 
 ![Qualify Imported Names Demo](../plugins/hls-qualify-imported-names-plugin/qualify-imported-names-demo.gif)
- 
+
 For usage see the ![readme](../plugins/hls-qualify-imported-names-plugin/README.md).
 
 ### Refine import
@@ -239,6 +240,13 @@ Shows module name matching file path, and applies it with a click.
 
 ![Module Name Demo](https://user-images.githubusercontent.com/54035/110860755-78ad8680-82bd-11eb-9845-9ea4b1cc1f76.gif)
 
+## Selection range
+Provided by: `hls-selection-range-plugin`
+
+Provides haskell specific
+[shrink/expand selection](https://code.visualstudio.com/docs/editor/codebasics#shrinkexpand-selection)
+support.
+
 ## Missing features
 
 The following features are supported by the LSP specification but not implemented in HLS.
@@ -251,7 +259,6 @@ Contributions welcome!
 | Jump to implementation | Unclear if useful                                                                        | `textDocument/implementation`                       |
 | Renaming               | [Parital implementation](https://github.com/haskell/haskell-language-server/issues/2193) | `textDocument/rename`, `textDocument/prepareRename` |
 | Folding                | Unimplemented                                                                            | `textDocument/foldingRange`                         |
-| Selection range        | Unimplemented                                                                            | `textDocument/selectionRange`                       |
 | Semantic tokens        | Unimplemented                                                                            | `textDocument/semanticTokens`                       |
 | Linked editing         | Unimplemented                                                                            | `textDocument/linkedEditingRange`                   |
 | Document links         | Unimplemented                                                                            | `textDocument/documentLink`                         |

docs/supported-versions.md

@@ -50,6 +50,7 @@ As such, the functionality provided by those plugins is not available in HLS whe
 | `hls-splice-plugin`                 | 9.2                      |
 | `hls-stylish-haskell-plugin`        | 9.0, 9.2                 |
 | `hls-tactics-plugin`                | 9.2                      |
+| `hls-selection-range-plugin`        |                          |
 
 ### Using deprecated GHC versions
 

exe/Plugins.hs

@@ -72,6 +72,10 @@ import           Ide.Plugin.Splice                 as Splice
 import           Ide.Plugin.AlternateNumberFormat  as AlternateNumberFormat
 #endif
 
+#if selectionRange
+import           Ide.Plugin.SelectionRange         as SelectionRange
+#endif
+
 -- formatters
 
 #if floskell
@@ -167,6 +171,9 @@ idePlugins includeExamples = pluginDescToIdePlugins allPlugins
 #endif
 #if alternateNumberFormat
       AlternateNumberFormat.descriptor "alternateNumberFormat" :
+#endif
+#if selectionRange
+      SelectionRange.descriptor "selectionRange" :
 #endif
     -- The ghcide descriptors should come last so that the notification handlers
     -- (which restart the Shake build) run after everything else

flake.lock

@@ -7,7 +7,7 @@
       flake = false;
     };
     lsp-types = {
-      url = "https://hackage.haskell.org/package/lsp-types-1.4.0.0/lsp-types-1.4.0.0.tar.gz";
+      url = "https://hackage.haskell.org/package/lsp-types-1.4.0.1/lsp-types-1.4.0.1.tar.gz";
       flake = false;
     };
     lsp-test = {