Release 0.6; and unexpose examples

Author: srid

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Revision history for ema
 
-## Unreleased
+## 0.6.0.0 -- 2022-02-05
 
 - Websocket API: Add `ema.switchRoute` to switch to other routes in live server.
 - Smaller core: remove helpers and examples (examples can be enabled by a flag)
@@ -9,7 +9,7 @@
     - `Ema.Helpers.FileSystem` moved to separate package *unionmount*.
     - `Ema.Helpers.Markdown` moved to separate package *commonmark-simple*.
     - `Ema.Helpers.Blaze` is no more. See `ema-template` if you need a ready made template using blaze HTML and TailwindCSS.
-  - Examples `with-examples` cabal flag is made False by default.
+  - Examples `with-examples` cabal flag is made False by default. Examples are not exposed modules.
   - `Ema.Route.Slug` moved to separate package *url-slug*
 
 ## 0.4.0.0 -- 2022-01-19

ema.cabal

@@ -1,6 +1,6 @@
 cabal-version:      2.4
 name:               ema
-version:            0.5.5.0
+version:            0.6.0.0
 license:            AGPL-3.0-only
 copyright:          2021 Sridhar Ratnakumar
 maintainer:         [email protected]
@@ -38,7 +38,6 @@ library
     , containers
     , data-default
     , dependent-sum
-    , url-slug
     , dependent-sum-template
     , directory
     , filepath
@@ -52,6 +51,7 @@ library
     , relude                  >=0.7      && <1.0
     , text
     , unliftio
+    , url-slug
     , wai
     , wai-middleware-static
     , wai-websockets
@@ -128,7 +128,7 @@ library
     Ema.Server
 
   if flag(with-examples)
-    exposed-modules:
+    other-modules:
       Ema.Example.Common
       Ema.Example.Ex01_HelloWorld
       Ema.Example.Ex02_Basic

src/Ema/Example/Common.hs

@@ -1,8 +1,5 @@
--- | Use Tailwind CSS with blaze-html? Try this module for rapid prototyping of
--- websites in Ema.
 module Ema.Example.Common
-  ( -- * Main functions
-    twindLayout,
+  ( tailwindLayout,
   )
 where
 
@@ -12,8 +9,8 @@ import Text.Blaze.Html5 qualified as H
 import Text.Blaze.Html5.Attributes qualified as A
 
 -- | A simple and off-the-shelf layout using Tailwind CSS
-twindLayout :: H.Html -> H.Html -> LByteString
-twindLayout h b =
+tailwindLayout :: H.Html -> H.Html -> LByteString
+tailwindLayout h b =
   layoutWith "en" "UTF-8" (tailwind2ShimCdn >> h) $
     -- The "overflow-y-scroll" makes the scrollbar visible always, so as to
     -- avoid janky shifts when switching to routes with suddenly scrollable content.

src/Ema/Example/Ex02_Basic.hs

@@ -6,7 +6,7 @@ import Data.LVar qualified as LVar
 import Ema (Ema (..))
 import Ema qualified
 import Ema.CLI qualified as CLI
-import Ema.Example.Common (twindLayout)
+import Ema.Example.Common (tailwindLayout)
 import Text.Blaze.Html5 ((!))
 import Text.Blaze.Html5 qualified as H
 import Text.Blaze.Html5.Attributes qualified as A
@@ -38,7 +38,7 @@ main = do
 
 render :: Model -> Route -> LByteString
 render model r =
-  twindLayout (H.title "Basic site" >> H.base ! A.href "/") $
+  tailwindLayout (H.title "Basic site" >> H.base ! A.href "/") $
     H.div ! A.class_ "container mx-auto" $ do
       H.div ! A.class_ "mt-8 p-2 text-center" $ do
         case r of

src/Ema/Example/Ex03_Clock.hs

@@ -14,7 +14,7 @@ import Data.List ((!!))
 import Data.Time (UTCTime, defaultTimeLocale, formatTime, getCurrentTime)
 import Ema (Ema (..))
 import Ema qualified
-import Ema.Example.Common (twindLayout)
+import Ema.Example.Common (tailwindLayout)
 import Text.Blaze.Html5 ((!))
 import Text.Blaze.Html5 qualified as H
 import Text.Blaze.Html5.Attributes qualified as A
@@ -44,7 +44,7 @@ main = do
 
 render :: UTCTime -> Route -> LByteString
 render now r =
-  twindLayout (H.title "Clock" >> H.base ! A.href "/") $
+  tailwindLayout (H.title "Clock" >> H.base ! A.href "/") $
     H.div ! A.class_ "container mx-auto" $ do
       H.div ! A.class_ "mt-8 p-2 text-center" $ do
         case r of