Struct ParsedSource 

pub struct ParsedSource(/* private fields */);

A parsed source containing an AST, comments, and possibly tokens.

Note: This struct is cheap to clone.

Implementations

impl ParsedSource

pub fn analyze_cjs(&self) -> CjsAnalysis

Analyzes the script for CommonJS exports and re-exports based on similar functionality to cjs-module-lexer (https://github.com/nodejs/cjs-module-lexer).

impl ParsedSource

pub fn analyze_es_runtime_exports(&self) -> ModuleExportsAndReExports

Analyzes the ES runtime exports for require ESM.

This is used during CJS export analysis when a CJS module re-exports an ESM module and the original CJS module needs to know the exports of the ESM module so it can create its wrapper ESM module.

impl ParsedSource

pub fn specifier(&self) -> &ModuleSpecifier

Gets the module specifier of the module.

pub fn media_type(&self) -> MediaType

Gets the media type of the module.

pub fn text(&self) -> &Arc<str>

Gets the text content of the module.

pub fn text_info_lazy(&self) -> &SourceTextInfo

Gets an object with pre-computed positions for lines and indexes of multi-byte chars.

Note: Prefer using .text() over this if able because this is lazily created.

pub fn range(&self) -> SourceRange<StartSourcePos>

Gets the source range of the parsed source.

pub fn program(&self) -> Arc<Program>

Gets the parsed program.

pub fn program_ref(&self) -> ProgramRef<'_>

Gets the parsed program as a reference.

pub fn comments(&self) -> &MultiThreadedComments

Gets the comments found in the source file.

pub fn globals(&self) -> &Globals

Wrapper around globals that swc uses for transpiling.

pub fn get_leading_comments(&self) -> Option<&Vec<Comment>>

Get the source’s leading comments, where triple slash directives might be located.

pub fn tokens(&self) -> &[TokenAndSpan]

Gets the tokens found in the source file.

This will panic if tokens were not captured during parsing.

pub fn into_with_scope_analysis(self) -> Self

Adds scope analysis to the parsed source if not parsed with scope analysis.

Note: This will attempt to not clone the underlying data, but will clone if multiple clones of the ParsedSource exist.

pub fn has_scope_analysis(&self) -> bool

Gets if the source’s program has scope information stored in the identifiers.

pub fn top_level_context(&self) -> SyntaxContext

Gets the top level context used when parsing with scope analysis.

This will panic if the source was not parsed with scope analysis.

pub fn unresolved_context(&self) -> SyntaxContext

Gets the unresolved context used when parsing with scope analysis.

This will panic if the source was not parsed with scope analysis.

pub fn diagnostics(&self) -> &Vec<ParseDiagnostic>

Gets extra non-fatal diagnostics found while parsing.

pub fn script_module_diagnostics(&self) -> &Vec<ParseDiagnostic>

Diagnostics that should be surfaced when transpiling if the file parsed as a script is discovered to be a module.

pub fn is_module(&self) -> bool

👎Deprecated: use compute_is_script() instead

Gets if this source is a module.

pub fn is_script(&self) -> bool

👎Deprecated: use compute_is_script() instead

Gets if this source is a script.

pub fn compute_is_script(&self) -> bool

Computes whether this program should be treated as a script.

impl ParsedSource

pub fn with_view<'a, T>(&self, with_view: impl FnOnce(Program<'a>) -> T) -> T

Gets a dprint-swc-ext view of the module.

This provides a closure to examine an “ast view” of the swc AST which has more helper methods and allows for going up the ancestors of a node.

Read more: https://github.com/dprint/dprint-swc-ext

impl ParsedSource

pub fn transpile( self, transpile_options: &TranspileOptions, transpile_module_options: &TranspileModuleOptions, emit_options: &EmitOptions, ) -> Result<TranspileResult, TranspileError>

Transform a TypeScript file into a JavaScript file attempting to transpile owned, then falls back to cloning the program.

When calling this, you should stirve to only have one reference to ParsedSource in order to prevent cloning.

Trait Implementations

impl Clone for ParsedSource

fn clone(&self) -> ParsedSource

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParsedSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SourceRanged for ParsedSource

fn start(&self) -> SourcePos

fn end(&self) -> SourcePos

fn range(&self) -> SourceRange

fn byte_width(&self) -> usize

fn start_line_fast<'a, P>(&self, source: P) -> usize

where P: SourceTextInfoProvider<'a>,

fn end_line_fast<'a, P>(&self, source: P) -> usize

where P: SourceTextInfoProvider<'a>,

fn start_column_fast<'a, P>(&self, source: P) -> usize

where P: SourceTextInfoProvider<'a>,

fn end_column_fast<'a, P>(&self, source: P) -> usize

where P: SourceTextInfoProvider<'a>,

fn column_at_pos<'a, P>(&self, source: P, pos: SourcePos) -> usize

where P: SourceTextInfoProvider<'a>,

fn char_width_fast<'a, P>(&self, source: P) -> usize

where P: SourceTextProvider<'a>,

fn text_fast<'a, P>(&self, source: P) -> &'a str

where P: SourceTextProvider<'a>,

fn tokens_fast<'a>(&self, program: impl RootNode<'a>) -> &'a [TokenAndSpan]

fn leading_comments_fast<'a>( &self, program: impl RootNode<'a>, ) -> CommentsIterator<'a>

fn trailing_comments_fast<'a>( &self, program: impl RootNode<'a>, ) -> CommentsIterator<'a>

fn previous_token_fast<'a>( &self, program: impl RootNode<'a>, ) -> Option<&'a TokenAndSpan>

fn next_token_fast<'a>( &self, program: impl RootNode<'a>, ) -> Option<&'a TokenAndSpan>

fn previous_tokens_fast<'a>( &self, program: impl RootNode<'a>, ) -> &'a [TokenAndSpan]

fn next_tokens_fast<'a>(&self, program: impl RootNode<'a>) -> &'a [TokenAndSpan]

impl<'a> SourceTextProvider<'a> for &'a ParsedSource

fn text(&self) -> &'a Arc<str>

fn start_pos(&self) -> StartSourcePos