Update for use with .ghc.environment files (#57)

This pull request updates HyperHaskell to work withe the latest
ecosystem. In particular,

* We support `.ghc.environment` files instead of the old way of `cabal`
installing packages globally.
* We update `Electron` to the latest version again.

Fix #43

Author: HeinrichApfelmus

CHANGELOG.md

@@ -3,6 +3,12 @@
 
 ### HyperHaskell app bundle
 
+**v2.4.0** — Snapshot release.
+
+* Works with `hyper-haskell-server` version 0.2.4.0.
+* Support `.ghc.environment` files.
+* Update Electron to version 38.2.2.
+
 **v2.3.0** — Snapshot release.
 
 * Add `~/.ghcup` directory to PATH by default.
@@ -41,6 +47,13 @@
 
 ### `hyper-haskell-server` package
 
+**v0.2.4.0**
+
+* Works with HyperHaskell app version v2.4.0.
+* Less time to wait after interpreter starts up successfully.
+* Report slightly more errors.
+* Bump depenencies to allow `scotty-0.22`.
+
 **v0.2.3.1** — Bump dependencies
 
 **v0.2.3.0**
@@ -73,6 +86,8 @@
 
 ### `hyper-extra` package
 
+**v0.2.0.2** — Bump dependencies, modernize `.cabal` file.
+
 **v0.2.0.1** — Bump dependencies
 
 **v0.2.0.0**
@@ -94,6 +109,8 @@
 
 ### `hyper`  package
 
+**v0.2.1.2** — Bump dependencies, modernize `.cabal` file.
+
 **v0.2.1.1** — Bump dependencies
 
 **v0.2.1.0**

README.md

@@ -18,6 +18,7 @@
   [haskell]: https://haskell.org
   [show]: http://hackage.haskell.org/package/base/docs/Prelude.html#t:Show
   [display]: https://hackage.haskell.org/package/hyper/docs/Hyper.html#t:Display
+  [cabal]: https://www.haskell.org/cabal/
   [ghc]: https://www.haskell.org/ghc/
   [electron]: http://electron.atom.io/
   [stack]: https://www.haskellstack.org
@@ -63,35 +64,56 @@ Installation from the binary distribution follows the structure explained above.
 
 2. Install the back-end server
 
-    1. Make sure that you have a working installation of the [GHC][] Haskell compiler.
+    1. Make sure that you have a working installation of
+    
+        * the [Glasgow Haskell compiler (GHC)][ghc].
+        * with [Cabal][] version **3.10** or higher.
 
     2. Install the back-end with Cabal by executing
 
-            cabal install hyper hyper-haskell-server
+            > cabal install hyper-haskell-server
+
+    3. Tell `hyper-haskell-server` about the Haskell packages that are in scope.
+
+        The `hyper-haskell-server` program will pick up the packages in scope from a [.ghc.environment][ghc-env] file. We follow the same logic as `ghci` on which file we pick up, where the current directory is the directory of the worksheet file.
+
+        There are two main ways to create a [.ghc.environment][ghc-env] file:
+
+        * Create a global environment file using `cabal install --lib`.
+        * Create a local environment file for a given `.cabal` package using the `--write-ghc-environment-files=always` flag with `cabal configure`.
+
+        In both cases, the compilation of the `hyper` package in the environment file must match the compilation of the `hyper` package in `hyper-haskell-server` — this means identical versions of compiler and all dependencies!
+
+        In the short-term, it's easiest to work with the global environment file. Execute
+        ```
+        > cabal install --lib diagrams diagrams-svg diagrams-lib hyper hyper-extra
+        ```
 
-        It is also recommended (but not necessary) that you install the additional support for other popular Haskell packages, e.g. the [Diagrams][] library by additionally executing
+        in order to install the `hyper` package, as well as additional support for graphics via `hyper-extra` and [Diagrams][].
 
-            cabal install hyper-extra
+        In the long-term, you may want to work with multiple local package environments. In this case, again, you have to make sure that `hyper-haskell-server` was compiled using `hyper` from this package environment.
 
-    3. Now you can start the front-end application and create a new worksheet, or open an existing one. Make sure that the "Interpreter Back-end" in the "Settings" section of the worksheet is set to "cabal". (The path field does not matter in this case.)
+    4. Now you can start the front-end application and create a new worksheet, or open an existing one. Make sure that the "Interpreter Back-end" in the "Settings" section of the worksheet is set to "cabal". (The path field does not matter in this case.)
 
         ![Settings](docs/screenshots/settings-back-end-cabal.png)
 
-        It is also possible to use [Stack][] by using `stack install`, but that is not fully explained here, only to some extent below.
+        It is also possible to use [Stack][] or [nix][nix], but that is not documented here.
 
 That's it! Happy hyper!
 
   [diagrams]: https://github.com/diagrams
+  [ghc-env]: https://downloads.haskell.org/ghc/latest/docs/users_guide/packages.html#package-environments
+  [nix]: https://nixos.org/download/
 
 ## Run from source
 
 When developing HyperHaskell itself, it is also possible to run it from source. Follow these steps:
 
 1. [Download and install Electron](http://electron.atom.io/releases/)
 
-    The whole thing is currently developed and tested with Electron version 10.1.5.
+    The whole thing is currently developed and tested with Electron version 38.2.2.
     
-    (If you use the [npm][] package manager, you can install it in your home directory with `cd ~ && npm install electron@10.5.1`.
+    (If you use the [npm][] package manager, you can install it in your home directory with `cd ~ && npm install electron@38.2.2`.
     On Debian-based Linux distributions, Electron [currently](https://github.com/electron-userland/electron-prebuilt/issues/70#issuecomment-192520913) requires the `nodejs-legacy` package.)
 
 2. Make sure that you have a working installation of
@@ -139,19 +161,19 @@ We use the [`electron-packager`][pkg] utility. To install it, you need to use th
 
     cd ~
     npm install electron-packager
-    npm install electron@10.1.5 --save-dev
+    npm install electron@38.2.2 --save-dev
 
 To create an application bundle and compress it in a zip-file, use the following commands:
 
   * On macOS:
 
-        make pkg-darwin
-        make zip-darwin
+        just pkg-darwin
+        just zip-darwin
 
   * On Windows: You need the [7zip](https://www.7-zip.org) utility in your path.
 
-        make pkg-win32
-        nake zip-win32
+        just pkg-win32
+        just zip-win32
 
   * On Linux: not implemented yet
 

app/package.json

@@ -1,8 +1,8 @@
 {
   "name": "HyperHaskell",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "main": "src/main.js",
   "devDependencies": {
-    "electron": "^31.4.0"
+    "electron": "^38.2.2"
   }
 }

app/src/interpreter-worksheet.js

@@ -110,7 +110,7 @@ window.newInterpreter = () => {
     that.loadImports = (config, cont) => {
         console.log('interpreter.loadImports')
         const doImports = () => {
-            console.log('interpreter.doImports')
+            console.log('interpreter.doImports', JSON.stringify(config))
             loadImports(config, cont)
         }
         if (   config.packagePath !== packagePath

app/src/interpreter.js

@@ -70,7 +70,7 @@ exports.init = () => {
     // setup environment
     let env      = {}
     env['HOME']  = app.getPath('home') // necessary for finding package database
-    // FIXME: Where to we get the path from as a standalone application?
+    // FIXME: Where do we get the path from as a standalone application?
     // pick up path from external environment if possible
     env['PATH']  = lib.process.env['PATH'] + ':/usr/bin:/usr/local/bin:' + env['HOME'] + '/.ghcup/bin'
     env['PORT']  = port.toString()
@@ -88,13 +88,18 @@ exports.init = () => {
       if (isWindows) {
         cmd  = env['HOME'] + '\\AppData\\Roaming\\cabal\\bin\\hyper-haskell-server'
       } else {
-        cmd  = env['HOME'] + '/.cabal/bin/hyper-haskell-server'
+        // cmd  = env['HOME'] + '/.cabal/bin/hyper-haskell-server'
+        // Cabal >= 3.10 installs binaries in ~/.local/bin by default.
+        cmd  = env['HOME'] + '/.local/bin/hyper-haskell-server'
       }
     } else if (packageTool == 'cabal.project') {
       cmd = 'cabal'
-      // FIXME: Add cabal project dir that is relative to the current worksheet
+      // FIXME?: Add cabal project dir that is relative to the current worksheet
       // args = ['exec', '--project-dir', lib.path.dirname(packagePath), 'hyper-haskell-server']
-      args = ['exec', 'hyper-haskell-server']
+      // NOTE: We use 'exec' instead of 'run' because we expect
+      // the developer to have build the executable 'hyper-haskell-server'.
+      // Using 'run' may change .ghc.environment files.
+      args = ['exec', 'hyper-haskell-server'] 
     } else if (packageTool == 'nix') {
       cmd = 'hyper-haskell-server'
       env = Object.assign({}, lib.process.env, { PORT: port.toString() })

app/worksheet.html

@@ -31,10 +31,10 @@ <h1 class="closed">Settings</h1>
       <p>
         <label for="packagePath">Interpreter Back-end:</label>
         <select id="packageTool" size="1">
-          <option value="cabal">cabal — (default paths) </option>
-          <option value="cabal.project">cabal — cabal.project</option>
+          <option value="cabal">cabal — .ghc.environment</option>
           <option value="stack">stack — stack.yaml</option>
           <option value="nix">nix</option>
+          <option value="cabal.project">(development — cabal.project)</option>
         </select>
         <input id="packagePath" type="text" value="">
       <p>The search path is used when a source file uses <code>import</code> and additional source files need to be located and interpreted.

docs/screenshots/settings-back-end-cabal.png

@@ -43,11 +43,7 @@
 
             pkgs.nodejs_22
             pkgs.electron
-          ] ++ lib.optionals pkgs.stdenv.isDarwin ([
-            pkgs.darwin.apple_sdk.frameworks.Cocoa
-            pkgs.darwin.apple_sdk.frameworks.CoreServices
-            pkgs.darwin.objc4.all
-          ]);
+          ];
         };
 
         shellHook = ''

flake.lock

@@ -27,7 +27,7 @@ tested-with:
 
 source-repository head
   type:               git
-  location:           git://github.com/HeinrichApfelmus/hyper-haskell.git
+  location:           https://github.com/HeinrichApfelmus/hyper-haskell.git
   subdir:             haskell/hyper-extra/
 
 library
@@ -38,7 +38,7 @@ library
     , diagrams-lib >= 1.3     && < 1.6
     , diagrams-svg >= 1.4     && < 1.6
     , hyper        >= 0.2     && < 0.3
-    , QuickCheck   >= 2.3.0.2 && < 2.16
+    , QuickCheck   >= 2.3.0.2 && < 2.18
     , svg-builder  >= 0.1     && < 0.2
     , text         >= 0.11    && < 2.2
   exposed-modules: