Struct TransformPluginProgramMetadata

pub struct TransformPluginProgramMetadata {
    pub comments: Option<PluginCommentsProxy>,
    pub source_map: PluginSourceMapProxy,
    pub unresolved_mark: Mark,
}

Available on (crate features __common_plugin_transform or __plugin_transform_host) and (crate features __common_plugin_transform or __css_plugin_transform or __ecma_plugin_transform) only.

An arbitary metadata for given Program to run transform in plugin. These are not directly attached to Program’s AST structures but required for certain transforms.

Fields

comments: Option<PluginCommentsProxy>

Proxy to the comments for the Program passed into plugin. This is a proxy to the actual data lives in the host. Only when plugin attempts to read these it’ll ask to the host to get values.

source_map: PluginSourceMapProxy

Proxy to the sourceMap for the Program passed into plugin. This is a proxy to the actual data lives in the host. Only when plugin attempts to read these it’ll ask to the host to get values.

unresolved_mark: Mark

Implementations

impl TransformPluginProgramMetadata

pub fn get_transform_plugin_config(&self) -> Option<String>

Returns current plugin’s configuration as a JSON string. Plugin may need to deserialize this string manually.

pub fn get_context( &self, key: &TransformPluginMetadataContextKind, ) -> Option<String>

Returns metadata value for given key.

pub fn get_experimental_context(&self, key: &str) -> Option<String>

Returns an experimental metadata value if exists. Returned value is always a String, but depends on the nature of the metadata it may require additional postprocessing.

Each time this is called, it’ll require a call between host-plugin which involves serialization / deserialization.

Note these metadata values can be changed anytime. There is no gaurantee values will be available across different @swc/core versions.

pub fn get_raw_experimental_context( &self, ) -> HashMap<String, String, FxBuildHasher>

Returns experimental metadata context, but returns whole value as a HashMap.

Each time this is called, it’ll require a call between host-plugin which involves serialization / deserialization.

Trait Implementations

impl Debug for TransformPluginProgramMetadata

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

Formats the value using the given formatter.