Crate oxc_semantic

Semantic analysis of a JavaScript/TypeScript program.

Example

#![expect(clippy::print_stdout)]
use std::{env, path::Path, sync::Arc};

use itertools::Itertools;
use oxc_allocator::Allocator;
use oxc_parser::Parser;
use oxc_semantic::SemanticBuilder;
use oxc_span::SourceType;

// Instruction:
// create a `test.js`,
// run `cargo run -p oxc_semantic --example semantic`
// or `just watch "run -p oxc_semantic --example semantic"`

fn main() -> std::io::Result<()> {
    let name = env::args().nth(1).unwrap_or_else(|| "test.js".to_string());
    let path = Path::new(&name);
    let source_text = Arc::new(std::fs::read_to_string(path)?);
    let source_type = SourceType::from_path(path).unwrap();
    // Memory arena where Semantic and Parser allocate objects
    let allocator = Allocator::default();

    // Parse the source text into an AST
    let parser_ret = Parser::new(&allocator, &source_text, source_type).parse();
    if !parser_ret.errors.is_empty() {
        let error_message: String = parser_ret
            .errors
            .into_iter()
            .map(|error| format!("{:?}", error.with_source_code(Arc::clone(&source_text))))
            .join("\n");
        println!("Parsing failed:\n\n{error_message}",);
        return Ok(());
    }

    let program = parser_ret.program;

    let semantic = SemanticBuilder::new()
        // Enable additional syntax checks not performed by the parser
        .with_check_syntax_error(true)
        .build(&program);

    if !semantic.errors.is_empty() {
        let error_message: String = semantic
            .errors
            .into_iter()
            .map(|error| format!("{:?}", error.with_source_code(Arc::clone(&source_text))))
            .join("\n");
        println!("Semantic analysis failed:\n\n{error_message}",);
    }

    Ok(())
}

Modules

dot

Structs

AstNode

Semantic node contains all the semantic information about an ast node.

AstNodes

Untyped AST nodes flattened into an vec

JSDoc

JSDocFinder

JSDocTag

NodeFlags

Contains additional information about an AST node.

NodeId

AST Node ID

Reference

Describes where and how a Symbol is used in the AST.

ReferenceFlags

Describes how a symbol is being referenced in the AST.

ReferenceId

ScopeFlags

ScopeId

Scoping

Symbol Table and Scope Tree

Semantic

Semantic analysis of a JavaScript/TypeScript program.

SemanticBuilder

Semantic Builder

SemanticBuilderReturn

Data returned by SemanticBuilder::build.

Stats

Statistics about data held in Semantic.

SymbolFlags

SymbolId

Traits

IsGlobalReference

Checks whether the a identifier reference is a global value or not.