Multi component ghcide setup #374

robrix · 2019-11-01T15:19:11Z

This PR:

Depends on Multi component repl #373.
Adds a couple of scripts for computing the correct flags for ghcide to use to load all of our components.
Adds a hie.yaml file configuring ghcide thus.

This reverts commit fbe02da.

robrix · 2019-11-01T15:28:03Z

script/ghci-flags

+root="$(pwd)"
+ghc_version="$(ghc --numeric-version)"


I’ve attempted to compute what I can about the project, but I don’t know how to efficiently and robustly parse cabal.project for the .cabal files or the .cabal files for the package version numbers, or how otherwise to ask cabal for this information since it seems reluctant to tell me its secrets.

robrix · 2019-11-01T16:21:59Z

script/ghci-flags

+# Emit package flags from the environment file, removing comments & prefixing with -
+cabal exec --builddir=$repl_builddir -v0 bash -- -c 'cat $GHC_ENVIRONMENT' | grep -v '^--' | sed -e 's/^/-/'


Rather than using the existing .ghc.environment* file in the project root, I’ve opted to use cabal exec to get the package flags out. I can’t just use echo "-package-conf=$(cabal exec -v0 bash -- -c 'echo $GHC_ENVIRONMENT')" because cabal makes a new file in dist-newstyle/tmp and deletes it as soon as the exec’d program exits, meaning that it would be removed before ghcide could find it.

robrix · 2019-11-01T16:23:29Z

script/ghci-flags

+echo "-i$root/semantic-analysis/src"
+echo "-i$root/semantic-ast/src"
+echo "-i$root/semantic-core/src"
+echo "-i$root/semantic-java/src"
+echo "-i$root/semantic-json/src"
+echo "-i$root/semantic-python/src"
+echo "-i$root/semantic-tags/src"
+echo "-i$root/app"
+echo "-i$root/src"
+echo "-i$root/bench"
+echo "-i$root/test"


This is pretty similar to what we were doing in .ghci.semantic (added in #373), but distinct in that VS Code runs ghcide with the PWD env var set to / and apparently the -i flags are resolved relative to that environment variable rather than the actual, you know, working directory, and thus we have to use absolute paths.

robrix · 2019-11-01T16:25:08Z

script/ghci-flags

+echo "-outputdir $repl_builddir/build/x86_64-osx/ghc-$ghc_version/semantic-0.8.0.0/build"
+echo "-odir $repl_builddir/build/x86_64-osx/ghc-$ghc_version/semantic-0.8.0.0/build"
+echo "-hidir $repl_builddir/build/x86_64-osx/ghc-$ghc_version/semantic-0.8.0.0/build"
+echo "-stubdir $repl_builddir/build/x86_64-osx/ghc-$ghc_version/semantic-0.8.0.0/build"


We don’t instruct ghcide to use -fwrite-interface or -fobject-code, but putting these here allows us to share more of the logic for determining the compiler version &c.

robrix · 2019-11-01T16:26:16Z

script/ghci-flags

+if [ "$1" == "--builddir" ]; then
+  repl_builddir="$2"
+  shift 2
+else
+  repl_builddir=dist-newstyle
+fi


We can’t pass flags into this program from hie.yaml, but I wanted to reuse it from script/repl without duplicating much of it or adding redundant wrapper scripts, so I’ve made this default to dist-newstyle if it’s unspecified.

robrix · 2019-11-01T16:27:11Z

script/ghci-flags-dependencies

+#!/bin/bash
+# Computes the paths to files causing changes to the ghci flags. You probably won’t be running this yourself, but rather ghcide will via configuration in hie.yaml.


Changes to the listed files might result in different package flags for ghcide to learn of, so we tell it to watch them.

robrix · 2019-11-01T16:29:05Z

script/repl

@@ -11,5 +11,5 @@ repl_builddir=dist-repl
 if [[ ! -d $repl_builddir ]]; then
  echo "$repl_builddir does not exist, first run 'cabal repl --builddir=$repl_builddir', exit, and then re-run $0"
 else
-  cabal exec --builddir=$repl_builddir ghci -- -ghci-script=.ghci.semantic $@
+  cabal exec --builddir=$repl_builddir ghci -- -ghci-script=.ghci.semantic $(script/ghci-flags --builddir "$repl_builddir") -no-ignore-dot-ghci $@


We reuse script/ghci-flags from script/repl in order to share a bunch of the path computation logic.

script/ghci-flags tells ghcide to ignore .ghci files so as to avoid getting confused, so we also say -no-ignore-dot-ghci afterwards because script/repl should load them.

robrix · 2019-11-01T16:30:00Z

.ghci.semantic

@@ -1,61 +1,17 @@
 -- GHCI settings for semantic, collected by running cabal repl -v and checking out the flags cabal passes to ghc.


All of the deletions in this file are now being handled via script/ghci-flags instead.

robrix · 2019-11-01T16:33:20Z

hie.yaml

+cradle:
+  bios:
+    program: script/ghci-flags
+    dependency-program: script/ghci-flags-dependencies


hie-bios recently added support for multiple cabal component cradles, but I couldn’t get it working with ghcide yet.

My direct configuration wasn’t portable due to VS Code using a PWD env var of / and -i flags being resolved relative to that env var rather than the actual working directory. So we had to compute it.

Computing it is probably better for our purposes anyway, since it allows us to share work between this and script/repl.

robrix · 2019-11-01T16:36:06Z

script/ghci-flags

+#!/bin/bash
+# Computes the flags for ghcide to pass to ghci. You probably won’t be running this yourself, but rather ghcide will via configuration in hie.yaml.


The approach here is similar to the approach of #373: basically just listing all the options we can think of, collected by clever use of cabal repl -v.

A more robust approach would probably be to do something like cabal repl for each component and union together the options, but that actually seems pretty challenging:

stuff like package flags come in as two flags

some of the flags, like -outputdir, probably shouldn’t be duplicated

ordering matters for a lot of the flags

some of them conflict with one another, like -i erasing any previously configured load paths

we probably don’t want to pass the module names in as that would force ghcide to load everything eagerly rather than when only when you actually look at the file

Maybe someday all of this will be made unnecessary by cabal itself, but until that happy day, this is a pretty good solution for loading & typechecking all of our sources in ghcide, at the cost of requiring us to do a bit more manual work around the project’s packages & versions.

tclem

Got this up and running on the repl and with ghcide in VS Code, nice work @robrix!

robrix added 8 commits November 1, 2019 10:32

Stub in a script to return the flags for ghci.

4e17878

Gather all the flags.

35270be

Run the rest of it out of the cabal exec.

ddff669

Don’t pass --interactive.

b2c8fd9

Un-ignore hie.yaml.

63f9cdb

Add a hie.yaml using the ghci flags script.

1e0ec64

Add a script to compute the files to watch for changes to the packages.

547617a

Tell hie-bios about the dependencies.

2541955

robrix changed the base branch from multi-component-repl to master November 1, 2019 15:19

robrix added 12 commits November 1, 2019 11:35

Enable strict data, in case it ever matters.

3f69e09

Warnings are warnings.

90bf61d

Don’t forget app.

c9cbc83

Work relative to a builddir.

e6fc10b

Echo any remaining args.

fbe02da

Revert "Echo any remaining args."

978beb7

This reverts commit fbe02da.

Use script/ghci-flags from script/repl.

09568bd

Don’t ignore .ghci when using script/repl.

8854575

Note why the remaining flags aren’t in script/ghci-flags.

9a212db

Move the build products dirs into script/ghci-flags.

d41961f

Make the output dirs relative to the builddir.

8ef9e14

Make the output dirs relative to the ghc version.

110b1b6

robrix commented Nov 1, 2019

View reviewed changes

robrix requested a review from a team November 1, 2019 16:40

Take care not to load semantic-source twice.

7662ee7

robrix mentioned this pull request Nov 7, 2019

Analysis effects #379

Merged

2 tasks

tclem approved these changes Nov 7, 2019

View reviewed changes

robrix merged commit cef6893 into master Nov 7, 2019

robrix deleted the multi-component-ghcide-setup branch November 7, 2019 18:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Multi component ghcide setup #374

Multi component ghcide setup #374

robrix commented Nov 1, 2019 •

edited

Loading

robrix Nov 1, 2019

robrix Nov 1, 2019

robrix Nov 1, 2019

robrix Nov 1, 2019

robrix Nov 1, 2019

robrix Nov 1, 2019

robrix Nov 1, 2019

robrix Nov 1, 2019

robrix Nov 1, 2019

robrix Nov 1, 2019

tclem left a comment

		# Emit package flags from the environment file, removing comments & prefixing with -
		cabal exec --builddir=$repl_builddir -v0 bash -- -c 'cat $GHC_ENVIRONMENT' \| grep -v '^--' \| sed -e 's/^/-/'

		#!/bin/bash
		# Computes the paths to files causing changes to the ghci flags. You probably won’t be running this yourself, but rather ghcide will via configuration in hie.yaml.

		@@ -1,61 +1,17 @@
		-- GHCI settings for semantic, collected by running cabal repl -v and checking out the flags cabal passes to ghc.

		#!/bin/bash
		# Computes the flags for ghcide to pass to ghci. You probably won’t be running this yourself, but rather ghcide will via configuration in hie.yaml.

		root="$(pwd)"
		ghc_version="$(ghc --numeric-version)"

Multi component ghcide setup #374

Multi component ghcide setup #374

Conversation

robrix commented Nov 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tclem left a comment

Choose a reason for hiding this comment

robrix commented Nov 1, 2019 •

edited

Loading