# shaker: simple and interactive command-line build tool

[ bsd3, development, library, program ] [ Propose Tags ]

Shaker is a build tool which allow to simply compile or launch test on an haskell project and provides some interesting features like continuous action. With continuous action, an action (compile or test) will be automatically executed when a source modification is detected.

All configuration are made via cabal; Shaker will read cabal configuration to discover source directories, compilation options and targets to compile.

Usage

The cabal configuration file should be generated beforehand with cabal configure. If you change your cabal configuration, you will need to recreate the configuration file.

Launch interactive prompt

In the root of your haskell project, launch shaker. An interactive prompt will allow you to execute different actions.

Launch a shaker action from command-line

In the root of your haskell project, launch shaker with your action as a command argument; shaker will execute the given action and exit. See examples for more details.

Action execution

Simple Execution
An action can be launched normally, by entering the action name.
Multiple action execution
You can specify multiple action to execute simply by separating action by spaces.
Continuous Action
A continuous action will execute the action when a file modification has been detected. Every action are elligible to continuous action, you simply need to prefix them with ~. To stop a continuous action, simply use ^C.

Available actions

compile
Compile the project. Targets of the compilation are main files (in case of executable) and exposed modules (in case of library).
fullcompile
Compile all hs files found in source directory. It is usefull to compile sources not declared in cabal. Since it is not possible to compile multiple modules with main, all modules with a main function are excluded.
help
Print all available action.
clean
Clean the directory containing .o and .hi files.
test
Launch all quickcheck properties and hunit tests of the project using test-framework. You can provide one or several regexps as argument and shaker will execute all tests matching one regexp. Quickcheck properties and HUnit tests are automatically discovered using GHC Api. All functions begining with “prop_” are considered as quickcheck properties and all functions of type Test.HUnit.Lang.Assertion and TestCase are considered as HUnit tests.
test-module
Same as test but test-module takes one or several module patterns as arguments.
quit
Exit the application. You can also use ^C or ^D to exit shaker.

Examples with interactive prompt

% compile
Simply compile the project
% clean compile
Clean and compile the project
% ~compile
Switch to continuous mode and will compile the project when sources are modified.
% ~clean compile
Switch to continuous mode and will clean and compile the project when sources are modified.
% test
Execute all tests in the project
% test prop_.*
Execute all quickcheck properties of the project.
% test testExecute.* testFilter.*
Execute all tests matching testExecute.* or testFilter.*
% test-module Regex Refle
Launch all tests in modules matching Regex.* or Refle.*

Examples with command-line

% shaker fullcompile
Launch shaker, execute the fullcompile action and give back the control.
% shaker "~fullcompile"
Launch shaker, continuously execute the fullcompile action until shaker is interrupted.

Versions [faq] 0.1, 0.2, 0.2.1, 0.3, 0.3.1, 0.4, 0.4.1, 0.4.2, 0.4.3, 0.5.0, 0.5.1 base (==4.*), bytestring (==0.9.*), Cabal (==1.10.*), containers (==0.4.*), directory (==1.*), filepath (==1.*), ghc (==7.*), ghc-paths (==0.1.*), haskeline (==0.6.*), haskell-src (==1.0.*), HUnit (==1.2.*), mtl (==2.*), old-time (>=1.0.0), parsec3 (==1.*), QuickCheck (==2.4.*), regex-posix (==0.95.*), template-haskell (>=2.5.0.0), test-framework (==0.4.*), test-framework-hunit (==0.2.*), test-framework-quickcheck2 (==0.2.*) [details] BSD-3-Clause Copyright (c) 2010 Anthonin Bonnefoy Anthonin Bonnefoy anthonin.bonnefoy@gmail.com Development http://github.com/bonnefoa/Shaker http://github.com/bonnefoa/Shaker/issues head: git clone git://github.com/bonnefoa/Shaker.gitthis: git clone git://github.com/bonnefoa/Shaker.git(tag 0.5.1) by AnthoninBonnefoy at 2011-06-19T14:56:08Z NixOS:0.5.1 shaker 7863 total (15 in the last 30 days) (no votes yet) [estimated by Bayesian average] λ λ λ Docs uploaded by userBuild status unknown

#### Maintainer's Corner

For package maintainers and hackage trustees

Shaker is a build tool which allow to compile and launch test on haskell project with some features like continuous action similar to SBT.
{"extraction_info": {"found_math": true, "script_math_tex": 0, "script_math_asciimath": 0, "math_annotations": 0, "math_alttext": 0, "mathml": 0, "mathjax_tag": 0, "mathjax_inline_tex": 0, "mathjax_display_tex": 0, "mathjax_asciimath": 1, "img_math": 0, "codecogs_latex": 0, "wp_latex": 0, "mimetex.cgi": 0, "/images/math/codecogs": 0, "mathtex.cgi": 0, "katex": 0, "math-container": 0, "wp-katex-eq": 0, "align": 0, "equation": 0, "x-ck12": 0, "texerror": 0, "math_score": 0.21701842546463013, "perplexity": 24447.191168607034}, "config": {"markdown_headings": true, "markdown_code": true, "boilerplate_config": {"ratio_threshold": 0.18, "absolute_threshold": 10, "end_threshold": 15, "enable": true}, "remove_buttons": true, "remove_image_figures": true, "remove_link_clusters": true, "table_config": {"min_rows": 2, "min_cols": 3, "format": "plain"}, "remove_chinese": true, "remove_edit_buttons": true, "extract_latex": true}, "warc_path": "s3://commoncrawl/crawl-data/CC-MAIN-2021-10/segments/1614178363217.42/warc/CC-MAIN-20210302034236-20210302064236-00090.warc.gz"}