Merge branch 'issue-266'

cabal.project

@@ -9,8 +9,18 @@ package ghcup
     flags: +tui
 
 constraints: http-io-streams -brotli,
-             any.Cabal ==3.4.0.0 || ==3.6.2.0
+             any.Cabal ==3.4.0.0 || ==3.6.2.0,
+             any.aeson >= 2.0.1.0
 
+source-repository-package
+    type: git
+    location: https://github.com/hasufell/aeson-pretty.git
+    tag: e902ab866bb41d990b66af3644aeb352ff7aaf6f
+
+source-repository-package
+    type: git
+    location: https://github.com/hasufell/HsYAML-aeson.git
+    tag: b4b4ab8592918b52a9f2e5bb0c5a795b9721b4f3
 
 package libarchive
   flags: -system-libarchive
@@ -21,4 +31,7 @@ package aeson-pretty
 package cabal-plan
   flags: -exe
 
+package aeson
+  flags: +ordered-keymap
+
 allow-newer: base, ghc-prim, template-haskell, language-c

docs/about.md

@@ -40,6 +40,12 @@ All you wanted to know about GHCup.
 * [haskell.org](https://www.haskell.org/haskell-org-committee/) via CI and infrastructure
 * [Haskell Foundation](https://haskell.foundation/affiliates/) via affiliation
 
+## How to help
+
+* if you want to contribute code or documentation, check out the [issue tracker](https://gitlab.haskell.org/haskell/ghcup-hs/-/issues) and the [Development guide](./dev.md)
+* if you want to propose features or write user feedback, feel free to [open a ticket](https://gitlab.haskell.org/haskell/ghcup-hs/-/issues/new?issue)
+* if you want to donate to the project, visit our [opencollective](https://opencollective.com/ghcup#category-CONTRIBUTE) page
+
 ## Design goals
 
 1. simplicity

docs/guide.md

@@ -39,34 +39,6 @@ explaining all possible configurations can be found in this repo: [config.yaml](
 
 Partial configuration is fine. Command line options always override the config file settings.
 
-## GPG verification
-
-GHCup supports verifying the GPG signature of the metadata file. The metadata file then contains SHA256 hashes of all downloads, so
-this is cryptographically secure.
-
-First, obtain the gpg key:
-
-```sh
-gpg --batch --keyserver keys.openpgp.org --recv-keys 7784930957807690A66EBDBE3786C5262ECB4A3F
-```
-
-Then verify the gpg key in one of these ways:
-
-1. find out where I live and visit me to do offline key signing
-2. figure out my mobile phone number and call me to verify the fingerprint
-3. more boring: contact me on Libera IRC (`maerwald`) and verify the fingerprint
-
-Once you've verified the key, you have to figure out if you trust me.
-
-If you trust me, then you can configure gpg in `~/.ghcup/config.yaml`:
-
-```yml
-gpg-setting: GPGLax # GPGStrict | GPGLax | GPGNone
-```
-
-In `GPGStrict` mode, ghcup will fail if verification fails. In `GPGLax` mode it will just print a warning.
-You can also pass the mode via `ghcup --gpg <strict|lax|none>`.
-
 ## Manpages
 
 For man pages to work you need [man-db](http://man-db.nongnu.org/) as your `man` provider, then issue `man ghc`. Manpages only work for the currently set ghc.
@@ -257,6 +229,34 @@ jobs:
       run: cabal test
       shell: bash
 ```
+
+## GPG verification
+
+GHCup supports verifying the GPG signature of the metadata file. The metadata file then contains SHA256 hashes of all downloads, so
+this is cryptographically secure.
+
+First, obtain the gpg key:
+
+```sh
+gpg --batch --keyserver keys.openpgp.org --recv-keys 7784930957807690A66EBDBE3786C5262ECB4A3F
+```
+
+Then verify the gpg key in one of these ways:
+
+1. find out where I live and visit me to do offline key signing
+2. figure out my mobile phone number and call me to verify the fingerprint
+3. more boring: contact me on Libera IRC (`maerwald`) and verify the fingerprint
+
+Once you've verified the key, you have to figure out if you trust me.
+
+If you trust me, then you can configure gpg in `~/.ghcup/config.yaml`:
+
+```yml
+gpg-setting: GPGLax # GPGStrict | GPGLax | GPGNone
+```
+
+In `GPGStrict` mode, ghcup will fail if verification fails. In `GPGLax` mode it will just print a warning.
+You can also pass the mode via `ghcup --gpg <strict|lax|none>`.
    
 ## Tips and tricks
 

docs/install.md

@@ -24,7 +24,17 @@ Set-ExecutionPolicy Bypass -Scope Process -Force;[System.Net.ServicePointManager
 
 If you want to know what these scripts do, check out the [source code at the repository](https://gitlab.haskell.org/haskell/ghcup-hs/-/tree/master/scripts/bootstrap). Advanced users may want to perform a [manual installation](#manual-install) and GPG verify the binaries.
 
-**Advice: Make sure to check out the [Haskell documentation](https://www.haskell.org/documentation/) after installation.**
+## First steps
+
+1. To get started with creating a Haskell project, follow the [Getting Started with Haskell and Cabal](https://cabal.readthedocs.io/en/latest/getting-started.html) guide
+2. To properly learn Haskell, run through the [CIS 194 Haskell course](https://www.cis.upenn.edu/~cis194/spring13/) including exercises
+3. To learn more about Haskell Toolchain management, check out the [ghcup user guide](./guide.md)
+
+## Uninstallation
+
+On linux, just run `ghcup nuke`, then make sure any ghcup added lines in your `~/.bashrc` (or similar) are removed.
+
+On windows, double-click on the `Uninstall Haskell.ps1` PowerShell script on your Desktop.
 
 ## Supported tools
 

ghcup.cabal

@@ -92,7 +92,7 @@ library
     -fwarn-incomplete-record-updates
 
   build-depends:
-    , aeson                 >=1.4        && <1.6
+    , aeson                 >=1.4
     , async                 >=0.8        && <2.3
     , base                  >=4.13       && <5
     , base16-bytestring     >=0.1.1.6    && <1.1
@@ -189,7 +189,7 @@ executable ghcup
     -fwarn-incomplete-record-updates -threaded
 
   build-depends:
-    , aeson                 >=1.4      && <1.6
+    , aeson                 >=1.4
     , aeson-pretty          ^>=0.8.8
     , async                 ^>=2.2.3
     , base                  >=4.13     && <5

lib/GHCup/Types/JSON.hs

@@ -28,9 +28,9 @@ import           GHCup.Utils.Logger             () -- TH is broken shite and nee
                                                    -- This is due to the boot file.
 
 import           Control.Applicative            ( (<|>) )
-import           Data.Aeson
+import           Data.Aeson              hiding (Key)
 import           Data.Aeson.TH
-import           Data.Aeson.Types
+import           Data.Aeson.Types        hiding (Key)
 import           Data.List.NonEmpty             ( NonEmpty(..) )
 import           Data.Text.Encoding            as E
 import           Data.Versions

scripts/bootstrap/bootstrap-haskell

@@ -158,7 +158,7 @@ _done() {
 				green "and the \"Mingw package management docs\""
 				green "desktop shortcuts."
 				green
-				green "If you are net to Haskell, check out https://www.haskell.org/documentation/"
+				green "If you are new to Haskell, check out https://www.haskell.org/ghcup/install/#first-steps"
 				;;
 			*)
 				green
@@ -173,7 +173,7 @@ _done() {
 				green "To install other GHC versions and tools, run:"
 				green "  ghcup tui"
 				green
-				green "If you are net to Haskell, check out https://www.haskell.org/documentation/"
+				green "If you are new to Haskell, check out https://www.haskell.org/ghcup/install/#first-steps"
 				;;
 
 	esac
@@ -448,7 +448,12 @@ warn_path() {
 }
 
 adjust_cabal_config() {
-	edo cabal user-config -a "extra-prog-path: $(cygpath -w "$GHCUP_BIN"), $(cygpath -w "$HOME"/AppData/Roaming/cabal/bin), $(cygpath -w "$GHCUP_MSYS2"/usr/bin), $(cygpath -w "$GHCUP_MSYS2"/mingw64/bin)" -a "extra-include-dirs: $(cygpath -w "$GHCUP_MSYS2"/mingw64/include)" -a "extra-lib-dirs: $(cygpath -w "$GHCUP_MSYS2"/mingw64/lib)" -f init
+    if [ -n "${CABAL_DIR}" ] ; then
+        cabal_bin="${CABAL_DIR}/bin"
+    else
+        cabal_bin="$HOME/AppData/Roaming/cabal/bin"
+    fi
+    edo cabal user-config -a "extra-prog-path: $(cygpath -w "$GHCUP_BIN"), $(cygpath -w "$cabal_bin"), $(cygpath -w "$GHCUP_MSYS2"/usr/bin), $(cygpath -w "$GHCUP_MSYS2"/mingw64/bin)" -a "extra-include-dirs: $(cygpath -w "$GHCUP_MSYS2"/mingw64/include)" -a "extra-lib-dirs: $(cygpath -w "$GHCUP_MSYS2"/mingw64/lib)" -f init
 }
 
 ask_cabal_config_init() {

scripts/bootstrap/bootstrap-haskell.ps1

@@ -47,14 +47,30 @@ function Print-Msg {
 }
 
 function Create-Shortcut {
-    param ( [Parameter(Mandatory=$true,HelpMessage='Target path')][string]$SourceExe, [Parameter(Mandatory=$true,HelpMessage='Arguments to the path/exe')][AllowEmptyString()]$ArgumentsToSourceExe, [Parameter(Mandatory=$true,HelpMessage='The destination of the desktop link')][string]$DestinationPath )
+    param ( [Parameter(Mandatory=$true,HelpMessage='Target path')][string]$SourceExe
+          , [Parameter(Mandatory=$true,HelpMessage='Arguments to the path/exe')][AllowEmptyString()]$ArgumentsToSourceExe
+          , [Parameter(Mandatory=$true,HelpMessage='The destination of the desktop link')][string]$DestinationPath
+          , [Parameter(Mandatory=$true,HelpMessage='Temporary path to create the link at')][string]$TempPath
+           )
+	# we save to a temp dir first due to
+	# https://gitlab.haskell.org/haskell/ghcup-hs/-/issues/267
+    $DesktopDir = [Environment]::GetFolderPath("Desktop")
+    if (!(Test-Path -Path ('{0}' -f $TempPath))) {
+      New-Item -Path $TempPath -ItemType "directory"
+    }
+    $TmpFile = ('{0}\{1}' -f $TempPath, $DestinationPath)
+    $FinalDest = ('{0}\{1}' -f $DesktopDir, $DestinationPath)
     $WshShell = New-Object -comObject WScript.Shell
-    $Shortcut = $WshShell.CreateShortcut($DestinationPath)
+    $Shortcut = $WshShell.CreateShortcut($TmpFile)
     $Shortcut.TargetPath = $SourceExe
     if($ArgumentsToSourceExe) {
       $Shortcut.Arguments = $ArgumentsToSourceExe
     }
     $Shortcut.Save()
+    if ((Test-Path -Path ('{0}' -f $FinalDest))) {
+      Remove-Item -LiteralPath $FinalDest -Force
+    }
+    Move-Item -LiteralPath $TmpFile -Destination $FinalDest
 }
 
 function Add-EnvPath {
@@ -512,11 +528,11 @@ if ($Host.Name -eq "ConsoleHost")
 }
 '@
 
-$DesktopDir = [Environment]::GetFolderPath("Desktop")
 $GhcInstArgs = '-mingw64 -mintty -c "pacman --noconfirm -S --needed base-devel gettext autoconf make libtool automake python p7zip patch unzip"'
-Create-Shortcut -SourceExe ('{0}\msys2_shell.cmd' -f $MsysDir) -ArgumentsToSourceExe $GhcInstArgs -DestinationPath ('{0}\Install GHC dev dependencies.lnk' -f $DesktopDir)
-Create-Shortcut -SourceExe ('{0}\msys2_shell.cmd' -f $MsysDir) -ArgumentsToSourceExe '-mingw64' -DestinationPath ('{0}\Mingw haskell shell.lnk' -f $DesktopDir)
-Create-Shortcut -SourceExe 'https://www.msys2.org/docs/package-management' -ArgumentsToSourceExe '' -DestinationPath ('{0}\Mingw package management docs.url' -f $DesktopDir)
+Create-Shortcut -SourceExe ('{0}\msys2_shell.cmd' -f $MsysDir) -ArgumentsToSourceExe $GhcInstArgs -DestinationPath 'Install GHC dev dependencies.lnk' -TempPath $GhcupDir
+Create-Shortcut -SourceExe ('{0}\msys2_shell.cmd' -f $MsysDir) -ArgumentsToSourceExe '-mingw64' -DestinationPath 'Mingw haskell shell.lnk' -TempPath $GhcupDir
+Create-Shortcut -SourceExe 'https://www.msys2.org/docs/package-management' -ArgumentsToSourceExe '' -DestinationPath 'Mingw package management docs.url' -TempPath $GhcupDir
+$DesktopDir = [Environment]::GetFolderPath("Desktop")
 $null = New-Item -Path $DesktopDir -Name "Uninstall Haskell.ps1" -ItemType "file" -Force -Value $uninstallShortCut
 
 Print-Msg -msg ('Adding {0}\bin to Users Path...' -f $GhcupDir)