Skip to main content

LensStudio:PluginVerifier

Module

Module providing base classes for writing plugin verifiers that validate plugin behavior in Lens Studio.

Example

// The LensStudio:PluginVerifier module provides infrastructure for
// verifying plugin output before publishing or exporting.
//
// Descriptor: extends BaseDescriptor with canVerify callback
// canVerify(descriptor: IPluginDescriptor): boolean
// Returns true if this verifier should run for the given plugin.
//
// PluginVerifier class:
// verify(pluginDescriptor, outputDir): Promise<void>
// Runs verification; throw to fail the export.

export class PluginVerifierModuleExampleVerifier extends PluginVerifier {
connections: any[];
static descriptor() {
const d = new Descriptor();
d.id = 'com.docs.PluginVerifierModuleExample';
d.name = 'Module Overview Verifier';
d.description = 'Demonstrates a minimal PluginVerifier';
d.canVerify = (desc: any) => {
return desc.id?.startsWith('com.docs.') ?? false;
};
return d;
}
constructor(pluginSystem: Editor.PluginSystem, descriptor?: Descriptor) {
super(pluginSystem, descriptor);
this.connections = [];
}
async verify(pluginDescriptor: any, outputDir: Editor.Path): Promise<void> {
console.log(`Verifying plugin: ${pluginDescriptor.id}`);
console.log(`Output directory: ${outputDir}`);
}
}

Classes

ClassDescription
DescriptorMetadata descriptor for a plugin verifier, including identity fields and a canVerify predicate that selects which plugins to test.
PluginVerifierBase class for plugin verifiers; extend this to implement a verify() method that tests plugin functionality against the editor.