2016-02-21 13:21:41 +03:00
|
|
|
#!/usr/bin/env stack
|
2018-03-31 04:43:28 +03:00
|
|
|
{- stack exec
|
|
|
|
--verbosity=info
|
2016-04-05 16:59:52 +03:00
|
|
|
--package base-prelude
|
|
|
|
--package directory
|
|
|
|
--package extra
|
|
|
|
--package safe
|
|
|
|
--package shake
|
|
|
|
--package time
|
2018-04-26 03:41:28 +03:00
|
|
|
ghc
|
2016-04-05 16:59:52 +03:00
|
|
|
-}
|
|
|
|
{-
|
2016-10-28 21:15:10 +03:00
|
|
|
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,
|
2016-12-29 22:21:32 +03:00
|
|
|
compiling is recommended; run the script in interpreted mode to do that.
|
2016-10-28 21:15:10 +03:00
|
|
|
|
|
|
|
It requires stack (https://haskell-lang.org/get-started) and
|
|
|
|
auto-installs the packages above. Also, some rules require:
|
2019-01-25 18:04:16 +03:00
|
|
|
|
2016-10-28 21:15:10 +03:00
|
|
|
- groff
|
|
|
|
- m4
|
|
|
|
- makeinfo
|
2019-01-25 18:04:16 +03:00
|
|
|
- pandoc
|
2016-10-28 21:15:10 +03:00
|
|
|
|
2016-12-31 01:32:43 +03:00
|
|
|
Usage: see below. Also:
|
|
|
|
|
|
|
|
$ find hledger-lib hledger | entr ./Shake website # rebuild web files on changes in these dirs
|
2016-04-05 16:59:52 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
Shake rule dependency graph:
|
|
|
|
file:///Users/simon/src/PLAINTEXTACCOUNTING/hledger/report.html?mode=rule-graph&query=!name(/(doc%7Cimages%7Cjs%7Ccss%7Cfonts%7Ctime%7Capi%7Cui%7Ccsv)/)
|
|
|
|
|
2016-10-28 21:15:10 +03:00
|
|
|
Shake wishes:
|
|
|
|
just one shake import
|
|
|
|
wildcards in phony rules
|
|
|
|
multiple individually accessible wildcards
|
|
|
|
not having to write :: Action ExitCode after a non-final cmd
|
|
|
|
-}
|
2016-04-05 16:59:52 +03:00
|
|
|
|
2019-02-01 04:36:52 +03:00
|
|
|
{-# LANGUAGE MultiWayIf #-}
|
|
|
|
{-# LANGUAGE PackageImports #-}
|
|
|
|
{-# LANGUAGE ScopedTypeVariables #-}
|
2016-10-29 20:51:43 +03:00
|
|
|
|
2016-04-05 16:59:52 +03:00
|
|
|
import Prelude ()
|
|
|
|
import "base-prelude" BasePrelude
|
2019-02-01 04:36:52 +03:00
|
|
|
import "base" Control.Exception as C
|
|
|
|
-- required packages, keep synced with Makefile -> SHAKEDEPS:
|
2018-03-31 04:43:28 +03:00
|
|
|
import "directory" System.Directory as S (getDirectoryContents)
|
2016-04-05 16:59:52 +03:00
|
|
|
import "extra" Data.List.Extra
|
2019-01-31 04:55:56 +03:00
|
|
|
import "process" System.Process
|
2016-04-05 16:59:52 +03:00
|
|
|
import "safe" Safe
|
|
|
|
import "shake" Development.Shake
|
|
|
|
import "shake" Development.Shake.FilePath
|
|
|
|
import "time" Data.Time
|
2019-01-20 01:49:20 +03:00
|
|
|
-- import "hledger-lib" Hledger.Utils.Debug
|
2016-04-05 16:59:52 +03:00
|
|
|
|
2016-10-28 21:15:10 +03:00
|
|
|
usage = unlines
|
|
|
|
["Usage:"
|
2016-12-29 22:21:32 +03:00
|
|
|
,"./Shake.hs # compile this script"
|
2019-01-20 01:49:20 +03:00
|
|
|
,"./Shake manuals # generate the txt/man/info manuals"
|
|
|
|
,"./Shake website # generate the website and web manuals"
|
2019-01-31 04:55:56 +03:00
|
|
|
,"./Shake commandhelp # generate the help text for hledger commands"
|
2019-01-30 21:27:53 +03:00
|
|
|
,"./Shake PKG # build the specified hledger package, with awareness of embedded docs"
|
|
|
|
,"./Shake build # build all hledger packages, with awareness of embedded docs"
|
2019-01-20 00:14:33 +03:00
|
|
|
,"./Shake all # generate everything"
|
2019-01-20 01:49:20 +03:00
|
|
|
,""
|
2019-02-01 04:36:52 +03:00
|
|
|
,"./Shake changelogs # update the changelogs with any new commits"
|
2019-01-20 01:49:20 +03:00
|
|
|
,"./Shake site/doc/VERSION/.snapshot # save the checked-out web manuals as a versioned snapshot"
|
2019-01-30 21:27:53 +03:00
|
|
|
,"./Shake FILE # build any individual file"
|
2016-10-28 21:15:10 +03:00
|
|
|
,"./Shake clean # clean generated files"
|
2019-01-30 21:27:53 +03:00
|
|
|
,"./Shake Clean # clean more thoroughly, including Shake's dependency cache"
|
2019-01-20 01:49:20 +03:00
|
|
|
,""
|
|
|
|
,"./Shake [help] # show commands"
|
2019-01-20 00:14:33 +03:00
|
|
|
,"./Shake --help # show detailed Shake options, eg --color"
|
2016-10-28 21:15:10 +03:00
|
|
|
]
|
2016-02-21 13:21:41 +03:00
|
|
|
|
2019-01-20 00:14:33 +03:00
|
|
|
groff = "groff"
|
2019-01-20 02:16:08 +03:00
|
|
|
makeinfo = "makeinfo"
|
|
|
|
pandoc = "pandoc"
|
|
|
|
|
|
|
|
-- The kind of markdown used in our doc source files.
|
2019-01-25 02:23:41 +03:00
|
|
|
fromsrcmd = "-f markdown-smart-tex_math_dollars"
|
2019-01-20 02:16:08 +03:00
|
|
|
|
|
|
|
-- The kind of markdown we like to generate for the website.
|
2019-01-25 02:23:41 +03:00
|
|
|
towebmd = "-t markdown-smart-fenced_divs --atx-headers"
|
2016-02-21 13:21:41 +03:00
|
|
|
|
2018-12-03 20:21:05 +03:00
|
|
|
|
2016-02-21 13:21:41 +03:00
|
|
|
main = do
|
|
|
|
|
2019-01-27 03:21:59 +03:00
|
|
|
-- hledger manual also includes the markdown files from here:
|
|
|
|
let commandsdir = "hledger/Hledger/Cli/Commands"
|
|
|
|
commandmds <- filter (".md" `isSuffixOf`) . map (commandsdir </>) <$> S.getDirectoryContents commandsdir
|
2019-01-30 21:27:53 +03:00
|
|
|
let commandtxts = map (-<.> "txt") commandmds
|
2019-01-27 03:21:59 +03:00
|
|
|
|
2016-04-05 16:59:52 +03:00
|
|
|
shakeArgs
|
|
|
|
shakeOptions{
|
2016-04-13 06:32:01 +03:00
|
|
|
shakeVerbosity=Loud
|
2016-04-05 16:59:52 +03:00
|
|
|
-- ,shakeReport=[".shake.html"]
|
|
|
|
} $ do
|
|
|
|
|
|
|
|
want ["help"]
|
|
|
|
|
|
|
|
phony "help" $ liftIO $ putStrLn usage
|
|
|
|
|
2019-01-31 04:55:56 +03:00
|
|
|
phony "all" $ need ["commandhelp", "manuals", "build", "website"]
|
2016-04-06 02:16:38 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- phony "compile" $ need ["Shake"]
|
|
|
|
-- "Shake" %> \out -> do
|
|
|
|
-- need [out <.> "hs"]
|
|
|
|
-- unit $ cmd "./Shake.hs" -- running as stack script installs deps and compiles
|
|
|
|
-- putLoud "You can now run ./Shake instead of ./Shake.hs"
|
|
|
|
|
|
|
|
|
2019-01-30 21:27:53 +03:00
|
|
|
-- NAMES, FILES, URIS..
|
2016-04-08 17:01:11 +03:00
|
|
|
|
|
|
|
let
|
2019-01-20 01:49:20 +03:00
|
|
|
-- documentation versions shown on the website (excluding 0.27 which is handled specially)
|
|
|
|
docversions = [ "1.0" , "1.1" , "1.2" , "1.3" , "1.4" , "1.5" , "1.9", "1.10", "1.11", "1.12" ]
|
|
|
|
|
2019-01-30 21:27:53 +03:00
|
|
|
-- main package names, in standard build order
|
|
|
|
packages = [
|
|
|
|
"hledger-lib"
|
|
|
|
,"hledger"
|
|
|
|
,"hledger-ui"
|
|
|
|
,"hledger-web"
|
|
|
|
,"hledger-api"
|
|
|
|
]
|
|
|
|
|
2019-02-01 04:36:52 +03:00
|
|
|
changelogs = "CHANGES.md" : map (</> "CHANGES.md") packages
|
|
|
|
changelogsdry = map (++"-dry") changelogs
|
|
|
|
|
2019-01-30 21:27:53 +03:00
|
|
|
-- doc files (or related targets) that should be generated
|
|
|
|
-- before building hledger packages.
|
|
|
|
-- [(PKG, [TARGETS])]
|
|
|
|
embeddedFiles = [
|
|
|
|
-- hledger embeds the plain text command help files and all packages' text/nroff/info manuals
|
|
|
|
("hledger", commandtxts ++ ["manuals"])
|
|
|
|
-- hledger-ui imports the hledger-ui manuals from hledger
|
|
|
|
,("hledger-ui", ["hledger"])
|
|
|
|
]
|
2019-01-20 01:49:20 +03:00
|
|
|
|
|
|
|
-- man page names (manual names plus a man section number), in suggested reading order
|
|
|
|
manpageNames = [
|
2016-04-08 17:01:11 +03:00
|
|
|
"hledger.1"
|
|
|
|
,"hledger-ui.1"
|
|
|
|
,"hledger-web.1"
|
|
|
|
,"hledger-api.1"
|
|
|
|
,"hledger_journal.5"
|
|
|
|
,"hledger_csv.5"
|
2016-04-13 07:10:02 +03:00
|
|
|
,"hledger_timeclock.5"
|
2016-04-08 17:01:11 +03:00
|
|
|
,"hledger_timedot.5"
|
|
|
|
]
|
2017-01-26 17:40:50 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- basic manual names, without numbers
|
2017-12-07 05:16:35 +03:00
|
|
|
manualNames = map manpageNameToManualName manpageNames
|
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- main markdown+m4 source files for manuals (hledger/hledger.m4.md)
|
|
|
|
-- These may include additional files using m4.
|
|
|
|
m4manuals = [manualDir m </> m <.> "m4.md" | m <- manualNames]
|
2017-12-07 05:16:35 +03:00
|
|
|
|
|
|
|
-- manuals rendered to nroff, ready for man (hledger/hledger.1)
|
2019-01-20 01:49:20 +03:00
|
|
|
nroffmanuals = [manpageDir m </> m | m <- manpageNames]
|
2017-01-26 17:40:50 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- manuals rendered to plain text, ready for embedding (hledger/hledger.txt)
|
|
|
|
txtmanuals = [manualDir m </> m <.> "txt" | m <- manualNames]
|
2017-01-26 17:40:50 +03:00
|
|
|
|
2017-12-07 05:16:35 +03:00
|
|
|
-- manuals rendered to info, ready for info (hledger/hledger.info)
|
2019-01-20 01:49:20 +03:00
|
|
|
infomanuals = [manualDir m </> m <.> "info" | m <- manualNames]
|
2018-05-06 08:18:58 +03:00
|
|
|
|
2019-01-31 04:55:56 +03:00
|
|
|
-- individual manuals rendered to markdown, ready for conversion to html (site/hledger.md)
|
2019-01-20 01:49:20 +03:00
|
|
|
webmanuals = ["site" </> manpageNameToUri m <.> "md" | m <- manpageNames]
|
2018-05-06 08:18:58 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- website html pages - all manual versions plus misc pages in site/ or copied from elsewhere.
|
2019-01-20 02:42:43 +03:00
|
|
|
-- TODO: make all have lower-case URIs on the final website.
|
2018-05-06 08:18:58 +03:00
|
|
|
webhtmlpages
|
|
|
|
= map (normalise . ("site/_site" </>))
|
|
|
|
$ ( [ prefix </> manpageNameToUri mPage <.> "html"
|
|
|
|
| prefix <- "" : [ "doc" </> v | v <- docversions ]
|
|
|
|
, mPage <- manpageNames
|
|
|
|
]
|
|
|
|
++ [ mPage <.> "html"
|
2019-01-20 00:14:33 +03:00
|
|
|
| mPage <- [
|
|
|
|
"contributors"
|
|
|
|
, "download"
|
|
|
|
, "ledgertips"
|
|
|
|
, "index"
|
|
|
|
, "intro"
|
|
|
|
, "release-notes"
|
2019-01-20 02:27:44 +03:00
|
|
|
, "README"
|
|
|
|
, "CONTRIBUTING"
|
2019-01-20 00:14:33 +03:00
|
|
|
]
|
2018-05-06 08:18:58 +03:00
|
|
|
]
|
|
|
|
++ [ prefix </> "manual" <.> "html"
|
|
|
|
| prefix <- "" : "doc/0.27" : [ "doc" </> v | v <- docversions ]
|
|
|
|
]
|
|
|
|
)
|
2017-01-26 17:40:50 +03:00
|
|
|
|
2018-05-09 20:20:21 +03:00
|
|
|
-- manuals rendered to markdown and combined, ready for web rendering
|
2019-01-20 01:49:20 +03:00
|
|
|
webmancombined = "site/manual.md"
|
2016-04-16 13:47:00 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- extensions of static web asset files, to be copied to the website
|
|
|
|
webassetexts = ["png", "gif", "cur", "js", "css", "eot", "ttf", "woff", "svg"]
|
2018-04-28 06:29:26 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- The directory in which to find this man page.
|
2016-04-16 13:47:00 +03:00
|
|
|
-- hledger.1 -> hledger/doc, hledger_journal.5 -> hledger-lib/doc
|
|
|
|
manpageDir m
|
2017-12-07 05:16:35 +03:00
|
|
|
| '_' `elem` m = "hledger-lib"
|
|
|
|
| otherwise = dropExtension m
|
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- The directory in which to find this manual.
|
2017-12-07 05:16:35 +03:00
|
|
|
-- hledger -> hledger, hledger_journal -> hledger-lib
|
|
|
|
manualDir m
|
|
|
|
| '_' `elem` m = "hledger-lib"
|
|
|
|
| otherwise = m
|
2016-04-08 17:01:11 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- The URI corresponding to this man page.
|
2016-04-08 17:01:11 +03:00
|
|
|
-- hledger.1 -> hledger, hledger_journal.5 -> journal
|
|
|
|
manpageNameToUri m | "hledger_" `isPrefixOf` m = dropExtension $ drop 8 m
|
|
|
|
| otherwise = dropExtension m
|
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- The man page corresponding to this URI.
|
2016-04-08 17:01:11 +03:00
|
|
|
-- hledger -> hledger.1, journal -> hledger_journal.5
|
|
|
|
manpageUriToName u | "hledger" `isPrefixOf` u = u <.> "1"
|
|
|
|
| otherwise = "hledger_" ++ u <.> "5"
|
|
|
|
|
2019-01-30 21:27:53 +03:00
|
|
|
-- MANUALS
|
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- Generate the manuals in nroff, plain text and info formats.
|
2017-08-01 01:53:34 +03:00
|
|
|
phony "manuals" $ do
|
2016-04-16 13:47:00 +03:00
|
|
|
need $
|
2019-01-20 01:49:20 +03:00
|
|
|
nroffmanuals
|
|
|
|
++ infomanuals
|
|
|
|
++ txtmanuals
|
2016-04-16 13:47:00 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- Generate nroff man pages suitable for man output.
|
|
|
|
phony "manmanuals" $ need nroffmanuals
|
|
|
|
nroffmanuals |%> \out -> do -- hledger/hledger.1
|
2017-12-07 05:16:35 +03:00
|
|
|
let src = manpageNameToManualName out <.> "m4.md"
|
2016-04-16 20:09:51 +03:00
|
|
|
lib = "doc/lib.m4"
|
|
|
|
dir = takeDirectory out
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
tmpl = "doc/manpage.nroff"
|
2016-04-16 20:09:51 +03:00
|
|
|
-- assume all other m4 files in dir are included by this one XXX not true in hledger-lib
|
|
|
|
deps <- liftIO $ filter (/= src) . filter (".m4.md" `isSuffixOf`) . map (dir </>) <$> S.getDirectoryContents dir
|
2018-04-26 02:44:30 +03:00
|
|
|
need $ src : lib : tmpl : deps
|
2019-01-27 03:21:59 +03:00
|
|
|
when (dir=="hledger") $ need commandmds
|
2016-04-16 20:09:51 +03:00
|
|
|
cmd Shell
|
|
|
|
"m4 -P -DMAN -I" dir lib src "|"
|
2019-01-20 02:16:08 +03:00
|
|
|
pandoc fromsrcmd "-s" "--template" tmpl
|
2018-04-22 01:00:45 +03:00
|
|
|
"--lua-filter tools/pandoc-drop-html-blocks.lua"
|
2018-04-22 01:17:00 +03:00
|
|
|
"--lua-filter tools/pandoc-drop-html-inlines.lua"
|
2018-04-22 01:23:07 +03:00
|
|
|
"--lua-filter tools/pandoc-drop-links.lua"
|
2016-04-08 07:58:42 +03:00
|
|
|
"-o" out
|
2016-02-21 13:21:41 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- Generate plain text manuals suitable for embedding in
|
|
|
|
-- executables and viewing with a pager.
|
|
|
|
phony "txtmanuals" $ need txtmanuals
|
|
|
|
txtmanuals |%> \out -> do -- hledger/hledger.txt
|
2017-12-07 07:53:36 +03:00
|
|
|
let src = manualNameToManpageName $ dropExtension out
|
2016-04-16 13:47:00 +03:00
|
|
|
need [src]
|
2016-06-12 07:34:20 +03:00
|
|
|
cmd Shell groff "-t -e -mandoc -Tascii" src "| col -bx >" out -- http://www.tldp.org/HOWTO/Man-Page/q10.html
|
2016-04-16 13:47:00 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- Generate Info manuals suitable for viewing with info.
|
|
|
|
phony "infomanuals" $ need infomanuals
|
|
|
|
infomanuals |%> \out -> do -- hledger/hledger.info
|
2016-04-19 03:54:55 +03:00
|
|
|
let src = out -<.> "m4.md"
|
|
|
|
lib = "doc/lib.m4"
|
|
|
|
dir = takeDirectory out
|
|
|
|
-- assume all other m4 files in dir are included by this one XXX not true in hledger-lib
|
|
|
|
deps <- liftIO $ filter (/= src) . filter (".m4.md" `isSuffixOf`) . map (dir </>) <$> S.getDirectoryContents dir
|
2018-04-26 02:44:30 +03:00
|
|
|
need $ src : lib : deps
|
2019-01-27 03:21:59 +03:00
|
|
|
when (dir=="hledger") $ need commandmds
|
2016-04-19 03:54:55 +03:00
|
|
|
cmd Shell
|
|
|
|
"m4 -P -I" dir lib src "|"
|
2019-01-20 02:16:08 +03:00
|
|
|
pandoc fromsrcmd
|
2018-04-22 01:00:45 +03:00
|
|
|
"--lua-filter tools/pandoc-drop-html-blocks.lua"
|
2018-04-22 01:17:00 +03:00
|
|
|
"--lua-filter tools/pandoc-drop-html-inlines.lua"
|
2018-04-22 01:23:07 +03:00
|
|
|
"--lua-filter tools/pandoc-drop-links.lua"
|
2016-04-19 03:54:55 +03:00
|
|
|
"-t texinfo |"
|
|
|
|
makeinfo "--force --no-split -o" out
|
|
|
|
|
2016-04-16 13:47:00 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- WEBSITE MARKDOWN SOURCE
|
2016-04-16 13:47:00 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- Generate the individual web manuals' markdown source, using m4
|
|
|
|
-- and pandoc to tweak content.
|
|
|
|
phony "webmanuals" $ need webmanuals
|
|
|
|
webmanuals |%> \out -> do -- site/hledger.md
|
2017-12-07 05:16:35 +03:00
|
|
|
let manpage = manpageUriToName $ dropExtension $ takeFileName out -- hledger
|
|
|
|
manual = manpageNameToManualName manpage
|
|
|
|
dir = manpageDir manpage
|
|
|
|
src = dir </> manual <.> "m4.md"
|
2016-04-16 20:09:51 +03:00
|
|
|
lib = "doc/lib.m4"
|
2017-12-07 05:16:35 +03:00
|
|
|
heading = let h = manual
|
2016-04-09 23:36:48 +03:00
|
|
|
in if "hledger_" `isPrefixOf` h
|
|
|
|
then drop 8 h ++ " format"
|
|
|
|
else h
|
2016-04-16 20:09:51 +03:00
|
|
|
-- assume all other m4 files in dir are included by this one XXX not true in hledger-lib
|
|
|
|
deps <- liftIO $ filter (/= src) . filter (".m4.md" `isSuffixOf`) . map (dir </>) <$> S.getDirectoryContents dir
|
2018-04-26 02:44:30 +03:00
|
|
|
need $ src : lib : deps
|
2019-01-27 03:21:59 +03:00
|
|
|
when (manual=="hledger") $ need commandmds
|
2016-04-09 23:36:48 +03:00
|
|
|
liftIO $ writeFile out $ "# " ++ heading ++ "\n\n"
|
2016-04-16 20:09:51 +03:00
|
|
|
cmd Shell
|
|
|
|
"m4 -P -DMAN -DWEB -I" dir lib src "|"
|
2019-01-20 02:16:08 +03:00
|
|
|
pandoc fromsrcmd towebmd
|
2018-04-18 05:25:06 +03:00
|
|
|
"--lua-filter tools/pandoc-demote-headers.lua"
|
2016-04-09 23:36:48 +03:00
|
|
|
">>" out
|
2016-02-21 13:21:41 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- Generate the combined web manual's markdown source, by
|
|
|
|
-- concatenating tweaked versions of the individual manuals.
|
|
|
|
phony "webmancombined" $ need [ webmancombined ]
|
|
|
|
webmancombined %> \out -> do
|
|
|
|
need webmanuals
|
|
|
|
liftIO $ writeFile webmancombined "\\$toc\\$" -- # Big Manual\n\n -- TOC style is better without main heading,
|
|
|
|
forM_ webmanuals $ \f -> do -- site/hledger.md, site/journal.md
|
|
|
|
cmd Shell ("printf '\\n\\n' >>") webmancombined :: Action ExitCode
|
2019-01-20 02:16:08 +03:00
|
|
|
cmd Shell pandoc f towebmd
|
2018-04-22 02:10:24 +03:00
|
|
|
"--lua-filter tools/pandoc-drop-toc.lua"
|
2018-04-18 05:25:06 +03:00
|
|
|
"--lua-filter tools/pandoc-demote-headers.lua"
|
2019-01-20 01:49:20 +03:00
|
|
|
">>" webmancombined :: Action ExitCode
|
2016-08-07 18:28:47 +03:00
|
|
|
|
2019-01-20 04:31:03 +03:00
|
|
|
-- Copy some extra markdown files from the main repo into the site
|
|
|
|
-- TODO adding table of contents placeholders
|
2019-01-20 02:27:44 +03:00
|
|
|
["site/README.md", "site/CONTRIBUTING.md"] |%> \out ->
|
2019-01-20 02:42:43 +03:00
|
|
|
copyFile' (dropDirectory1 out) out -- XXX (map toLower out)
|
2016-04-16 15:55:16 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- WEBSITE HTML & ASSETS
|
|
|
|
|
2019-01-30 23:45:09 +03:00
|
|
|
phony "website" $ need [ "webassets" , "webhtml" ]
|
2019-01-20 01:49:20 +03:00
|
|
|
|
|
|
|
-- copy all static asset files (files with certain extensions
|
|
|
|
-- found under sites, plus one or two more) to sites/_site/
|
|
|
|
phony "webassets" $ do
|
|
|
|
assets <- getDirectoryFiles "site" (map ("//*" <.>) webassetexts)
|
2018-04-28 06:29:26 +03:00
|
|
|
need [ "site/_site" </> file
|
2019-01-20 01:49:20 +03:00
|
|
|
| file <- assets ++ [
|
|
|
|
"files/README"
|
|
|
|
]
|
2018-04-28 06:29:26 +03:00
|
|
|
, not ("_site//*" ?== file)
|
|
|
|
]
|
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- copy any one of the static asset files to sites/_site/
|
|
|
|
"site/_site/files/README" : [ "site/_site//*" <.> ext | ext <- webassetexts ] |%> \out -> do
|
|
|
|
copyFile' ("site" </> dropDirectory2 out) out
|
2018-05-06 08:18:58 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- render all website pages as html, saved in sites/_site/
|
|
|
|
phony "webhtml" $ need webhtmlpages
|
2018-04-28 06:23:14 +03:00
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- render one website page as html, saved in sites/_site/
|
2018-05-06 08:18:58 +03:00
|
|
|
"site/_site//*.html" %> \out -> do
|
|
|
|
let source = "site" </> dropDirectory2 out -<.> "md"
|
|
|
|
pageTitle = takeBaseName out
|
|
|
|
template = "site/site.tmpl"
|
|
|
|
siteRoot = if "site/_site/doc//*" ?== out then "../.." else "."
|
2018-05-19 00:50:54 +03:00
|
|
|
need [source, template]
|
2019-01-20 02:16:08 +03:00
|
|
|
cmd Shell pandoc fromsrcmd "-t html" source
|
2018-05-06 08:18:58 +03:00
|
|
|
"--template" template
|
|
|
|
("--metadata=siteRoot:" ++ siteRoot)
|
|
|
|
("--metadata=title:" ++ pageTitle)
|
2018-05-19 00:50:54 +03:00
|
|
|
"--lua-filter" "tools/pandoc-site.lua"
|
2018-05-06 08:18:58 +03:00
|
|
|
"--output" out
|
|
|
|
|
2019-01-30 21:27:53 +03:00
|
|
|
-- HLEDGER PACKAGES/EXECUTABLES
|
|
|
|
|
2019-01-30 23:45:09 +03:00
|
|
|
phony "build" $ need packages
|
2019-01-30 21:27:53 +03:00
|
|
|
|
2019-01-30 23:45:09 +03:00
|
|
|
-- build any of the hledger packages, after generating any doc
|
|
|
|
-- files they embed or import.
|
2019-01-30 21:27:53 +03:00
|
|
|
sequence_ [ phony pkg $ do
|
|
|
|
need $ fromMaybe [] $ lookup pkg embeddedFiles
|
|
|
|
cmd Shell "stack build " pkg
|
|
|
|
| pkg <- packages ]
|
|
|
|
|
2019-01-31 04:55:56 +03:00
|
|
|
phony "commandhelp" $ need commandtxts
|
|
|
|
|
2019-01-30 21:27:53 +03:00
|
|
|
commandtxts |%> \out -> do
|
|
|
|
let src = out -<.> "md"
|
|
|
|
-- lib = "doc/lib.m4"
|
|
|
|
need [src]
|
|
|
|
cmd Shell
|
|
|
|
-- "m4 -P -DHELP -I" commandsdir lib src "|"
|
2019-01-31 19:34:49 +03:00
|
|
|
pandoc fromsrcmd src "--lua-filter" "tools/pandoc-dedent-code-blocks.lua" "-t plain" ">" out
|
2019-01-20 01:49:20 +03:00
|
|
|
|
2019-02-01 04:36:52 +03:00
|
|
|
-- CHANGELOGS
|
|
|
|
|
|
|
|
let
|
|
|
|
-- git log showing short commit hashes
|
|
|
|
gitlog = "git log --abbrev-commit"
|
|
|
|
|
|
|
|
-- git log formats suitable for changelogs/release notes
|
|
|
|
-- %s=subject, %an=author name, %n=newline if needed, %w=width/indent1/indent2, %b=body, %h=hash
|
|
|
|
changelogGitFormat = "--pretty=format:'- %s (%an)%n%w(0,2,2)%b'"
|
|
|
|
-- changelogVerboseGitFormat = "--pretty=format:'- %s (%an)%n%w(0,2,2)%b%h' --stat"
|
|
|
|
|
|
|
|
-- Format a git log message, with one of the formats above, as a changelog item
|
|
|
|
changelogCleanupCmd = unwords [
|
|
|
|
"sed -E"
|
|
|
|
,"-e 's/^( )*\\* /\1- /'" -- ensure bullet lists in descriptions use hyphens not stars
|
|
|
|
,"-e 's/ \\(Simon Michael\\)//'" -- strip maintainer's author name
|
|
|
|
,"-e 's/^- (doc: *)?(updated? *)?changelogs?( *updates?)?$//'" -- strip some variants of "updated changelog"
|
|
|
|
,"-e 's/^ +\\[ci skip\\] *$//'" -- strip [ci skip] lines
|
|
|
|
,"-e 's/^ +$//'" -- replace lines containing only spaces with empty lines
|
|
|
|
-- ,"-e 's/\r//'" -- strip windows carriage returns (XXX \r untested. IDEA doesn't like a real ^M here)
|
|
|
|
,"-e '/./,/^$/!d'" -- replace consecutive newlines with one
|
|
|
|
]
|
|
|
|
|
|
|
|
-- Things to exclude when doing git log for project-wide changelog.
|
|
|
|
-- git exclude pathspecs, https://git-scm.com/docs/gitglossary.html#gitglossary-aiddefpathspecapathspec
|
|
|
|
projectChangelogExcludeDirs = unwords [
|
|
|
|
":!hledger-lib"
|
|
|
|
,":!hledger"
|
|
|
|
,":!hledger-ui"
|
|
|
|
,":!hledger-web"
|
|
|
|
,":!hledger-api"
|
|
|
|
,":!tests"
|
|
|
|
]
|
|
|
|
|
|
|
|
-- update all changelogs with latest commits
|
|
|
|
phony "changelogs" $ need changelogs
|
|
|
|
|
|
|
|
-- show the changelogs updates that would be written
|
|
|
|
-- phony "changelogs-dry" $ need changelogsdry
|
|
|
|
|
|
|
|
-- CHANGES.md */CHANGES.md CHANGES.md-dry */CHANGES.md-dry
|
|
|
|
-- Add commits to the specified changelog since the tag/commit in
|
|
|
|
-- the topmost heading, also removing that previous heading if it
|
|
|
|
-- was an interim heading (a commit hash). Or (the -dry variants)
|
|
|
|
-- just print the new changelog items to stdout without saving.
|
|
|
|
phonys (\out' -> if
|
|
|
|
| not $ out' `elem` (changelogs ++ changelogsdry) -> Nothing
|
|
|
|
| otherwise -> Just $ do
|
|
|
|
let (out, dryrun) | "-dry" `isSuffixOf` out' = (take (length out' - 4) out', True)
|
|
|
|
| otherwise = (out', False)
|
|
|
|
old <- liftIO $ lines <$> readFileStrictly out
|
|
|
|
|
|
|
|
let dir = takeDirectory out
|
|
|
|
pkg | dir=="." = Nothing
|
|
|
|
| otherwise = Just dir
|
|
|
|
gitlogpaths = fromMaybe projectChangelogExcludeDirs pkg
|
|
|
|
isnotheading = not . ("#" `isPrefixOf`)
|
|
|
|
iscommithash s = length s > 6 && all isAlphaNum s
|
|
|
|
(preamble, oldheading:rest) = span isnotheading old
|
|
|
|
lastversion = words oldheading !! 1
|
|
|
|
lastrev | iscommithash lastversion = lastversion
|
|
|
|
| otherwise = fromMaybe "hledger" pkg ++ "-" ++ lastversion
|
|
|
|
|
|
|
|
headrev <- unwords . words . fromStdout <$>
|
|
|
|
(cmd Shell gitlog "-1 --pretty=%h -- " gitlogpaths :: Action (Stdout String))
|
|
|
|
|
|
|
|
if headrev == lastrev
|
|
|
|
then liftIO $ putStrLn $ out ++ ": up to date"
|
|
|
|
else do
|
|
|
|
newitems <- fromStdout <$>
|
|
|
|
(cmd Shell gitlog changelogGitFormat (lastrev++"..") "--" gitlogpaths
|
|
|
|
"|" changelogCleanupCmd :: Action (Stdout String))
|
|
|
|
let newcontent = "# "++headrev++"\n\n" ++ newitems
|
|
|
|
newfile = unlines $ concat [
|
|
|
|
preamble
|
|
|
|
,[newcontent]
|
|
|
|
,if iscommithash lastrev then [] else [oldheading]
|
|
|
|
,rest
|
|
|
|
]
|
|
|
|
liftIO $ if dryrun
|
|
|
|
then putStr newcontent
|
|
|
|
else writeFile out newfile
|
|
|
|
)
|
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- MISC
|
|
|
|
|
|
|
|
-- Generate the web manuals based on the current checkout and save
|
|
|
|
-- them as the specified versioned snapshot in site/doc/VER/ .
|
|
|
|
-- .snapshot is a dummy file.
|
|
|
|
"site/doc/*/.snapshot" %> \out -> do
|
|
|
|
need $ webmancombined : webmanuals
|
|
|
|
let snapshot = takeDirectory out
|
|
|
|
cmd Shell "mkdir -p" snapshot :: Action ExitCode
|
|
|
|
forM_ webmanuals $ \f -> do -- site/hledger.md, site/journal.md
|
|
|
|
cmd Shell "cp" f (snapshot </> takeFileName f) :: Action ExitCode
|
|
|
|
cmd Shell "cp" "site/manual.md" snapshot :: Action ExitCode
|
|
|
|
cmd Shell "cp -r site/images" snapshot :: Action ExitCode
|
|
|
|
cmd Shell "touch" out -- :: Action ExitCode
|
2016-04-06 01:40:59 +03:00
|
|
|
|
2016-02-21 13:21:41 +03:00
|
|
|
phony "clean" $ do
|
|
|
|
putNormal "Cleaning generated files"
|
2019-01-31 04:55:56 +03:00
|
|
|
removeFilesAfter "." commandtxts
|
2019-01-20 01:49:20 +03:00
|
|
|
removeFilesAfter "." webmanuals
|
|
|
|
removeFilesAfter "." [webmancombined]
|
2019-01-20 02:47:39 +03:00
|
|
|
removeFilesAfter "." ["site/README.md", "site/CONTRIBUTING.md"]
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
|
|
|
|
phony "Clean" $ do
|
|
|
|
need ["clean"]
|
2018-04-28 06:23:05 +03:00
|
|
|
putNormal "Cleaning all site generated files"
|
2016-04-10 00:24:33 +03:00
|
|
|
removeFilesAfter "site" ["_*"]
|
2016-10-29 19:45:59 +03:00
|
|
|
putNormal "Cleaning object files" -- also forces rebuild of executables
|
2017-03-27 14:39:00 +03:00
|
|
|
removeFilesAfter "tools" ["*.o","*.p_o","*.hi"]
|
2016-04-10 00:24:33 +03:00
|
|
|
removeFilesAfter "site" ["*.o","*.p_o","*.hi"]
|
2016-02-21 13:21:41 +03:00
|
|
|
putNormal "Cleaning shake build files"
|
2016-04-13 06:32:01 +03:00
|
|
|
removeFilesAfter ".shake" ["//*"]
|
2019-01-20 00:14:33 +03:00
|
|
|
|
|
|
|
|
2019-01-20 01:49:20 +03:00
|
|
|
-- Convert numbered man page names to manual names.
|
|
|
|
-- hledger.1 -> hledger, hledger_journal.5 -> hledger_journal
|
|
|
|
manpageNameToManualName = dropNumericSuffix
|
|
|
|
where
|
|
|
|
dropNumericSuffix s = reverse $
|
|
|
|
case reverse s of
|
|
|
|
c : '.' : cs | isDigit c -> cs
|
|
|
|
cs -> cs
|
|
|
|
|
|
|
|
-- Convert manual names to numbered man page names.
|
|
|
|
-- hledger -> hledger.1, hledger_journal -> hledger_journal.5
|
|
|
|
manualNameToManpageName s
|
|
|
|
| '_' `elem` s = s <.> "5"
|
|
|
|
| otherwise = s <.> "1"
|
|
|
|
|
2019-01-20 00:14:33 +03:00
|
|
|
dropDirectory2 = dropDirectory1 . dropDirectory1
|
|
|
|
|
2019-02-01 04:36:52 +03:00
|
|
|
readFileStrictly :: FilePath -> IO String
|
|
|
|
readFileStrictly f = readFile f >>= \s -> C.evaluate (length s) >> return s
|
|
|
|
|