0.4.2 • Published 8 months ago

elm-shiori v0.4.2

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

elm-shiori

  • 自作カードゲームのUI確認モチベで作っています
  • storybook + doctest的なツール
  • elmのPATH通す必要あり
  • 現状bunの利用必須、クロスコンパイルは気が向いたら
  • bunあまりよくわかってない
  • 使い方の雰囲気はexamples(作りかけ)
  • macでしか動作確認していない
  • coderabbitaiお試し中

インストール

bun(推奨)

bun add -D elm-shiori
bun -b shiori init

npm(未検証)

npm i -D bun elm-shiori
npx bun -b shiori init

pnpm(ちょっとだけ試した)

pnpm i -D bun elm-shiori
pnpm bun -b shiori init

使い方

1.初回はbun -b shiori initを実行

2.【Optional】shiori/src/Shiori_View.elmを編集

3.【Optional】shiori/src/index.htmlを編集し任意のCSSやjs等読み込ませる

4.examplesを参考にshiori.jsonを設定

5.コメント追加

6.bun -b shiori serve

7.【Optional】shiori/src/Shiori.elmを編集し外観を変更

コメントの書き方

単体

{-|

    <shiori> button

-}
button : Html Msg
button =
    div []
        [ Html.button [ onClick Sample ] [ text "button" ]
        ]

引数有りの場合

{-|

    <shiori> button "World"

-}
button : String -> Html Msg
button str =
    div []
        [ Html.button [ onClick Sample ] [ text <| "Hello " ++ str ]
        ]

複数

{-|

    <shiori> button "World"

    <shiori> button "World2"

-}
button : String -> Html Msg
button str =
    div []
        [ Html.button [ onClick Sample ] [ text <| "Hello " ++ str ]
        ]

import

{-|

    import Html exposing (div)

    <shiori> div [] <| .body <| view { world = "world" }

-}
view : Model -> { title : String, body : List (Html Msg) }
view model =
    { title = "home"
    , body = [ text <| "hello " ++ model.world ]
    }

複数行

  • 現状非対応です。1行で書き切ってください。
  • 気が向いたら対応します。

CLI

bun -b shiori init
bun -b shiori build
bun -b shiori serve

開発

  • global install必要
    • bun
    • elm

基本

cd examples/【n-任意】
bun --watch ../../bin/shiori.ts serve

検証

bun add -D https://github.com/TheSacredLipton/elm-shiori.git#branch-name
bun -b shiori init

あるいはインストール

npm publish

  • とりあえず手動
  • 気が向いたらgithub actions
bun npm-publish

ライセンス

  • MIT license
  • 一部elm-codegenで生成されたコードを含みます
0.4.1

8 months ago

0.4.0

8 months ago

0.4.2

8 months ago

0.3.0

12 months ago

0.2.1

2 years ago

0.2.0

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago