Add stack ghc installation hooks and install stack by default

Fixes #407.

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Revision history for ghcup
 
+## 0.1.18.1 -- 2022-08-06
+
+* fix sdist and unbreak hackage, wrt [#399](https://gitlab.haskell.org/haskell/ghcup-hs/-/issues/399)
+
 ## 0.1.18.0 -- 2022-07-30
 
 * Fix tui set wrt [#266](https://gitlab.haskell.org/haskell/ghcup-hs/-/merge_requests/266) by Arjun Kathuria
@@ -8,23 +12,23 @@
     - bindists that don't support `make DESTDIR=/some/tmp/dir install` are now unsupported
     - installed GHC files are now recorded to avoid use of `removePathForcibly`
     - internally uses a newtype wrapper for user-input paths and restrict destructive operations to validated paths
+* Add `--disable-ld-override` for darwin bindists wrt #391
+* Allow passing bindist configure args wrt #377
 * use of `TMPDIR` is dropped... now uses an internal tmp dir `~/.ghcup/tmp`
 * improvements to error handling and warnings
 * Require --isolate to have an absolute directory, fixes #367
 * Fix mingw PATH handling wrt #371
 * Add --mingw-path switch to `ghcup run`
 * Fix `ghcup run` on windows, fixes #375
-* Allow passing bindist configure args wrt #377
+* Improve `ghcup compile <hls|ghc>`
-* Improve `ghcup compile hls`
     - short hashes now work
-    - print the long hash in addition to the detected cabal version of HLS
+    - print the long hash in addition to the detected version
+* Improve `ghcup compile hls`
     - add `--git-describe-version` switch as an alternative to `--overwrite-version`
     - Allow to build HLS from hackage (now is the default)
 	- Allow to run 'cabal update' automatically before the HLS build
 	- Fix parser and completer for 'ghcup compile hls --version'
 * Improve `ghcup compile ghc`
-    - short hashes now work
-    - print the long hash in addition to the detected cabal version of HLS
     - Allow to build from arbitrary GHC source dists
 
 ## 0.1.17.10 -- 2022-05-12

app/ghcup/GHCup/OptParse/Install.hs

@@ -171,7 +171,7 @@ Examples:
   ghcup install ghc 8.10.2
 
   # install GHC head fedora bindist
-  ghcup install ghc -u https://gitlab.haskell.org/api/v4/projects/1/jobs/artifacts/master/raw/ghc-x86_64-fedora27-linux.tar.xz?job=validate-x86_64-linux-fedora27 head|]
+  ghcup install ghc -u 'https://gitlab.haskell.org/ghc/ghc/-/jobs/artifacts/master/raw/ghc-x86_64-linux-fedora33-release.tar.xz?job=x86_64-linux-fedora33-release' head|]
 
 
 installOpts :: Maybe Tool -> Parser InstallOptions
@@ -546,4 +546,3 @@ install installCommand settings getAppState' runLogger = case installCommand of
                 logError $ T.pack $ prettyShow e
                 logError $ "Also check the logs in " <> T.pack (fromGHCupPath logsDir)
               pure $ ExitFailure 4
-

docs/guide.md

@@ -238,7 +238,8 @@ There are a couple of good use cases to install custom bindists:
 1. manually built bindists (e.g. with patches)
     - example: `ghcup install ghc -u 'file:///home/mearwald/tmp/ghc-eff-patches/ghc-8.10.2-x86_64-deb10-linux.tar.xz' 8.10.2-eff`
 2. GHC head CI bindists
-    - example: `ghcup install ghc -u 'https://gitlab.haskell.org/api/v4/projects/1/jobs/artifacts/master/raw/ghc-x86_64-fedora27-linux.tar.xz?job=validate-x86_64-linux-fedora27' head`
+    - example specifying a branch (`master`): `ghcup install ghc -u 'https://gitlab.haskell.org/ghc/ghc/-/jobs/artifacts/master/raw/ghc-x86_64-linux-fedora33-release.tar.xz?job=x86_64-linux-fedora33-release' head`
+    - example specifying a job id (`1129565`): `ghcup install ghc -u ' https://gitlab.haskell.org/api/v4/projects/1/jobs/1129565/artifacts/ghc-x86_64-linux-alpine3_12-validate+fully_static.tar.xz' mr7847`
 3. DWARF bindists
     - example: `ghcup install ghc -u 'https://downloads.haskell.org/~ghc/8.10.2/ghc-8.10.2-x86_64-deb10-linux-dwarf.tar.xz' 8.10.2-dwarf`
 
@@ -302,6 +303,23 @@ To instruct cabal to run `cabal update` before building, run `ghcup compile hls
 
 As always, check `ghcup compile hls --help`.
 
+#### Updating HLS for a new GHC version
+
+First try to build from hackage with some tricks:
+
+```sh
+ghcup compile hls --version 1.7.0.0 --ghc 9.2.4 --cabal-update -- --allow-newer --index-state=2022-06-12T00:00:00Z
+```
+
+This augments the currently installed 1.7.0.0 official bindists in ghcup with new GHC versions support.
+
+If that fails (since `--allow-newer` is quite brutal), you can install from HLS master branch (which may contain new fixes) like so:
+```
+ghcup compile hls --git-ref master --git-describe-version --ghc 8.10.7 --ghc 9.2.4 --cabal-update
+```
+
+This however will create a new HLS version in ghcup, e.g. `1.7.0.0-105-gdc682ba1`, for both 8.10.7 and 9.2.4. If you want to switch back to the official bindists, run `ghcup set hls 1.7.0.0`.
+
 ### Cross support
 
 ghcup can compile and install a cross GHC for any target. However, this
@@ -329,20 +347,20 @@ You need to use the `--isolate` or `-i` flag followed by the directory path.
 
 Examples:
 
-1. install an isolated GHC version at location /home/user/isolated_dir/ghc/  
+1. install an isolated GHC version at location /home/user/isolated_dir/ghc/
     - `ghcup install ghc 8.10.5 --isolate /home/user/isolated_dir/ghc`
 
-2. isolated install Cabal at a location you desire  
+2. isolated install Cabal at a location you desire
     - `ghcup install cabal --isolate /home/username/my_isolated_dir/`
 
-3. do an isolated install with a custom bindist  
+3. do an isolated install with a custom bindist
-    - `ghcup install ghc --isolate /home/username/my_isolated_dir/ -u 'https://gitlab.haskell.org/api/v4/projects/1/jobs/artifacts/master/raw/ghc-x86_64-fedora27-linux.tar.xz?job=validate-x86_64-linux-fedora27' head`
+    - `ghcup install ghc --isolate /home/username/my_isolated_dir/ -u 'https://gitlab.haskell.org/ghc/ghc/-/jobs/artifacts/master/raw/ghc-x86_64-linux-fedora33-release.tar.xz?job=x86_64-linux-fedora33-release' head`
 
-4. isolated install HLS  
+4. isolated install HLS
     - `ghcup install hls --isolate /home/username/dir/hls/`
 
-5. you can even compile ghc to an isolated location.  
+5. you can even compile ghc to an isolated location.
-    - `ghcup compile ghc -j 4 -v 9.0.1 -b 8.10.5 -i /home/username/my/dir/ghc` 
+    - `ghcup compile ghc -j 4 -v 9.0.1 -b 8.10.5 -i /home/username/my/dir/ghc`
 
 ## Continuous integration
 

docs/install.md

@@ -55,7 +55,9 @@ GHCup supports the following tools, which are also known as the **Haskell Toolch
 <table>
 <thead><tr><th>GHC Version</th><th>Tags</th></tr></thead>
 <tbody>
-<tr><td>9.2.3</td><td><span style="color:blue">latest</span>, base-4.16.2.0</td></tr>
+<tr><td>9.4.1</td><td><span style="color:blue">latest</span>, base-4.17.0.0</td></tr>
+<tr><td>9.2.4</td><td>base-4.16.3.0</td></tr>
+<tr><td>9.2.3</td><td>base-4.16.2.0</td></tr>
 <tr><td>9.2.2</td><td>base-4.16.1.0</td></tr>
 <tr><td>9.2.1</td><td>base-4.16.0.0</td></tr>
 <tr><td>9.0.2</td><td>base-4.15.1.0</td></tr>
@@ -208,6 +210,8 @@ The developers of the Haskell Language Server offer an [extension](https://githu
 3. Make sure your project uses the GHC version installed from GHCup (otherwise HLS is likely to fail on launch):
     - instructions for [stack](https://docs.haskellstack.org/en/stable/yaml_configuration/#system-ghc)
 
+On Linux, some users have reported an issue when VSCode is not launched from a terminal ("cannot find ghc version"). A solution is to [let HLS know about your GHCup on $PATH](https://github.com/haskell/vscode-haskell#stackcabalghc-can-not-be-found).
+
 ## Get help
 
 * [Libera IRC chat on #haskell-ghcup or #haskell](https://kiwiirc.com/nextclient/irc.libera.chat/?nick=Guest%7C?#haskell,#haskell-ghcup)

docs/steps.md

@@ -335,7 +335,7 @@ see the [Cabal user guide](https://cabal.readthedocs.io/en/stable/getting-starte
 
 To learn Haskell, try any of those:
 
-- A beginner friendly [4-lectures course](https://github.com/haskell-beginners-2022/course-plan) with exercises (by [Kowainik](https://kowainik.github.io/))
+- A beginner friendly [4-lectures course](https://github.com/haskell-beginners-2022/course-plan) with exercises (by [Dmitrii Kovanikov](https://kodimensional.dev/))
 - An in-depth university [CIS 194 Haskell course](https://www.cis.upenn.edu/~cis194/spring13/) including exercises (by [Brent Yorgey](https://byorgey.wordpress.com/))
 
 ## Projects to contribute to

ghcup.cabal

@@ -1,6 +1,6 @@
 cabal-version:      3.0
 name:               ghcup
-version:            0.1.18.0
+version:            0.1.18.1
 license:            LGPL-3.0-only
 license-file:       LICENSE
 copyright:          Julian Ospald 2020
@@ -21,6 +21,8 @@ extra-doc-files:
   README.md
 
 extra-source-files:
+  cbits/dirutils.c
+  cbits/dirutils.h
   data/build_mk/cross
   data/build_mk/default
   test/golden/GHCupInfo.json
@@ -162,14 +164,13 @@ library
       , terminal-progress-bar  >=0.4.1
 
   if os(windows)
-    cpp-options:   -DIS_WINDOWS
+    cpp-options:     -DIS_WINDOWS
     other-modules:
       GHCup.Prelude.File.Windows
       GHCup.Prelude.Windows
-    -- GHCup.OptParse.Run uses this
-    exposed-modules:
-      GHCup.Prelude.Process.Windows
 
+    -- GHCup.OptParse.Run uses this
+    exposed-modules: GHCup.Prelude.Process.Windows
     build-depends:
       , bzlib
       , process  ^>=1.6.11.0
@@ -183,7 +184,10 @@ library
       GHCup.Prelude.Posix
       GHCup.Prelude.Process.Posix
 
-    c-sources:     cbits/dirutils.c
+    include-dirs:     cbits
+    includes:         dirutils.h
+    install-includes: dirutils.h
+    c-sources:        cbits/dirutils.c
     build-depends:
       , bz2              >=0.5.0.5 && <1.1
       , terminal-size    ^>=0.3.2.1
@@ -237,7 +241,7 @@ executable ghcup
     , aeson-pretty          ^>=0.8.8
     , async                 ^>=2.2.3
     , base                  >=4.12     && <5
-    , bytestring            >=0.10       && <0.12
+    , bytestring            >=0.10     && <0.12
     , cabal-plan            ^>=0.7.2
     , containers            ^>=0.6
     , deepseq               ^>=1.4
@@ -314,11 +318,11 @@ test-suite ghcup-test
 
   build-depends:
     , base                      >=4.12    && <5
-    , bytestring            >=0.10       && <0.12
+    , bytestring                >=0.10    && <0.12
     , containers                ^>=0.6
     , directory                 ^>=1.3.6.0
     , filepath                  ^>=1.4.2.1
-    , generic-arbitrary         >=0.1.0  && < 0.2.1 || >=0.2.2 && <0.3
+    , generic-arbitrary         >=0.1.0   && <0.2.1 || >=0.2.2 && <0.3
     , ghcup
     , hspec                     >=2.7.10  && <2.10
     , hspec-golden-aeson        ^>=0.9

lib/GHCup/Errors.hs

@@ -138,7 +138,7 @@ data AlreadyInstalled = AlreadyInstalled Tool Version
 instance Pretty AlreadyInstalled where
   pPrint (AlreadyInstalled tool ver') =
     (pPrint tool <> text "-" <> pPrint ver') <+> text "is already installed;"
-    <+> text "if you really want to reinstall it, you may want to run 'ghcup install cabal --force" <+> (pPrint ver' <> text "'")
+    <+> text "if you really want to reinstall it, you may want to run 'ghcup install" <+> pPrint tool <+> text "--force" <+> (pPrint ver' <> text "'")
 
 
 -- | The Directory is supposed to be empty, but wasn't.

scripts/bootstrap/bootstrap-haskell

@@ -12,7 +12,8 @@
 #   * BOOTSTRAP_HASKELL_VERBOSE - any nonzero value for more verbose installation
 #   * BOOTSTRAP_HASKELL_GHC_VERSION - the ghc version to install
 #   * BOOTSTRAP_HASKELL_CABAL_VERSION - the cabal version to install
-#   * BOOTSTRAP_HASKELL_INSTALL_STACK - whether to install latest stack
+#   * BOOTSTRAP_HASKELL_INSTALL_NO_STACK - disable installation of stack
+#   * BOOTSTRAP_HASKELL_INSTALL_NO_STACK_HOOK - disable installation stack ghcup hook
 #   * BOOTSTRAP_HASKELL_INSTALL_HLS - whether to install latest hls
 #   * BOOTSTRAP_HASKELL_ADJUST_BASHRC - whether to adjust PATH in bashrc (prepend)
 #   * BOOTSTRAP_HASKELL_ADJUST_CABAL_CONFIG - whether to adjust mingw paths in cabal.config on windows
@@ -27,7 +28,7 @@
 
 plat="$(uname -s)"
 arch=$(uname -m)
-ghver="0.1.17.8"
+ghver="0.1.18.0"
 : "${GHCUP_BASE_URL:=https://downloads.haskell.org/~ghcup}"
 
 export GHCUP_SKIP_UPDATE_CHECK=yes
@@ -692,40 +693,44 @@ ask_hls() {
 }
 
 ask_stack() {
-	if [ -n "${BOOTSTRAP_HASKELL_INSTALL_STACK}" ] ; then
+    if [ -n "${BOOTSTRAP_HASKELL_INSTALL_NO_STACK}" ] ; then
+		return 0
+    elif [ -n "${BOOTSTRAP_HASKELL_INSTALL_NO_STACK_HOOK}" ] ; then
 		return 1
 	fi
 
 	if [ -z "${BOOTSTRAP_HASKELL_NONINTERACTIVE}" ] ; then
 		echo "-------------------------------------------------------------------------------"
 
-		warn "Do you want to install stack?"
+		warn "Do you want to enable better integration of stack with GHCup?"
-		warn "Stack is a haskell build tool similar to cabal that is used by some projects."
+        warn "This means that stack won't install its own GHC versions, but uses GHCup's."
-		warn "Also see https://docs.haskellstack.org/"
+        warn "For more information see:"
+        warn "  https://docs.haskellstack.org/en/stable/yaml_configuration/#ghc-installation-customisation-experimental"
+        warn "If you want to keep stacks vanilla behavior, answer 'No'."
 		warn ""
-		warn "[Y] Yes  [N] No  [?] Help (default is \"N\")."
+		warn "[Y] Yes  [N] No  [?] Help (default is \"Y\")."
 		warn ""
 
 		while true; do
 			read -r stack_answer </dev/tty
 
 			case $stack_answer in
-				[Yy]*)
+				[Yy]* | "")
+					return 2 ;;
+				[Nn]*)
 					return 1 ;;
-				[Nn]* | "")
-					return 0 ;;
 				*)
 					echo "Possible choices are:"
 					echo
-					echo "Y - Yes, install stack"
+                    echo "Y - Yes, enable better integration (default)"
-					echo "N - No, don't install anything more (default)"
+					echo "N - No, keep stacks vanilla behavior"
 					echo
 					echo "Please make your choice and press ENTER."
 					;;
 			esac
 		done
 	else
-		return 0
+		return 2
 	fi
 
 	unset stack_answer
@@ -742,7 +747,7 @@ echo "This script can download and install the following binaries:"
 echo "  * ghcup - The Haskell toolchain installer"
 echo "  * ghc   - The Glasgow Haskell Compiler"
 echo "  * cabal - The Cabal build tool for managing Haskell software"
-echo "  * stack - (optional) A cross-platform program for developing Haskell projects"
+echo "  * stack - A cross-platform program for developing Haskell projects (similar to cabal)"
 echo "  * hls   - (optional) A language server for developers to integrate with their editor/IDE"
 echo
 if [ -z "${GHCUP_USE_XDG_DIRS}" ] ; then
@@ -839,7 +844,35 @@ esac
 
 case $ask_stack_answer in
 	1)
-		_eghcup --cache install stack || warn "Stack installation failed, continuing anyway"
+		_eghcup --cache install stack || die "Stack installation failed"
+		;;
+	2)
+		_eghcup --cache install stack || die "Stack installation failed"
+        edo mkdir -p "${STACK_ROOOT:-$HOME/.stack}"/hooks
+        hook_exe="${STACK_ROOOT:-$HOME/.stack}"/hooks/ghc-install.sh
+        hook_url="https://www.haskell.org/ghcup/sh/hooks/stack/ghc-install.sh"
+
+        if [ -e "${hook_exe}" ] ; then
+            warn "$hook_exe already exists, skipping hook installation."
+            warn "If you want to reinstall the hook, delete it manually and re-run"
+            warn "this script!"
+        else
+            case "${BOOTSTRAP_HASKELL_DOWNLOADER}" in
+                "curl")
+                    # shellcheck disable=SC2086
+                    edo curl -Lf ${GHCUP_CURL_OPTS} "${hook_url}" > "${hook_exe}"
+                    ;;
+                "wget")
+                    # shellcheck disable=SC2086
+                    edo wget -O /dev/stdout ${GHCUP_WGET_OPTS} "${hook_url}" > "${hook_exe}"
+                    ;;
+                *)
+                    die "Unknown downloader: ${BOOTSTRAP_HASKELL_DOWNLOADER}"
+                    ;;
+            esac
+            edo chmod +x "${hook_exe}"
+        fi
+
 		;;
 	*) ;;
 esac

scripts/hooks/stack/ghc-install.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# see https://docs.haskellstack.org/en/stable/yaml_configuration/#ghc-installation-customisation-experimental
+# for documentation about hooks
+
+set -euo pipefail
+
+case $HOOK_GHC_TYPE in
+    bindist)
+        echo "$(ghcup run --ghc "$HOOK_GHC_VERSION" --install)/ghc"
+        ;;
+    git)
+        # TODO: should be somewhat possible
+        >&2 echo "Hook doesn't support installing from source"
+        exit 1
+        ;;
+    *)
+        >&2 echo "Unsupported GHC installation type: $HOOK_GHC_TYPE"
+        exit 2
+        ;;
+esac