avh4 / elm-compile-html

Compile HTML templates into Elm code

Compile HTML files into Elm code!

Installation

git clone https://github.com/avh4/elm-compile-html.git
cd elm-compile-html
npm install --global

Use

elm-package install evancz/elm-html
elm-compile-html MyHtmlFile.html > MyHtmlFile.elm

You can now import MyHtmlFile as an Elm module:

import MyHtmlFile

main = MyHtmlFile.render

Example

MyPanel.html:

<div class="panel panel-default">
  <div class="panel-heading">
    <h3 class="panel-title">Panel title</h3>
  </div>
  <div class="panel-body">
    Panel content
  </div>
</div>

Running elm-compile MyPanel.html yields:

module MyPanel where

import Html exposing (Html)
import Html.Attributes as Attr

render : Html
render = Html.node "div"
    [ Attr.attribute "class" "panel panel-default" ]
    [ Html.text "\n  "
    , Html.node "div"
        [ Attr.attribute "class" "panel-heading" ]
        [ Html.text "\n    "
        , Html.node "h3" [ Attr.attribute "class" "panel-title" ] [ Html.text "Panel title" ]
        , Html.text "\n  "
        ]
    , Html.text "\n  "
    , Html.node "div" [ Attr.attribute "class" "panel-body" ] [ Html.text "\n    Panel content\n  " ]
    , Html.text "\n"
    ]

Demos

See examples/Clock/README.md.

Development

Running tests:

npm test

elm-compile-html's Issues

Generate `Attr.class` instead of `Attr.attribute "class"`

This will make the resulting vdom nodes have className properties instead of class attributes, which is desirable for making Html testable.

Generate `Attr.id` instead of `Attr.attribute "id"`

See #9

Add command line argument to specify module name

Make sure double quotes work in text and attributes

generate module names with '.'s in them

elm-compile-html Path/To/MyHtmlFile.html should yield module Path.To.MyHtmlFile.

pretty-print generated code

Escape newline characters in generated code

With no args, should read input from stdin

The generated module should have documentation

Use properties instead of attributes where appropriate

See #9.

This applies to almost every attribute defined in Html.Attributes.

The generated module should explicitly list what it exposes