Merge branch 'haskell:master' into master

Author: eddiemundo

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,17 +8,19 @@ assignees: ''
 ---
 
 <!--
-Before opening an issue, please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html). This explains some common issues and will also help you to find the information that the issue template asks for.
+Before opening an issue, please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html).
+This explains some common issues and will also help you to find the information that the issue template asks for.
 
-When filing an issue, please fill out as much of the information below as you can. This helps us to debug your issue, but is not required!
+When filing an issue, please fill out as much of the information below as you can.
+This helps us to debug your issue, but is not required!
 -->
 
 ### Your environment
 
 Which OS do you use:
 <!-- Windows, MacOS, Ubuntu, ArchLinux, etc... -->
-Which lsp-client do you use:
-<!-- Neovim, emacs, VS Codium, etc... -->
+Which LSP client (editor/plugin) do you use:
+<!-- Neovim+LanguageClient-neovim, emacs+lsp-mode, VS Codium+vscode-haskell, etc... -->
 Describe your project (alternative: link to the project):
 <!-- stack.yaml, package.yaml, *.cabal files, cabal.project, hie.yaml -->
 
@@ -32,26 +34,5 @@ Describe your project (alternative: link to the project):
 <!-- Tell us what happens instead. -->
 
 ### Include debug information
-Execute in the root of your project the command `haskell-language-server-wrapper --debug .` and paste the logs here:
-(if you are using the vscode extension check the executable location [here](https://github.com/haskell/vscode-haskell#downloaded-binaries))
-<details>
-<summary>
-Debug output:
-</summary>
-
-```
-<paste your logs here>
-```
-</details>
-
-Paste the logs from the lsp-client, you can check instructions about for VS Code [here](https://github.com/haskell/vscode-haskell#troubleshooting)
-
-<details>
-<summary>
-LSP logs:
-</summary>
-
-```
-<paste your logs here>
-```
-</details>
+
+<!-- Include any useful debug information, such as relevant log snippets. -->

.github/workflows/bench.yml

@@ -24,7 +24,7 @@ jobs:
         uses: fkirc/skip-duplicate-actions@v3.4.1
         with:
           cancel_others: false
-          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**.nix", "**/test/**", "flake.lock", "**/README.md", "FUNDING.yml"]'
+          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**.nix", "**/test/**", "flake.lock", "**/README.md", "FUNDING.yml", "**/stack*.yaml"]'
 
   bench_init:
     if: needs.pre_job.outputs.should_skip != 'true'
@@ -203,6 +203,5 @@ jobs:
           echo "jobs info: ${{ toJSON(needs) }}"
       - if: contains(needs.*.result, 'failure')
         run: exit 1
-      - if: contains(needs.*.result, 'cancelled')
-        name: cancelling
-        uses: andymckay/cancel-action@0.2
+      - if: contains(needs.*.result, 'cancelled') && needs.pre_job.outputs.should_skip != 'true'
+        run: exit 1

.github/workflows/caching.yml

@@ -30,6 +30,18 @@ on:
   push:
     branches:
       - master
+  schedule:
+    # Refresh snapshot every (02+8*x):25 UTC
+    # When cache is present it is a light check workflow with early termination.
+    # When primary cache is not hit - runs the cache generation.
+    # Why: GitHub repo has 10G pool & on overflow GitHub removes caches in FIFO manner.
+    # When internal branche PRs save into the same pool -
+    #   their cache is accessible only inside of the scope of the PR.
+    # If main cache is forced out - there are no cache shared between PRs,
+    #   which implies all PRs would start to create & save their cache.
+    # Reinstitution of the main chache puts it back into FIFO
+    #   & so it gets shared across all PRs.
+    - cron: "25 2/8 * * *"
 
 env:
   cabalBuild: "v2-build all --enable-tests --enable-benchmarks"
@@ -78,7 +90,7 @@ jobs:
       - if: runner.os == 'Windows'
         name: (Windows) Platform config
         run: |
-          echo "CABAL_PKGS_DIR=~\\AppData\\cabal\\packages" >> $GITHUB_ENV
+          echo "CABAL_PKGS_DIR=C:\\cabal\\packages" >> $GITHUB_ENV
       - if: ( runner.os == 'Linux' ) || ( runner.os == 'macOS' )
         name: (Linux,macOS) Platform config
         run: |
@@ -130,6 +142,7 @@ jobs:
           restore-keys: ${{ env.cache-name }}-
 
       - name: Compiled deps cache
+        id: compiled-deps
         uses: actions/cache@v2
         env:
           cache-name: compiled-deps
@@ -141,9 +154,12 @@ jobs:
                 ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-
                 ${{ env.cache-name }}-${{ runner.os }}-
 
-      - run: cabal update
+      - if: (! steps.compiled-deps.outputs.cache-hit)
+        run: |
+          cabal update
 
-      - name: Download all sources
+      - if: (! steps.compiled-deps.outputs.cache-hit)
+        name: Download all sources
         run: |
           cabal $cabalBuild --only-download
 
@@ -152,7 +168,8 @@ jobs:
       # but to cache what can be cached, so step is fault tolerant & would always succseed.
       # 2021-12-11: NOTE: Building all targets, since
       # current Cabal does not allow `all --enable-tests --enable-benchmarks --only-dependencies`
-      - name: Build all targets; try 3 times
+      - if: (! steps.compiled-deps.outputs.cache-hit)
+        name: Build all targets; try 3 times
         continue-on-error: true
         run: |
           cabal $cabalBuild || cabal $cabalBuild || cabal $cabalBuild

.github/workflows/nix.yml

@@ -24,7 +24,7 @@ jobs:
         uses: fkirc/skip-duplicate-actions@v3.4.1
         with:
           cancel_others: false
-          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**/README.md", "FUNDING.yml"]'
+          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**/README.md", "FUNDING.yml", "**/stack*.yaml"]'
       - id: skip_check_no_nix
         uses: fkirc/skip-duplicate-actions@v3.4.1
         with:
@@ -114,6 +114,5 @@ jobs:
           echo "jobs info: ${{ toJSON(needs) }}"
       - if: contains(needs.*.result, 'failure')
         run: exit 1
-      - if: contains(needs.*.result, 'cancelled')
-        name: cancelling
-        uses: andymckay/cancel-action@0.2
+      - if: contains(needs.*.result, 'cancelled') && needs.pre_job.outputs.should_skip != 'true'
+        run: exit 1

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
         uses: fkirc/skip-duplicate-actions@v3.4.1
         with:
           cancel_others: false
-          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", "install/**", "**.nix", "flake.lock", "**/README.md", "FUNDING.yml", ".circleci/**"]'
+          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", "install/**", "**.nix", "flake.lock", "**/README.md", "FUNDING.yml", ".circleci/**", "**/stack*.yaml"]'
       # If we only change ghcide downstream packages we have not test ghcide itself
       - id: skip_ghcide_check
         uses: fkirc/skip-duplicate-actions@v3.4.1
@@ -85,7 +85,7 @@ jobs:
       - if: runner.os == 'Windows'
         name: (Windows) Platform config
         run: |
-          echo "CABAL_PKGS_DIR=~\\AppData\\cabal\\packages" >> $GITHUB_ENV
+          echo "CABAL_PKGS_DIR=C:\\cabal\\packages" >> $GITHUB_ENV
       - if: ( runner.os == 'Linux' ) || ( runner.os == 'macOS' )
         name: (Linux,macOS) Platform config
         run: |
@@ -244,7 +244,7 @@ jobs:
         name: Test hls-hlint-plugin test suite
         run: cabal test hls-hlint-plugin --test-options="$TEST_OPTS" || cabal test hls-hlint-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-hlint-plugin --test-options="$TEST_OPTS"
 
-      - if: matrix.test
+      - if: matrix.test && false
         name: Test hls-alternate-number-format-plugin test suite
         run: cabal test hls-alternate-number-format-plugin --test-options="$TEST_OPTS" || cabal test hls-alternate-number-format-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-alternate-number-format-plugin --test-options="$TEST_OPTS"
 
@@ -261,6 +261,5 @@ jobs:
           echo "jobs info: ${{ toJSON(needs) }}"
       - if: contains(needs.*.result, 'failure')
         run: exit 1
-      - if: contains(needs.*.result, 'cancelled')
-        name: cancelling
-        uses: andymckay/cancel-action@0.2
+      - if: contains(needs.*.result, 'cancelled') && needs.pre_job.outputs.should_skip != 'true'
+        run: exit 1

cabal-ghc901.project

@@ -37,7 +37,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2021-11-29T12:30:07Z
+index-state: 2021-11-29T12:30:08Z
 
 constraints:
   -- These plugins don't work on GHC9 yet

cabal-ghc921.project

@@ -36,7 +36,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2021-11-29T12:30:07Z
+index-state: 2021-11-29T12:30:08Z
 
 constraints:
   -- These plugins doesn't work on GHC92 yet

cabal.project

@@ -40,7 +40,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2021-11-29T12:30:07Z
+index-state: 2021-11-29T12:30:08Z
 
 constraints:
     hyphenation +embed

docs/conf.py

@@ -14,16 +14,41 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+import re
+import sys
 
 # -- Project information -----------------------------------------------------
 
 project = 'haskell-language-server'
-copyright = '2021, The Haskell IDE Team'
-author = 'The Haskell IDE Team'
 
-# The full version, including alpha/beta/rc tags
-release = '1.3.0'
+# We want to take some of the metadata from the Cabal file, especially the version.
+# (otherwise it's very easy to forget to update it!)
+release = None
+copyright = None
+author = None
+versionPattern = re.compile("^version:\s*([\d.]+)")
+copyrightPattern = re.compile("^copyright:\s*(.+)")
+authorPattern = re.compile("^author:\s*(.+)")
+for i, line in enumerate(open('../haskell-language-server.cabal')):
+    versionMatch = re.search(versionPattern, line)
+    if versionMatch:
+        release = versionMatch.group(1)
+    copyrightMatch = re.search(copyrightPattern, line)
+    if copyrightMatch:
+        copyright = copyrightMatch.group(1)
+    authorMatch = re.search(authorPattern, line)
+    if authorMatch:
+        author = authorMatch.group(1)
 
+if not release:
+    print("Couldn't find version")
+    sys.exit()
+if not copyright:
+    print("Couldn't find copyright")
+    sys.exit()
+if not author:
+    print("Couldn't find author")
+    sys.exit()
 
 # -- General configuration ---------------------------------------------------
 
@@ -32,7 +57,8 @@
 # ones.
 extensions = [
     'myst_parser',
-    'sphinx_rtd_theme'
+    'sphinx_rtd_theme',
+    'sphinx.ext.autosectionlabel'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/features.md

@@ -17,7 +17,7 @@ You can watch demos for some of these features [below](#demos).
 - [Module name suggestions](#module-names) for insertion or correction
 - [Call hierarchy support](#call-hierarchy)
 - [Qualify names from an import declaration](#qualify-imported-names) in your code
-- [Suggest alternate numeric formats](#alternate-number-formatting)
+- [Suggest alternate numeric formats](#alternate-number-formatting). This plugin is not included by default yet due to a performance issue, see <https://github.com/haskell/haskell-language-server/issues/2490>
 
 ## Demos
 

docs/index.rst

@@ -1,11 +1,12 @@
 haskell-language-server
 =======================
 
-Official haskell ide support via language server (LSP). Successor of `ghcide <https://github.com/haskell/ghcide>`_ and `haskell-ide-engine <https://github.com/haskell/haskell-ide-engine>`_. Read the `project's background <https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-them-all.html>`_.
+Official Haskell Language Server implementation. :ref:`Read more<What is haskell-language-server?>`.
 
 .. toctree::
    :maxdepth: 2
 
+   what-is-hls
    features
    installation
    supported-versions

docs/installation.md

@@ -39,6 +39,8 @@ choco install haskell-language-server
 
 If you are using Visual Studio Code, the [Haskell extension](https://marketplace.visualstudio.com/items?itemName=haskell.haskell) will automatically download and install `haskell-language-server` for you.
 
+If you need to find the binaries, please consult the [documentation](https://github.com/haskell/vscode-haskell#downloaded-binaries) for the extension.
+
 ## Pre-built binaries
 
 There are pre-built binaries available from the [releases page](https://github.com/haskell/haskell-language-server/releases) for Linux, Windows and macOS.