Plugin Development

API reference

Quick reference for classes and utilities

API Reference

Core Classes

Plugin - Top-level plugin container
Resource<T> - Abstract base class for resources
StatefulParameter<T, V> - Stateful parameter implementation
Plan<T> - Change set representation

Utility Functions

// PTY access
getPty(): IPty

// Path utilities
tildify(absolutePath: string): string
untildify(pathWithTilde: string): string

// File utilities
fileExists(path: string): Promise<boolean>
directoryExists(path: string): Promise<boolean>

// Array utilities
areArraysEqual<T>(a: T[], b: T[], isEqual?: (a: T, b: T) => boolean): boolean

Best practices

Write reliable, maintainable plugins

Examples

Real-world plugin examples

On this page

API Reference Core Classes Utility Functions