🥮 mooncakes.io
    Sign in

    smithy-syntax

    Smithy syntax for MoonBit: lossless IDL parser, traversal, diagnostics and typed JSON AST codec

    smithy
    idl
    parser
    ast
    moonbit
    Download zip
    Author
    Version
    0.1.0
    License
    Apache-2.0
    Repository
    Last updated
    6 days ago
    Downloads
    74

    #moonrockz/smithy-syntax

    Smithy syntax for MoonBit: a lossless IDL scanner, a typed AST with spans, a CST that prints the source back byte for byte, a parser with recovery per statement, diagnostics in the style of Elm and Rust, and a typed JSON AST codec.

    #Status

    • Scanner: done.
    • AST: done.
    • CST: done.
    • Parser: done.
    • Diagnostics: done.
    • Traversal: done (traversal: NodeRef, walk, fold, reduce, accept, events, Tree, TreeCursor).
    • JSON AST: done (json_ast: typed records, decoder and encoder with exact numeric text round trips).

    #Example

    test {
      let r = @syntax.parse_idl(
        (
          #|$version: "2"
          #|namespace com.foo
          #|
          #|string Name
          #|
        ),
        name="a.smithy",
      )
      inspect(r.has_errors(), content="false")
    }

    #Installation

    moon add moonrockz/smithy-syntax

    #Packages

    PackageImport pathHolds
    spanmoonrockz/smithy-syntax/spanSpan, Position, SourceText
    diagnostic.../diagnosticSeverity, Label, Diagnostic, codes()
    scanner.../scannerTokenKind, Token, Trivia, Comment, TokenStream, tokenize, unescape, text_block_value
    ast.../astthe typed IDL tree
    cst.../cstIdlCst, StatementCst, StatementKind
    parser.../parserparse, parse_tokens, ParseResult, Version, max_nesting
    traversal.../traversalNodeRef, walk, fold, reduce, reduce_pruned, accept, EventReader, push_events, Tree, TreeCursor, NodePath, kind_table
    report.../reportrender_terminal, render_plain, render_short
    json_ast.../json_astJsonAst, shape records, parse, decode, encode, stringify
    rootmoonrockz/smithy-syntaxparse_idl, parse_json_ast, decode_json_ast, encode_json_ast, public type re-exports

    Dependencies point one way: span ← diagnostic ← scanner ← ast ← cst ← parser ← traversal and report ← root (traversal and report do not import each other). Each package has a README.mbt.md with checked examples. See the design in DESIGN.md, and the cookbook in docs/cookbook for task articles.

    The JSON AST package depends on core JSON and the IDL AST's simple-type enum. Its package guide defines the codec's preservation and validation rules. The semantic loader and IDL-to-JSON conversion are available in moonrockz/smithy.

    The facade also exports parse_tokens, codes and render_all_to. Use the scanner package for its pipeline records Piece and Step, and the parser package for Depth and ParseError. Property-test generators are internal.

    ShapeKind::keyword() and its Show implementation return IDL keywords. NumberLiteral::as_double() returns signed infinity on overflow. The exact number stays in NumberLiteral::value. Partial trees may contain duplicate member names; check has_errors() before relying on member uniqueness.

    AggregateType

    source

    The AST.

    ApplyStatement

    source

    The AST.

    Column

    source

    Spans (UTF-16 unit offsets), positions and source text.

    Comment

    source

    The scanner: tokens, trivia and lexical errors.

    CommentKind

    source

    The scanner: tokens, trivia and lexical errors.

    Control

    source

    The traversal: the node model, the cursor, the tree and the event types.

    ControlStatement

    source

    The AST.

    Diagnostic

    source

    Diagnostics: severity, labels and the problem record.

    DocComment

    source

    The AST.

    EnterEvent

    source

    The traversal: the node model, the cursor, the tree and the event types.

    EntityType

    source

    The AST.

    EnumMember

    source

    The AST.

    EnumType

    source

    The AST.

    Event

    source

    The traversal: the node model, the cursor, the tree and the event types.

    EventReader

    source

    The traversal: the node model, the cursor, the tree and the event types.

    EventSource

    source

    The traversal: the node model, the cursor, the tree and the event types.

    Handler

    source

    The traversal: the node model, the cursor, the tree and the event types.

    IdlCst

    source

    The CST: every token grouped per statement.

    IdlFile

    source

    The AST.

    InlineShape

    source

    The AST.

    JsonAst

    source

    Typed Smithy JSON AST records. The IDL AST and JSON AST are separate representations; converting between them requires the semantic loader.

    JsonMember

    source

    Typed Smithy JSON AST records. The IDL AST and JSON AST are separate representations; converting between them requires the semantic loader.

    JsonOperation

    source

    Typed Smithy JSON AST records. The IDL AST and JSON AST are separate representations; converting between them requires the semantic loader.

    JsonReference

    source

    Typed Smithy JSON AST records. The IDL AST and JSON AST are separate representations; converting between them requires the semantic loader.

    JsonResource

    source

    Typed Smithy JSON AST records. The IDL AST and JSON AST are separate representations; converting between them requires the semantic loader.

    JsonService

    source

    Typed Smithy JSON AST records. The IDL AST and JSON AST are separate representations; converting between them requires the semantic loader.

    JsonShape

    source

    Typed Smithy JSON AST records. The IDL AST and JSON AST are separate representations; converting between them requires the semantic loader.

    JsonShapeKind

    source

    Typed Smithy JSON AST records. The IDL AST and JSON AST are separate representations; converting between them requires the semantic loader.

    Keyword

    source

    The AST.

    Label

    source

    Diagnostics: severity, labels and the problem record.

    LeaveEvent

    source

    The traversal: the node model, the cursor, the tree and the event types.

    Length

    source

    Spans (UTF-16 unit offsets), positions and source text.

    Line

    source

    Spans (UTF-16 unit offsets), positions and source text.

    Member

    source

    The AST.

    MemberTarget

    source

    The AST.

    MetadataStatement

    source

    The AST.

    Mixins

    source

    The AST.

    NamespaceStatement

    source

    The AST.

    Node

    source

    The AST.

    NodeKvp

    source

    The AST.

    NodePath

    source

    The traversal: the node model, the cursor, the tree and the event types.

    NodeRef

    source

    The traversal: the node model, the cursor, the tree and the event types.

    NodeValue

    source

    The AST.

    NumberLiteral

    source

    The AST.

    NumberValue

    source

    The AST.

    Offset

    source

    Spans (UTF-16 unit offsets), positions and source text.

    OperationProperty

    source

    The AST.

    OperationTarget

    source

    The AST.

    ParseResult

    source

    The parser's result and declared version.

    PathStep

    source

    The traversal: the node model, the cursor, the tree and the event types.

    Position

    source

    Spans (UTF-16 unit offsets), positions and source text.

    Severity

    source

    Diagnostics: severity, labels and the problem record.

    Shape

    source

    The AST.

    ShapeId

    source

    The AST.

    ShapeKind

    source

    The AST.

    ShapeStatement

    source

    The AST.

    SimpleType

    source

    The AST.

    SourceText

    source

    Spans (UTF-16 unit offsets), positions and source text.

    Span

    source

    Spans (UTF-16 unit offsets), positions and source text.

    Statement

    source

    The AST.

    StatementCst

    source

    The CST: every token grouped per statement.

    StatementKind

    source

    The CST: every token grouped per statement.

    Token

    source

    The scanner: tokens, trivia and lexical errors.

    TokenKind

    source

    The scanner: tokens, trivia and lexical errors.

    TokenStream

    source

    The scanner: tokens, trivia and lexical errors.

    Trait

    source

    The AST.

    TraitBody

    source

    The AST.

    Tree

    source

    The traversal: the node model, the cursor, the tree and the event types.

    TreeCursor

    source

    The traversal: the node model, the cursor, the tree and the event types.

    Trivia

    source

    The scanner: tokens, trivia and lexical errors.

    UseStatement

    source

    The AST.

    Version

    source

    The parser's result and declared version.

    Visitor

    source

    The traversal: the node model, the cursor, the tree and the event types.

    accept

    source

    Call one Visitor method per node; see @traversal.accept.

    codes

    source
    fn codes() -> ArrayView[String]

    Every registered diagnostic code, in table order.

    decode_json_ast

    source

    Decode a Smithy JSON AST value, with JSON Pointer paths on errors.

    diagnostic_description

    source
    fn diagnostic_description(code : String) -> String?

    The one-line description of a diagnostic code, or None.

    encode_json_ast

    source
    fn encode_json_ast(document : 
    JsonAst    ) -> Json

    Encode a typed Smithy JSON AST document.

    fold

    source

    Thread an accumulator through a walk; see @traversal.fold.

    kind_table

    source
    fn kind_table() -> Array[(String, String, Array[String])]

    Every node type: (category, kind, fields); see @traversal.kind_table.

    parse

    source

    Parse a source text with recovery per statement.

    parse_idl

    source
    fn parse_idl(text : String, name? : String) -> 
    ParseResult

    Parse Smithy IDL text. name is shown in rendered diagnostics.

    test {
      let r = @syntax.parse_idl(
        (
          #|$version: "2"
          #|namespace com.foo
          #|
          #|string Name
          #|
        ),
        name="a.smithy",
      )
      inspect(r.has_errors(), content="false")
    }

    parse_json_ast

    source
    fn parse_json_ast(text : String) -> 
    JsonAst     raise

    Parse a Smithy JSON AST document from text.

    parse_tokens

    source

    Parse an existing lossless token stream, with recovery per statement.

    push_events

    source

    Drive an event source into a handler; see @traversal.push_events.

    reduce

    source

    Reduce root bottom up; see @traversal.reduce.

    reduce_pruned

    source

    Reduce bottom up, steered by enter; see @traversal.reduce_pruned.

    render_all

    source

    Render every diagnostic in order, ending with an error/warning count.

    render_all_to

    source

    Render every diagnostic and the summary into a caller's sink.

    render_plain

    source

    Render one diagnostic without colour, as the Elm/Rust-style layout.

    render_short

    source

    Render one diagnostic as a single line, for editors (path:line:col:severity[code]: message).

    render_terminal

    source

    Render one diagnostic for a terminal, with ANSI colour by default.

    render_terminal_to

    source

    Render into any core Logger, for callers with their own sink.

    tokenize

    source

    Scan source into tokens with trivia. Lossless: to_source() is the text.

    version

    source
    fn version() -> String

    The version of smithy-syntax, maintained from the root moon.mod by scripts/versions.mbtx set and checked by validate:versions.

    walk

    source

    Visit root and every node below it in pre-order; see @traversal.walk.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io