slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

shake: clean up docs

Browse Source
This commit is contained in:
Simon Michael 2019-03-05 19:21:45 -08:00
parent 51d3395564
commit 247cb4e1ad
1 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Shake.hs
View File

@ -11,15 +11,13 @@
ghc ghc
-} -}
{- {-
One of two project scripts files (Makefile, Shake.hs).
This one provides a stronger programming language and more
platform independence than Make. It will build needed packages (above)
on first run and whenever the resolver in stack.yaml changes.
To minimise such startup delays, and reduce sensitivity to git checkout,
compiling is recommended; run the script in interpreted mode to do that.
It requires stack (https://haskell-lang.org/get-started) and One of two project scripts files (Makefile, Shake.hs). This one
auto-installs the packages above. Also, some rules require: provides a stronger programming language and more platform
independence than Make. It requires stack and will auto-install the
haskell packages above when needed (on first run or when a new
resolver is configured in stack.yaml). Some rules below use additional
tools, including:
- groff - groff
- m4 - m4
@ -27,17 +25,23 @@ auto-installs the packages above. Also, some rules require:
- pandoc - pandoc
- sed - sed
Usage: see below. Also: Compiling this script is recommended, to ensure required packages are
installed, minimise startup delay, and reduce sensitivity to the
current git state (eg when bisecting). To compile, run "./Shake.hs".
(Or "make Shake", or any other make rule depending on Shake).
$ find hledger-lib hledger | entr ./Shake website # rebuild web files on changes in these dirs Once compiled, run ./Shake without any arguments to list commands and
targets (see below).
Shake rule dependency graph: When developing/troubleshooting this script, these are useful:
file:///Users/simon/src/PLAINTEXTACCOUNTING/hledger/report.html?mode=rule-graph&query=!name(/(doc%7Cimages%7Cjs%7Ccss%7Cfonts%7Ctime%7Capi%7Cui%7Ccsv)/)
watch Shake.hs for compile errors: make ghcid-shake
load Shake.hs in GHCI: make ghci-shake
rebuild things when files change with entr (file watcher), eg:
find hledger-lib hledger | entr ./Shake website
view rule dependency graph:
./Shake --report, open report.html?mode=rule-graph&query=!name(/(doc%7Cimages%7Cjs%7Ccss%7Cfonts%7Ctime%7Capi%7Cui%7Ccsv)/)
Shake wishes:
just one shake import
wildcards in phony rules
multiple individually accessible wildcards
-} -}
{-# LANGUAGE MultiWayIf #-} {-# LANGUAGE MultiWayIf #-}