Add supported platforms to README

Update HLS
Warn when installing 8.10.5/8.10.6
2021-09-17 11:50:26 +02:00 · 2021-09-16 21:41:05 +02:00 · 2021-09-16 16:01:51 +02:00 · 2021-09-15 23:08:48 +02:00 · 2021-09-15 22:41:57 +02:00 · 2021-09-14 12:36:14 +02:00
7 changed files with 210 additions and 27 deletions
--- a/README.md
+++ b/README.md
@@ -10,8 +10,10 @@ Similar in scope to [rustup](https://github.com/rust-lang-nursery/rustup.rs), [p
 [![Join the chat at Matrix.org](https://img.shields.io/matrix/haskell-tooling:matrix.org?label=chat%20on%20matrix.org)](https://app.element.io/#/room/#haskell-tooling:matrix.org)
 [![Join the chat at Discord](https://img.shields.io/discord/280033776820813825?label=chat%20on%20discord)](https://discord.gg/pKYf3zDQU7)
 [![Join the chat at https://gitter.im/haskell/ghcup](https://badges.gitter.im/haskell/ghcup.svg)](https://gitter.im/haskell/ghcup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+<a href="https://opencollective.com/ghcup#category-CONTRIBUTE"><img src="https://opencollective.com/webpack/donate/button@2x.png?color=blue" alt="Donate" width="150"></a>

   * [Installation](#installation)
+     * [Supported platforms](#supported-platforms)
     * [Simple bootstrap](#simple-bootstrap)
     * [Manual install](#manual-install)
     * [Vim integration](#vim-integration)
@@ -34,6 +36,56 @@ Similar in scope to [rustup](https://github.com/rust-lang-nursery/rustup.rs), [p

 ## Installation

+### Supported platforms
+
+This list may not be exhaustive and specifies support for bindists only.
+
+| Platform | Architecture | ghcup | GHC | cabal | HLS | stack | 
+| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
+| Windows 7 | amd64 | ❔ | ✅ | ✅ | ✅ | ✅ |
+| Windows 10 | amd64 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| Windows Server 2016 | amd64 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| Windows Server 2019 | amd64 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| Windows Server 2022 | amd64 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| Windows WSL1 | amd64 | ❌ | ❔ | ❔ | ❔ | ❔ |
+| Windows WSL2 | amd64 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| MacOS >=13 | amd64 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| MacOS <13 | amd64 | ❌ | ❔ | ❔ | ❔ | ❔ |
+| MacOS | aarch64 | ✅ | ✅ | ✅ | ⚠️ | ❌ |
+| FreeBSD | amd64 | ✅ | ⚠️ | ✅ | ⚠️ | ❌ |
+| Linux generic | x86 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| Linux generic | amd64 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| Linux generic | aarch64 | ✅ | ⚠️ | ✅ | ⚠️ | ❌ |
+| Linux generic | armv7 | ✅ | ⚠️ | ✅ | ⚠️ | ❌ |
+
+#### Windows 7
+
+May or may not work, several issues:
+
+* https://gitlab.haskell.org/haskell/ghcup-hs/-/issues/140
+* https://gitlab.haskell.org/haskell/ghcup-hs/-/issues/197
+
+#### WSL1
+
+Unsupported. GHC may or may not work. Upgrade to WSL2.
+
+#### MacOS <13
+
+Not supported. Would require separate binaries, since >=13 binaries are incompatible.
+Please upgrade.
+
+#### MacOS aarch64
+
+HLS bindists are still experimental. Stack is theoretically supported, but has no binaries yet.
+
+#### FreeBSD
+
+Lacks some upstream bindists and may need compat libs, since most bindists are built on FreeBSD-12.
+
+#### Linux ARMv7/AARCH64
+
+Lower availability of bindists. HLS only has experimental ones. Stack now supported currently.
+
 ### Simple bootstrap

 Follow the instructions at [https://www.haskell.org/ghcup/](https://www.haskell.org/ghcup/)
--- a/data/metadata/ghcup-0.0.6.yaml
+++ b/data/metadata/ghcup-0.0.6.yaml
@@ -72,7 +72,6 @@ toolRequirements:
        '( >= 7 && < 8 )':
          distroPKGs:
          - gcc
-          - gcc-c++
          - gmp
          - gmp-devel
          - make
@@ -83,7 +82,6 @@ toolRequirements:
        unknown_versioning:
          distroPKGs:
          - gcc
-          - gcc-c++
          - gmp
          - gmp-devel
          - make
@@ -96,7 +94,6 @@ toolRequirements:
        unknown_versioning:
          distroPKGs:
          - gcc
-          - gcc-c++
          - gmp
          - gmp-devel
          - make
@@ -111,14 +108,15 @@ toolRequirements:
          - binutils-gold
          - curl
          - gcc
-          - g++
          - gmp-dev
-          - ncurses-dev
+          - libc-dev
          - libffi-dev
          - make
-          - xz
-          - tar
+          - musl-dev
+          - ncurses-dev
          - perl
+          - tar
+          - xz
          notes: ''
      Linux_UnknownLinux:
        unknown_versioning:
@@ -1598,6 +1596,11 @@ ghcupDownloads:
        dlHash: f10941f16e4fbd98580ab5241b9271bb0851304560c4d5ca127e3b0e20e3076f
      viPostRemove: *ghc-post-remove
      viPreCompile: *ghc-pre-compile
+      viPostInstall: &ghc-8105-post-install |
+        GHC 8.10.5 and 8.10.6 have several issues on Darwin, e.g.
+          https://gitlab.haskell.org/ghc/ghc/-/issues/19950
+        Consider upgrading to 8.10.7 via
+          ghcup install ghc --set 8.10.7
      viArch:
        A_64:
          Linux_Debian:
@@ -1698,6 +1701,7 @@ ghcupDownloads:
        dlHash: 43afba72a533408b42c1492bd047b5e37e5f7204e41a5cedd3182cc841610ce9
      viPostRemove: *ghc-post-remove
      viPreCompile: *ghc-pre-compile
+      viPostInstall: *ghc-8105-post-install
      viArch:
        A_64:
          Linux_Debian:
@@ -2314,7 +2318,8 @@ ghcupDownloads:
              dlHash: 983ebb5b584bfa600704216a63f94b40d36a02573834e90ef1042c8472d9ad57
  HLS:
    1.1.0:
-      viTags: []
+      viTags:
+        - old
      viChangeLog: https://github.com/haskell/haskell-language-server/blob/master/ChangeLog.md#110
      viPostInstall: &hls-post-install |
        This is just the server part of your LSP configuration. Consult the README on how to
@@ -2337,7 +2342,8 @@ ghcupDownloads:
          Linux_Alpine:
            unknown_versioning: *hls-110-64
    1.2.0:
-      viTags: []
+      viTags:
+        - old
      viChangeLog: https://github.com/haskell/haskell-language-server/blob/master/ChangeLog.md#120
      viPostInstall: *hls-post-install
      viArch:
@@ -2357,9 +2363,7 @@ ghcupDownloads:
          Linux_Alpine:
            unknown_versioning: *hls-120-64
    1.3.0:
-      viTags:
-        - Recommended
-        - Latest
+      viTags: []
      viChangeLog: https://github.com/haskell/haskell-language-server/blob/master/ChangeLog.md#130
      viPostInstall: *hls-post-install
      viArch:
@@ -2378,6 +2382,46 @@ ghcupDownloads:
              dlHash: 46aac7be888e29a9907cf56698c1ce1475c148b5e6cc099513e9ef74a0520dcf
          Linux_Alpine:
            unknown_versioning: *hls-130-64
+    1.4.0:
+      viTags:
+        - Recommended
+        - Latest
+      viChangeLog: https://github.com/haskell/haskell-language-server/blob/master/ChangeLog.md#140
+      viPostInstall: *hls-post-install
+      viArch:
+        A_64:
+          Linux_UnknownLinux:
+            unknown_versioning: &hls-140-64
+              dlUri: https://github.com/haskell/haskell-language-server/releases/download/1.4.0/haskell-language-server-Linux-1.4.0.tar.gz
+              dlHash: f93c114441911ccce55649702adc9553cb4c9f953c37878321d2806a3525fee8
+          Darwin:
+            unknown_versioning:
+              dlUri: https://github.com/haskell/haskell-language-server/releases/download/1.4.0/haskell-language-server-macOS-1.4.0.tar.gz
+              dlHash: a7f0ac6be93ffb08cc239e5f5fead99b061061825f99566c1be33ee60cab62a4
+          FreeBSD:
+            unknown_versioning:
+              dlUri: https://downloads.haskell.org/ghcup/unofficial-bindists/haskell-language-server/1.4.0/haskell-language-server-freebsd-1.4.0.tar.gz
+              dlHash: 6b2ad2398ed8c3964dea017e3d5e553b54c10ba1373d7653d2edd019854f4da2
+          Windows:
+            unknown_versioning:
+              dlUri: https://github.com/haskell/haskell-language-server/releases/download/1.4.0/haskell-language-server-Windows-1.4.0.tar.gz
+              dlHash: 0ec77cee750037b7a0ede817b46a913a702821f4098c6a858bcb686cb30f7efd
+          Linux_Alpine:
+            unknown_versioning: *hls-140-64
+        A_ARM64:
+          Linux_UnknownLinux:
+            unknown_versioning:
+              dlUri: https://downloads.haskell.org/ghcup/unofficial-bindists/haskell-language-server/1.4.0/haskell-language-server-linux-aarch64-1.4.0.tar.gz
+              dlHash: 8ad97e2bf1c538e637edec194e1cd9939019955bb749cb470f34bbe5a067b001
+          Darwin:
+            unknown_versioning:
+              dlUri: https://downloads.haskell.org/ghcup/unofficial-bindists/haskell-language-server/1.4.0/haskell-language-server-macOS-aarch64-1.4.0.tar.gz
+              dlHash: 70c6fe38e987ba44c1e19173486c01f666ffb30a74cd5a7968296a5aba4c2dd0
+        A_ARM:
+          Linux_UnknownLinux:
+            unknown_versioning:
+              dlUri: https://downloads.haskell.org/ghcup/unofficial-bindists/haskell-language-server/1.4.0/haskell-language-server-linux-armv7-1.4.0.tar.gz
+              dlHash: 4a921fbca06b02f3b1c0930cec5e65e9362b603e7715680ec7b150f18bd703d6
  Stack:
    2.5.1:
      viTags:
--- a/data/metadata/ghcup-0.0.7.yaml
+++ b/data/metadata/ghcup-0.0.7.yaml
@@ -72,7 +72,6 @@ toolRequirements:
        '( >= 7 && < 8 )':
          distroPKGs:
          - gcc
-          - gcc-c++
          - gmp
          - gmp-devel
          - make
@@ -83,7 +82,6 @@ toolRequirements:
        unknown_versioning:
          distroPKGs:
          - gcc
-          - gcc-c++
          - gmp
          - gmp-devel
          - make
@@ -96,7 +94,6 @@ toolRequirements:
        unknown_versioning:
          distroPKGs:
          - gcc
-          - gcc-c++
          - gmp
          - gmp-devel
          - make
@@ -109,7 +106,6 @@ toolRequirements:
        unknown_versioning:
          distroPKGs:
          - gcc
-          - g++
          - gmp
          - gmp-devel
          - make
@@ -125,14 +121,15 @@ toolRequirements:
          - binutils-gold
          - curl
          - gcc
-          - g++
          - gmp-dev
-          - ncurses-dev
+          - libc-dev
          - libffi-dev
          - make
-          - xz
-          - tar
+          - musl-dev
+          - ncurses-dev
          - perl
+          - tar
+          - xz
          notes: ''
      Linux_UnknownLinux:
        unknown_versioning:
@@ -1652,6 +1649,11 @@ ghcupDownloads:
        dlHash: f10941f16e4fbd98580ab5241b9271bb0851304560c4d5ca127e3b0e20e3076f
      viPostRemove: *ghc-post-remove
      viPreCompile: *ghc-pre-compile
+      viPostInstall: &ghc-8105-post-install |
+        GHC 8.10.5 and 8.10.6 have several issues on Darwin, e.g.
+          https://gitlab.haskell.org/ghc/ghc/-/issues/19950
+        Consider upgrading to 8.10.7 via
+          ghcup install ghc --set 8.10.7
      viArch:
        A_64:
          Linux_Debian:
@@ -1754,6 +1756,7 @@ ghcupDownloads:
        dlHash: 43afba72a533408b42c1492bd047b5e37e5f7204e41a5cedd3182cc841610ce9
      viPostRemove: *ghc-post-remove
      viPreCompile: *ghc-pre-compile
+      viPostInstall: *ghc-8105-post-install
      viArch:
        A_64:
          Linux_Debian:
@@ -2376,7 +2379,8 @@ ghcupDownloads:
              dlHash: 983ebb5b584bfa600704216a63f94b40d36a02573834e90ef1042c8472d9ad57
  HLS:
    1.1.0:
-      viTags: []
+      viTags:
+        - old
      viChangeLog: https://github.com/haskell/haskell-language-server/blob/master/ChangeLog.md#110
      viPostInstall: &hls-post-install |
        This is just the server part of your LSP configuration. Consult the README on how to
@@ -2399,7 +2403,8 @@ ghcupDownloads:
          Linux_Alpine:
            unknown_versioning: *hls-110-64
    1.2.0:
-      viTags: []
+      viTags:
+        - old
      viChangeLog: https://github.com/haskell/haskell-language-server/blob/master/ChangeLog.md#120
      viPostInstall: *hls-post-install
      viArch:
@@ -2419,9 +2424,7 @@ ghcupDownloads:
          Linux_Alpine:
            unknown_versioning: *hls-120-64
    1.3.0:
-      viTags:
-        - Recommended
-        - Latest
+      viTags: []
      viChangeLog: https://github.com/haskell/haskell-language-server/blob/master/ChangeLog.md#130
      viPostInstall: *hls-post-install
      viArch:
@@ -2440,6 +2443,46 @@ ghcupDownloads:
              dlHash: 46aac7be888e29a9907cf56698c1ce1475c148b5e6cc099513e9ef74a0520dcf
          Linux_Alpine:
            unknown_versioning: *hls-130-64
+    1.4.0:
+      viTags:
+        - Recommended
+        - Latest
+      viChangeLog: https://github.com/haskell/haskell-language-server/blob/master/ChangeLog.md#140
+      viPostInstall: *hls-post-install
+      viArch:
+        A_64:
+          Linux_UnknownLinux:
+            unknown_versioning: &hls-140-64
+              dlUri: https://github.com/haskell/haskell-language-server/releases/download/1.4.0/haskell-language-server-Linux-1.4.0.tar.gz
+              dlHash: f93c114441911ccce55649702adc9553cb4c9f953c37878321d2806a3525fee8
+          Darwin:
+            unknown_versioning:
+              dlUri: https://github.com/haskell/haskell-language-server/releases/download/1.4.0/haskell-language-server-macOS-1.4.0.tar.gz
+              dlHash: a7f0ac6be93ffb08cc239e5f5fead99b061061825f99566c1be33ee60cab62a4
+          FreeBSD:
+            unknown_versioning:
+              dlUri: https://downloads.haskell.org/ghcup/unofficial-bindists/haskell-language-server/1.4.0/haskell-language-server-freebsd-1.4.0.tar.gz
+              dlHash: 6b2ad2398ed8c3964dea017e3d5e553b54c10ba1373d7653d2edd019854f4da2
+          Windows:
+            unknown_versioning:
+              dlUri: https://github.com/haskell/haskell-language-server/releases/download/1.4.0/haskell-language-server-Windows-1.4.0.tar.gz
+              dlHash: 0ec77cee750037b7a0ede817b46a913a702821f4098c6a858bcb686cb30f7efd
+          Linux_Alpine:
+            unknown_versioning: *hls-140-64
+        A_ARM64:
+          Linux_UnknownLinux:
+            unknown_versioning:
+              dlUri: https://downloads.haskell.org/ghcup/unofficial-bindists/haskell-language-server/1.4.0/haskell-language-server-linux-aarch64-1.4.0.tar.gz
+              dlHash: 8ad97e2bf1c538e637edec194e1cd9939019955bb749cb470f34bbe5a067b001
+          Darwin:
+            unknown_versioning:
+              dlUri: https://downloads.haskell.org/ghcup/unofficial-bindists/haskell-language-server/1.4.0/haskell-language-server-macOS-aarch64-1.4.0.tar.gz
+              dlHash: 70c6fe38e987ba44c1e19173486c01f666ffb30a74cd5a7968296a5aba4c2dd0
+        A_ARM:
+          Linux_UnknownLinux:
+            unknown_versioning:
+              dlUri: https://downloads.haskell.org/ghcup/unofficial-bindists/haskell-language-server/1.4.0/haskell-language-server-linux-armv7-1.4.0.tar.gz
+              dlHash: 4a921fbca06b02f3b1c0930cec5e65e9362b603e7715680ec7b150f18bd703d6
  Stack:
    2.5.1:
      viTags:
--- a/lib/GHCup.hs
+++ b/lib/GHCup.hs
@@ -868,6 +868,8 @@ setGHC ver sghc = do
  -- create symlink for share dir
  when (isNothing . _tvTarget $ ver) $ lift $ symlinkShareDir ghcdir verS

+  when (sghc == SetGHCOnly) $ lift warnAboutHlsCompatibility
+
  pure ver

 where
@@ -978,6 +980,8 @@ setHLS ver = do

  lift $ createLink destL wrapper

+  lift warnAboutHlsCompatibility
+
  pure ()


@@ -1010,6 +1014,31 @@ setStack ver = do
  pure ()


+-- | Warn if the installed and set HLS is not compatible with the installed and
+-- set GHC version.
+warnAboutHlsCompatibility :: ( MonadReader env m
+                             , HasDirs env
+                             , HasLog env
+                             , MonadThrow m
+                             , MonadCatch m
+                             , MonadIO m
+                             )
+                          => m ()
+warnAboutHlsCompatibility = do
+  supportedGHC <- hlsGHCVersions
+  currentGHC   <- fmap _tvVersion <$> ghcSet Nothing
+  currentHLS   <- hlsSet
+
+  case (currentGHC, currentHLS) of
+    (Just gv, Just hv) | gv `notElem` supportedGHC -> do
+      logWarn $
+        "GHC " <> T.pack (prettyShow gv) <> " is not compatible with " <>
+        "Haskell Language Server " <> T.pack (prettyShow hv) <> "." <> "\n" <>
+        "Haskell IDE support may not work until this is fixed." <> "\n" <>
+        "Install a different HLS version, or install and set one of the following GHCs:" <> "\n" <>
+        T.pack (prettyShow supportedGHC)
+        
+    _ -> return ()

    ------------------
    --[ List tools ]--
--- a/lib/GHCup/Utils.hs
+++ b/lib/GHCup/Utils.hs
@@ -475,7 +475,7 @@ hlsGHCVersions = do
        . splitOn "~"
        )
      bins
-  pure . rights . concat . maybeToList $ vers
+  pure . sortBy (flip compare) . rights . concat . maybeToList $ vers


 -- | Get all server binaries for an hls version, if any.
--- a/www/ghcup.css
+++ b/www/ghcup.css
@@ -174,7 +174,17 @@ span.code {
    line-height: 2rem;
 }

+#help {
+    margin-bottom: 0px !important;
+}
+
+#collective {
+    margin-top: 1em !important;
+    margin-bottom: 0px !important;
+}
+
 #about {
+    margin-top: 0.5em !important;
    font-size: 16px;
    line-height: 2em;
 }
--- a/www/index.html
+++ b/www/index.html
@@ -137,9 +137,14 @@

      </div>

-      <p>
+      <p id="help">
 	  Need help? Ask on <a href="https://kiwiirc.com/nextclient/irc.libera.chat/?nick=Guest%7C?#haskell,#haskell-ghcup"><img src="irc.svg" height="18px" alt="" />IRC</a>, <a href="https://discord.gg/pKYf3zDQU7"><img src="Discord-Logo-Black.svg" height="18px" alt="" />Discord</a>, <a href="https://app.element.io/#/room/#haskell-tooling:matrix.org"><img src="Matrix_logo.svg" height="25px" alt="" style="top:5px;position:relative;" /></a> or <a href="https://gitlab.haskell.org/haskell/ghcup-hs/issues">report a bug <img src="Octicons-bug.svg" height="18px" alt="" /></a>.
      </p>
+      <p id="collective">
+		<a id="collective" href="https://opencollective.com/ghcup#category-CONTRIBUTE" target="_blank">
+			<img src="https://opencollective.com/webpack/donate/button@2x.png?color=blue" width=200 />
+		</a>
+      </p>

      <p id="about">
        <img src="haskell-logo.svg" alt="" />
Author	SHA1	Message	Date
Julian Ospald	b1f891b005	Add supported platforms to README	2021-09-17 11:50:26 +02:00
Julian Ospald	648dcc7287	Update HLS	2021-09-16 21:41:05 +02:00
Julian Ospald	2175f7dd3d	Warn when installing 8.10.5/8.10.6	2021-09-16 16:01:51 +02:00
Julian Ospald	aff90a52f1	Merge branch 'hls-1.4.0'	2021-09-15 23:08:48 +02:00
Julian Ospald	0f14dee72a	Bump HLS to 1.4.0	2021-09-15 22:41:57 +02:00
Julian Ospald	ae2031174e	Improve warnAboutHlsCompatibility	2021-09-14 12:36:14 +02:00
Julian Ospald	c163278c64	Merge remote-tracking branch 'origin/merge-requests/172'	2021-09-14 12:26:41 +02:00
Julian Ospald	d10133f06f	Clean up toolRequirements	2021-09-13 22:33:46 +02:00
Julian Ospald	4377fc663e	Merge branch 'opencollective'	2021-09-13 08:43:10 +02:00
Julian Ospald	487e236882	Add opencollective button	2021-09-13 08:34:13 +02:00
Chris Smith	737f72f90f	Lint fix.	2021-09-11 23:35:39 -04:00
Chris Smith	c3aab65521	Rewording	2021-09-11 23:24:21 -04:00
Chris Smith	972474f79a	Add version numbers to error message. Fixes after formatting changes.	2021-09-11 23:17:14 -04:00
Julian Ospald	bc64d2ade0	Apply 3 suggestion(s) to 1 file(s)	2021-09-12 03:09:36 +00:00
Chris Smith	eddda55fe6	Fix hlint warnings	2021-09-11 19:57:42 -04:00
Chris Smith	13aca91231	Add a warning when the installed HLS and GHC versions are not compatible. This is triggered when: 1. The user has just set either the GHC or HLS version. 2. There is an HLS version set (so some GHC version is compatible). 3. There is a GHC version. 4. The HLS version doesn't support that GHC version. Fixes #234	2021-09-11 19:33:27 -04:00