Struct ModuleInfo 

pub struct ModuleInfo {

    pub imports: Vec<Import>,
    pub exports: Vec<Export>,
    pub in_file_references: Vec<String>,
    pub has_cjs_exports: bool,
    pub has_jsx: bool,
    pub jsx_import_source: Option<String>,
    pub jsx_import_source_span: Option<Span>,
    pub directives: Vec<String>,
    pub unresolved_dynamic: Vec<Span>,
    pub ambient_modules: Vec<String>,
    pub augmented_modules: Vec<String>,
    pub commands: Vec<String>,
    pub template_tags: Vec<String>,
    pub parse_diagnostics: Vec<ParseIssue>,
    pub fatal: bool,
}

Everything skif needs to know about one source file.

Fields

imports: Vec<Import>

Module references, in source order.

exports: Vec<Export>

Exports, in source order.

in_file_references: Vec<String>

Export names referenced inside the same file; sorted, deduplicated.

has_cjs_exports: bool

module.exports = …, module.exports.x = … or exports.x = … anywhere in the file. The file is then a CommonJS module whose export names are not tracked: treat all of its exports as used.

has_jsx: bool

The file contains JSX.

jsx_import_source: Option<String>

Value of a @jsxImportSource pragma.

jsx_import_source_span: Option<Span>

Location of the value of the @jsxImportSource pragma. Only a pragma in the comments before the first statement counts.

directives: Vec<String>

Directive prologue strings of the top level, such as use client and use server. See ModuleInfo::is_client_boundary and ModuleInfo::is_server_actions.

unresolved_dynamic: Vec<Span>

import(), require() and import.meta.glob() calls whose argument is not static.

ambient_modules: Vec<String>

Names declared with declare module 'name' { … } in a script (a file without top-level import or export): the declaration is the module, for every file of the program.

augmented_modules: Vec<String>

Names augmented with declare module 'name' { … } in a module file: the block adds to a module that has to exist already and declares nothing on its own.

commands: Vec<String>

The command lines the file runs through node:child_process (execSync('tsc -b'), spawn('eslint', ['.'])), in source order without duplicates; only literal commands. They are parsed like the scripts of package.json.

template_tags: Vec<String>

The tag names of the template of a .vue file as written (AppButton, app-card, div), with the static values of its is attributes (is="AppButton", :is="'AppButton'"), and the names of the resolveComponent('AppButton') calls of any file, sorted and without duplicates: unplugin-vue-components imports the components it registers into the files that use them so (ADR 0020). Empty for other files.

parse_diagnostics: Vec<ParseIssue>

Syntax errors the parser recovered from; the other fields describe the recovered program. For component files, the issues of every script block.

fatal: bool

The parser could not recover (or, for a component file, could not recover in at least one script block): the facts of the affected code are missing. Report the file as unparseable instead of treating it as empty.

Implementations

impl ModuleInfo

pub fn removal_ranges(&self) -> impl Iterator<Item = &Removal>

Removal edits of every export that has one, in source order.

pub fn is_client_boundary(&self) -> bool

The file starts with the "use client" directive: a React Server Components client boundary whose exports are consumed by the framework.

pub fn is_server_actions(&self) -> bool

The file starts with the "use server" directive: every export is a server action the framework calls.

pub fn removal_edits( &self, is_unused: impl Fn(&Export) -> bool, ) -> Vec<(u32, u32)>

Disjoint, sorted deletions that remove every export for which is_unused holds.

Specifier ranges of one statement are merged; a statement whose specifiers are all unused is deleted whole instead of leaving export {}; a RemovalKind::SharedExportKeyword applies only when every sibling is unused.

Trait Implementations

impl Clone for ModuleInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleInfo

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

Formats the value using the given formatter.

impl Default for ModuleInfo

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModuleInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ModuleInfo

impl PartialEq for ModuleInfo

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ModuleInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModuleInfo