Merge pull request #533 from hasufell/update-hls-installation

Update HLS installation method

Author: fendor

.github/workflows/test.yml

@@ -11,35 +11,69 @@ jobs:
     strategy:
       matrix:
         os: [macos-11, ubuntu-latest, windows-latest]
-        ghc: [9.0.1]
-        include:
-          # To test a ghc version deprecated in newer hls versions
-          - os: ubuntu-latest
-            ghc: 8.10.4
+        ghc: [9.0.1, 8.10.4]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Install Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 14
+          node-version: 17
+      # Setup the environment for the tests
       - name: Ensure there is a supported ghc versions
         uses: haskell/actions/setup@v1
         with:
           ghc-version: ${{ matrix.ghc }}
+          run: xvfb-run -s '-screen 0 640x480x16' -a npm test
+      - name: "Install `tree` for MacOs"
+        run: |
+          brew update
+          brew install tree
+        if: runner.os == 'macOS'
+      - name: "Install `tree` for Windows"
+        run: |
+          choco install tree
+        if: runner.os == 'Windows'
+      # Pre-fetch HLS binaries before the tests because otherwise
+      # we run into timeouts. Downloading takes longer, since we download
+      # per HLS version one HLS binary per GHC version.
+      - run: |
+          mkdir -p test-workspace/bin/
+          export GHCUP_INSTALL_BASE_PREFIX=$(pwd)/test-workspace/bin
+          echo $XDG_BIN_HOME $GHCUP_INSTALL_BASE_PREFIX
+          ghcup config set cache true
+          ghcup --no-verbose prefetch hls 1.4.0
+          ghcup --no-verbose prefetch hls latest
+        shell: bash
+
+      # Install test dependencies
       - run: npm ci
       - run: npm run webpack
+
+      # Run the tests
       - run: xvfb-run -s '-screen 0 640x480x16' -a npm test
         if: runner.os == 'Linux'
       - run: npm test
         if: runner.os != 'Linux'
+
+      # Upload test artefacts
       - name: Upload log file to workflow artifacts on error
         if: failure()
         uses: actions/upload-artifact@v2
         with:
           name: extension-${{ matrix.os }}.log
           path: test-workspace/hls.log
+
+      # Create package artefacts
+      - name: Delete test artefacts
+        # The test-suite doesn't clean up correctly after itself.
+        # This is a poor man's workaround that after test execution,
+        # the test-workspace still contains binaries and caches.
+        run: |
+          tree -a test-workspace/
+          rm -rf test-workspace/
+        shell: bash
       - name: Package tested extension
         if: runner.os == 'Linux'
         run: npx vsce package

README.md

@@ -71,21 +71,27 @@ The environment _only will be visible for the lsp server_, not for other extensi
 
 ### Downloaded binaries
 
-This extension will download `haskell-language-server` binaries to a specific location depending on your system.
+This extension will download `haskell-language-server` binaries via an (internal) ghcup to a specific location depending
+on your system, unless you set the config option `haskell.manageHLS` to `false` (the default is `true`).
 
 It will download the newest version of haskell-language-server which has support for the required ghc.
 That means it could use an older version than the latest one, without the last features and bug fixes.
 For example, if a project needs ghc-8.10.4 the extension will download and use haskell-language-server-1.4.0, the lastest version which supported ghc-8.10.4. Even if the lastest global haskell language-server version is 1.5.1.
 
 If you find yourself running out of disk space, you can try deleting old versions of language servers in this directory. The extension will redownload them, no strings attached.
 
-| Platform | Path                                                                      |
-| -------- | ------------------------------------------------------------------------- |
-| macOS    | `~/Library/Application\ Support/Code/User/globalStorage/haskell.haskell/` |
-| Windows  | `%APPDATA%\Code\User\globalStorage\haskell.haskell`                       |
-| Linux    | `$HOME/.config/Code/User/globalStorage/haskell.haskell`                   |
+| Platform | Path                                                                            |
+| -------- | ------------------------------------------------------------------------------- |
+| macOS    | `~/Library/Application\ Support/Code/User/globalStorage/haskell.haskell/.ghcup` |
+| Windows  | `%APPDATA%\Code\User\globalStorage\haskell.haskell\ghcup`                       |
+| Linux    | `$HOME/.config/Code/User/globalStorage/haskell.haskell/.ghcup`                  |
 
-Note that if `haskell-language-server-wrapper`/`haskell-language-server` is already on the PATH or you have set the `haskell.serverExecutablePath` option, then the extension will launch it directly instead of downloading binaries, even if the version of the former is older then the latter.
+If you want to manage HLS yourself, set `haskell.manageHLS` to `false` and make sure HLS is in your PATH
+or set `haskell.serverExecutablePath` to a valid executable.
+
+You can also tell HLS to use your system provided ghcup by setting `haskell.useSystemGHCup` to `true` (default is `false`).
+
+If you need to set mirrors for ghcup download info, check the settings `haskell.metadataURL` and `haskell.releasesURL`.
 
 ### Supported GHC versions