https://github.com/eeue56/elm-init-scripts
https://github.com/eeue56/elm-init-scripts
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/eeue56/elm-init-scripts
- Owner: eeue56
- License: bsd-3-clause
- Created: 2016-04-02T04:24:13.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-05T22:48:30.000Z (about 8 years ago)
- Last Synced: 2025-04-15T01:16:09.917Z (18 days ago)
- Language: Python
- Size: 6.84 KB
- Stars: 25
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# elm-init-scripts
This is a script to bootstrap your projects in the style that NRI uses internally.
This script supports Elm version `0.18.0`
## Usage:
```bash
python bootstrap.py Some.Module.Name app/assets/javascripts/
```
Don't forget to update `elm-package.json` to include the chosen source directory:
```json
{
...
"source-directories": [
"."
...
, "./src"
],
...
"dependencies": {
"elm-lang/core": "5.0.0 <= v < 6.0.0",
"elm-lang/html": "2.0.0 <= v < 3.0.0"
},
"elm-version": "0.18.0 <= v < 0.19.0"
}
```
The script should generate the following files:
`app/assets/javascripts/Some/Module/Name/API.js.elm`
```elm
module Some.Module.Name.API where
module Some.Module.Name.API exposing (main)
import Html exposing (Html)
import Some.Module.Name.Messages exposing (Msg(..))
import Some.Module.Name.Subscriptions exposing (subscriptions)
import Some.Module.Name.Model exposing (Model)
import Some.Module.Name.Update exposing (update)
import Some.Module.Name.View exposing (view)
initialModel : Model
initialModel = { }
init : ( Model, Cmd Msg )
init =
( initialModel
, Cmd.none )
main =
Html.program
{ init = init
, update = update
, view = view
, subscriptions = \_ -> Sub.none }
```
`app/assets/javascripts/Some/Module/Name/Update.elm`
```elm
module Some.Module.Name.Update exposing (update)
import Some.Module.Name.Model exposing (Model)
import Some.Module.Name.Messages exposing (Msg(..))
update : Msg -> Model -> (Model, Cmd Msg)
update msg model =
case msg of
NoOp ->
(model, Cmd.none)
```
`app/assets/javascripts/Some/Module/Name/Model.elm`
```elm
module Some.Module.Name.Model where
type alias Model =
{}
```
`app/assets/javascripts/Some/Module/Name/View.elm`
```elm
module Some.Module.Name.View exposing (view)
import Html exposing (..)
import Html.Attributes exposing (..)
import Html.Events exposing (..)
import Some.Module.Name.Model exposing (Model)
import Some.Module.Name.Messages exposing (Msg(..))
view : Model -> Html Msg
view model =
div [] [ text "Hello world!" ]
```
`app/assets/javascripts/Some/Module/Name/Messages.elm`
```elm
module Some.Module.Name.Messages exposing (Msg(..))
type Msg
= NoOp
```
`app/assets/javascripts/Some/Module/Name/Subscriptions.elm`
```elm
module Some.Module.Name.Subscriptions exposing (subscriptions)
import Some.Module.Name.Model exposing (Model)
import Some.Module.Name.Messages exposing (Msg(..))
subscriptions : Model -> Sub Msg
subscriptions model =
Sub.none
```