Struct ParserReturn

#[non_exhaustive]
pub struct ParserReturn<'a> {
    pub program: Program<'a>,
    pub module_record: ModuleRecord<'a>,
    pub errors: Vec<OxcDiagnostic>,
    pub irregular_whitespaces: Box<[Span]>,
    pub panicked: bool,
    pub is_flow_language: bool,
}

Return value of Parser::parse consisting of AST, errors and comments

AST Validity

program will always contain a structurally valid AST, even if there are syntax errors. However, the AST may be semantically invalid. To ensure a valid AST,

1. Check that errors is empty
2. Run semantic analysis with syntax error checking enabled

Errors

Oxc’s Parser is able to recover from some syntax errors and continue parsing. When this happens,

1. errors will be non-empty
2. program will contain a full AST
3. panicked will be false

When the parser cannot recover, it will abort and terminate parsing early. program will be empty and panicked will be true.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

program: Program<'a>

The parsed AST.

Will be empty (e.g. no statements, directives, etc) if the parser panicked.

Validity

It is possible for the AST to be present and semantically invalid. This will happen if

1. The Parser encounters a recoverable syntax error
2. The logic for checking the violation is in the semantic analyzer

To ensure a valid AST, check that errors is empty. Then, run semantic analysis with syntax error checking enabled.

module_record: ModuleRecord<'a>

See https://tc39.es/ecma262/#sec-abstract-module-records

errors: Vec<OxcDiagnostic>

Syntax errors encountered while parsing.

This list is not comprehensive. Oxc offloads more-expensive checks to semantic analysis, which can be enabled using SemanticBuilder::with_check_syntax_error.

irregular_whitespaces: Box<[Span]>

Irregular whitespaces for Oxlint

panicked: bool

Whether the parser panicked and terminated early.

This will be false if parsing was successful, or if parsing was able to recover from a syntax error. When true, program will be empty and errors will contain at least one error.

is_flow_language: bool

Whether the file is flow.