Module documentation for 0.3.3.0
Shake+ - Super Powered Shake
Attempt at a batteries included Shake. We reexport replacements for the main utility functions of Shake with the following adjustments whereever possible.
- Well-typed paths using the path library.
- New type classes
RAction r a = RAction (ReaderT r Action a)and
ShakePlus r a = ShakePlus (ReaderT r Rules a)
Stringwherever it is appropriate.
Using the path library is kind of a
no brainer. I lose a lot of time to problems that could be avoided by using
this library, so it’s everywhere. The names for these functions shadow the
existing names, so you may want to
import qualified Development.Shake while
this library progresses if you have other
FilePath based Shake rules that
you want to mix into your build.
Development.Shake.FilePath functions for directory manipulation
are not re-exported in full, and you should use the functions in the path
library (such as
replaceExtension) and other path-based libraries. This will
FilePatterns are kept as-is, as
Path is strongly normalizing it makes
sense to keep these as
ReaderT r Action a transformer (called
RAction) is similar to the
RIO type and should be used
similarly. In fact, you can reuse the logging functions from
RIO within any
RAction block, which is one of the main motivators for having an
which is also a
MonadReader. If you need to reuse an existing shake
Action in an
The main entry point to this library is the
runShakePlus function, which
ReaderT r Rules () to a
Rules () and passes the environment to
ShakePlus and the underlying
RActions have to match. A typical setup might look like this.
let r = --setup env here shake shakeOptions $ do -- include some regular shake rules. runShakePlus r $ do -- some shake-plus rules.
Changelog for shake-plus
- Remove unnecessary comonad dependency.
- Drop dependency on path-like.
- Drop dependency on within.
- Restore monomorphic
Pathvariants of everything.
withinstyle combinators to shake-plus-extended.
- Add dependency on path-like.
- Update interface to use
- Add unlifted versions of
- Add lower bound to aeson.
- Remove hashable dependency.
runSimpleShakePlusfor quickrunning with args and a log function.
Withinstyle functions more consistent in that they actually take
Withinvalues across the board.
batchLoadfunctions more consistent and usable.
wantvariants now take any
- Update to
within-0.1.1.0which changes the data type to an
- Drop the
loadSortFilterApplyloader functions in favour of a simpler
batchLoadset of functions which accepts a loading function which can be cached.
- Add enough documentation to get started.
- Add functions based on Within to better keep track of source and target directories.
- Reexport more shake functions to remove need to import vanilla shake qualified.
- Add convenience functions
loadSortFilterApplyWfor batch loading via
- Add more of the API surface with
Withinincluding variants of