Merge branch 'master' into hindent-support

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,7 +31,7 @@ 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",

.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/action@v3.0.0

.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"

.gitpod.Dockerfile

@@ -2,17 +2,23 @@ FROM gitpod/workspace-full
 
 RUN sudo install-packages build-essential curl libffi-dev libffi7 libgmp-dev libgmp10 \
         libncurses-dev libncurses5 libtinfo5 && \
-    BOOTSTRAP_HASKELL_NONINTERACTIVE=1 \
-    BOOTSTRAP_HASKELL_MINIMAL=1 \
-    curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh && \
+    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 && \
-    ghcup install ghc --set && \
+    # 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 stylish-haskell hoogle implicit-hie && \
+    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

@@ -10,7 +10,8 @@ tasks:
         $HOME/.local
         $HOME/.cabal
         $HOME/.stack
-        $HOME/.ghcup
+        $HOME/.cache/ghcide
+        $HOME/.cache/hie-bios
         /nix
       )
       for DIR in "${CACHE_DIRS[@]}"; do
@@ -41,9 +42,7 @@ tasks:
         echo '}' >> .vscode/settings.json
       fi
 
-      pushd docs
-        pip install -r requirements.txt
-      popd
+      pip install -r docs/requirements.txt
     init: |
       cabal update
       cabal configure --enable-executable-dynamic

.pre-commit-config.yaml

@@ -24,7 +24,7 @@
           {
             "id": "mixed-line-ending",
             "args": ["--fix", "lf"],
-            "exclude": "test/testdata/.*CRLF*.hs$"
+            "exclude": "test/testdata/.*CRLF.*?\\.hs$"
           }
        ]
     }

CODEOWNERS

@@ -29,6 +29,7 @@
 /plugins/hls-splice-plugin @konn
 /plugins/hls-stylish-haskell-plugin @Ailrun
 /plugins/hls-tactics-plugin @isovector
+/plugins/hls-stan-plugin @uhbif19
 
 # Benchmarking
 /shake-bench @pepeiborra

cabal.project

@@ -28,6 +28,7 @@ packages:
          ./plugins/hls-qualify-imported-names-plugin
          ./plugins/hls-code-range-plugin
          ./plugins/hls-change-type-signature-plugin
+         ./plugins/hls-stan-plugin
          ./plugins/hls-gadt-plugin
          ./plugins/hls-hindent-plugin
 
@@ -68,4 +69,5 @@ allow-newer:
   ----------
   hiedb:base,
 
+  ekg-core,
   ekg-wai:time

configuration-ghc-90.nix

@@ -19,13 +19,12 @@ let
       ptr-poker = hself.callCabal2nix "ptr-poker" inputs.ptr-poker { };
 
       ghc-lib = hself.ghc-lib_9_2_2_20220307;
-      ghc-lib-parser = hself.ghc-lib-parser_9_2_2_20220307;
-      ghc-lib-parser-ex = hself.ghc-lib-parser-ex_9_2_0_3;
+      ghc-lib-parser = hself.ghc-lib-parser_9_2_3_20220709;
+      ghc-lib-parser-ex = hself.ghc-lib-parser-ex_9_2_0_4;
 
       Cabal = hself.Cabal_3_6_3_0;
-      ormolu = hself.ormolu_0_4_0_0;
+      ormolu = hself.ormolu_0_5_0_0;
       fourmolu = hself.fourmolu_0_6_0_0;
-
       # Hlint is still broken
       hlint = doJailbreak (hself.callCabal2nix "hlint" inputs.hlint-34 { });
 

configuration-ghc-92.nix

@@ -29,6 +29,8 @@ let
       # Hlint is still broken
       hlint = doJailbreak (hself.callCabal2nix "hlint" inputs.hlint { });
 
+      stylish-haskell = appendConfigureFlag  hsuper.stylish-haskell "-fghc-lib";
+
       # Re-generate HLS drv excluding some plugins
       haskell-language-server =
         hself.callCabal2nixWithOptions "haskell-language-server" ./.

docs/configuration.md

@@ -18,7 +18,7 @@ The LSP protocol is designed to support many useful server configuration options
 These are sent to the server by the client, and can be controlled without reference to a specific language.
 
 For example, there are protocol methods for highlighting matching identifiers throughout a document.
-This is a capability which any server can implement, so the client can decide generically whether to ask the server to do it or not.
+This is a capability that any server can implement, so the client can decide generically whether to ask the server to do it or not.
 So your editor can provide a setting to turn this on or off globally, for any language server you might use.
 
 Settings like this are typically provided by the generic LSP client support for your editor, for example in Emacs by [lsp-mode](https://github.com/emacs-lsp/lsp-mode).
@@ -42,7 +42,7 @@ Here is a list of the additional settings currently supported by `haskell-langua
 
 - Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, `stylish-haskell`, or `brittany` (if compiled with the brittany plugin).
 - Max completions (`haskell.maxCompletions`, default 40): maximum number of completions sent to the LSP client.
-- Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on load. As it is activated by default could drive to bad perfomance in large projects.
+- Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on load. As it is activated by default could drive to bad performance in large projects.
 - Check parents (`haskell.checkParents`, default `CheckOnSaveAndClose`): when to typecheck reverse dependencies of a file; one of `NeverCheck`, `CheckOnClose`, `CheckOnSaveAndClose`, or `AlwaysCheck`.
 
 #### Generic plugin configuration
@@ -72,7 +72,7 @@ Plugins have a generic config to control their behaviour. The schema of such con
     - `haskell.plugin.ghcide-completions.config.snippetsOn`, default true: Inserts snippets when using code completions.
     - `haskell.plugin.ghcide-completions.config.autoExtendOn`, default true: Extends the import list automatically when completing a out-of-scope identifier.
   - `ghcide-type-lenses`:
-    - `haskell.plugin.ghcide-type-lenses.config.mode`, default `always`: Control how type lenses are shown. One of `always`, `exported`, `diganostics`.
+    - `haskell.plugin.ghcide-type-lenses.config.mode`, default `always`: Control how type lenses are shown. One of `always`, `exported`, `diagnostics`.
   - `hlint`:
     - `haskell.plugin.hlint.config.flags`, default empty: List of flags used by hlint.
 This reference of configuration can be outdated at any time but we can query the `haskell-server-executable` about what configuration is effectively used:

docs/features.md

@@ -38,6 +38,12 @@ Provided by: `hls-hlint-plugin`
 
 Provides hlint hints as diagnostics.
 
+### Stan hints
+
+Provided by: `hls-stan-plugin`
+
+Provides Stan hints as diagnostics.
+
 ## Hovers
 
 Provided by: `ghcide`

docs/installation.md

@@ -19,27 +19,10 @@ You can check if HLS is available for your platform via `ghcup` here: <https://h
 You can also install HLS from source without checking out the code manually:
 
 ```bash
-# `ghcup compile` uses cabal under the hood to build, so you may 
-# want to run `cabal update` beforehand
-cabal update
 ghcup compile hls -v $HLS_VERSION --ghc $GHC_VERSION
 ```
 
-Make sure to check `ghcup compile hls --help` for more complete help.
-
-Examples:
-
-Install HLS 1.7.0.0 for GHC 8.10.7, or for multiple GHC versions:
-```bash
-ghcup compile hls -v 1.7.0.0 --ghc 8.10.7
-ghcup compile hls -v 1.7.0.0 --ghc 8.10.7 --ghc 9.2.3
-```
-
-Install HLS from master, or a specific commit:
-```
-ghcup compile hls -g master --ghc 9.2.3
-ghcup compile hls -g 510bd51e46fea8fb51ddfaa60bba505f0663497d --ghc 9.2.3
-```
+More information here: <https://www.haskell.org/ghcup/guide/#hls>
 
 ## Installation from source
 

docs/supported-versions.md

@@ -58,6 +58,7 @@ Sometimes a plugin will be supported in the pre-built binaries but not in a HLS
 | `hls-fourmolu-plugin`               |                          |
 | `hls-haddock-comments-plugin`       | 9.2                      |
 | `hls-hlint-plugin`                  |                          |
+| `hls-stan-plugin`                   | 8.6, 9.0, 9.2            |
 | `hls-module-name-plugin`            |                          |
 | `hls-ormolu-plugin`                 |                          |
 | `hls-pragmas-plugin`                |                          |