hakyll-dhall 0.2.1.2 → 0.2.1.3

raw patch · 4 files changed

+30/−44 lines, 4 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

CHANGELOG.md +9/−20
README.md +0/−13
hakyll-dhall.cabal +2/−2
src/Hakyll/Web/Dhall.hs +19/−9

CHANGELOG.md view

@@ -1,32 +1,21 @@ CHANGELOG ========= -Version 0.2.1.2------------------*October 9, 2018*--<https://github.com/mstksg/backprop/releases/tag/v0.2.1.2>--*   Export `interpretDhallCompiler`.--Version 0.2.1.1------------------*October 8, 2018*--<https://github.com/mstksg/backprop/releases/tag/v0.2.1.1>--*   Rearranging documentation.- Version 0.2.1.0 ---------------  *October 8, 2018* -<https://github.com/mstksg/backprop/releases/tag/v0.2.1.0> -*   Swap argument order for `parseDhall` and `parseDhallWith`.+*   [v0.2.1.3][]: Reformatting malformed README.+*   [v0.2.1.2][]: Export `interpretDhallCompiler`.+*   [v0.2.1.1][]: Rearranging documentation.+*   [v0.2.1.0][]: Swap argument order for `parseDhall` and `parseDhallWith`.++[v0.2.1.0]: https://github.com/mstksg/backprop/releases/tag/v0.2.1.0+[v0.2.1.1]: https://github.com/mstksg/backprop/releases/tag/v0.2.1.1+[v0.2.1.2]: https://github.com/mstksg/backprop/releases/tag/v0.2.1.2+[v0.2.1.3]: https://github.com/mstksg/backprop/releases/tag/v0.2.1.3  Version 0.2.0.0 ---------------

README.md view

@@ -9,19 +9,6 @@ customizing rebuilding behavior for network, environment variable, and non-project local files. -`loadDhall` and `loadDhallExpr` allow for loading and parsing of Dhall files-for usage within the 'Compiler' monad, so you can use the results as-intermediate parts in building your pages.  `parseDhall` allows directly-passing in Dhall strings to parse and resolve, tracking imports.-`dhallCompiler` is meant as a "final end-point", which just pretty-prints a-parsed Dhall file, with optional normalization.--Hakyll compiler and loader for Dhall files.  Functions are intended to-track all local dependencies within the project directory, so rebuilds-are properly triggered on up-stream imports.  Provides options for-customizing rebuilding behavior for network, environment variable, and-non-project local files.- There are three major workflows:  1. `dExprCompiler`, `loadDhall`, and `dhallCompiler`, for loading underlying

hakyll-dhall.cabal view

@@ -2,10 +2,10 @@ -- -- see: https://github.com/sol/hpack ----- hash: c1e5f19bf61a64a02470c6299324cd3ceb1563b40c298e49a1fecd02f0583eb4+-- hash: 6f78bcd8cf9547efe49ede6a8b5c6e8faf541543464ec4193bf48dc8f42f7965  name:           hakyll-dhall-version:        0.2.1.2+version:        0.2.1.3 synopsis:       Dhall compiler for Hakyll description:    Please see the README on GitHub at <https://github.com/mstksg/hakyll-dhall#readme> category:       Web

src/Hakyll/Web/Dhall.hs view

@@ -355,7 +355,9 @@ -- expressions into the Hakyll cache, which you can later interpret and -- load  with 'loadDhall' or 'loadDhallSnapshot'.  A @'DExpr' a@ is an -- @'Expr' 'Src' a@, but wrapped so that it has a 'Bi.Binary' instance that--- is usable by the Hakyll cache.+-- is usable by the Hakyll cache.  Tracks all dependencies, so will trigger+-- rebuilds of items that depend on it if any downstream dhall files are+-- modified. -- -- For example, here is a rule to parse and cache all Dhall files in the -- directory ./config:@@ -374,19 +376,19 @@ -- 'loadDhall' 'auto' "config/my_config.dhall" -- @ ----- Note that if the @a@ is not inferrable by type inference (like in the--- situation above), you can specify the @a@ using type application syntax--- (like above).------ Note that this is mostly useful for routes that match many different+-- This is mostly useful for routes that match many different -- files which will be interpreted as values of different types, or for -- caching a single expression that you might want to interpret as -- different types later.  If you want to parse and immediately interpret, -- see 'dhallCompiler'. ----- Note also that this isn't really meant to be a "final end-point", but if--- it is used as such, a pretty-printed version will be rendered to the--- output directory, based on the 'Writable' instance of 'DExpr'.+-- _Note_: If the @a@ is not inferrable by type inference (like in the+-- situation above), you can specify the @a@ using type application syntax+-- (like above).+--+-- _Note_: This isn't really meant to be a "final end-point", but if it is+-- used as such, a pretty-printed version will be rendered to the output+-- directory, based on the 'Writable' instance of 'DExpr'. dExprCompiler :: DefaultDhallResolver a => Compiler (Item (DExpr a)) dExprCompiler = dExprCompilerWith defaultDhallCompilerOptions @@ -421,6 +423,10 @@ -- -- Expects item at identifier to be saved as @'DExpr' 'X'@ (possibly using -- @'dExprCompiler' \@'X'@)+--+-- Tracks dependencies properly, so any pages or routes that use the saved+-- Dhall expression will re-build if any of the downstream Dhall files are+-- edited. loadDhall     :: Type a     -> Identifier@@ -435,6 +441,10 @@ -- -- Expects item at identifier to be saved as @'DExpr' 'X'@ (possibly using -- @'dExprCompiler' \@'X'@)+--+-- Tracks dependencies properly, so any pages or routes that use the saved+-- Dhall expression will re-build if any of the downstream Dhall files are+-- edited. loadDhallSnapshot     :: Type a     -> Identifier