moonrockz/gleam-parser/format

README
U
Arg
U
ArgNames
U
Assert
U
AssignName
U
Assignment
U
AssignmentKind
U
BinOp
U
BindingError
U
BitArrayOption
U
BitArraySegment
U
BitArraySize
U
BitArrayUnit
U
Budget
U
ByteLength
U
ByteOffset
U
CallArg
U
ChildIndex
U
Clause
U
ClauseGuard
U
ColumnNumber
U
Comment
U
CommentError
U
CommentKind
U
Config
U
ConfigError
U
Constant
U
Control
U
CoordinateError
U
CustomType
U
DecodeError
U
Definition
U
DefinitionCst
U
DefinitionKind
U
Deprecation
U
Diagnostic
U
Dialect
U
Documentation
U
EnterEvent
U
Environment
U
Event
U
EventReader
U
EventSource
U
ExportError
U
Expr
U
Extended
U
ExtendedError
U
External
U
ExternalBinding
U
ExternalBindings
U
FormatError
U
Fuel
U
FuelExhausted
U
Function
U
FunctionLiteralKind
U
Handler
U
ImplicitCallArgOrigin
U
Import
U
ImportAlias
U
IncorrectNamePosition
U
IntOperator
U
InvalidBitArrayUnit
U
InvalidBudget
U
Keyword
U
Label
U
LeaveEvent
U
LexicalErrorType
U
LineCount
U
LineNumber
U
Module
U
ModuleConstant
U
ModuleCst
U
ModuleExtra
U
NestingLimit
U
NodeDepth
U
NodePath
U
NodeRef
U
Operation
U
OracleOutput
U
ParseError
U
ParseErrorDetails
U
ParseErrorType
U
ParseResult
U
Parsed
U
Partial
U
PathStep
U
Pattern
U
Position
U
Profile
U
ProfileError
U
Profiles
U
Publicity
U
RecordBeingUpdated
U
RecordConstructor
U
RecordConstructorArg
U
RecordUpdateArg
U
RegistrationError
U
Rule
U
Severity
U
Source
U
SourceText
U
SpannedString
U
Spent
U
SrcSpan
U
Statement
U
StringPrefixLeftSideAssignment
U
TailPattern
U
Target
U
TargetName
U
TargetRegistry
U
TargetedDefinition
U
TodoKind
U
Token
U
TokenKind
U
TokenStream
U
TraversalValueError
U
Tree
U
TreeCursor
U
Trivia
U
TupleIndex
U
TypeAlias
U
TypeAst
U
TypeAstConstructor
U
TypeAstConstructorName
U
TypeAstFn
U
TypeAstHole
U
TypeAstTuple
U
TypeAstVar
U
UnicodeEscapeError
U
UnqualifiedImport
U
Use
U
UseAssignment
U
Utf16Offset
U
Visitor
U
Warning
V
accept
V
canonical
V
decode_expr
V
decode_extended
V
decode_oracle_output
V
decode_parsed
V
default_budget
V
diagnostic_description
V
encode_diagnostics
V
encode_expr
V
encode_extended
V
encode_oracle_output
V
encode_parsed
V
fold
V
format
V
format_parsed
V
kind_table
V
parse_float_value
V
parse_int_value
V
parse_module
V
parse_text
V
push_events
V
reduce
V
reduce_with_fields
V
render_plain
V
render_terminal
V
tokenize
V
tokenize_text
V
version
V
walk

moonrockz/gleam-parser/format does not have a README file

FormatError

pub(all) suberror FormatError {
  DialectMismatch(expected~ : @moonrockz/gleam-parser/dialect.Dialect
Dialect, supplied~ : @moonrockz/gleam-parser/dialect.Dialect
Dialect)
  ParseFailed(Array[@moonrockz/gleam-parser/diagnostic.Diagnostic
Diagnostic])
  OutOfFuel(@moonrockz/gleam-parser/fuel.FuelExhausted
FuelExhausted)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Why format gives no text.

format

source

fn format(text : String, config? : @moonrockz/gleam-parser/config.Config
Config) -> String raise FormatError

Format Gleam source as gleam format (1.19.2) does: 80 columns, two spaces of indentation, no options. Comments and empty lines are kept where the compiler keeps them; the output is idempotent and parses again where the compiler's is (see "Format Parity" in AGENTS.md for the known differences). Raises ParseFailed when the text has a syntax error, OutOfFuel when config.fuel runs out.

test {
  inspect(
    @format.format("pub fn main(){\n  io.println(  \"hi\" )\n}\n"),
    content="pub fn main() {\n  io.println(\"hi\")\n}\n",
  )
}

format_parsed

source

fn format_parsed(result : @moonrockz/gleam-parser/parser.ParseResult
ParseResult, config? : @moonrockz/gleam-parser/config.Config
Config) -> String raise FormatError

Format a parse result, as format formats text. The source is rebuilt from the CST (byte for byte), so the comments keep their text. Raises ParseFailed when the result has an error diagnostic. By default, use the configuration stored in the result. An explicit different dialect raises DialectMismatch; an explicit fuel change is allowed. Every target and external binding is preserved. Layout changes can move source locations.

test {
  let r = @parser.parse_text("//// m\n// c\n")
  inspect(@format.format_parsed(r), content="//// m\n\n// c\n")
}

Site source Report issue Packages Build queue Skills Statistics

#FormatError

#format

#format_parsed

Source Files

FormatError

format

format_parsed