Skip to content

Latest commit

 

History

History
70 lines (59 loc) · 3.36 KB

README.md

File metadata and controls

70 lines (59 loc) · 3.36 KB

Print pure elm-syntax declarations as grain code.

import Elm.Parser
import ElmSyntaxToGrain

"""module Sample exposing (..)

plus2 : Int -> Int
plus2 n =
    n + ([ 2 ] |> List.sum)
"""
    |> Elm.Parser.parseToFile
    |> Result.mapError (\_ -> "failed to parse elm source code")
    |> Result.map
        (\syntaxModule ->
            [ syntaxModule ]
                |> ElmSyntaxToGrain.modules
                |> .declarations
                |> ElmSyntaxToGrain.grainDeclarationsToModuleString
        )
-->
Ok """module Elm
..some default declarations..

provide let sample_plus2 : (Number) => Number =
    (n) => basics_add(n, list_sum([ 2 ]))
"""

To try it out, you can run this node script.

be aware

  • only a subset of elm is currently supported. not supported:
    • elm/regex, elm/file, elm/bytes, elm/http, elm/random, elm/url, elm/json, elm/parser, elm/virtual-dom, elm/html, elm/svg, elm/browser, elm/time, elm-explorations/markdown, elm-explorations/webgl, elm-explorations/benchmark, elm-explorations/linear-algebra
    • Platform, Platform.Cmd, Platform.Sub, Task, Process
    • ports, glsl, currying, the prefix operator functions (>>) and (<<)
    • ++ will default to List.append unless one of the arguments is a string literal. So e.g. use a ++ b ++ "" to append string variables (which is also faster in elm)
    • Working with anonymous records where the same field names are used together with different fields is likely to run into problems when accessing 
      [ { a = 0, b = 1 }.a
, { a = 0, c {- problem -} = 2 }.a
]
    • potential future candidates: Basics.(<<), Basics.(>>), Basics.clamp, Basics.degrees, Basics.turns, Basics.radians, Basics.logBase, Basics.toPolar, Basics.fromPolar, Basics.never, List.map5, List.map4, Char.toLocaleLower, Char.toLocaleUpper, Char.isAlpha, Char.isAlphaNum, Char.isDigit, Char.isOctDigit, Char.isHexDigit, String.split, String.contains, List.partition, List.map3/4/5, List.sortBy, Bitwise, Array. Any help appreciated!
  • no checks are performed before transpiling to grain. So if you don't add a compile check of your elm input, you might e.g. get a running program that circumvents an elm opaque type or phantom type, or a grain program that can't be run
  • not much care has been put into making the resulting code readable or even conventionally formatted and comments are not preserved

Please report any issues you notice <3

why grain?

  • it runs fast and has exceptional support for Wasm
  • it's pretty much a superset of elm which makes transpiling easy

Honestly, it's a match made in heaven. I've fought against too slim standard libraries, type checking anonymous records and parsing inconsistencies in all other languages but grain had none of these problems!

shoutout