shake-cabal-build

Utility for building Shake build systems using Cabal sandboxes https://github.com/samplecount/shake-cabal-build

Latest on Hackage:0.1.0

This package is not currently in any snapshots. If you're interested in using it, we recommend adding it to Stackage Nightly. Doing so will make builds more reliable, and allow stackage.org to host generated Haddocks.

Apache-2.0 licensed by Stefan Kersten

shake-cabal-build

Build systems written in [Shake][] normally need to be compiled, see the Shake manual for more information. shake is a simple Haskell script that takes care of all the details. Using the [Cabal][] infrastructure, build scripts are compiled on the fly for execution and also be reused as library components.

The only prerequisite for running the script is the latest Haskell platform.

Installation and usage

Copy or link the script to your source folder. You can also install shake-cabal-build from Hackage with cabal install. The executable is called shake-cabal-build in order to avoid a clash with a different executable installed by [Shake][], you can create an alias with a different name if you want.

Write a file shakefile.hs containing Shake rule definitions and create a file shakefile.cabal with the following contents:

Name: hearhearme-shakefile
Version: 0.1.0
Cabal-Version: >= 1.2
Build-Type: Simple

Executable hearhearme-shakefile
  Main-Is: shakefile.hs
  Ghc-Options: -rtsopts -with-rtsopts=-I0
  Build-Depends:
      base == 4.*
    , shake

If you're using shake-language-c, add it to the dependencies as well. Refer to the Cabal manual for more information about configuration file features. cabal init is another way of creating the Cabal file. It can automatically pick up the dependencies referenced from package imports in your shakefile.hs (if it exists already).

./shake .update creates a Cabal sandbox, installs the dependencies and compiles your build system script.

./shake .scrub calls your build script's clean target and removes the Cabal sandbox and all build products.

./shake .init initialises the sandbox and configures your package. This might be necessary sometimes but usually you don't need that command.

Running ./shake with any argument not starting with a . runs your build script with the arguments passed on the command line, usually Shake options and targets to build.

Cabal file extensions

The shake script supports the custom Cabal configuration setting x-shake-package-dirs. It allows to specify Cabal source packages that should be added to the sandbox with cabal add-source, for example:

X-Shake-Package-Dirs:
  external_libraries/methcla/external_libraries/shake
  external_libraries/methcla/external_libraries/shake-language-c
  external_libraries/methcla

Add this setting before the Executable section containing your build script. See here for an example of a production configuration file that also exports a library.

Tips and tricks

Since Shake includes some high-level profiling features, usually you don't need to do low-level profiling of the build system. Creating a file cabal.config in the top source directory with a line

Library-Profiling: False

can significantly decrease the time needed for updating the build system.

Used by 1 package:
comments powered byDisqus