README.md

November 23, 2018 ยท View on GitHub

This setup shows how to index haskell packages using stack and the haskell-indexer-plugin.

First change directory to stack-example and build the plugin.

$ cd stack-example
$ stack build haskell-indexer-plugin

Then generate a ghc wrapper script. This script will pass to GHC all the flags needed to enable the indexer plugin.

$ ./gen-ghc-wrapper.sh

USAGE

    ./gen-ghc-wrapper.sh OUTDIR GHC_PATH PLUGIN_DB

Generates a wrapper for a ghc compiler in OUTDIR that indexes
using the given compiler.

EXAMPLE

    ./gen-ghc-wrapper.sh ghc_wrapper "$(stack path --compiler-exe)" \
    "$(stack path --snapshot-pkg-db)"

$ ./gen-ghc-wrapper.sh ghc_wrapper "$(stack path --compiler-exe)" \
  "$(stack path --snapshot-pkg-db)"

Now we can index a package and almost all of its dependencies with

$ export INDEXER_OUTPUT_DIR=/tmp/indexer-output
$ PATH=$(pwd)/ghc_wrapper:$PATH \
  STACK_ROOT=$HOME/.stack-indexer stack --system-ghc build <pkg>

We direct stack to use the ghc wrapper by including it in the PATH and passing the flag --system-ghc to it.

The purpose of using STACK_ROOT above, is to rebuild and index even the dependencies of haskell-indexer-plugin. If you are not interested in those, then using STACK_ROOT can be omitted.

Packages which use Safe Haskell can't be indexed currently. They can be skipped with

$ INDEXER_PLUGIN_ENABLE=0 PATH=$(pwd)/ghc_wrapper:$PATH \
  STACK_ROOT=$HOME/.stack-indexer stack --system-ghc build <pkg>

INDEXER_PLUGIN_ENABLE=0 stops the ghc wrapper from using the plugin, but it stills tells GHC where to find it. The latter is necessary to workaround a limitation in GHC when managing source plugins.

To see the result of indexing, all produced files need to be collected into a serving table. This requires installing kythe in advance.

Then you can use serve.sh to start the web ui. It picks the indexer output from the environment variable INDEXER_OUTPUT_DIR.

$ ../serve.sh localhost:8080

Limitations