Merge branch 'master' into qualified-completion

Author: pepeiborra

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +1,47 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: I've spotted something specific thats' going wrong
 title: ''
 labels: 'status: needs triage, type: bug'
 assignees: ''
 
 ---
 
 <!--
-Before opening an issue, please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html).
+Before opening a bug, 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!
 -->
 
 ### Your environment
 
-Which OS do you use:
+<!--
+Everything in this section is optional, but it does help us to debug your issue!
+-->
+
+Which OS do you use?
 <!-- Windows, MacOS, Ubuntu, ArchLinux, etc... -->
-Which LSP client (editor/plugin) do you use:
+Which version of GHC do you use and how did you install it?
+<!-- 9.0.2 from stack/ghcup, etc. -->
+How is your project built (alternative: link to the project)?
+
+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 -->
+Which version of HLS do you use and how did you install it?
+<!-- 1.7.0.1 from ghcup, etc. -->
+Have you configured HLS in any way (especially: a `hie.yaml` file)?
 
 ### Steps to reproduce
+
 <!-- Tell us how to reproduce this issue. -->
 
 ### Expected behaviour
+
 <!-- Tell us what should happen. -->
 
 ### Actual behaviour
+
 <!-- Tell us what happens instead. -->
 
-### Include debug information
+### Debug information
 
 <!-- Include any useful debug information, such as relevant log snippets. -->

.github/ISSUE_TEMPLATE/feature_request.md renamed to .github/ISSUE_TEMPLATE/enhancement_request.md

@@ -1,24 +1,24 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
+name: Enhancement request
+about: I have an idea for how to make things better
 title: ''
 labels: 'status: needs triage, type: enhancement'
 assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
+## Is your enhancement request related to a problem? Please describe.
 
 <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 
-**Describe the solution you'd like**
+## Describe the solution you'd like
 
 <!-- A clear and concise description of what you want to happen. -->
 
-**Describe alternatives you've considered**
+## Describe alternatives you've considered
 
 <!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Additional context**
+## Additional context
 
 <!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/support.md

@@ -0,0 +1,39 @@
+---
+name: Support request
+about: Help, something isn't working and I'm stuck!
+title: ''
+labels: 'status: needs triage, type: support'
+assignees: ''
+
+---
+
+<!--
+Before asking for support, 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.
+-->
+
+## Your environment 
+
+<!--
+Everything in this section is optional, but it does help us to debug your issue!
+-->
+
+Which OS do you use?
+<!-- Windows, MacOS, Ubuntu, ArchLinux, etc... -->
+Which version of GHC do you use and how did you install it?
+<!-- 9.0.2 from stack/ghcup, etc. -->
+How is your project built (alternative: link to the project)?
+
+Which LSP client (editor/plugin) do you use?
+<!-- Neovim+LanguageClient-neovim, emacs+lsp-mode, VS Codium+vscode-haskell, etc... -->
+Which version of HLS do you use and how did you install it?
+<!-- 1.7.0.1 from ghcup, etc. -->
+Have you configured HLS in any way (especially: a `hie.yaml` file)?
+
+## What's wrong?
+
+<!-- What's not working? What have you tried? -->
+
+### Debug information
+
+<!-- Include any useful debug information, such as relevant log snippets. -->

.github/workflows/hackage.yml

@@ -31,12 +31,12 @@ jobs:
                   "hls-brittany-plugin", "hls-floskell-plugin", "hls-fourmolu-plugin",
                   "hls-ormolu-plugin", "hls-stylish-haskell-plugin",
                   "hls-class-plugin", "hls-eval-plugin", "hls-explicit-imports-plugin",
-                  "hls-haddock-comments-plugin", "hls-hlint-plugin",
+                  "hls-haddock-comments-plugin", "hls-hlint-plugin", "hls-stan-plugin",
                   "hls-module-name-plugin", "hls-pragmas-plugin",
                   "hls-refine-imports-plugin", "hls-rename-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-selection-range-plugin",
+                  "hls-qualify-imported-names-plugin", "hls-code-range-plugin",
                   "haskell-language-server"]
         ghc: [ "9.0.2"
              , "8.10.7"

.github/workflows/hlint.yml

@@ -6,7 +6,7 @@ on:
       - '**'
 
 jobs:
-  build10:
+  hlint:
     name: "Hlint check run"
     runs-on: ubuntu-latest
     steps:
@@ -15,11 +15,12 @@ jobs:
     - name: 'Installing'
       uses: rwe/actions-hlint-setup@v1
       with:
-        version: '3.3.4'
+        version: '3.4'
 
     - name: 'Checking code'
       uses: rwe/actions-hlint-run@v1
       with:
-        hlint-bin: "hlint --with-group=extra --hint=ghcide/.hlint.yaml"
-        path: '[ "ghcide/src", "ghcide/exe", "ghcide/bench/lib", "ghcide/bench/exe", "ghcide/bench/hist", "shake-bench/src", "ghcide/test/exe"]'
+        hlint-bin: "hlint --with-group=extra"
+        fail-on: error
+        path: .
 

.github/workflows/pre-commit.yml

@@ -0,0 +1,43 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: ./.github/actions/setup-build
+      with:
+        ghc: "9.2.3"
+        os: ${{ runner.os }}
+        shorten-hls: false
+
+    - name: "Install stylish-haskell"
+      run: |
+        cabal install stylish-haskell
+        echo "${HOME}/.cabal/bin" >> $GITHUB_PATH
+
+    - name: "Check stylish-haskell is available"
+      run: |
+        echo $(which stylish-haskell)
+
+    - name: Compiled deps cache
+      id: stylish-haskell-compiled-cache
+      uses: actions/cache@v2
+      env:
+        cache-name: stylish-haskell-compiled-cache
+      with:
+        path: ${{ env.CABAL_PKGS_DIR }}
+        key:  ${{ inputs.cache-prefix }}${{ env.cache-name }}-${{ inputs.os }}-${{ inputs.ghc }}-${{ env.INDEX_STATE }}-${{ hashFiles('cabal.project.freeze') }}
+        restore-keys: |
+              ${{ inputs.cache-prefix }}${{ env.cache-name }}-${{ inputs.os }}-${{ inputs.ghc }}-${{ env.INDEX_STATE }}-
+              ${{ inputs.cache-prefix }}${{ env.cache-name }}-${{ inputs.os }}-${{ inputs.ghc }}-
+              ${{ inputs.cache-prefix }}${{ env.cache-name }}-${{ inputs.os }}-
+
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/[email protected]

.github/workflows/test.yml

@@ -223,6 +223,10 @@ 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 && matrix.ghc != '9.0.1' && matrix.ghc != '9.0.2' && matrix.ghc != '9.2.2'
+        name: Test hls-stan-plugin test suite
+        run: cabal test hls-stan-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-stan-plugin --test-options="$TEST_OPTS"
+
       - if: matrix.test
         name: Test hls-module-name-plugin test suite
         run: cabal test hls-module-name-plugin --test-options="$TEST_OPTS" || cabal test hls-module-name-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-module-name-plugin --test-options="$TEST_OPTS"
@@ -236,8 +240,8 @@ jobs:
         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"
+        name: Test hls-code-range-plugin test suite
+        run: cabal test hls-code-range-plugin --test-options="$TEST_OPTS" || cabal test hls-code-range-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-code-range-plugin --test-options="$TEST_OPTS"
 
       - if: matrix.test
         name: Test hls-change-type-signature test suite

.gitignore

@@ -30,9 +30,6 @@ test/testdata/**/hie.yaml
 # shake build folder (used in benchmark suite)
 .shake/
 
-# pre-commit-hook.nix
-.pre-commit-config.yaml
-
 # direnv
 /.direnv/
 /.envrc

.gitpod.Dockerfile

@@ -0,0 +1,24 @@
+FROM gitpod/workspace-full
+
+RUN sudo install-packages build-essential curl libffi-dev libffi7 libgmp-dev libgmp10 \
+        libncurses-dev libncurses5 libtinfo5 && \
+    curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | BOOTSTRAP_HASKELL_NONINTERACTIVE=1 BOOTSTRAP_HASKELL_MINIMAL=1 sh && \
+    echo 'source $HOME/.ghcup/env' >> $HOME/.bashrc && \
+    echo 'export PATH=$HOME/.cabal/bin:$HOME/.local/bin:$PATH' >> $HOME/.bashrc && \
+    . /home/gitpod/.ghcup/env && \
+    # Install all verions of GHC that HLS supports. Putting GHC into Docker image makes workspace start much faster.
+    ghcup install ghc 8.6.5 && \
+    ghcup install ghc 8.8.4 && \
+    ghcup install ghc 8.10.7 && \
+    ghcup install ghc 9.0.2 && \
+    ghcup install ghc 9.2.2 && \
+    ghcup install ghc 9.2.3 --set && \
+    ghcup install hls --set && \
+    ghcup install cabal --set && \
+    ghcup install stack --set && \
+    cabal update && \
+    cabal install --disable-executable-dynamic --install-method copy --constraint "stylish-haskell +ghc-lib" \
+      stylish-haskell implicit-hie hoogle && \
+    rm -rf $HOME/.cabal/store && \
+    pip install pre-commit && \
+    npm install -g http-server

.gitpod.yml

@@ -1,42 +1,53 @@
+image:
+  file: .gitpod.Dockerfile
 # List the start up tasks. Learn more https://www.gitpod.io/docs/config-start-tasks/
 tasks:
-  - before: |
-      # Only the /workspace folder is persistent
-      export XDG_DATA_HOME=/workspace/.local/share
-      export XDG_CONFIG_HOME=/workspace/.local/config
-      export XDG_STATE_HOME=/workspace/.local/state
-      export XDG_CACHE_HOME=/workspace/.cache
-      export CABAL_DIR=/workspace/.cabal
-      export STACK_ROOT=/workspace/.stack
+  - name: Setup
+    before: |
+      # Make sure some folders not in /workspace persist between worksapce restarts.
+      # You may add additional directories to this list.
+      declare -a CACHE_DIRS=(
+        $HOME/.local
+        $HOME/.cabal
+        $HOME/.stack
+        $HOME/.cache/ghcide
+        $HOME/.cache/hie-bios
+        /nix
+      )
+      for DIR in "${CACHE_DIRS[@]}"; do
+        mkdir -p $(dirname /workspace/cache$DIR)
+        mkdir -p $DIR # in case $DIR doesn't already exist
+        # On a fresh start with no prebuilds, we move existing directory
+        # to /workspace. 'sudo mv' fails with 'no permission', I don't know why
+        if [ ! -d /workspace/cache$DIR ]; then
+          sudo cp -rp $DIR /workspace/cache$DIR
+          sudo rm -rf $DIR/*
+        fi
+        mkdir -p /workspace/cache$DIR # make sure it exists even if cp fails
+        # Now /workspace/cache$DIR exists.
+        # Use bind mount to make $DIR backed by /workspace/cache$DIR
+        sudo mount --bind /workspace/cache$DIR $DIR
+      done
 
-      # install ghcup, ghc and cabal
-      export GHCUP_INSTALL_BASE_PREFIX=/workspace
-      export BOOTSTRAP_HASKELL_NONINTERACTIVE=1
-      export BOOTSTRAP_HASKELL_MINIMAL=1
-      curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh
-      /workspace/.ghcup/bin/ghcup install ghc --set
-      /workspace/.ghcup/bin/ghcup install cabal
-
-      # Add ghcup binaries to the PATH since VSCode does not see 'source .ghcup/env'
-      pushd /usr/local/bin
-      sudo ln -s /workspace/.ghcup/bin/* /usr/local/bin
-      popd
-
-      # Fix the Cabal dir since VSCode does not see CABAL_DIR 
-      cabal update
-      echo "Symlinking /workspace/.cabal to ~/.cabal"
-      ln -s /workspace/.cabal ~
+      # Install pre-commit hook
+      pre-commit install
 
       # Configure VSCode to use the locally built version of HLS
       mkdir -p .vscode
-      echo '{ "haskell.serverExecutablePath": "/workspace/.cabal/bin/haskell-language-server" }' > .vscode/settings.json 
+      if [ ! -f .vscode/settings.json ]; then
+        # Only write to .vscode/settings.json if it doesn't exist.
+        echo '{' > .vscode/settings.json
+        echo '  "haskell.serverExecutablePath": "/home/gitpod/.cabal/bin/haskell-language-server",' >> .vscode/settings.json
+        echo '  "haskell.formattingProvider": "stylish-haskell"' >> .vscode/settings.json
+        echo '}' >> .vscode/settings.json
+      fi
 
-    init: | 
+      pip install -r docs/requirements.txt
+    init: |
+      cabal update
       cabal configure --enable-executable-dynamic
-      cabal build --enable-tests
-      cabal install exe:haskell-language-server      
-    command: | 
-      cabal build --enable-tests
+      cabal build --enable-tests all
+      cabal install exe:haskell-language-server
 
 # List the ports to expose. Learn more https://www.gitpod.io/docs/config-ports/
 ports: []
@@ -62,4 +73,4 @@ vscode:
   extensions:
     - "haskell.haskell"
     - "justusadam.language-haskell"
-    - "usernamehw.errorlens"
+    - "EditorConfig.EditorConfig"