Struct SourceType

#[repr(C)]
pub struct SourceType { /* private fields */ }

Source Type for JavaScript vs TypeScript / Script vs Module / JSX

Implementations

impl SourceType

pub const fn cjs() -> Self

Creates a SourceType representing a regular JavaScript file.

This file could be a vanilla script (no module system of any kind) or a CommonJS file.

The resulting source type is not a module, nor does it support JSX. Use SourceType::jsx for JSX sources.

Example

let js = SourceType::cjs();
assert!(js.is_javascript());
assert!(js.is_script()); // not a module
assert!(!js.is_jsx());

pub const fn mjs() -> Self

Creates a SourceType representing a JavaScript file using ES6 modules. This is akin to a file with an .mjs extension.

Example

let mjs = SourceType::mjs();

pub const fn unambiguous() -> Self

A SourceType that will be treated as a module if it contains ESM syntax.

After a file is parsed with an unambiguous source type, it will have a final ModuleKind of either Module or Script.

pub const fn jsx() -> Self

Creates a SourceType representing a JavaScript` file with JSX.

Example

let jsx = SourceType::jsx();
assert!(jsx.is_javascript());
assert!(jsx.is_jsx());

pub const fn ts() -> Self

Creates a SourceType representing a TypeScript file.

Unlike SourceType::cjs, this method creates modules. Use SourceType::tsx for TypeScript files with JSX support.

Example

let ts = SourceType::ts();
assert!(ts.is_typescript());
assert!(!ts.is_typescript_definition());
assert!(ts.is_module());
assert!(!ts.is_jsx());

pub const fn tsx() -> Self

Creates a SourceType representing a TypeScript file with JSX.

Example

let tsx = SourceType::tsx();
assert!(tsx.is_typescript());
assert!(!tsx.is_typescript_definition());
assert!(tsx.is_module());
assert!(tsx.is_jsx());

pub const fn d_ts() -> Self

Creates a SourceType representing a [TypeScript definition] file.

Example

let dts = SourceType::d_ts();
assert!(dts.is_typescript());
assert!(dts.is_typescript_definition());
assert!(dts.is_module());
assert!(!dts.is_jsx());

pub fn is_script(self) -> bool

Mark this source type as a script.

pub fn is_module(self) -> bool

Mark this source type as a module.

pub fn is_unambiguous(self) -> bool

true if this SourceType is unambiguous.

pub fn module_kind(self) -> ModuleKind

What module system is this source type using?

pub fn is_javascript(self) -> bool

Returns true if this is a JavaScript file with or without syntax extensions (like JSX).

pub fn is_typescript(self) -> bool

Returns true if this is a TypeScript file or TypeScript definition file.

I.e., true for .ts, .cts, .mts, .tsx, and .d.ts files.

pub fn is_typescript_definition(self) -> bool

Returns true if this is a TypeScript definition file (e.g. .d.ts).

pub fn is_jsx(self) -> bool

Returns true if this source type is using JSX.

Note that TSX is considered JSX in this context.

pub fn is_strict(self) -> bool

Does this source type implicitly use strict mode semantics?

Does not consider "use strict"; directives.

pub const fn with_script(self, yes: bool) -> Self

Mark this SourceType as a script if yes is true. No change will occur if yes is false.

pub const fn with_module(self, yes: bool) -> Self

Mark this SourceType as a module if yes is true. No change will occur if yes is false.

pub const fn with_unambiguous(self, yes: bool) -> Self

Mark this SourceType as unambiguous if yes is true. No change will occur if yes is false.

pub const fn with_javascript(self, yes: bool) -> Self

Mark this SourceType as using JavaScript if yes is true. No change will occur if yes is false.

pub const fn with_typescript(self, yes: bool) -> Self

Mark this SourceType as using TypeScript if yes is true. No change will occur if yes is false.

pub const fn with_typescript_definition(self, yes: bool) -> Self

Mark this SourceType as a [TypeScript definition] file if yes is true.

pub const fn with_jsx(self, yes: bool) -> Self

Mark this SourceType as using JSX if yes is true. No change will occur if yes is false.

When using TypeScript, this source type now represents a TSX file.

pub const fn with_standard(self, yes: bool) -> Self

Disable language extensions (e.g. JSX) if yes is true. No change will occur if yes is false.

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, UnknownExtension>

Converts a file Path to SourceType.

Examples

// supports .ts, .mts, .cts, .tsx, .d.ts, etc.
let ts = SourceType::from_path("foo.ts").unwrap();
assert!(ts.is_typescript());
assert!(!ts.is_typescript_definition());

// supports .js, .mjs, .cjs, .jsx
let jsx = SourceType::from_path("foo.jsx").unwrap();
assert!(jsx.is_javascript());
assert!(jsx.is_jsx());

Behavior

JSX

All JavaScript-like files are treated as JSX, since some tools (like babel) also do not make a distinction between .js and .jsx. However, for TypeScript files, only .tsx files are treated as JSX.

Note that this behavior deviates from SourceType::cjs, which produces scripts.

Modules vs. Scripts.

Oxc has partial support for Node’s CommonJS detection strategy. Any file with a .c[tj]s extension is treated as a script. All other files are treated as modules.

Errors

Returns UnknownExtension if:

• there is no file name
• the file extension is not one of “js”, “mjs”, “cjs”, “jsx”, “ts”, “mts”, “cts”, “tsx”. See VALID_EXTENSIONS for the list of valid extensions.

Trait Implementations

impl Clone for SourceType

fn clone(&self) -> SourceType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> CloneIn<'a> for SourceType

type Cloned = SourceType

The type of the cloned object.

fn clone_in(&self, _: &'a Allocator) -> Self

Clone self into the given allocator. allocator may be the same one that self is already in.

fn clone_in_with_semantic_ids( &self, allocator: &'new_alloc Allocator, ) -> Self::Cloned

Almost identical as clone_in, but for some special type, it will also clone the semantic ids. Please use this method only if you make sure semantic info is synced with the ast node.

impl ContentEq for SourceType

fn content_eq(&self, other: &Self) -> bool

This method tests for contents of self and other to be equal.

fn content_ne(&self, other: &Self) -> bool

This method tests for contents of self and other not to be equal. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Debug for SourceType

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

Formats the value using the given formatter.

impl Default for SourceType

fn default() -> Self

Returns the “default value” for a type.

impl Hash for SourceType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SourceType

fn eq(&self, other: &SourceType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SourceType

impl Eq for SourceType

impl StructuralPartialEq for SourceType